This file has functions used by the guild subsystem. This includes functions to check whether user is member of the guild, and what rank he has, and also routines to advance in guild etc.

Guilds are identified in the cerea2 by the guild tag, which is short string following normal tag rules. It should be descriptive enough to identify the guild, but short enough it can be used as part of the tags in various places. Each guild has a guild object placed somewhere and will have the “guild_<guildtag>” as a tag (lowercased guild tag). The guild object should be some placeable with empty description (the description is replaced with the member list of guild). It should also be plot, and usable, but not static. It can also have examine as default action.

The guild object will have variables describing the guild. Variables required in the object are:

Note that each guild is made as separate object, including each order of the church, i.e. inside the game each order is considered as separate guild.

Guild clerk must have cd_g_guild_clerk as a dialog, and must have following variables set:

then either:

or

(Guild)

If sGuildTag is empty then return first guild the oPC is member of. If not empty, return next guild. When all guilds processed return empty string

string C_GetGuildNext(object oPC,
		      string sGuildTag);

(Guild)

Return guild name

string C_GetGuildName(object oPC, string sGuildTag);

(Guild)

Return rank number for the PC for the guild sGuildTag. If member is retired or expelled, then this will aways return CI_GUILD_NOT_MEMBER.

int C_GetGuildRank(object oPC,
		   string sGuildTag);

(Guild)

Return rank text for the PC for the guild sGuildTag. If the member is retired or expelled, then this will return the text “Retired <old rank>” or “Expelled <old rank>”.

string C_GetGuildRankString(object oPC,
			    string sGuildTag);

(Guild)

Check if the oPC fulfills the requirements needed to advance in the guild sGuildTag to level nLevel. If all requirements are fulfilled then return empty string otherwise return error text that can be shown to user to indicate what requirements they are missing. if CI_GUILD_LEVEL_NEXT is used as nLevel, then check requirements for the next level in guild. If member has expelled status in guild, then this will always return error.

string C_CheckGuildRequirements(object oPC,
				string sGuildTag,
				int nLevel = CI_GUILD_LEVEL_NEXT);

(Guild)

Return guild requirements as string

string C_GetGuildRequirements(object oPC,
			      string sGuildTag,
			      int nLevel = CI_GUILD_LEVEL_NEXT);

(Guild)

Advance member oPC in the guild sGuildTag to level nLevel. This will NOT check requirements, those check are done by the C_CheckGuildRequirements above, and that function should always be called before calling this. This will check that rank must be advancing, and will fail and error in case this is not true. This will also check that member is not expelled. It will always set status to active.

void C_AdvanceLevelInGuild(object oPC,
			   string sGuildTag,
			   int nLevel = CI_GUILD_LEVEL_NEXT);

(Guild)

Demote member oPC in the guild sGuildTag to level nLevel. This will check that rank must be demoting, and will fail and error in case this is not true.

void C_DemoteLevelInGuild(object oPC,
			  string sGuildTag,
			  int nLevel = CI_GUILD_LEVEL_PREV);

(Guild)

Set member oPC in the guild sGuildTag to have level nLevel instead of old level nOldLevel. This will not check anything, but will update the global membership registry.

void C_SetLevelInGuild(object oPC,
		       string sGuildTag,
		       int nLevel,
                       int nOldLevel);

(Guild)

Return membership string for guild. Include those levels which have bit on in the nLevelBitmask (CB_GUILD_*). Only nMaxLimit members from the top are returned. If nMaxLimit is -1 then there is no limit.

string C_GetMemberList(object oPC,
		       string sGuildTag,
		       int nLevelBitmask = CB_GUILD_DEFAULT,
		       int nMaxLimit = -1);

(Guild)

Check if player has enough reputation points to advance

string C_CheckGuildReputation(object oPC,
			      string sGuildTag,
			      int nLevel = CI_GUILD_LEVEL_NEXT);

(Guild)

Consume required reputation points when advancing rank in guild

void C_ConsumeGuildReputation(object oPC,
			      string sGuildTag,
			      int nLevel = CI_GUILD_LEVEL_NEXT);

(Guild)

Return number of reputation points needed for oPC to give recommendation to oTarget for the guild sGuildTag. If returns -1, then no recommendation can be given

int C_GetGuildRecommendationCost(object oPC,
				 string sGuildTag,
				 object oTarget);

(Guild)

Return number of effective reputation points to be passed to oTarget when giving recommendation the guild sGuildTag. If returns -1, then no recommendation can be given.

int C_GetGuildRecommendationPoints(object oPC,
				   string sGuildTag,
				   object oTarget);

(Guild)

Gives recommendation from oPC to oTarget for advancing in sGuildTag. Consumes reputation points from the oPC.

void C_GiveGuildRecommendation(object oPC,
			       string sGuildTag,
			       object oTarget);

(Guild)

Returns a comma separated list of guild tags where the oPC can give recommendations for the oTarget

string C_GetGuildRecommendationList(object oPC, object oTarget);

(Guild)

Return the status of the oPC in the guild sGuildTag.

int C_GetGuildStatus(object oPC,
		     string sGuildTag);

(Guild)

Return the status of the oPC in the guild sGuildTag as string.

string C_GetGuildStatusString(object oPC,
			      string sGuildTag);

(Guild)

Set the status of the oPC in the guild sGuildTag to nStatus.

void C_SetGuildStatus(object oPC,
		      string sGuildTag,
		      int nStatus);

(Guild)

Return string describing the list of guilds oPC is member of and the ranks in them if bPrintRanks is TRUE.

string C_GetGuildsString(object oPC, int bPrintRanks = TRUE);