Help

Revision as of 22:55, 21 February 2023 by Scrivener07 (talk | contribs) (I am exploring a new presentation for parameters.)

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>
Parameters
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.

See Also

Console Commands