DevShell - Console

The DevShell-Console supports static and non-static command functions using a simple attribute-based system. This allows you to register and expose methods as console commands with minimal setup.

Creating a Static Command

To create a static command:

1. Define a static method in any class.

2. Add the [ShellCommand] attribute to it.

3. Optionally, provide an alias name inside the attribute. If no alias is specified, the method name will be used as the command name.

Access modifiers (public, protected, private) do not matter for command registration.

Example:

public static class GameCommands

{

[ShellCommand("reset-game")]

private static void ResetGameState()

{

// Reset logic

}

}

In this example, the console command is reset-game. If no alias was provided, the command would be called via ResetGameState.

Creating non-static Command using Shell Bindable

To make a component bindable, implement the IShellBindable interface:

public class AudioManager : MonoBehaviour, IShellBindable

{

public void Mute(string category)

{

Debug.Log($"Muted category: {category}");

}

[ShellCommandHide]

public void SetVolume(string category, float level)

{

Debug.Log($"Set volume of {category} to {level}");

}

}

In this example, Mute is exposed to the console and can be executed at runtime. SetVolume is hidden from the shell due to the [ShellCommandHide] attribute.

Command Arguments

Each parameter of a static method can be annotated with the [ShellArgument] attribute to define:

• A human-readable name
• Whether the argument is optional
• An optional alias used to pass the value via the console

If no [ShellArgument] is applied, the parameter is treated as optional by default.

Example with Arguments:

public static class TimeCommands

{

[ShellCommand]

public static void SetTime(

[ShellArgument(Alias: "time")] float timeOfDay,

[ShellArgument(Optional: true, Alias: "pause")] bool pauseGame = false)

{

// Apply time and pause logic

}

}

Passing Arguments in the Console

You can pass arguments in two ways:

1. Named Arguments (Recommended)

Use -alias or -parameterName syntax. Argument order does not matter.

Example:

settime -time 18.5 -pause true

2. Positional Arguments

If no named arguments are provided, the console will match arguments in order, from left to right.

Example:

settime 18.5 true