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. More...
void	Execute (string[] args)
override int	GetHashCode ()
void	ClientExecute (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 More...
Action< string[]>	OnClientExecute
	Executed when a client uses the command. If not set, the command is relayed to the server as-is. More...
bool	RelayToServer = true

Detailed Description

Definition at line 43 of file BarotraumaShared/SharedSource/DebugConsole.cs.

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.

Definition at line 60 of file BarotraumaShared/SharedSource/DebugConsole.cs.

Member Function Documentation

ClientExecute()

void Barotrauma.DebugConsole.Command.ClientExecute

(

string[]

args

)

Definition at line 32 of file BarotraumaClient/ClientSource/DebugConsole.cs.

Execute()

void Barotrauma.DebugConsole.Command.Execute

(

string[]

args

)

Definition at line 71 of file BarotraumaShared/SharedSource/DebugConsole.cs.

GetHashCode()

override int Barotrauma.DebugConsole.Command.GetHashCode

(

)

Definition at line 92 of file BarotraumaShared/SharedSource/DebugConsole.cs.

Member Data Documentation

GetValidArgs

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

Definition at line 50 of file BarotraumaShared/SharedSource/DebugConsole.cs.

Help

readonly string Barotrauma.DebugConsole.Command.Help

Definition at line 46 of file BarotraumaShared/SharedSource/DebugConsole.cs.

IsCheat

readonly bool Barotrauma.DebugConsole.Command.IsCheat

Using a command that's considered a cheat disables achievements

Definition at line 55 of file BarotraumaShared/SharedSource/DebugConsole.cs.

Names

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

Definition at line 45 of file BarotraumaShared/SharedSource/DebugConsole.cs.

OnClientExecute

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

Executed when a client uses the command. If not set, the command is relayed to the server as-is.

Definition at line 28 of file BarotraumaClient/ClientSource/DebugConsole.cs.

OnExecute

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

Definition at line 48 of file BarotraumaShared/SharedSource/DebugConsole.cs.

RelayToServer

bool Barotrauma.DebugConsole.Command.RelayToServer = true

Definition at line 30 of file BarotraumaClient/ClientSource/DebugConsole.cs.