Planeshift
Public Member Functions | Public Attributes

AdminCmdDataAssignFaction Class Reference

Class for assigning awards for factions. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

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

Public Attributes

csString factionName
 faction name to assign
int factionPoints
 faction points to assign

Detailed Description

Class for assigning awards for factions.

Definition at line 3007 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataAssignFaction::AdminCmdDataAssignFaction ( ) [inline]

Creates obj for specified command that assigns factions.

Definition at line 3015 of file adminmanager.h.

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

Definition at line 3028 of file adminmanager.h.


Member Function Documentation

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

Creates an object containing the parsed data for factions.

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

faction name to assign

Definition at line 3010 of file adminmanager.h.

faction points to assign

Definition at line 3011 of file adminmanager.h.


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