Skip to content

Commit 81d8a15

Browse files
authored
Update DOCUMENTATION.md
1 parent 25f56f3 commit 81d8a15

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

DOCUMENTATION.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,13 @@ Custom commands can be added to the dev console by developers. They can be creat
3838
- Add the ``[DevConsoleCommand]`` attribute above a static method declaration, using the method body as the callback and arguments as command parameters.
3939

4040
#### Parameters
41-
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>
42-
Enums are also supported.</br>
43-
Commands that use a nullable bool (``Boolean?``) parameter accept "~", "!", "null", and "toggle" - used primarily as a toggle.</br>
44-
For example, executing "<b>showfps !</b>" will toggle showing the fps on-screen.</br></br>
45-
To add a custom type, use ``DevConsole.AddParameterType<T>()`` (see FAQ below).
41+
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>
42+
To add a custom type, use ``DevConsole.AddParameterType<T>()`` (see FAQ below).</br>
43+
- Enums are also supported.</br>
44+
- Nullable-type parameters accept "null" and "~" (e.g. ``GameObject`` or ``Color?``).
45+
- Value-type parameters accept "default" and "~" (e.g. ``Int32`` or ``Color``).
46+
47+
Commands that use a nullable bool (``Boolean?``) are used primarily as a toggle. For example, executing "<b>showfps ~</b>" will toggle showing the fps on-screen.
4648

4749
#### Example using Command.Create
4850
```cs
@@ -132,4 +134,4 @@ Listed below are all the built-in commands that come with the developer console
132134
- ``time``: Display the current time.
133135
- ``sys_info``: Display system information.
134136
- ``datapath``: Display information about where data is stored by Unity and the developer console.
135-
- ``colour``: Display a colour in the developer console.
137+
- ``colour``: Display a colour in the developer console.

0 commit comments

Comments
 (0)