Difference between revisions of "Help"
Jump to navigation
Jump to search
Scrivener07 (talk | contribs) (Added the Help console command. I used Skyrim as a guide https://ck.uesp.net/wiki/Help) |
Scrivener07 (talk | contribs) (I am exploring a new presentation for parameters.) |
||
| Line 1: | Line 1: | ||
[[Category:Console Commands]] | [[Category:Console Commands]] | ||
[[Category:Designer Debug Tools]] | [[Category:Designer Debug Tools]] | ||
[[Help]] lists all available console commands and forms that contain a specified word. Use Page Up and Page Down to scroll through the list. | [[Help]] lists all available console commands and forms that contain a specified word. Use {{key press|Page Up}} and {{key press|Page Down}} to scroll through the list. | ||
==Syntax== | ==Syntax== | ||
<source> | |||
Help <matchstring> <filter> <form type> | |||
</source> | |||
{| class="wikitable" | |||
|+style="text-align:left"|<big>Parameters</big> | |||
|- | |||
! 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== | ==Parameters== | ||
* '''matchstring | * '''matchstring:''' The word to search for may be in the command name or description. | ||
* '''filter | * '''filter:''' Will filter results to the given category. The default filter is 0 when none is provided. | ||
** '''0) All:''' This will return matches from all categories. | ** '''0) All:''' This will return matches from all categories. | ||
** '''1) Functions:''' This will return matches from the function category. | ** '''1) Functions:''' This will return matches from the function category. | ||
** '''2) Settings:''' This will return matches from the settings category. | ** '''2) Settings:''' This will return matches from the settings category. | ||
** '''3) Globals:''' This will return matches from the [[Global]] category. | ** '''3) Globals:''' This will return matches from the [[Global]] category. | ||
** '''4) Other Forms:''' Specifies a | ** '''4) Other Forms:''' Specifies a ''form type'' to use as the [[Object]] category filter. | ||
* '''form type | * '''form type:''' The form type is 4 characters and is ignored unless the filter is 4. | ||
==Examples== | ==Examples== | ||
Revision as of 21:55, 21 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
Help <matchstring> <filter> <form type>| 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
- matchstring: The word to search for may be in the command name or description.
- filter: Will filter results to the given category. The default filter is 0 when none is provided.
- 0) 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.
- form type: The form type is 4 characters and is ignored unless the filter is 4.
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.