psCharacterList Class Reference

Holds a list of characters associated to one account. More...

#include <pscharacterlist.h>

Public Member Functions
virtual void	DeleteSelf ()
const char *	GetCharacterFullName (int index)
unsigned int	GetCharacterID (int index)
const char *	GetCharacterName (int index)
bool	GetEntryValid (int index)
int	GetListLength ()
int	GetValidCount ()
	Get the number of valid characters in list. More...
virtual void	ProcessCacheTimeout ()
	This function is called by the generic cache if the specified ticks go by and the cache object is not already removed. More...
	psCharacterList ()
virtual void *	RecoverObject ()
	required for iCachedObject but not used here More...
void	SetCharacterFullName (int index, const char *v, const char *w)
void	SetCharacterID (int index, unsigned int v)
void	SetCharacterName (int index, const char *v)
void	SetEntryValid (int index, bool v)
void	SetValidCount (int size)
	Set the number of valid characters in this list. More...
	~psCharacterList ()
Public Member Functions inherited from iCachedObject
virtual	~iCachedObject ()

Detailed Description

Holds a list of characters associated to one account.

Used in the select character screen.

Definition at line 43 of file pscharacterlist.h.

Constructor & Destructor Documentation

psCharacterList::psCharacterList

(

)

psCharacterList::~psCharacterList

(

)

Member Function Documentation

virtual void psCharacterList::DeleteSelf ( )

inlinevirtual

Delete must come from inside object to handle operator::delete overrides.

Implements iCachedObject.

Definition at line 81 of file pscharacterlist.h.

const char* psCharacterList::GetCharacterFullName

(

int

index

)

unsigned int psCharacterList::GetCharacterID

(

int

index

)

const char* psCharacterList::GetCharacterName

(

int

index

)

bool psCharacterList::GetEntryValid

(

int

index

)

int psCharacterList::GetListLength

(

)

int psCharacterList::GetValidCount ( )

inline

Get the number of valid characters in list.

Definition at line 63 of file pscharacterlist.h.

virtual void psCharacterList::ProcessCacheTimeout ( )

inlinevirtual

This function is called by the generic cache if the specified ticks go by and the cache object is not already removed.

After this function is called, the object is removed from the generic cache and deleted.

Implements iCachedObject.

Definition at line 76 of file pscharacterlist.h.

virtual void* psCharacterList::RecoverObject ( )

inlinevirtual

required for iCachedObject but not used here

Turn iCachedObject ptr into psCharacterList

Implements iCachedObject.

Definition at line 77 of file pscharacterlist.h.

void psCharacterList::SetCharacterFullName	(	int	index,
		const char *	v,
		const char *	w
	)

void psCharacterList::SetCharacterID	(	int	index,
		unsigned int	v
	)

void psCharacterList::SetCharacterName	(	int	index,
		const char *	v
	)

void psCharacterList::SetEntryValid	(	int	index,
		bool	v
	)

void psCharacterList::SetValidCount ( int  size )

inline

Set the number of valid characters in this list.

Definition at line 70 of file pscharacterlist.h.

---

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

• server/bulkobjects/pscharacterlist.h