OnCrosshairOff

From GECK
Jump to: navigation, search


A function added by the Lutana NVSE plugin, now part of the JIP NVSE Plugin.

Description

Event block type that calls the UDF when the current ref is no longer in the crosshair. Crosshair (ref) is passed to the UDF. Can be filtered with a form or list, or Form Type. OnCrosshairOn and OnCrosshairOff can also be filtered by form type via "OnCrosshairOff:25" etc.

Syntax

[help]
(crosshairRef:ref) SetEventHandler "OnCrosshairOff" myUDF:userDefinedFunction 

Example with no filtering

SetEventHandler "OnCrosshairOff" MyUDF

scn MyUDF

ref rCrosshairRef

begin function {rCrosshairRef}

end function

Example with filtering by a form

SetEventHandler "OnCrosshairOff" ""::someForm MyUDF

scn MyUDF

ref rCrosshairRef

begin function {rCrosshairRef}

end function


Example with filtering by formlist

SetEventHandler "OnCrosshairOff" ""::someFormList MyUDF

scn MyUDF

ref rCrosshairRef

begin function {rCrosshairRef}

end function 


Example with filtering by form type 24 (armor)

SetEventHandler "OnCrosshairOff:24" MyUDF

scn MyUDF

ref rCrosshairRef

begin function {rCrosshairRef}

end function  



See Also