This class represents a Group inside the game. More...

Public Member Functions
	Group (GamePlayer leader)
virtual bool	AddMember (GameLiving living)
	Adds a player to the group.
ICollection< GameLiving >	GetMembersInTheGroup ()
	Gets all members of the group.
ICollection< GamePlayer >	GetPlayersInTheGroup ()
	Gets all players of the group.
virtual bool	RemoveMember (GameLiving living)
	Removes a player from the group.
virtual void	SendMessageToGroupMembers (GameLiving from, string msg, eChatType type, eChatLoc loc)
	Sends a message to all group members.
virtual void	SendMessageToGroupMembers (string msg, eChatType type, eChatLoc loc)
virtual bool	IsInTheGroup (GameLiving living)
	Checks if a player is inside the group.
void	UpdateMember (GameLiving living, bool updateIcons, bool updateOtherRegions)
	Updates a group member to all other players in the group.
void	UpdateGroupWindow ()
	Updates the group window to all players.
bool	IsGroupInCombat ()
	If at least one player is in combat group is in combat.
bool	MakeLeader (GamePlayer player)
	Makes player current leader of the group.
void	UpdateAllToMember (GamePlayer player, bool updateIcons, bool updateOtherRegions)
	Updates all group members to one member.
string	GroupMemberString (GamePlayer player)
	This is NOT to be used outside of Battelgroup code.
string	GroupMemberClassString (GamePlayer player)
	This is NOT to be used outside of Battelgroup code.
Protected Attributes
List< GameLiving >	m_groupMembers = new List<GameLiving>(8)
	This holds all players inside the group.
byte	m_status = 0x0A
	This holds the status of the group eg. looking for members etc ...
Properties
GamePlayer	Leader `[get, set]`
Quests.AbstractMission	Mission `[get, set]`
bool	AutosplitLoot `[get, set]`
bool	AutosplitCoins `[get, set]`
byte	Status `[get, set]`
	Gets or sets the status of this group.
byte	MemberCount `[get]`
	Returns the number of players inside this group.

Detailed Description

This class represents a Group inside the game.

Member Function Documentation

virtual bool DOL.GS.Group.AddMember ( GameLiving living ) [virtual]

Adds a player to the group.

Parameters:

player GamePlayer to be added to the group

Returns:: true if added successfully

ICollection<GameLiving> DOL.GS.Group.GetMembersInTheGroup ( )

Gets all members of the group.

Returns:: Array of GamePlayers in this group

ICollection<GamePlayer> DOL.GS.Group.GetPlayersInTheGroup ( )

Gets all players of the group.

Returns:: Array of GamePlayers in this group

string DOL.GS.Group.GroupMemberClassString ( GamePlayer player )

This is NOT to be used outside of Battelgroup code.

Parameters:

player Input from battlegroups

Returns:: A string of group members

string DOL.GS.Group.GroupMemberString ( GamePlayer player )

This is NOT to be used outside of Battelgroup code.

Parameters:

player Input from battlegroups

Returns:: A string of group members

bool DOL.GS.Group.IsGroupInCombat ( )

If at least one player is in combat group is in combat.

Returns:: true if group in combat

virtual bool DOL.GS.Group.IsInTheGroup ( GameLiving living ) [virtual]

Checks if a player is inside the group.

Parameters:

player GamePlayer to check

Returns:: true if the player is in the group

bool DOL.GS.Group.MakeLeader ( GamePlayer player )

Makes player current leader of the group.

Parameters:

player

Returns:

virtual bool DOL.GS.Group.RemoveMember ( GameLiving living ) [virtual]

Removes a player from the group.

Parameters:

player GamePlayer to be removed

Returns:: true if removed, false if not

virtual void DOL.GS.Group.SendMessageToGroupMembers	(	GameLiving	from,
		string	msg,
		eChatType	type,
		eChatLoc	loc
	)		`[virtual]`

Sends a message to all group members.

Parameters:

msg	message string
type	message type
loc	message location

void DOL.GS.Group.UpdateAllToMember	(	GamePlayer	player,
		bool	updateIcons,
		bool	updateOtherRegions
	)

Updates all group members to one member.

Parameters:

player	The player that should receive updates
updateIcons	Do icons need an update
updateOtherRegions	Should updates be sent to players in other regions

void DOL.GS.Group.UpdateGroupWindow ( )

Updates the group window to all players.

void DOL.GS.Group.UpdateMember	(	GameLiving	living,
		bool	updateIcons,
		bool	updateOtherRegions
	)

Updates a group member to all other players in the group.

Parameters:

player	player to update
updateIcons	Do icons need an update
updateOtherRegions	Should updates be sent to players in other regions

Member Data Documentation

List<GameLiving> DOL.GS.Group.m_groupMembers = new List<GameLiving>(8) [protected]

This holds all players inside the group.

byte DOL.GS.Group.m_status = 0x0A [protected]

This holds the status of the group eg. looking for members etc ...

Property Documentation

byte DOL.GS.Group.MemberCount [get]

Returns the number of players inside this group.

byte DOL.GS.Group.Status [get, set]

Gets or sets the status of this group.

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

C:/Users/Graveen/Documents/Dawn of Light/Svn DoL/GameServer/gameutils/Group.cs

Public Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation