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

The GuildMgr holds pointers to all guilds, and pointers to their members. More...

List of all members.

Classes

class  GuildMemberDisplay
 This class represents a guild member for the purpose of displaying in the social window. More...

Static Public Member Functions

static Dictionary< string,
GuildMemberDisplay
GetAllGuildMembers (string guildID)
 Gets a copy of a dictionary of all guild members of a given guild, indexed on player InternalID.
static void AddPlayerToAllGuildPlayersList (GamePlayer player)
 Add a player to the guild players dictionary list.
static bool RemovePlayerFromAllGuildPlayersList (GamePlayer player)
 Remove a player from the all guilds and players dictionary.
static bool AddGuild (Guild guild)
 Adds a guild to the list of guilds.
static bool RemoveGuild (Guild guild)
 Removes a guild from the manager.
static bool DoesGuildExist (string guildName)
 Checks if a guild with guildName exists.
static Guild CreateGuild (eRealm realm, string guildName, GamePlayer creator=null)
static void CreateRanks (Guild guild)
static void RepairRanks (Guild guild)
static bool DeleteGuild (string guildName)
 Deletes a guild.
static Guild GetGuildByName (string guildName)
 Returns a guild according to the matching name.
static Guild GetGuildByGuildID (string guildid)
 Returns a guild according to the matching database ID.
static string GuildNameToGuildID (string guildName)
 Returns a database ID for a matching guild name.
static bool LoadAllGuilds ()
 Load all guilds and alliances from the database.
static void SaveAllGuilds ()
 Save all guild into database.
static bool IsEmblemUsed (int emblem)
 Returns true if a guild is using the emblem.
static void ChangeEmblem (GamePlayer player, int oldemblem, int newemblem)
 Process for changing an emblem.
static List< GuildGetAllGuilds ()
 Get a list of all guilds (creates a copy)

Public Attributes

const long COST_RE_EMBLEM = 1000000
 The cost in copper to reemblem the guild.

Detailed Description

The GuildMgr holds pointers to all guilds, and pointers to their members.


Member Function Documentation

static bool DOL.GS.GuildMgr.AddGuild ( Guild  guild) [static]

Adds a guild to the list of guilds.

Parameters:
guildThe guild to add
Returns:
True if the function succeeded, otherwise false
static void DOL.GS.GuildMgr.AddPlayerToAllGuildPlayersList ( GamePlayer  player) [static]

Add a player to the guild players dictionary list.

Parameters:
playerPlayer to add
static void DOL.GS.GuildMgr.ChangeEmblem ( GamePlayer  player,
int  oldemblem,
int  newemblem 
) [static]

Process for changing an emblem.

Parameters:
player
oldemblem
newemblem
static bool DOL.GS.GuildMgr.DeleteGuild ( string  guildName) [static]

Deletes a guild.

static bool DOL.GS.GuildMgr.DoesGuildExist ( string  guildName) [static]

Checks if a guild with guildName exists.

Parameters:
guildNameThe guild to check
Returns:
true or false
static Dictionary<string, GuildMemberDisplay> DOL.GS.GuildMgr.GetAllGuildMembers ( string  guildID) [static]

Gets a copy of a dictionary of all guild members of a given guild, indexed on player InternalID.

Parameters:
guildIDThe guild id for a player
Returns:
Copy of a dictionary of all guild members for the guild or null if guild is not found
static List<Guild> DOL.GS.GuildMgr.GetAllGuilds ( ) [static]

Get a list of all guilds (creates a copy)

Returns:
static Guild DOL.GS.GuildMgr.GetGuildByGuildID ( string  guildid) [static]

Returns a guild according to the matching database ID.

Returns:
Guild
static Guild DOL.GS.GuildMgr.GetGuildByName ( string  guildName) [static]

Returns a guild according to the matching name.

Returns:
Guild
static string DOL.GS.GuildMgr.GuildNameToGuildID ( string  guildName) [static]

Returns a database ID for a matching guild name.

Returns:
Guild
static bool DOL.GS.GuildMgr.IsEmblemUsed ( int  emblem) [static]

Returns true if a guild is using the emblem.

Parameters:
emblem
Returns:
static bool DOL.GS.GuildMgr.LoadAllGuilds ( ) [static]

Load all guilds and alliances from the database.

static bool DOL.GS.GuildMgr.RemoveGuild ( Guild  guild) [static]

Removes a guild from the manager.

Parameters:
guildthe guild
Returns:
static bool DOL.GS.GuildMgr.RemovePlayerFromAllGuildPlayersList ( GamePlayer  player) [static]

Remove a player from the all guilds and players dictionary.

Parameters:
playerPlayer to remove
Returns:
True if player was removed, else false.
static void DOL.GS.GuildMgr.SaveAllGuilds ( ) [static]

Save all guild into database.


Member Data Documentation

const long DOL.GS.GuildMgr.COST_RE_EMBLEM = 1000000

The cost in copper to reemblem the guild.


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