SetOnFastTravelEventHandler

From the Fallout3 GECK Wiki
Revision as of 17:53, 24 January 2017 by imported>Jazzisparis (Created page with "{{Function |origin = JIP |summary = Sets/removes the specified '''UDF Script''' as a handler that will be invoked in the event the player fast-travels to a '''Map Marker'''....")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
< [[::Category:Functions|Category:Functions]]

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 fast-travels to a Map Marker. When invoked, the script is passed with a single argument: the Map Marker reference traveled to.

Syntax

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

Example

SetOnFastTravelEventHandler OnPCFastTravelUDF 1

Sets the OnPCFastTravelUDF script as a handler.

SetOnFastTravelEventHandler OnPCFastTravelUDF 0

Removes the OnPCFastTravelUDF script as a handler.

Handler Script

A skeleton handler script for this event:

scn	OnPCFastTravelUDF

ref	rMapMarkerRef

begin Function {rMapMarkerRef}

(code)

end

See Also