Interface ICommandParameter

Namespace

BSGameLib.Chat

Assembly

BSGameLib.Chat.dll

A parameter of a command: its name, position and type.

public interface ICommandParameter

Properties

CapturesRemainder

True when this parameter consumes the rest of the message rather than one space-delimited token. See RequiredParameterAttribute.CapturesRemainder.

bool CapturesRemainder { get; }

Property Value

bool

HelpText

The help text for the parameter, or null.

string HelpText { get; }

Property Value

string

IsRequired

Whether the player must give the parameter.

bool IsRequired { get; }

Property Value

bool

Name

The name the parameter is found by, such as with GetParameterByName.

string Name { get; }

Property Value

string

Order

The parameter's position among the command's parameters. Parameters are read in this order.

int Order { get; }

Property Value

int

ParameterType

The type the typed text is converted to.

Type ParameterType { get; }

Property Value

Type

Suggestions

What the game suggests for this parameter as it is typed -- players, say -- a name the game knows the values of; null when it suggests nothing.

string Suggestions { get; }

Property Value

string