Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.BattleGroup Class Reference

Battlegroups. More...

List of all members.

Public Member Functions

 BattleGroup ()
 constructor of battlegroup
virtual bool AddBattlePlayer (GamePlayer player, bool leader)
 Adds a player to the chatgroup.
virtual bool IsInTheBattleGroup (GamePlayer player)
bool GetBGLootType ()
GamePlayer GetBGTreasurer ()
int GetBGLootTypeThreshold ()
bool SetBGLootTypeThreshold (int thresh)
void SetBGLootType (bool type)
bool SetBGTreasurer (GamePlayer treasurer)
GamePlayer[] GetPlayersInTheBattleGroup ()
virtual void SendMessageToBattleGroupMembers (string msg, eChatType type, eChatLoc loc)
virtual bool RemoveBattlePlayer (GamePlayer player)

Public Attributes

const string BATTLEGROUP_PROPERTY = "battlegroup"

Protected Attributes

HybridDictionary m_battlegroupMembers = new HybridDictionary()
 This holds all players inside the battlegroup.

Properties

HybridDictionary Members [get, set]
bool Listen [get, set]
bool IsPublic [get, set]
string Password [get, set]
int PlayerCount [get]

Detailed Description

Battlegroups.


Constructor & Destructor Documentation

DOL.GS.BattleGroup.BattleGroup ( )

constructor of battlegroup


Member Function Documentation

virtual bool DOL.GS.BattleGroup.AddBattlePlayer ( GamePlayer  player,
bool  leader 
) [virtual]

Adds a player to the chatgroup.

Parameters:
playerGamePlayer to be added to the group
leader
Returns:
true if added successfully
virtual bool DOL.GS.BattleGroup.RemoveBattlePlayer ( GamePlayer  player) [virtual]

Removes a player from the group

Parameters:
playerGamePlayer to be removed
Returns:
true if removed, false if not

Member Data Documentation

HybridDictionary DOL.GS.BattleGroup.m_battlegroupMembers = new HybridDictionary() [protected]

This holds all players inside the battlegroup.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Properties Events