Planeshift
Public Member Functions | Public Attributes

AdminCmdDataTeleport Class Reference

Class for teleport command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

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

Public Attributes

csString dest
 destination command (when not a generic target)
InstanceID destInstance
 id for the destination instance (when given)
bool destInstanceValid
 true when the instance is valid
AdminCmdSubCommandParser destList
 list of destination commands
csString destMap
 mapname
AdminCmdTargetParser destObj
 when specified at the cmd line, that an ingame object is the destination
csString destSector
 sectorname
float x
 point to teleport to x coordinate
float y
 point to teleport to y coordinate
float z
 point to teleport to z coordinate

Detailed Description

Class for teleport command.

Definition at line 1421 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataTeleport::AdminCmdDataTeleport ( ) [inline]

Creates obj for teleport command data.

Definition at line 1440 of file adminmanager.h.

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

Parses the given message and stores its data for teleporting.

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

Definition at line 1453 of file adminmanager.h.


Member Function Documentation

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

Creates an object containing the parsed data for teleporting.

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

destination command (when not a generic target)

Definition at line 1431 of file adminmanager.h.

id for the destination instance (when given)

Definition at line 1429 of file adminmanager.h.

true when the instance is valid

Definition at line 1430 of file adminmanager.h.

list of destination commands

Definition at line 1424 of file adminmanager.h.

mapname

Definition at line 1432 of file adminmanager.h.

when specified at the cmd line, that an ingame object is the destination

Definition at line 1428 of file adminmanager.h.

sectorname

Definition at line 1433 of file adminmanager.h.

point to teleport to x coordinate

Definition at line 1434 of file adminmanager.h.

point to teleport to y coordinate

Definition at line 1435 of file adminmanager.h.

point to teleport to z coordinate

Definition at line 1436 of file adminmanager.h.


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