IArgs

Namespace: uModCommonCommand

Assembly: uMod.Common.dll

Implements IDisposable, IEnumerable<Object>, IEnumerable

Summary

Represents a command argument container

Properties

Name

Summary

Arguments

Gets an enumerable representation of the command arguments

Command

Gets the command verb

ContextObjects

Gets extra objects attached to arguments

Definition

Gets the command definition

IsAdmin

Determines if player context is an administrator

IsModerator

Determines if player context is a moderator

IsServer

Determine if player context is a server

IsValid

Determine if required arguments are provided

Item

Gets an argument value by name

Item

Gets an argument value by name

Keys

Gets the argument keys

Length

Gets the number of arguments

Player

Gets the player context

Values

Gets the argument values

Methods

Name

Summary

GetArgument (String, Object)

Gets an argument value by name with optional default result

GetArgument<T> (String, T)

Gets a generic argument value by name with an optional default result

GetBool (String, Boolean)

Gets an argument value by name with an optional default result

GetBoolean (String, Boolean)

Gets an argument value by name with an optional default result

GetByte (String, Byte)

Gets an argument value by name with an optional default result

GetDateTime (String)

GetDecimal (String, Decimal)

Gets an argument value by name with an optional default result

GetDouble (String, Double)

Gets an argument value by name with an optional default result

GetFloat (String, Single)

Gets an argument value by name with an optional default result

GetInt (String, Int32)

Gets an argument value by name with an optional default result

GetInt64 (String, Int64)

Gets an argument value by name with an optional default result

GetInteger (String, Int32)

Gets an argument value by name with an optional default result

GetLong (String, Int64)

Gets an argument value by name with an optional default result

GetPoint (String, Point)

Gets an argument value by name with an optional default result

GetPosition (String, Position)

Gets an argument value by name with an optional default result

GetPosition4 (String, Position4)

Gets an argument value by name with an optional default result

GetSByte (String, SByte)

Gets an argument value by name with an optional default result

GetShort (String, Int16)

Gets an argument value by name with an optional default result

GetString (String, String)

Gets an argument value by name with an optional default result

GetTimeSpan (String)

GetUInt (String, UInt32)

Gets an argument value by name with an optional default result

GetUInt64 (String, UInt64)

Gets an argument value by name with an optional default result

GetULong (String, UInt64)

Gets an argument value by name with an optional default result

GetUShort (String, UInt16)

Gets an argument value by name with an optional default result

HasArgument (String)

Determines whether argument exists by name

IsArgument (String, Type)

IsArgument<T> (String)

Determine if argument is of type

IsDefault (String)

Determine if argument is default

Message (String)

Send message to player context with specified message

Message (String, String, Object[])

Send message to player context with specified message (with optional format parameters and prefix)

Reply (String)

Reply to player context with specified message

Reply (String, String, Object[])

Reply to player context with specified message (with optional format parameters and prefix)

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

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)