Sidebar
reference:scripting_reference:scripting_objects:scriptcommanddata
ScriptCommandData
The ScriptCommandData object is passed to the script-defined entry points for any internal commands added by a script add-in. The method name for these events is defined by the script itself, but generically it's referred to as OnScriptCommand.
| Property Name | Return Type | Description |
|---|---|---|
cmdline |
string |
This returns the original command line that invoked the command. If any arguments were provided on the command line they are available in parsed form from the func.args property. |
fayt |
string |
If this is a string, it means this is being called as a FAYT extension command. If set to False it's a regular command. |
func |
object:Func |
Returns a Func object relating to this function. This provides access to information about the function's environment (source and destination tabs, etc) as well as any variables and parsed command line arguments. |