Directory Opus Manual

User Tools

Site Tools

You are here: Introduction » Reference » Scripting Reference » Scripting Events » OnScriptFAYTCommand

Sidebar

reference:scripting_reference:scripting_events:onscriptfaytcommand

OnScriptFAYTCommand

The OnScriptFAYTCommand event is the entry point for a script add-in that extends the FAYT field. The actual name of the event is defined by the script itself, when the command is added via the ScriptInitData.AddCommand method - OnScriptFAYTCommand is merely a placeholder name.

Method Name: OnScriptFAYTCommand

Argument Type:

ScriptFAYTCommandData 

Return Type:

none

Description:

When a script extends the FAYT field by adding a new internal command using ScriptInitData.AddCommand, it specifies the name of its entry point with the ScriptCommand.method property. When the FAYT extension is triggered, Opus will call that method within your script.

The ScriptFAYTCommandData object provides information about what the user has typed to trigger your extension.