~~Title: OnScriptCommand ~~
<pageheader/>

The **OnScriptCommand** event is the entry point for an [[:scripting:example_scripts:adding_a_new_internal_command|internal command]] added by a [[:scripting:script_add-ins|script add-in]]. The actual name of the event is defined by the script itself, when the command is added via the **[[..:scripting_objects:scriptinitdata|ScriptInitData]].AddCommand** method - **OnScriptCommand** is merely a placeholder name.


<commandtable columns="2" id="cmdtable_1">
$$ (#)**Method Name:**
$$ OnScriptCommand
$$ (#)**Argument Type:**
$$ **[[..:scripting_objects:scriptcommanddata|ScriptCommandData]]** 
$$ (#)**Return Type:**
$$ //bool//
$$ (#)**Description:**
$$ When a script add-in adds a new internal command using **ScriptInitData.AddCommand**, it specifies the name of its entry point with the **ScriptCommand.method** property. When the internal command is run, Opus will call that method within your script.

The **ScriptCommandData.func** property provides information about the command environment (including any parsed arguments), and the **cmdline** property provides the raw command line that invoked your command.

Return the value `1` from this event if you want your function to be called once for each selected file. Otherwise your entry point will only be called once, and you can query all selected files using the various objects provided.

If this event returns **True** the function will be aborted - you might do this if an error occurs and the user chooses to abort the operation.
</commandtable>