Planeshift
Public Member Functions | Public Attributes

AdminCmdDataAward Class Reference

Class for awarding rewards command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataAward ()
 Creates obj for specified command that awards rewards.
 AdminCmdDataAward (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Parses the given message and stores its data.
virtual AdminCmdDataCreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Creates an object containing the parsed data for rewards.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataAward ()

Public Attributes

AdminCmdRewardParser rewardList
 rewards parser and storage

Detailed Description

Class for awarding rewards command.

Definition at line 1775 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataAward::AdminCmdDataAward ( ) [inline]

Creates obj for specified command that awards rewards.

Definition at line 1782 of file adminmanager.h.

AdminCmdDataAward::AdminCmdDataAward ( AdminManager msgManager,
MsgEntry me,
psAdminCmdMessage msg,
Client client,
WordArray words 
)

Parses the given message and stores its data.

Parameters:
msgManagermessage manager that handles this command
meThe incoming message from the GM
msgpsAdminCmdMessage containing the message
clientclient of the network communication
wordscommand message to parse
virtual AdminCmdDataAward::~AdminCmdDataAward ( ) [inline, virtual]

Definition at line 1795 of file adminmanager.h.


Member Function Documentation

virtual AdminCmdData* AdminCmdDataAward::CreateCmdData ( AdminManager msgManager,
MsgEntry me,
psAdminCmdMessage msg,
Client client,
WordArray words 
) [virtual]

Creates an object containing the parsed data for rewards.

Parameters:
msgManagermessage manager that handles this command
meThe incoming message from the GM
msgpsAdminCmdMessage containing the message
clientclient of the network communication
wordscommand message to parse
Returns:
AdminCmdData* pointer to object containing parsed data. When parsing failed the valid flag is set to false.

Reimplemented from AdminCmdDataTarget.

virtual csString AdminCmdDataAward::GetHelpMessage ( ) [virtual]

Returns a helpmessage that fits to the parser of the class.

Returns:
csString: a help message to send back to the client

Reimplemented from AdminCmdDataTarget.


Member Data Documentation

rewards parser and storage

Definition at line 1778 of file adminmanager.h.


The documentation for this class was generated from the following file: