Anvil
Anvil.Services.IScriptDispatcher Interface Reference

Implement in a service to add a custom handler for event scripts. More...

+ Inheritance diagram for Anvil.Services.IScriptDispatcher:

Public Member Functions

ScriptHandleResult ExecuteScript (string scriptName, uint oidSelf)
 Called when the game would execute the specified script name. More...
 

Properties

int ExecutionOrder [get]
 

Detailed Description

Implement in a service to add a custom handler for event scripts.

Member Function Documentation

◆ ExecuteScript()

ScriptHandleResult Anvil.Services.IScriptDispatcher.ExecuteScript ( string  scriptName,
uint  oidSelf 
)

Called when the game would execute the specified script name.

Parameters
scriptNameThe script being called.
oidSelfThe current object context (OBJECT_SELF).
Returns
If this is a conditional script, return True or False. Otherwise return Handled if this script should not be called by other dispatchers or the game.

The documentation for this interface was generated from the following file: