psBuddyManager Class Reference

Class to handle buddies. More...

#include <pscharacter.h>

Classes
struct	Buddy

Public Member Functions
bool	AddBuddy (PID buddyID, csString &name)
	Add the player with a certain Player ID to this character buddy list. More...
void	AddBuddyOf (PID buddyID)
	Adds this player as having this character on their buddy list. More...
csArray< psBuddyManager::Buddy >	GetBuddyList ()
csArray< PID >	GetBuddyOfList ()
void	Initialize (PID charID)
	Setup the buddy manager. More...
bool	IsBuddy (PID buddyID)
	Checks if a playerID is a buddy of this character. More...
bool	LoadBuddies (Result &myBuddies, Result &buddyOf)
	Load the set of my buddies as well as those that have me as a buddy. More...
void	RemoveBuddy (PID buddyID)
	Remove the player with a certain Player ID from this character buddy list. More...
void	RemoveBuddyOf (PID buddyID)
	Remove character as having this character on their buddy list. More...

Detailed Description

Class to handle buddies.

Definition at line 195 of file pscharacter.h.

Member Function Documentation

bool psBuddyManager::AddBuddy	(	PID	buddyID,
		csString &	name
	)

Add the player with a certain Player ID to this character buddy list.

Parameters

buddyID	the Player ID which we are going to add to the character buddy list
name	The name of the buddy.

void psBuddyManager::AddBuddyOf

(

PID

buddyID

)

Adds this player as having this character on their buddy list.

Parameters

buddyID

the Player ID of the character that has this character as a buddy.

csArray<psBuddyManager::Buddy> psBuddyManager::GetBuddyList ( )

inline

Definition at line 260 of file pscharacter.h.

csArray<PID> psBuddyManager::GetBuddyOfList ( )

inline

Definition at line 264 of file pscharacter.h.

void psBuddyManager::Initialize ( PID  charID )

inline

Setup the buddy manager.

Parameters

charID

The PID of the owner of this buddy manager.

Definition at line 209 of file pscharacter.h.

bool psBuddyManager::IsBuddy

(

PID

buddyID

)

Checks if a playerID is a buddy of this character.

Parameters

buddyID

the Player ID of which we are checking the presence in the character buddy list

Returns

true if the provided PID was found in this character.

bool psBuddyManager::LoadBuddies	(	Result &	myBuddies,
		Result &	buddyOf
	)

Load the set of my buddies as well as those that have me as a buddy.

Parameters

myBuddies	The database set of characters that are my buddy.
buddyOf	The database set of characters that have me as a buddy.

void psBuddyManager::RemoveBuddy

(

PID

buddyID

)

Remove the player with a certain Player ID from this character buddy list.

Parameters

buddyID

the Player ID which we are going to remove from the character buddy list

void psBuddyManager::RemoveBuddyOf

(

PID

buddyID

)

Remove character as having this character on their buddy list.

Parameters

buddyID

the Player ID of the character that has removed this character as a buddy.

---

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

• server/bulkobjects/pscharacter.h