OnPlayerRelease

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
< [[::Category:Functions|Category:Functions]]

A function added by the Lutana NVSE plugin.

Description

Event block type that calls the UDF when the when the player releases (drops the grabbed ref) (Control Code 27 ) the form or form in the formlist. Released (ref) is passed to the UDF. Can be filtered with a form or formlist.

Syntax

[help]
(grabbedRef:ref) SetEventHandler "OnPlayerRelease" myUDF:userDefinedFunction


Example with no filtering

SetEventHandler "OnPlayerRelease" MyUDF

scn MyUDF

ref rReleasedRef

begin function {rReleasedRef}

end function

Example with filtering by a form

SetEventHandler "OnPlayerRelease" ""::someForm MyUDF

scn MyUDF

ref rReleasedRef

begin function {rReleasedRef}

end function


Example with filtering by formlist

SetEventHandler "OnPlayerRelease" ""::someFormList MyUDF

scn MyUDF

ref rReleasedRef

begin function {rReleasedRef}

end function 


See Also