SetJohnnyOnFailQuestEventHandler

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 a specified Quest (or any Quest) is failed. Formlists are also accepted as filters. When invoked, the script is passed with a single argument: a Quest that was failed.

Syntax

[help]
SetJohnnyOnFailQuestEventHandler setORremove:1/0 handlerScript:ref flag:int quest:filter 

Or:

SetOnFailQuestEventHandler setORremove:1/0 handlerScript:ref flag:int quest:filter

Example

SetJohnnyOnFailQuestEventHandler 1 OnFailQuestUDF 0 MyQuest

Sets the OnFailQuestUDF script as a handler to be invoked when MyQuest is started.

SetJohnnyOnFailQuestEventHandler 0 OnFailQuestUDF 0 MyQuest

Removes the OnFailQuestUDF script as a handler of the above.

Handler Script

A skeleton handler script for this event:

scn OnFailQuestUDF

ref rQuest

begin Function {rQuest} 

...

end

Notes

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

See Also