Skip to content

Commit 903b27a

Browse files
committedJul 28, 2021
2 parents e1d1b9a + aede526 commit 903b27a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed
 

‎.github/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ Custom commands can be added to the dev console by developers. They can be creat
5252
#### Parameters
5353
Default supported parameter types implement the [``IConvertible``](https://docs.microsoft.com/en-us/dotnet/api/system.iconvertible) interface (e.g. int, float, string, bool, etc.)</br>
5454
Enums are also supported.</br>
55+
Commands that use a nullable bool (Boolean?) parameter accept "~", "!", "null", and "toggle" - used primarily as a toggle.</br>
56+
E.g. executing "<b>showfps !</b>" will toggle showing the fps on-screen.</br></br>
5557
To add a custom type, use ``DevConsole.AddParameterType<T>()`` (see FAQ below).
5658

5759
#### Example using Command.Create
@@ -85,8 +87,9 @@ The asset provides various built-in commands.
8587
- ``help (String)commandName``: display helpful information about the specified command.
8688
- ``print (String)message``: display a message in the dev console log.
8789
- ``exit``: exit the game.
88-
- ``fullscreen (Boolean)enabled``: query or set whether the window is fullscreen.
90+
- ``fullscreen (Boolean?)enabled``: query or set whether the window is fullscreen.
8991
- ``bind (InputKey)key (String)command``: bind the specified key to execute a command, even if the dev console window is closed.
92+
- ``showfps (Boolean?)enabled``: query or set whether to display the fps on-screen.
9093
- ``scene_load (Int32)buildIndex``: load a scene.
9194
- ``scene_info (Int32)sceneIndex``: display information about an active scene.
9295
- ``obj_list``: display a hierarchical list of all game objects in the scene.

0 commit comments

Comments
 (0)
Please sign in to comment.