Difference between revisions of "Help"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
(Added the Help console command. I used Skyrim as a guide https://ck.uesp.net/wiki/Help)
 
(Added link to object class list for type codes used with the help command.)
 
(3 intermediate revisions by the same user not shown)
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==
Help <matchstring> <filter> <form type>
{| class="wikitable"
|+style="text-align:left"|
<big>
<source>
Help <matchstring> <filter> <form type>
</source>
</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. See [[Object Class List]] for type codes.
|}


==Parameters==
===Parameters===
* '''matchstring::<code>string</code>:''' The word to search for may be in the command name or description.
{| class="wikitable"
* '''filter::<code>int</code>:''' Will filter results to the given category. The default filter is 0 when none is provided.
|+style="text-align:left"|
** '''0) All:''' This will return matches from all categories.
<big><code><filter></code></big>
** '''1) Functions:''' This will return matches from the function category.
|-
** '''2) Settings:''' This will return matches from the settings category.
! Value !! Description
** '''3) Globals:''' This will return matches from the [[Global]] category.
|-
** '''4) Other Forms:''' Specifies a user provided ''form type'' to use as a category filter.
| 0 ''(Default)'' || All: This will return matches from all categories.
* '''form type::<code>string</code>:''' The form type is 4 characters and is ignored unless the filter is 4.
|-
| 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 category filter. See [[Object Class List]] for type codes.
|}


==Examples==
==Examples==
Line 27: Line 50:


==See Also==
==See Also==
[[:Category:Console Commands| Console Commands]]
* [[:Category:Console Commands| Console Commands]]
* [[Console]]
* [[Object Class List]]

Latest revision as of 02:50, 23 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[edit | edit source]

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. See Object Class List for type codes.

Parameters[edit | edit source]

<filter>
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 category filter. See Object Class List for type codes.

Examples[edit | edit source]

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[edit | edit source]