AdminCmdRewardParser Class Reference

Class for parsing rewards data from a command string and storing it. More...

#include <adminmanager.h>

List of all members.

Public Member Functions
	AdminCmdRewardParser ()
	Creates a reward parser with the default reward types.
virtual csString	GetHelpMessage ()
	Returns a help message describing the rewards syntax.
bool	ParseWords (size_t index, const WordArray &words)
	Parses the list of words starting at index.
	~AdminCmdRewardParser ()
Public Attributes
csString	error
	only set when an error occured during parsing
csPDelArray< psRewardData >	rewards
	extracted rewards
AdminCmdSubCommandParser	rewardTypes
	reward types

---

Detailed Description

Class for parsing rewards data from a command string and storing it.

Definition at line 556 of file adminmanager.h.

---

Constructor & Destructor Documentation

AdminCmdRewardParser::AdminCmdRewardParser

(

)

Creates a reward parser with the default reward types.

Returns:

AdminCmdRewardParser::~AdminCmdRewardParser

(

)

[inline]

Definition at line 570 of file adminmanager.h.

---

Member Function Documentation

virtual csString AdminCmdRewardParser::GetHelpMessage

(

)

[virtual]

Returns a help message describing the rewards syntax.

Returns:

help message for the rewards syntax

bool AdminCmdRewardParser::ParseWords	(	size_t	index,
		const WordArray &	words
	)

Parses the list of words starting at index.

Parameters:

index	to start the parsing in the words array
words	array containing a commands parameters

Returns:

false when an error occured, otherwise true

---

Member Data Documentation

csString AdminCmdRewardParser::error

only set when an error occured during parsing

Definition at line 562 of file adminmanager.h.

csPDelArray<psRewardData> AdminCmdRewardParser::rewards

extracted rewards

Definition at line 561 of file adminmanager.h.

AdminCmdSubCommandParser AdminCmdRewardParser::rewardTypes

reward types

Definition at line 559 of file adminmanager.h.

---

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

• server/adminmanager.h