GetCommands
From LoTROInterface Wiki
(Difference between revisions)
(New page: {{API_Breadcrumb|API Reference > Turbine.Shell.'''{{PAGENAME}}()'''}} Gets the list of commands available by the shell. ==Syntax== {...) |
Current revision (10:58, 24 September 2010) (view source) |
||
| Line 1: | Line 1: | ||
| - | {{API_Breadcrumb|[[:Category:API_Reference|API Reference]] > [[Turbine_(Package)|Turbine]].[[Shell]].''' | + | {{API_Breadcrumb|[[:Category:API_Reference|API Reference]] > [[Turbine_(Package)|Turbine]].[[Shell]].'''GetCommands()'''}} |
| + | __NOTOC__ | ||
| - | Gets the list of commands available by the shell. | + | Gets the list of commands available by the shell. |
==Syntax== | ==Syntax== | ||
| - | {{API_Example|Lua|function Shell.GetCommands();}} | + | {{API_Example|Lua|{{API_Keyword|function}}{{API_Whitespace| }}Shell{{API_Operator|.}}GetCommands{{API_Operator|(}}{{API_Operator|)}}{{API_Operator|;}}{{API_Whitespace|<br>}}}} |
====Returns==== | ====Returns==== | ||
| - | + | {{API_Type|string|The list of available commands that can be executed.}} | |
| - | {{API_Type|string| | + | |
==Remarks== | ==Remarks== | ||
| + | This method will return a list of strings that identifies all the commands that can be executed from a user's chat window. This list includes all aliases for commands as well. | ||
| - | |||
[[Category:API_Methods]] | [[Category:API_Methods]] | ||
Current revision
API Reference > Turbine.Shell.GetCommands()
Gets the list of commands available by the shell.
Syntax
| Lua | |
|---|---|
| function Shell.GetCommands(); | |
Returns
Type: string
The list of available commands that can be executed.
Remarks
This method will return a list of strings that identifies all the commands that can be executed from a user's chat window. This list includes all aliases for commands as well.