Class DebugCommands

Debug commands and console variables system.

DebugCommands
Assembly: FlaxEngine.dll
File: Engine/Debug/DebugCommands.h
Syntax
public class DebugCommands

Methods

Execute(StringView command)

Executes the command.

Declaration
public static void Execute(StringView command)
Parameters
StringView command

The command line (optionally with arguments).

GetCommandFlags(StringView command)

Returns flags of the command.

Declaration
public static CommandFlags GetCommandFlags(StringView command)
Parameters
StringView command

The full name of the command.
Returns
CommandFlags

GetCommandName(int32 index)

Declaration
public static StringView GetCommandName(int32 index)
Parameters
int32 index

Returns
StringView

InitAsync()

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

Declaration
public static void InitAsync()

Iterate(const StringView& searchText, int32& index)

Declaration
public static bool Iterate(const StringView& searchText, int32& index)
Parameters
StringView searchText

int32 index

Returns
bool

Search(StringView searchText, Array<StringView, HeapAllocation>& matches, bool startsWith=false)

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

Declaration
public static void Search(StringView searchText, Array<StringView, HeapAllocation>& matches, bool startsWith=false)
Parameters
StringView searchText

The query text.
Array<StringView, HeapAllocation> matches

The output list of commands that match a given query (unsorted).
bool startsWith

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