Class CommandDefinition

Inheritance

Object

CommandDefinition

Namespace: Clavusaurus.Cosmos

Assembly: cs.temp.dll.dll

Syntax

public class CommandDefinition

Fields

category

The command category index, -1 is uncategorized

Declaration

public int category

Field Value

Type	Description
Int32

description

The command description

Declaration

public string description

Field Value

Type	Description
String

disabled

Sets whether this command is disabled and thus unavailable to be called

Declaration

public bool disabled

Field Value

Type	Description
Boolean

executionType

Defines where this command can be called from and executed on

Declaration

public ECommandExecuteType executionType

Field Value

Type	Description
ECommandExecuteType

keyword

The command keyword

Declaration

public string keyword

Field Value

Type	Description
String

parameters

List of parameters. There is a limit of 255 parameters.

Declaration

public List<CommandParameterDefinition> parameters

Field Value

Type	Description
List<CommandParameterDefinition>

userAccessFlags

User access flags, where the user ID is the flag index. If 1, the user can call this command. Default value is 2, so only set the built-in 'admin' account has access.

Declaration

public int userAccessFlags

Field Value

Type	Description
Int32

Methods

Copy()

Declaration

public CommandDefinition Copy()

Returns

Type	Description
CommandDefinition

Deserialize(BinaryReader, Boolean)

Declaration

public void Deserialize(BinaryReader reader, bool fromServer)

Parameters

Type	Name	Description
BinaryReader	reader
Boolean	fromServer

Serialize(BinaryWriter, Boolean)

Declaration

public void Serialize(BinaryWriter writer, bool forClient)

Parameters

Type	Name	Description
BinaryWriter	writer
Boolean	forClient