C# Class NutMud.Commands.Attributes.CommandParameterAttribute

Inheritance: System.Attribute
Show file Open project: SwiftAusterity/NetMud

Public Methods

Method Description
CommandParameterAttribute ( CommandUsage usage, Type type, CacheReferenceType cacheTypes, bool optional ) : System

Creates a new parameter attribute with a blank matching pattern

CommandParameterAttribute ( CommandUsage usage, Type type, CacheReferenceType cacheTypes, string matchingPattern, bool optional ) : System

Creates a new parameter attribute

MatchesPattern ( string inputString ) : bool

Does the keywords incoming match the regex pattern (unless it's blank, in which case it always matches)

Method Details

CommandParameterAttribute() public method

Creates a new parameter attribute with a blank matching pattern
public CommandParameterAttribute ( CommandUsage usage, Type type, CacheReferenceType cacheTypes, bool optional ) : System
usage CommandUsage How the parameter is used in the command
type System.Type The system type of the parameter expected
cacheTypes CacheReferenceType How this parameter can be found (is it data, is it a live entity)
optional bool Is this parameter optional
return System

CommandParameterAttribute() public method

Creates a new parameter attribute
public CommandParameterAttribute ( CommandUsage usage, Type type, CacheReferenceType cacheTypes, string matchingPattern, bool optional ) : System
usage CommandUsage How the parameter is used in the command
type System.Type The system type of the parameter expected
cacheTypes CacheReferenceType How this parameter can be found (is it data, is it a live entity)
matchingPattern string Does this pattern keyword follow a regex pattern
optional bool Is this parameter optional
return System

MatchesPattern() public method

Does the keywords incoming match the regex pattern (unless it's blank, in which case it always matches)
public MatchesPattern ( string inputString ) : bool
inputString string
return bool