Difference between revisions of "Settings"
From ReflexCLI
| Line 10: | Line 10: | ||
===Control Keys=== | ===Control Keys=== | ||
;Open Console Key | ;Open Console Key | ||
| − | :Defines the key to open the console. Defaults to Tab. If you are using Tab in your game (i.e. to open a different menu, then you will want to change this to prevent conflicts. | + | :Defines the key to open the console. Defaults to Tab. If you are using Tab in your game (i.e. to open a different menu, then you will want to change this to prevent conflicts). |
;Close Console Key | ;Close Console Key | ||
| − | :Defines the key to close the console. Defaults to Escape. If you are using escape as pause (etc.), you can either remap this key, or suppress your menu opening when the console is open (see | + | :Defines the key to close the console. Defaults to Escape. If you are using escape as pause (etc.), you can either remap this key, or suppress your menu opening when the console is open (see [[Conflict With Game Inputs]] for details). |
===Logging=== | ===Logging=== | ||
| Line 20: | Line 20: | ||
===Command Format=== | ===Command Format=== | ||
| + | ;Default Naming Convention | ||
| + | :Commands are given default names based upon the method/field/property name in code. To help prevent name collisions, they are also prefixed with the class and namespace names. This setting will modify what gets included in the prefix. | ||
| + | :Options are as follows: | ||
| + | :*Namespace and Class Prefix | ||
| + | :*Class Prefix | ||
| + | :*No Prefix | ||
| + | |||
;Suggestions Case Insensitive | ;Suggestions Case Insensitive | ||
:allows suggestions and autocomplete to be case insensitive when matching user input. Generally preferred. | :allows suggestions and autocomplete to be case insensitive when matching user input. Generally preferred. | ||
| + | |||
| + | ;Hierarchical Autocomplete | ||
| + | :When presenting typing in the console, suggestions and autocomplete will only show until the next separator (normally '.' or '/') when this option is selected. | ||
| + | |||
| + | ===Console Behaviour=== | ||
| + | ;Include Inactive Objects | ||
| + | :When searching for GameObjects and Components in the scene view, inactive objects will be included in the search. | ||
| + | |||
| + | ===Console Visuals=== | ||
| + | ;Console Font | ||
| + | :Select an override font asset for the console, i.e. to theme with your game, or simply to enable a monospaced font to feel more "console-y"! | ||
Revision as of 13:54, 3 January 2018
To modify the configuration of the console, go to the following from the main "Edit" menu in the Unity Editor:
- Edit/Project Settings/Reflex/Console Settings
Contents
Settings
General
- Enable Console
- Globally enables / disables the console. NOTE that the console will, by default, be compiled out in release (non-development) builds, regardless of this setting. See Build Configuration for details.
Control Keys
- Open Console Key
- Defines the key to open the console. Defaults to Tab. If you are using Tab in your game (i.e. to open a different menu, then you will want to change this to prevent conflicts).
- Close Console Key
- Defines the key to close the console. Defaults to Escape. If you are using escape as pause (etc.), you can either remap this key, or suppress your menu opening when the console is open (see Conflict With Game Inputs for details).
Logging
- Display Unity Log
- Allows the Unity Log to be piped to the Reflex Console. Useful for development builds, to easily see all log messages.
Command Format
- Default Naming Convention
- Commands are given default names based upon the method/field/property name in code. To help prevent name collisions, they are also prefixed with the class and namespace names. This setting will modify what gets included in the prefix.
- Options are as follows:
- Namespace and Class Prefix
- Class Prefix
- No Prefix
- Suggestions Case Insensitive
- allows suggestions and autocomplete to be case insensitive when matching user input. Generally preferred.
- Hierarchical Autocomplete
- When presenting typing in the console, suggestions and autocomplete will only show until the next separator (normally '.' or '/') when this option is selected.
Console Behaviour
- Include Inactive Objects
- When searching for GameObjects and Components in the scene view, inactive objects will be included in the search.
Console Visuals
- Console Font
- Select an override font asset for the console, i.e. to theme with your game, or simply to enable a monospaced font to feel more "console-y"!
