Index | Collapse All Expand All

AddCommand Method
Shell Class Members See Also

Beta Documentation - Subject to change.
Adds a command that can be executed.

# Syntax

Lua
    function Shell.AddCommand(name, shellCommand);

#### Parameters

name
  Type: string
  The name of the command that can be execute. Multiple names can be specified by separating them using a semicolon ';'.

shellCommand
  Type: ShellCommand
  The shell command to bind to the names.

#### Returns

Type: number
The number of names from the name argument that were successful registered.

# Remarks

This method will attempt to register the shell command specified for each of the names specified in the semicolon separated list of names passed into the name argument.The return value indicates how many of the names were successful registered. This may be less than the number of names specified if some of the names are already bound to other commands in the shell.

# See Also

- Shell
- Turbine