Planeshift
Public Member Functions | Public Attributes

AdminCmdDataKillNPC Class Reference

Class for killing and reloading a npc. More...

#include <adminmanager.h>

List of all members.

Public Member Functions

 AdminCmdDataKillNPC ()
 Creates obj for specified command that kills/reloads a npc.
 AdminCmdDataKillNPC (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Parses the given message for killing/reloadin a npc.
virtual AdminCmdDataCreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
 Creates a command data object of the current class containing the parsed data.
virtual csString GetHelpMessage ()
 Returns a helpmessage that fits to the parser of the class.
virtual ~AdminCmdDataKillNPC ()

Public Attributes

float damage
 If <> 0 than only do this damage.
bool reload
 whether NPC should be reloaded after the kill or not

Detailed Description

Class for killing and reloading a npc.

Definition at line 911 of file adminmanager.h.


Constructor & Destructor Documentation

AdminCmdDataKillNPC::AdminCmdDataKillNPC ( ) [inline]

Creates obj for specified command that kills/reloads a npc.

Definition at line 919 of file adminmanager.h.

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

Parses the given message for killing/reloadin a npc.

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

Definition at line 932 of file adminmanager.h.


Member Function Documentation

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

Creates a command data object of the current class containing the parsed 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
Returns:
AdminCmdData* pointer to object containing parsed data. When parsing failed the valid flag is set to false.

Reimplemented from AdminCmdDataTarget.

virtual csString AdminCmdDataKillNPC::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

If <> 0 than only do this damage.

Definition at line 915 of file adminmanager.h.

whether NPC should be reloaded after the kill or not

Definition at line 914 of file adminmanager.h.


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