Class WordRangeArgParser

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

public class WordRangeArgParser : ArgumentParserBase, ICommandArgumentParser

Inheritance

object

ArgumentParserBase

WordRangeArgParser

Implements

ICommandArgumentParser

Inherited Members

ArgumentParserBase.lastErrorMessage

ArgumentParserBase.isMandatoryArg

ArgumentParserBase.argCount

ArgumentParserBase.argName

ArgumentParserBase.LastErrorMessage

ArgumentParserBase.ArgumentName

ArgumentParserBase.IsMandatoryArg

ArgumentParserBase.IsMissing

ArgumentParserBase.ArgCount

ArgumentParserBase.GetLastError()

ArgumentParserBase.parseSubArgs(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WordRangeArgParser(string, bool, params string[])

public WordRangeArgParser(string argName, bool isMandatoryArg, params string[] words)

Parameters

argName string

isMandatoryArg bool

words string[]

Fields

word

protected string word

Field Value

string

Methods

GetSyntax()

public override string GetSyntax()

Returns

string

GetSyntaxExplanation(string)

public override string GetSyntaxExplanation(string indent)

Parameters

indent string

Returns

string

GetSyntaxUnformatted()

public override string GetSyntaxUnformatted()

Returns

string

GetValidRange(CmdArgs)

public override string[] GetValidRange(CmdArgs args)

Parameters

args CmdArgs

Returns

string[]

GetValue()

public override object GetValue()

Returns

object

PreProcess(TextCommandCallingArgs)

public override void PreProcess(TextCommandCallingArgs args)

Parameters

args TextCommandCallingArgs

SetValue(object)

Used by the async system

public override void SetValue(object data)

Parameters

data object

TryProcess(TextCommandCallingArgs, Action<AsyncParseResults>)

Parse the args.

public override EnumParseResult TryProcess(TextCommandCallingArgs args, Action<AsyncParseResults> onReady = null)

Parameters

args TextCommandCallingArgs

onReady Action<AsyncParseResults>

Only needs to be called when returning Deferred as parseresult

Returns

EnumParseResult