Struct CommandFlagInfo

Namespace

Uncreated.Warfare.Interaction.Commands

Assembly

Uncreated.Warfare.dll

Provides basic information about command flags.

public readonly struct CommandFlagInfo

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CommandFlagInfo(string, int, int)

Provides basic information about command flags.

public CommandFlagInfo(string name, int dashCount, int argumentPosition)

Parameters

name string

dashCount int

Number of dashes, either 1 or 2.

argumentPosition int

The argument before the flag, where 1 is the first argument. A value of zero indicates this flag was before the first argument.

Fields

ArgumentPosition

The argument before the flag, where 1 is the first argument. A value of zero indicates this flag was before the first argument.

public readonly int ArgumentPosition

Field Value

int

Remarks

Note that there can be more than one flag with the same argument position.

DashCount

Number of dashes, either 1 or 2.

public readonly int DashCount

Field Value

int

FlagName

Name of the flag not including the dashes.

public readonly string FlagName

Field Value

string

Methods

ToString()

Returns the flag as it was entered.

public override string ToString()

Returns

string