GetShortHelp
From LoTROInterface Wiki
(Difference between revisions)
(New page: {{API_Breadcrumb|API Reference > Turbine.ShellCommand.'''{{PAGENAME}}()'''}} Gets a short help string for the command. ==Syntax== {{...) |
Current revision (11:01, 24 September 2010) (view source) |
||
| Line 1: | Line 1: | ||
| - | {{API_Breadcrumb|[[:Category:API_Reference|API Reference]] > [[Turbine_(Package)|Turbine]].[[ShellCommand]].''' | + | {{API_Breadcrumb|[[:Category:API_Reference|API Reference]] > [[Turbine_(Package)|Turbine]].[[ShellCommand]].'''GetShortHelp()'''}} |
| + | __NOTOC__ | ||
| - | Gets a short help string for the command. | + | Gets a short help string for the command. |
==Syntax== | ==Syntax== | ||
| - | {{API_Example|Lua|function ShellCommand:GetShortHelp();}} | + | {{API_Example|Lua|{{API_Keyword|function}}{{API_Whitespace| }}ShellCommand{{API_Operator|:}}GetShortHelp{{API_Operator|(}}{{API_Operator|)}}{{API_Operator|;}}{{API_Whitespace|<br>}}}} |
====Returns==== | ====Returns==== | ||
| - | {{API_Type|string|A short help string for the command | + | {{API_Type|string|A short help string for the command.}} |
==Remarks== | ==Remarks== | ||
| - | The short help text is the text display when a | + | The short help text is the text display when a play displays the entire list of commands. |
| + | |||
[[Category:API_Methods]] | [[Category:API_Methods]] | ||
Current revision
API Reference > Turbine.ShellCommand.GetShortHelp()
Gets a short help string for the command.
Syntax
| Lua | |
|---|---|
| function ShellCommand:GetShortHelp(); | |
Returns
Type: string
A short help string for the command.
Remarks
The short help text is the text display when a play displays the entire list of commands.