OnCrosshairOn
From GECK
A function added by the Lutana NVSE plugin, now part of the JIP NVSE Plugin.
Contents
Description
Event block type that calls the UDF when the a new ref is found 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 "OnCrosshairOn:25" etc.
This event functions similarly to the GetCrosshairRef function - it only tracks refs within activation distance.
Syntax
(crosshairRef:ref) SetEventHandler "OnCrosshairOn" myUDF:userDefinedFunction
Example with no filtering
SetEventHandler "OnCrosshairOn" MyUDF
scn MyUDF
ref rCrosshairRef
begin function {rCrosshairRef}
end function
Example with filtering by a form
SetEventHandler "OnCrosshairOn" ""::someForm MyUDF
scn MyUDF
ref rCrosshairRef
begin function {rCrosshairRef}
end function
Example with filtering by formlist
SetEventHandler "OnCrosshairOn" ""::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
