SetOnNoteAddedEventHandler

From GECK
Jump to: navigation, search


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 a new Note is added to the player.

When invoked, the script is passed with a single argument: the Note form that was added.

Syntax

[help]
SetOnNoteAddedEventHandler handlerScript:ref setORremove:1/0

Example

SetOnNoteAddedEventHandler OnNoteAddedUDF 1

Sets the OnNoteAddedUDF script as a handler.

SetOnNoteAddedEventHandler OnNoteAddedUDF 0

Removes the OnNoteAddedUDF script as a handler.

Handler Script

A skeleton handler script for this event:

scn	OnNoteAddedUDF

ref	rNote

begin Function {rNote}

(code)

end