Planeshift
Public Member Functions | Public Attributes

AdminCmdDataGameMasterEvent Class Reference

Class for game event command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataGameMasterEvent ()
 Creates obj for specified command that concern game events.
 AdminCmdDataGameMasterEvent (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 an event.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataGameMasterEvent ()

Public Attributes

csString commandMod
 subsubcommand
csString gmeventDesc
 description of the event
csString gmeventName
 name of the event
AdminCmdTargetParser player
 when a playertarget needs to be parsed
float range
 range to search for targets
RangeSpecifier rangeSpecifier
 range type
AdminCmdRewardParser rewardList
 rewards parser and storage
csString subCmd
 subcommand storage
AdminCmdSubCommandParser subCommandList
 list of subcommands

Detailed Description

Class for game event command.

Definition at line 2528 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataGameMasterEvent::AdminCmdDataGameMasterEvent ( ) [inline]

Creates obj for specified command that concern game events.

Definition at line 2546 of file adminmanager.h.

AdminCmdDataGameMasterEvent::AdminCmdDataGameMasterEvent ( 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 AdminCmdDataGameMasterEvent::~AdminCmdDataGameMasterEvent ( ) [inline, virtual]

Definition at line 2559 of file adminmanager.h.


Member Function Documentation

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

Creates an object containing the parsed data for an event.

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 AdminCmdData.

virtual csString AdminCmdDataGameMasterEvent::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 AdminCmdData.


Member Data Documentation

subsubcommand

Definition at line 2540 of file adminmanager.h.

description of the event

Definition at line 2538 of file adminmanager.h.

name of the event

Definition at line 2537 of file adminmanager.h.

when a playertarget needs to be parsed

Definition at line 2534 of file adminmanager.h.

range to search for targets

Definition at line 2542 of file adminmanager.h.

range type

Definition at line 2541 of file adminmanager.h.

rewards parser and storage

Definition at line 2535 of file adminmanager.h.

subcommand storage

Definition at line 2532 of file adminmanager.h.

list of subcommands

Definition at line 2531 of file adminmanager.h.


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