AdminCmdDataBan Class Reference

Class for banning a player. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdDataBan ()
	Creates obj for specified command that bans a player.
	AdminCmdDataBan (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Creates obj for specified command parsing the words banning a player.
virtual AdminCmdData *	CreateCmdData (AdminManager *msgManager, MsgEntry *me, psAdminCmdMessage &msg, Client *client, WordArray &words)
	Parses the given message and stores its data.
virtual csString	GetHelpMessage ()
	Retrieve help message for the command that fits to the data.
virtual	~AdminCmdDataBan ()
Public Attributes
bool	banIP
	true if the IP address is to ban
int	days
	days part of the time to ban
int	hours
	hours part of the time to ban
int	minutes
	minutes part of the time to ban
csString	reason
	reason for the ban

---

Detailed Description

Class for banning a player.

Definition at line 867 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdDataBan::AdminCmdDataBan

(

)

[inline]

Creates obj for specified command that bans a player.

Definition at line 878 of file adminmanager.h.

AdminCmdDataBan::AdminCmdDataBan	(	AdminManager *	msgManager,
		MsgEntry *	me,
		psAdminCmdMessage &	msg,
		Client *	client,
		WordArray &	words
	)

Creates obj for specified command parsing the words banning a player.

Parameters:

msgManager	message manager that handles this command
me	The incoming message from the GM
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command message to parse

virtual AdminCmdDataBan::~AdminCmdDataBan

(

)

[inline, virtual]

Definition at line 891 of file adminmanager.h.

---

Member Function Documentation

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

Parses the given message and stores its data.

Parameters:

msgManager	message manager that handles this command
me	The incoming message from the GM
msg	psAdminCmdMessage containing the message
client	client of the network communication
words	command message to parse

Reimplemented from AdminCmdDataTarget.

virtual csString AdminCmdDataBan::GetHelpMessage

(

)

[virtual]

Retrieve help message for the command that fits to the data.

Returns:

csString: a help message to send back to the client

Reimplemented from AdminCmdDataTarget.

---

Member Data Documentation

bool AdminCmdDataBan::banIP

true if the IP address is to ban

Definition at line 873 of file adminmanager.h.

int AdminCmdDataBan::days

days part of the time to ban

Definition at line 872 of file adminmanager.h.

int AdminCmdDataBan::hours

hours part of the time to ban

Definition at line 871 of file adminmanager.h.

int AdminCmdDataBan::minutes

minutes part of the time to ban

Definition at line 870 of file adminmanager.h.

csString AdminCmdDataBan::reason

reason for the ban

Definition at line 874 of file adminmanager.h.

---

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

• server/adminmanager.h