DOL.GS.Guild Class Reference

Guild inside the game. More...

List of all members.

Public Types
enum	eRank {   Emblem, AcHear, AcSpeak, Demote,   Promote, GcHear, GcSpeak, Invite,   OcHear, OcSpeak, Remove, Leader,   Alli, View, Claim, Upgrade,   Release, Buff, Dues, Withdraw }
enum	eBonusType {   None = 0, RealmPoints = 1, BountyPoints = 2, MasterLevelXP = 3,   CraftingHaste = 4, ArtifactXP = 5, Experience = 6 }
Public Member Functions
double	GetGuildBank ()
bool	IsGuildDuesOn ()
long	GetGuildDuesPercent ()
void	SetGuildDues (bool dues)
void	SetGuildDuesPercent (long dues)
void	SetGuildBank (GamePlayer donating, double amount)
	Set guild bank command.
void	WithdrawGuildBank (GamePlayer withdraw, double amount)
	Guild (DBGuild dbGuild)
	Creates an empty Guild. Don't use this, use GuildMgr.CreateGuild() to create a guild.
bool	AddOnlineMember (GamePlayer player)
	Adds a player to the guild.
bool	RemoveOnlineMember (GamePlayer player)
	Removes a player from the guild.
void	ClearOnlineMemberList ()
	Remove all Members from memory.
GamePlayer	GetOnlineMemberByID (string memberID)
	Returns a player according to the matching membername.
bool	AddPlayer (GamePlayer addPlayer)
	Add a player to a guild at rank 9.
bool	AddPlayer (GamePlayer addPlayer, DBRank rank)
	Add a player to a guild with the specified rank.
bool	RemovePlayer (string removername, GamePlayer member)
	Delete's a member from this Guild.
bool	HasRank (GamePlayer member, Guild.eRank rankNeeded)
	Looks up if a given client have access for the specific command in this guild.
DBRank	GetRankByID (int index)
	get rank by level
IList< GamePlayer >	GetListOfOnlineMembers ()
	Returns a list of all online members.
void	SendMessageToGuildMembers (string msg, PacketHandler.eChatType type, PacketHandler.eChatLoc loc)
	Sends a message to all guild members.
virtual bool	RemoveBountyPoints (long amount)
	Called when this guild loose bounty points returns true if BPs were reduced and false if BPs are smaller than param amount if false is returned, no BPs were removed.
virtual void	GainMeritPoints (long amount)
	Called when this guild gains merit points.
virtual void	RemoveMeritPoints (long amount)
	Called when this guild loose bounty points.
bool	AddToDatabase ()
bool	SaveIntoDatabase ()
	Saves this guild to database.
string	GuildBannerStatus (GamePlayer player)
void	UpdateMember (GamePlayer player)
void	UpdateGuildWindow ()
Static Public Member Functions
static string	BonusTypeToName (eBonusType bonusType)
Public Attributes
Object	m_memberListLock = new Object()
	Use this object to lock the guild member list.
Quests.AbstractMission	Mission = null
Protected Attributes
readonly Dictionary< string, GamePlayer >	m_onlineGuildPlayers = new Dictionary<string, GamePlayer>()
	This holds all players inside the guild (InternalID, GamePlayer)
Alliance	m_alliance = null
	This holds all players inside the guild.
DBGuild	m_DBguild
	This holds the DB instance of the guild.
ushort	m_id
	the runtime ID of the guild
List< AbstractGameKeep >	m_claimedKeeps = new List<AbstractGameKeep>()
	Stores claimed keeps (unique)
Properties
eRealm	Realm [get, set]
string	Webpage [get, set]
DBRank[]	Ranks [get, set]
int	GuildHouseNumber [get, set]
bool	GuildOwnsHouse [get, set]
int	Emblem [get, set]
bool	GuildBanner [get, set]
DateTime	GuildBannerLostTime [get, set]
string	Omotd [get, set]
string	Motd [get, set]
string	AllianceId [get, set]
Alliance	alliance [get, set]
	Gets or sets the guild alliance.
string	GuildID [get, set]
	Gets or sets the guild id.
ushort	ID [get, set]
	Gets or sets the runtime guild id.
string	Name [get, set]
	Gets or sets the guild name.
long	RealmPoints [get, set]
long	BountyPoints [get, set]
List< AbstractGameKeep >	ClaimedKeeps [get, set]
	Gets or sets the guild claimed keep.
int	MemberOnlineCount [get]
	Returns the number of players online inside this guild.
long	MeritPoints [get, set]
	Gets or sets the guild merit points.
long	GuildLevel [get]
eBonusType	BonusType [get, set]
	Gets or sets the guild buff type.
DateTime	BonusStartTime [get, set]
	Gets or sets the guild buff time.
string	Email [get, set]

---

Detailed Description

Guild inside the game.

---

Constructor & Destructor Documentation

DOL.GS.Guild.Guild

(

DBGuild

dbGuild

)

Creates an empty Guild. Don't use this, use GuildMgr.CreateGuild() to create a guild.

---

Member Function Documentation

bool DOL.GS.Guild.AddOnlineMember

(

GamePlayer

player

)

Adds a player to the guild.

Parameters:

player

GamePlayer to be added to the guild

Returns:

true if added successfully

bool DOL.GS.Guild.AddPlayer

(

GamePlayer

addPlayer

)

Add a player to a guild at rank 9.

Parameters:

addPlayer

Returns:

bool DOL.GS.Guild.AddPlayer	(	GamePlayer	addPlayer,
		DBRank	rank
	)

Add a player to a guild with the specified rank.

Parameters:

addPlayer
rank

Returns:

void DOL.GS.Guild.ClearOnlineMemberList

(

)

Remove all Members from memory.

virtual void DOL.GS.Guild.GainMeritPoints

(

long

amount

)

[virtual]

Called when this guild gains merit points.

Parameters:

amount

The amount of bounty points gained

IList<GamePlayer> DOL.GS.Guild.GetListOfOnlineMembers

(

)

Returns a list of all online members.

Returns:

ArrayList of members

GamePlayer DOL.GS.Guild.GetOnlineMemberByID

(

string

memberID

)

Returns a player according to the matching membername.

Returns:

GuildMemberEntry

DBRank DOL.GS.Guild.GetRankByID

(

int

index

)

get rank by level

Parameters:

index

the index of rank

Returns:

the dbrank

bool DOL.GS.Guild.HasRank	(	GamePlayer	member,
		Guild.eRank	rankNeeded
	)

Looks up if a given client have access for the specific command in this guild.

Returns:

true or false

virtual bool DOL.GS.Guild.RemoveBountyPoints

(

long

amount

)

[virtual]

Called when this guild loose bounty points returns true if BPs were reduced and false if BPs are smaller than param amount if false is returned, no BPs were removed.

virtual void DOL.GS.Guild.RemoveMeritPoints

(

long

amount

)

[virtual]

Called when this guild loose bounty points.

Parameters:

amount

The amount of bounty points gained

bool DOL.GS.Guild.RemoveOnlineMember

(

GamePlayer

player

)

Removes a player from the guild.

Parameters:

player

GamePlayer to be removed

Returns:

true if removed, false if not

bool DOL.GS.Guild.RemovePlayer	(	string	removername,
		GamePlayer	member
	)

Delete's a member from this Guild.

Parameters:

removername	the player (client) removing
member	the player named beeing remove

Returns:

true or false

bool DOL.GS.Guild.SaveIntoDatabase

(

)

Saves this guild to database.

void DOL.GS.Guild.SendMessageToGuildMembers	(	string	msg,
		PacketHandler.eChatType	type,
		PacketHandler.eChatLoc	loc
	)

Sends a message to all guild members.

Parameters:

msg	message string
type	message type
loc	message location

void DOL.GS.Guild.SetGuildBank	(	GamePlayer	donating,
		double	amount
	)

Set guild bank command.

Parameters:

donating
amount

Returns:

---

Member Data Documentation

Alliance DOL.GS.Guild.m_alliance = null [protected]

This holds all players inside the guild.

List<AbstractGameKeep> DOL.GS.Guild.m_claimedKeeps = new List<AbstractGameKeep>() [protected]

Stores claimed keeps (unique)

DBGuild DOL.GS.Guild.m_DBguild [protected]

This holds the DB instance of the guild.

ushort DOL.GS.Guild.m_id [protected]

the runtime ID of the guild

Object DOL.GS.Guild.m_memberListLock = new Object()

Use this object to lock the guild member list.

readonly Dictionary<string, GamePlayer> DOL.GS.Guild.m_onlineGuildPlayers = new Dictionary<string, GamePlayer>() [protected]

This holds all players inside the guild (InternalID, GamePlayer)

---

Property Documentation

Alliance DOL.GS.Guild.alliance [get, set]

Gets or sets the guild alliance.

DateTime DOL.GS.Guild.BonusStartTime [get, set]

Gets or sets the guild buff time.

eBonusType DOL.GS.Guild.BonusType [get, set]

Gets or sets the guild buff type.

List<AbstractGameKeep> DOL.GS.Guild.ClaimedKeeps [get, set]

Gets or sets the guild claimed keep.

string DOL.GS.Guild.GuildID [get, set]

Gets or sets the guild id.

ushort DOL.GS.Guild.ID [get, set]

Gets or sets the runtime guild id.

int DOL.GS.Guild.MemberOnlineCount [get]

Returns the number of players online inside this guild.

long DOL.GS.Guild.MeritPoints [get, set]

Gets or sets the guild merit points.

string DOL.GS.Guild.Name [get, set]

Gets or sets the guild name.

---

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

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