SetOnMouseoverChangeEventHandler

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 mouseover-ed, or highlighted selection in the specified Menu Mode, is changed.

When invoked, the script is passed with a single argument: the Menu Mode ID.

Syntax

[help]

SetOnMouseoverChangeEventHandler handlerScript:ref setORremove:1/0 menuID:int

Example

SetOnMouseoverChangeEventHandler OnMouseoverChangeUDF 1 1002

Sets the OnMouseoverChangeUDF script as a handler to be invoked when the highlighted selection in the Inventory Menu is changed.

SetOnMouseoverChangeEventHandler OnMouseoverChangeUDF 0 1002

Removes the OnMouseoverChangeUDF script as a handler of the above.

Notes

• Use any of GetActiveUIComponentID, GetActiveUIComponentName, or GetActiveUIComponentFullName to determine which UI component is currently selected.
• Where applicable, use GetSelectedItemRef to determine which item is currently selected.

Handler Script

A skeleton handler script for this event:

scn	OnMouseoverChangeUDF

int	iMenuID

begin Function {iMenuID}

(code)

end