Planeshift
Classes | Public Member Functions

psCharacterList Class Reference

#include <pscharacterlist.h>

List of all members.

Classes

struct  psCharacterListEntry

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.
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.
 psCharacterList ()
virtual void * RecoverObject ()
 required for iCachedObject but not used here
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.
 ~psCharacterList ()

Detailed Description

Definition at line 39 of file pscharacterlist.h.


Constructor & Destructor Documentation

psCharacterList::psCharacterList ( )
psCharacterList::~psCharacterList ( )

Member Function Documentation

virtual void psCharacterList::DeleteSelf ( ) [inline, virtual]

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

Implements iCachedObject.

Definition at line 77 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 59 of file pscharacterlist.h.

virtual void psCharacterList::ProcessCacheTimeout ( ) [inline, virtual]

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 72 of file pscharacterlist.h.

virtual void* psCharacterList::RecoverObject ( ) [inline, virtual]

required for iCachedObject but not used here

Turn iCachedObject ptr into psCharacterList

Implements iCachedObject.

Definition at line 73 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 66 of file pscharacterlist.h.


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