Planeshift
Public Member Functions | Public Attributes

AdminCmdDataSetTrait Class Reference

Class for setting traits or retrieving info. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataSetTrait ()
 Creates obj for specified command that sets/displays traits.
 AdminCmdDataSetTrait (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 traits.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataSetTrait ()

Public Attributes

PSCHARACTER_GENDER gender
 gender of the character
csString race
 specifier for the race of the character
csString subCmd
 subcommand
csString traitName
 name of the trait to add (if adding is possible)

Detailed Description

Class for setting traits or retrieving info.

Definition at line 2756 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataSetTrait::AdminCmdDataSetTrait ( ) [inline]

Creates obj for specified command that sets/displays traits.

Definition at line 2766 of file adminmanager.h.

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

Definition at line 2779 of file adminmanager.h.


Member Function Documentation

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

Creates an object containing the parsed data for traits.

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

gender of the character

Definition at line 2761 of file adminmanager.h.

specifier for the race of the character

Definition at line 2760 of file adminmanager.h.

subcommand

Definition at line 2759 of file adminmanager.h.

name of the trait to add (if adding is possible)

Definition at line 2762 of file adminmanager.h.


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