Planeshift
Public Member Functions | Public Attributes

AdminCmdDataCrystal Class Reference

Base class for creating treasure hunts. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataCrystal ()
 Creates obj for specified command that define a treasure hunt.
 AdminCmdDataCrystal (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 a treasure hunt.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataCrystal ()

Public Attributes

int amount
 amount of items
int interval
 respawn interval ??
csString itemName
 name of the item to hunt
int random
 ??
float range
 spawn range ??

Detailed Description

Base class for creating treasure hunts.

Definition at line 1376 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataCrystal::AdminCmdDataCrystal ( ) [inline]

Creates obj for specified command that define a treasure hunt.

Definition at line 1387 of file adminmanager.h.

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

Definition at line 1400 of file adminmanager.h.


Member Function Documentation

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

Creates an object containing the parsed data for a treasure hunt.

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 AdminCmdDataCrystal::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

amount of items

Definition at line 1381 of file adminmanager.h.

respawn interval ??

Definition at line 1379 of file adminmanager.h.

name of the item to hunt

Definition at line 1383 of file adminmanager.h.

??

Definition at line 1380 of file adminmanager.h.

spawn range ??

Definition at line 1382 of file adminmanager.h.


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