Args

Namespace: uModCommand

Assembly: uMod.Core.dll

Inheritance Object Args

Implements IArgs, IDisposable, IEnumerable<Object>, IEnumerable

Summary

Represents a parsed command

Constructors

Name

Summary

Args ()

Create a new empty args object

Args (ICommandDefinition, IPlayer, String, Object[])

Create a new args object

Properties

Name

Summary

Arguments

Get all arguments, named and arbitrary

Command

Gets the verb

ContextObjects

Gets context objects

Definition

Gets the command definition

IsAdmin

Determine if command is from administrator

IsModerator

Determine if command is from moderator

IsServer

Determine if command is from server

IsValid

Determine if required arguments are provided

Item [ String ]

Gets or sets an argument

Item

Gets or sets an argument

Keys

Gets all argument keys

Length

Gets length of arguments

Player

Get Player who ran command

Values

Gets all argument values

Methods

Name

Summary

Dispose ()

Dispose of Arg

GetArgument (String, Object)

Gets the specified case-insensitive named argument

GetArgument<T> (String, T)

Gets the specified case-insensitive named argument

GetBool (String, Boolean)

Get argument as boolean by the specified key Default is returned when specified key is unavailable

GetBoolean (String, Boolean)

Get argument as boolean by the specified key Default is returned when specified key is unavailable

GetByte (String, Byte)

Get argument as byte by the specified key Default is returned when specified key is unavailable

GetDateTime (String)

Get argument as datetime by the specified key Default is returned when specified key is unavailable

GetDecimal (String, Decimal)

Get argument as decimal by the specified key Default is returned when specified key is unavailable

GetDouble (String, Double)

Get argument as double by the specified key Default is returned when specified key is unavailable

GetEnumerator ()

GetFloat (String, Single)

Get argument as float by the specified key Default is returned when specified key is unavailable

GetInt (String, Int32)

Get argument as integer by the specified key Default is returned when specified key is unavailable

GetInt64 (String, Int64)

Get argument as long by the specified key Default is returned when specified key is unavailable

GetInteger (String, Int32)

Get argument as integer by the specified key Default is returned when specified key is unavailable

GetLong (String, Int64)

Get argument as long by the specified key Default is returned when specified key is unavailable

GetPoint (String, Point)

Get argument as point by the specified key

GetPosition (String, Position)

Get argument as position by the specified key

GetPosition4 (String, Position4)

Get argument as position4 by the specified key

GetSByte (String, SByte)

Get argument as signed byte by the specified key Default is returned when specified key is unavailable

GetShort (String, Int16)

Get argument as short by the specified key Default is returned when specified key is unavailable

GetString (String, String)

Get argument as string by the specified key Default is returned when specified key is unavailable

GetTimeSpan (String)

Get argument as timespan by the specified key Default is returned when specified key is unavailable

GetUInt (String, UInt32)

Get argument as unsigned integer by the specified key Default is returned when specified key is unavailable

GetUInt64 (String, UInt64)

Get argument as unsigned long by the specified key Default is returned when specified key is unavailable

GetULong (String, UInt64)

Get argument as unsigned long by the specified key Default is returned when specified key is unavailable

GetUShort (String, UInt16)

Get argument as unsigned short by the specified key Default is returned when specified key is unavailable

HasArgument (String)

Determine if argument exists in command

IsArgument (String, Type)

Determine if argument is of type

IsArgument<T> (String)

Determine if argument is of type

IsDefault (String)

Determine if argument is default

Message (String)

Sends the specified message to the player

Message (String, String, Object[])

Sends the specified message and prefix to the player

Reply (String)

Replies to the player with the specified message

Reply (String, String, Object[])

Replies to the player with the specified message and prefix

Shift (ICommandDefinition)

ToString ()

Transform Args object to string

TryGetArgument (String, out Object)

Try to get an argument by name

TryGetArgument<T> (String, out T)

TryGetContext (Type, out Object)

Try to get a context object of the specified type

TryGetContext<T> (Type, out T)