Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.CmdAttribute Class Reference

Marks a class as a command handler. More...

List of all members.

Public Member Functions

 CmdAttribute (string cmd, string[] alias, ePrivLevel lvl, string desc, params string[] usage)
 Constructor.
 CmdAttribute (string cmd, ePrivLevel lvl, string desc, params string[] usage)
 Constructor.

Properties

string Cmd [get]
 Gets the command being handled.
string[] Aliases [get]
 Gets aliases for the command being handled.
uint Level [get]
 Gets minimum required plvl for the command to be used.
string Description [get]
 Gets the description of the command.
string[] Usage [get]
 Gets the command usage.

Detailed Description

Marks a class as a command handler.


Constructor & Destructor Documentation

DOL.GS.CmdAttribute.CmdAttribute ( string  cmd,
string[]  alias,
ePrivLevel  lvl,
string  desc,
params string[]  usage 
)

Constructor.

Parameters:
cmdCommand to handle
aliasOther names the command goes by
lvlMinimum required plvl for this command
descDescription of the command
usageHow to use the command
DOL.GS.CmdAttribute.CmdAttribute ( string  cmd,
ePrivLevel  lvl,
string  desc,
params string[]  usage 
)

Constructor.

Parameters:
cmdCommand to handle
lvlMinimum required plvl for this command
descDescription of the command
usageHow to use the command

Property Documentation

string [] DOL.GS.CmdAttribute.Aliases [get]

Gets aliases for the command being handled.

string DOL.GS.CmdAttribute.Cmd [get]

Gets the command being handled.

string DOL.GS.CmdAttribute.Description [get]

Gets the description of the command.

uint DOL.GS.CmdAttribute.Level [get]

Gets minimum required plvl for the command to be used.

string [] DOL.GS.CmdAttribute.Usage [get]

Gets the command usage.


The documentation for this class was generated from the following file:
All Classes Namespaces Functions Variables Enumerations Properties Events