SetJohnnyOnSettingsUpdateEventHandler

From GECK
Jump to: navigation, search


A function added by the JohnnyGuitar NVSE Plugin.

Description

Sets/removes the specified UDF Script as a handler that will be invoked when the user makes changes in Settings Menu and closes it.

Syntax

[help]
SetJohnnyOnSettingsUpdateEventHandler setORremove:1/0 handlerScript:ref flag:int 

Or:

SetOnSettingsUpdateEventHandler setORremove:1/0 handlerScript:ref flag:int

Example

SetJohnnyOnSettingsUpdateEventHandler 1 OnSettingsUpdateUDF 0

Sets the OnSettingsUpdateUDF script as a handler to be invoked when settings are changed.

SetJohnnyOnSettingsUpdateEventHandler 0 OnSettingsUpdateUDF 0

Removes the OnSettingsUpdateUDF script as a handler of the above.

Handler Script

A skeleton handler script for this event:

scn OnSettingsUpdateUDF 

begin Function {} 

...

end

Notes

  • Flag argument is reserved for future use and should always be 0.

See Also