Planeshift
Public Member Functions | Public Attributes

AdminCmdDataSlide Class Reference

Class for sliding a player command. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataSlide ()
 Creates obj for specified command that needs a reason.
 AdminCmdDataSlide (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 the parsed data for sliding.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataSlide ()

Public Attributes

csString direction
 direction where the slide should done
float slideAmount
 the distance to slide

Detailed Description

Class for sliding a player command.

Sliding is some sort of moving the player around.

Definition at line 1476 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataSlide::AdminCmdDataSlide ( ) [inline]

Creates obj for specified command that needs a reason.

Definition at line 1484 of file adminmanager.h.

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

Definition at line 1497 of file adminmanager.h.


Member Function Documentation

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

Creates an object the parsed data for sliding.

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

direction where the slide should done

Definition at line 1479 of file adminmanager.h.

the distance to slide

Definition at line 1480 of file adminmanager.h.


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