SetOnLocationDiscoverEventHandler

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Sets/removes the specified UDF Script as a handler that will be invoked in the event the player discovers a new location (and unlocks a Map Marker).

When invoked, the script is passed with a single argument: the Map Marker reference of the discovered location.

Syntax

[help]
SetOnLocationDiscoverEventHandler handlerScript:ref setORremove:1/0

Example

SetOnLocationDiscoverEventHandler OnLocationDiscoverUDF 1

Sets the OnLocationDiscoverUDF script as a handler.

SetOnLocationDiscoverEventHandler OnLocationDiscoverUDF 0

Removes the OnLocationDiscoverUDF script as a handler.

Handler Script

A skeleton handler script for this event:

scn	OnLocationDiscoverUDF

ref	rMapMarkerRef

begin Function {rMapMarkerRef}

(code)

end