Barotrauma Server
Loading...
Searching...
No Matches
Barotrauma.DebugConsole.Command Class Reference

Public Member Functions

 Command (string name, string help, Action< string[]> onExecute, Func< string[][]> getValidArgs=null, bool isCheat=false)
 Use this constructor to create a command that executes the same action regardless of whether it's executed by a client or the server.
 
void Execute (string[] args)
 
override int GetHashCode ()
 
void ServerExecuteOnClientRequest (Client client, Vector2 cursorWorldPos, string[] args)
 

Public Attributes

readonly ImmutableArray< Identifier > Names
 
readonly string Help
 
Action< string[]> OnExecute
 
Func< string[][]> GetValidArgs
 
readonly bool IsCheat
 Using a command that's considered a cheat disables achievements.
 
Action< Client, Vector2, string[]> OnClientRequestExecute
 Executed server-side when a client attempts to use the command.
 

Constructor & Destructor Documentation

◆ Command()

Barotrauma.DebugConsole.Command.Command ( string name,
string help,
Action< string[]> onExecute,
Func< string[][]> getValidArgs = null,
bool isCheat = false )

Use this constructor to create a command that executes the same action regardless of whether it's executed by a client or the server.

Member Function Documentation

◆ Execute()

void Barotrauma.DebugConsole.Command.Execute ( string[] args)

◆ GetHashCode()

override int Barotrauma.DebugConsole.Command.GetHashCode ( )

◆ ServerExecuteOnClientRequest()

void Barotrauma.DebugConsole.Command.ServerExecuteOnClientRequest ( Client client,
Vector2 cursorWorldPos,
string[] args )

Member Data Documentation

◆ GetValidArgs

Func<string[][]> Barotrauma.DebugConsole.Command.GetValidArgs

◆ Help

readonly string Barotrauma.DebugConsole.Command.Help

◆ IsCheat

readonly bool Barotrauma.DebugConsole.Command.IsCheat

Using a command that's considered a cheat disables achievements.

◆ Names

readonly ImmutableArray<Identifier> Barotrauma.DebugConsole.Command.Names

◆ OnClientRequestExecute

Action<Client, Vector2, string[]> Barotrauma.DebugConsole.Command.OnClientRequestExecute

Executed server-side when a client attempts to use the command.

◆ OnExecute

Action<string[]> Barotrauma.DebugConsole.Command.OnExecute

The documentation for this class was generated from the following files: