Class PlayersArgParser

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

Open in GitHub

public class PlayersArgParser : ArgumentParserBase, ICommandArgumentParser

Inheritance

object

ArgumentParserBase

PlayersArgParser

Implements

ICommandArgumentParser

Inherited Members

ArgumentParserBase.lastErrorMessage

ArgumentParserBase.isMandatoryArg

ArgumentParserBase.argCount

ArgumentParserBase.argName

ArgumentParserBase.LastErrorMessage

ArgumentParserBase.ArgumentName

ArgumentParserBase.IsMandatoryArg

ArgumentParserBase.IsMissing

ArgumentParserBase.ArgCount

ArgumentParserBase.GetSyntax()

ArgumentParserBase.GetSyntaxUnformatted()

ArgumentParserBase.GetLastError()

ArgumentParserBase.parseSubArgs(string)

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)

Constructors

PlayersArgParser(string, ICoreAPI, bool)

public PlayersArgParser(string argName, ICoreAPI api, bool isMandatoryArg)

Parameters

argName string

api ICoreAPI

isMandatoryArg bool

Fields

api

protected ICoreServerAPI api

Field Value

ICoreServerAPI

Methods

GetSyntaxExplanation(string)

public override string GetSyntaxExplanation(string indent)

Parameters

indent string

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