Difference between revisions of "Help"
Jump to navigation
Jump to search
Scrivener07 (talk | contribs) (Changed the syntax and parameter values to use wiki tables.) |
Scrivener07 (talk | contribs) m (Added link to Console menu page.) |
||
| Line 50: | Line 50: | ||
==See Also== | ==See Also== | ||
[[:Category:Console Commands| Console Commands]] | * [[:Category:Console Commands| Console Commands]] | ||
* [[Console]] | |||
Revision as of 23:14, 22 February 2023
Help lists all available console commands and forms that contain a specified word. Use Page Up and Page Down to scroll through the list.
Syntax
| Type | Name | Value | Description |
|---|---|---|---|
| string | matchstring | The word to search for may be in the command name or description. | |
| integer | filter | Default:0, Range:0-4 | Will filter results to the given category. The default filter is 0 when none is provided. |
| string | form type | 4 character type code | The form type is 4 characters and is ignored unless the filter is 4. |
Parameters
| Value | Description |
|---|---|
| 0 (Default) | All: This will return matches from all categories. |
| 1 | Functions: This will return matches from the function category. |
| 2 | Settings: This will return matches from the settings category. |
| 3 | Globals: This will return matches from the Global category. |
| 4 | Other Forms: Specifies a form type to use as the Object category filter. |
Examples
Help
All commands, functions, and forms will be listed.
Help quest
All commands, functions, and forms with the word "quest" will be listed.
Help quest 1
All functions with the word "quest" will be listed.