Class DebugCommands

Debug commands and console variables system.

Inheritance

System.Object

DebugCommands

Namespace: FlaxEngine

Assembly: FlaxEngine.CSharp.dll

Syntax

[Unmanaged]
public static class DebugCommands : Object

Methods

Execute(String)

Executes the command.

Declaration

[Unmanaged]
public static void Execute(string command)

Parameters

System.String command The command line (optionally with arguments).

GetAllCommands(out String[])

Gets all available commands.

Declaration

[Unmanaged]
public static void GetAllCommands(out string[] commands)

Parameters

System.String[] commands The output list of all commands (unsorted).

GetCommandFlags(String)

Returns flags of the command.

Declaration

[Unmanaged]
public static DebugCommands.CommandFlags GetCommandFlags(string command)

Parameters

System.String command The full name of the command.

Returns

DebugCommands.CommandFlags

InitAsync()

Starts asynchronous debug commands caching. Cna be used to minimize time-to-interactive when using console interface or when using scripted actions.

Declaration

[Unmanaged]
public static void InitAsync()

Search(String, out String[], Boolean)

Searches the list of commands to return candidates that match the given query text.

Declaration

[Unmanaged]
public static void Search(string searchText, out string[] matches, bool startsWith = false)

Parameters

System.String searchText The query text.

System.String[] matches The output list of commands that match a given query (unsorted).

System.Boolean startsWith True if filter commands that start with a specific search text, otherwise will return commands that contain a specific query.