Class ChatCommand

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

A base class for all chat commands.

public abstract class ChatCommand

Inheritance

object

ChatCommand

Derived

ClientChatCommand

ServerChatCommand

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectHandleExtensions.ToGcHandle(object)

ObjectHandleExtensions.ToIntPtr(object)

Fields

Command

the command calling name.

public string Command

Field Value

string

Description

The description of the command.

public string Description

Field Value

string

RequiredPrivilege

The required privilage for the command to be ran.

public string RequiredPrivilege

Field Value

string

Syntax

The syntax of the command.

public string Syntax

Field Value

string

Methods

CallHandler(IPlayer, int, CmdArgs)

The call handler for the command.

public abstract void CallHandler(IPlayer player, int groupId, CmdArgs args)

Parameters

player IPlayer

The player calling the command.

groupId int

The groupID of the player.

args CmdArgs

The arguments of the command.

GetDescription()

gets the description of the command.

public virtual string GetDescription()

Returns

string

GetHelpMessage()

Gets the help message of the command.

public virtual string GetHelpMessage()

Returns

string

GetSyntax()

Gets the syntax of the command.

public virtual string GetSyntax()

Returns

string