SetOnControlDownEventHandler

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 specified Control ID is pressed.

When invoked, the script is passed with a single argument: the pressed Control ID.

Syntax

[help]

SetOnControlDownEventHandler handlerScript:ref setORremove:1/0 controlID:int

Example

SetOnControlDownEventHandler OnControlDownUDF 1 4

Sets the OnControlDownUDF script as a handler to be invoked whenever the Attack control is pressed.

SetOnControlDownEventHandler OnControlDownUDF 0 4

Removes the OnControlDownUDF script as a handler for the above.

Handler Script

A skeleton handler script for this event:

scn	OnControlDownUDF

int	iControlID

begin Function {iControlID}

(code)

end

See Also

• SetOnControlUpEventHandler
• OnControlUp / OnControlDown (uses the NVSE event handling system)