Table of Contents

Class DoubleArgParser

Namespace
Vintagestory.API.Common
Assembly
VintagestoryAPI.dll
public class DoubleArgParser : ArgumentParserBase, ICommandArgumentParser
Inheritance
DoubleArgParser
Implements
Inherited Members
Extension Methods

Constructors

DoubleArgParser(string, double, bool)

public DoubleArgParser(string argName, double defaultvalue, bool isMandatoryArg)

Parameters

argName string
defaultvalue double
isMandatoryArg bool

DoubleArgParser(string, double, double, bool)

public DoubleArgParser(string argName, double min, double max, bool isMandatoryArg)

Parameters

argName string
min double
max double
isMandatoryArg bool

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