Includes

Class Index

• deity_cache

Method index

• add_command(string, string, int)
  This method adds a command to be given to the priests.
• add_excommunicated(string, string, string)
  This method adds a priest or worshipper to the list of excommunicated players and posts a message to the board
• add_faith_rod(string, string, string, int, int)
  This method adds a faith rod to the set used by the deity.
• add_highpriest_ability(string, string)
  This method adds an ability to the set given by the deity to high priests.
• add_highpriest_command(string, string, int)
  This method adds a command into the set of commands that high priests learn.
• add_highpriest_prayer(string, string, string, int, string)
  This method adds a ritual to the set given by the deity to high priests.
• add_position(string, string, int, string *)
  This method adds a new position for the guild.
• add_prayer(string, string)
• add_priest(string, string)
  This method adds a priest to the deity
• add_ritual(string, string, string, int, string)
  This method adds a ritual to the set given by the deity.
• add_worshipper(string, string, int)
  This method adds the information associated with the non-priest worshipper.
• add_worshipper_ritual(string, string, string, int, string)
  Add a worshipper ritual!
• adjust_points(string, int, mixed, string)
  This method adjusts the number of points associated with the deity.
• adjust_priest_rating(string, string, int, int)
  This method adjusts the rating for the priest.
• adjust_rating(string, int)
  This method adjusts the rating for the deity.
• align_string(int)
  This method gives a string represtentation of the the alignment level.
• appoint_position(string, string, string)
  This method appoints a player to a position in the guild.
• challenge_high_priest(string)
  This method starts voting for a schism, retaining the current high priest.
• check_deity(string, int)
• clear_ritual(string)
• clear_worshipper_rituals(string)
  Clear all worshippe rituals!
• delete_command(string, string)
  This method deletes a command to be given to the priests.
• delete_creator_set_data(string, string)
• delete_excommunicated(string, string)
  This method reinstates a priest or worshipper to the church, from the list of excommunicated players
• delete_faith_rod(string, string)
  This method deletes a faith rod from the deity.
• delete_highpriest_ability(string, string)
  This method removes an ability from the list which is given to high priests of the deity.
• delete_highpriest_command(string, string)
  This method deletes a command from the set of commands high priests can learn.
• delete_highpriest_prayer(string, string)
  This method removes a ritual from the list which is given to high preists of the deity.
• delete_player_set_data(string, string)
• delete_prayer(string, string)
• delete_priest(string, string)
  This method removes a priest fromt he clergy.
• delete_ritual(string, string)
  This method deletes a ritual from the deity.
• delete_worshipper(string, string)
  This method deletes the given non-priest worshipper.
• delete_worshipper_ritual(string, string)
  This method deletes a ritual from the deity.
• dismiss_position(string, string, string)
  This method dismiss a player from a position in the guild.
• elect_high_priest(string)
  This method starts an election and clears the high priest.
• end_election(string)
  This method finishes off the election and elects the new high priest.
• get_random_faith_rod(string, int, int)
  This method returns the path of a randomly selected faith rod that deity may use.
• initiate_schism(string, string)
  This method starts voting for a schism but keeps the high priest the same.
• is_allowed_to_be_minister(string)
  This method is here to check the 'minister' titles to make sure the people who have them are allowed to have them.
• is_high_priest(string)
  This method checks to see if the player is a high priest.
• query_aka(string)
  This method queries an alternate deity as the recipent for points and such.
• query_al_lower(string)
  This method returns the lower alignment limit for the given deity.
• query_al_middle(string)
  This method returns the middle alignment for the given deity.
• query_al_upper(string)
  This method returns the upper alignment limit for the given deity.
• query_all_creator_set_data(string)
• query_all_player_set_data(string)
• query_commands(string)
  Thie method queries the commands given to priests.
• query_creator_set_data(string, string)
• query_current_deities()
  This method is the returns the current list of available deities.
• query_current_nationality_deities(string)
  This method returns the list of deities from a certain location.
• query_deity(string)
  This method tells us if the deity exists.
• query_deity_cap_name(string)
• query_deity_finger(string)
  This method returns the string used when fingering a deity.
• query_deity_nationalities()
  This method returns the list of nationalities currently noted against deities.
• query_deity_short(string, int)
• query_distance_rating(string)
• query_election(string)
  This method queries the current election statistics.
• query_election_status(string)
  This method tells us what state the election is in.
• query_excommunicated(string, string)
  This method checks to see if the player has been excommunicated from the given deity
• query_excommunicateds(string)
  This method returns the names of everyone excommunicated from a priesthood.
• query_excommunication_reason(string, string)
  This method returns the given reason for a player's excommunication
• query_extra_finger_info(string)
• query_faith_rods(string)
• query_favour_rating(string)
• query_gender(string)
  This method returns the gender of the deity.
• query_high_priest(string)
  This method returns the current high priest for the deity.
• query_highpriest_commands(string)
  This method queries the commands given to the high priests.
• query_highpriest_prayers(string)
  This method queries the rituals given by this deity to high preists.
• query_info(string)
  This method returns information about the deity.
• query_last_high_priest(string)
  This method returns the former high priest for the deity, until a new one is elected.
• query_max_points(string)
  This method returns the maximum number of points associated with the deity.
• query_nationality(string)
  This method returns the deity's nationality.
• query_objective(string)
  This method returns the objective for the deity.
• query_player_ability(string, string, string)
  This method returns whether a player has a specific ability.
• query_player_position(string, string)
  This method returns the position help by a player.
• query_player_set_data(string, string)
• query_points(string)
  This method returns the number of points associated with the deity.
• query_position(string, string)
  This method returns the appointments for a position.
• query_position_abilities(string, string)
  This method returns the abilities for a position.
• query_position_appointments(string, string)
  This method returns the appointments for a position.
• query_positions(string)
  This method returns all positions for this guild.
• query_possessive(string)
  This method returns the possessive for the deity.
• query_prayers(string, string)
• query_priest(string, string)
  This method checks to see if the player is a priest of the given deity.
• query_priest_rating(string, string)
  This method returns the current rating for the priest.
• query_priesthood(string)
  This method returns the current ratings mapping for the deity.
• query_priests(string)
  This method returns the names of everyone in the priesthood.
• query_pronoun(string)
  This method returns the pronoun for the deity.
• query_rating(string)
  This method returns the rating for the deity.
• query_rituals(string)
  This method queries the rituals given by this deity.
• query_schism(string)
  This method queries the current schisms statistics.
• query_short()
• query_title(string)
  This method returns the title for the deity.
• query_title_type(string)
  This method returns the title type for the deity.
• query_totem_chats(string)
  This method returns the chats of the deities totem figure.
• query_totem_description(string)
  This method returns the description of the deities totem figure.
• query_valid_al(string, int, int)
  This method determines if the alignment is valid for the deity.
• query_voted(string)
  This method returns a list of the priests who have voted for the the high priests.
• query_want_priests(string)
  This method tells us if the deity wants priests or not.
• query_want_worshippers(string)
  This method tells us if the deity wants worshippers or not.
• query_worshipper(string, string)
  This method returns the information associated with the non-priest worshipper.
• query_worshipper_quests(string)
  This method queries the list of worshipper quests.
• query_worshipper_rituals(string)
• query_worshippers(string)
  This method queries the mapping of non-priest worshippers.
• random_al(string)
  This method returns a random alignment between the limits for the given deity.
• recheck_worshipper(string)
  This method figures out the number of rituals the worshipper should know based on the number of quests they have done.
• remove_high_priest(string, string)
  This method is a generic form of removing the incumbent high priest through some external means (they have died, resigned, become inactive, etc).
• remove_position(string, string)
  This method removes a position for the guild.
• reset_positions(string)
  This method removes all appointments for a guild.
• schism_stand(string, string)
• schism_support(string, string, string)
• schism_withdraw(string, string)
• set_aka(string, string)
  This method sets an alternate deity as the recipent for points and such.
• set_al_lower(string, int)
  This method sets the lower alignment limit for the given deity.
• set_al_upper(string, int)
  This method sets the upper alignment limit for the given deity.
• set_creator_set_data(string, string, mixed)
• set_extra_finger_info(string, mixed)
• set_gender(string, int)
  This method sets the gender of the deity.
• set_high_priest(string, string)
  This method sets the current high priest for the deity.
• set_info(string, string)
  This method sets information about the deity.
• set_nationality(string, string)
  This method sets the deity's nationality.
• set_player_set_data(string, string, mixed)
• set_points(string, int)
  This method sets the number of points associated with the deity.
• set_rating(string, int)
  This method sets the rating for the deity.
• set_short(string)
• set_title(string, string, int)
  This method sets the title for the deity.
• set_totem_chats(string, mixed *)
  This method sets the chats of the deities totem figure.
• set_totem_description(string, string, string, string, string, mixed)
  This method sets the description of the deities totem figure.
• set_vote(string, string, string)
  This method sets the current vote for the priest to the given candidate.
• set_want_priests(string, int)
  This method sets if the deity wants priests or not.
• set_want_worshippers(string, int)
  This method sets if the deity wants worshippers or not.
• set_worshipper(string, string, int)
  This method sets the information associated with the non-priest worshipper.
• set_worshipper_quests(string, mixed *)
  This method sets the list of worshipper quests.
• set_worshippers(string, mapping)
  This method sets the mapping of non-priest worshippers.
• valid_high_priest(string)
  This method checks to see if the high priest is valid.
• valid_priest(string)
  This method checks to see if the priest is valid.
• valid_worshipper(string)
  This method checks to see if the worshipper is valid.
• withdraw_candidate(string, string)
  This method withdraws a candidate from the high priest election.

Public Functions

add_command

int add_command(string word1,
                string word2,
                int number)

This method adds a command to be given to the priests.

Parameters:
word1 - the deity to add the commands for
word2 - the name of the command
number - the level at which it is to be taught

Returns:
1 if success, 0 if not

add_excommunicated

int add_excommunicated(string deity,
                       string who,
                       string reason)

This method adds a priest or worshipper to the list of excommunicated players and posts a message to the board

Parameters:
deity - the deity
who - the player name to add
the - reason given for excommunicating them

Returns:
DEITY_FAIL if the player has already been excommunicated or does not belong to the church, DEITY_OK if not

add_faith_rod

int add_faith_rod(string deity,
                  string name,
                  string path,
                  int chance,
                  int unique)

This method adds a faith rod to the set used by the deity.

Parameters:
deity - the name of the deity
name - the name of the rod to add
path - the file name of the rod
chance - the relative commonness of the rod
unique - whether the rod should be handed out as a matter of course

Returns:
always returns 1

add_highpriest_ability

int add_highpriest_ability(string deity,
                           string ability)

This method adds an ability to the set given by the deity to high priests.

Parameters:
deity - the name of the deity
ability - the ability to add

Returns:
always returns 1

add_highpriest_command

int add_highpriest_command(string word1,
                           string word2,
                           int number)

This method adds a command into the set of commands that high priests learn.

Parameters:
word1 - the deity to add the commands for
word2 - the name of the command to add
number - the level at which it will be taught

Returns:
1 if it was successful, 0 if it was not

add_highpriest_prayer

int add_highpriest_prayer(string word1,
                          string word2,
                          string word3,
                          int number,
                          string word4)

This method adds a ritual to the set given by the deity to high priests.

Parameters:
word1 - the name of the deith
word2 - the name ritual to add
word3 - the file name of the ritual
number - the level to teach the ritual at
word4 - the skill to check for the level

Returns:
always returns 1

add_position

int add_position(string deity_name,
                 string position,
                 int max,
                 string * abilities)

This method adds a new position for the guild.

Parameters:
deity_name - the name of the deity:)
position - position to add
max - the maximum number of people appointed to this position
abilities - the abilities assiciated with this position

Returns:
DEITY_POSITION_OK if successful, DEITY_POSITION_FAIL if the position already exists

See also:
remove_position(), query_position() and query_positions()

add_prayer

void add_prayer(string deity,
                string name)

add_priest

int add_priest(string word1,
               string word2)

This method adds a priest to the deity

Parameters:
word1 - the deity
word2 - the player name to add

Returns:
DEITY_FAIL if the player already exists, DEITY_OK if not

add_ritual

int add_ritual(string word1,
               string word2,
               string word3,
               int number,
               string word4)

This method adds a ritual to the set given by the deity.

Parameters:
word1 - the name of the deith
word2 - the name ritual to add
word3 - the file name of the ritual
number - the level to teach the ritual at
word4 - the skill to check for the level

Returns:
always returns 1

add_worshipper

void add_worshipper(string deity_name,
                    string word2,
                    int number)

This method adds the information associated with the non-priest worshipper. This corresponds to the number of rituals learnable.

Parameters:
deity_name - the name of the deity
word2 - the non-priest whorshipper to check
number - the number of extra rituals to learn

See also:
set_worshipper(), delete_worshipper() and query_worshipper()

add_worshipper_ritual

int add_worshipper_ritual(string word1,
                          string word2,
                          string word3,
                          int number,
                          string word4)

Add a worshipper ritual!

adjust_points

int adjust_points(string deity_name,
                  int number,
                  mixed who,
                  string type)

This method adjusts the number of points associated with the deity. The points are a measure of the total amount prayer that has been directed to the deity.

Parameters:
deity_name - the name of the deity to adjust the points for
number - the amount to adjust the points by
who - the player who altered the points
type - the method by which the points where altered

adjust_priest_rating

int adjust_priest_rating(string word1,
                         string word2,
                         int number1,
                         int number2)

This method adjusts the rating for the priest. The rating is calculate as min(max((number1 + old_rating), 0), (2 * number2)).

Parameters:
word1 - the dieyt
word2 - the priest
number1 - the number1 as defined above
number2 - the number2 as defined above

Returns:
the new rating

adjust_rating

void adjust_rating(string deity_name,
                   int number)

This method adjusts the rating for the deity.

Parameters:
deity_name - the name of deity to adjust the rating for
number - the amount to change the rating by

align_string

string align_string(int alignment)

This method gives a string represtentation of the the alignment level.

Parameters:
alignment - the alignment to return

Returns:
the string name fo the alignment

appoint_position

int appoint_position(string deity_name,
                     string position,
                     string player)

This method appoints a player to a position in the guild. If the player is already appointed to some other position, that position's lost.

Parameters:
deity_name - the name of the deity:)
position - position to appoint player to
player - player to appoint

Returns:
DEITY_POSITION_OK if successful, DEITY_POSITION_TOO_MANY if the position is filled, DEITY_POSITION_ALREADY_APPOINTED if that player already holds that position, DEITY_POSITION_FAIL if the position doesn't exist
NB! There's NO check for the player being a priest, a follower, or even a player

See also:
dismiss_position() and add_position()

challenge_high_priest

void challenge_high_priest(string deity)

This method starts voting for a schism, retaining the current high priest.

Parameters:
word - the deity

check_deity

void check_deity(string deity,
                 int next_time)

clear_ritual

int clear_ritual(string deity)

clear_worshipper_rituals

int clear_worshipper_rituals(string deity)

Clear all worshippe rituals!

delete_command

int delete_command(string word1,
                   string word2)

This method deletes a command to be given to the priests.

Parameters:
word1 - the name of the deity
word2 - the name of the command to delete

Returns:
1 if success, 0 if not

delete_creator_set_data

void delete_creator_set_data(string deity,
                             string key)

delete_excommunicated

int delete_excommunicated(string deity,
                          string who)

This method reinstates a priest or worshipper to the church, from the list of excommunicated players

Parameters:
deity - the deity
who - the player name to add

Returns:
DEITY_FAIL if the player has not been excommunicated, DEITY_OK if they have and were recommunicated

delete_faith_rod

int delete_faith_rod(string deity,
                     string name)

This method deletes a faith rod from the deity.

Parameters:
deity - the name of the deity
name - the rod to delete

delete_highpriest_ability

int delete_highpriest_ability(string deity,
                              string ability)

This method removes an ability from the list which is given to high priests of the deity.

Parameters:
word1 - the name of the deity
word2 - the name of the ability

delete_highpriest_command

int delete_highpriest_command(string word1,
                              string word2)

This method deletes a command from the set of commands high priests can learn.

Parameters:
word1 - the name of the deity
word2 - the name of the command to delete

Returns:
DEITY_OK if it was successful, DEITY_FAIL if it was not

delete_highpriest_prayer

int delete_highpriest_prayer(string word1,
                             string word2)

This method removes a ritual from the list which is given to high preists of the deity.

Parameters:
word1 - the name of the deity
word2 - the name of the ritual

delete_player_set_data

void delete_player_set_data(string deity,
                            string key)

delete_prayer

void delete_prayer(string deity,
                   string name)

delete_priest

int delete_priest(string deity,
                  string who)

This method removes a priest fromt he clergy.

Parameters:
deity - the deity
who - the player to delete

Returns:
DEITY_OK if successful, DEITY_FAIL if not

delete_ritual

int delete_ritual(string word1,
                  string word2)

This method deletes a ritual from the deity.

Parameters:
word1 - the name of the deity
word2 - the ritual to delete

delete_worshipper

int delete_worshipper(string deity,
                      string who)

This method deletes the given non-priest worshipper.

Parameters:
deity - the name of the deity
who - the non-priest whorshipper to delete

Returns:
1 if the operation was successful, 0 if it failed

See also:
add_worshipper(), set_worshipper() and query_worshipper()

delete_worshipper_ritual

int delete_worshipper_ritual(string word1,
                             string word2)

This method deletes a ritual from the deity.

Parameters:
word1 - the name of the deity
word2 - the ritual to delete

dismiss_position

int dismiss_position(string deity_name,
                     string position,
                     string player)

This method dismiss a player from a position in the guild.

Parameters:
deity_name - the name of the deity:)
position - position to appoint player to
player - player to appoint

Returns:
DEITY_POSITION_OK if successful, DEITY_POSITION_FAIL if the player didn't have that position.

See also:
appoint_position() and add_position()

elect_high_priest

void elect_high_priest(string word)

This method starts an election and clears the high priest.

Parameters:
word - the deity

end_election

void end_election(string word)

This method finishes off the election and elects the new high priest.

Parameters:
word - the deity

get_random_faith_rod

string get_random_faith_rod(string deity,
                            int chance_generic,
                            int allow_unique)

This method returns the path of a randomly selected faith rod that deity may use.

Parameters:
deity - the name of the deity
name - the rod to delete

initiate_schism

void initiate_schism(string deity,
                     string bringer)

This method starts voting for a schism but keeps the high priest the same.

Parameters:
deity - the deity

is_allowed_to_be_minister

int is_allowed_to_be_minister(string player)

This method is here to check the 'minister' titles to make sure the people who have them are allowed to have them.

Parameters:
player - the player name to check

is_high_priest

int is_high_priest(string player)

This method checks to see if the player is a high priest.

Parameters:
player - the player name to check

query_aka

string query_aka(string deity_name)

This method queries an alternate deity as the recipent for points and such. (Like the Tsortian God of Thunder is really Blind Io, with a false beard and another hammer).

Parameters:
deity_name - the deity to get the aka for

Returns:
the aka for the deity

query_al_lower

int query_al_lower(string deity_name)

This method returns the lower alignment limit for the given deity. Note that that's the limit to how good the deity accepts followers.

Parameters:
deity_name - the name of the deity to query

Returns:
the lower alignment limit

query_al_middle

int query_al_middle(string deity_name)

This method returns the middle alignment for the given deity.

Parameters:
deity_name - the name of the deity to query

Returns:
the middle alignment value

query_al_upper

int query_al_upper(string deity_name)

This method returns the upper alignment limit for the given deity. Note that that's the limit to how evil the deity accepts followers.

Parameters:
deity_name - the name of the deity to query

Returns:
the upper alignment limit

query_all_creator_set_data

mapping query_all_creator_set_data(string deity)

query_all_player_set_data

mapping query_all_player_set_data(string deity)

query_commands

mapping query_commands(string word)

Thie method queries the commands given to priests. The keys of the mapping are the commands given and the value associated with the key is the level at which it is taught.

Parameters:
word - the deity to get the commands for

Returns:
the commands mapping

query_creator_set_data

mixed query_creator_set_data(string deity,
                             string key)

query_current_deities

string * query_current_deities()

This method is the returns the current list of available deities.

Returns:
the available deity names

query_current_nationality_deities

string * query_current_nationality_deities(string nationality)

This method returns the list of deities from a certain location.

Returns:
the deity names from the nationality

query_deity

int query_deity(string deity_name)

This method tells us if the deity exists.

Parameters:
deity_name - the name of the deity to check

Returns:
1 if the deity exists, 0 if not

query_deity_cap_name

string query_deity_cap_name(string deity_name)

query_deity_finger

string query_deity_finger(string deity_name)

This method returns the string used when fingering a deity.

Parameters:
deity_name - the deity to finger

Returns:
the information relating to the deity

query_deity_nationalities

string * query_deity_nationalities()

This method returns the list of nationalities currently noted against deities.

Returns:
the list of current nationalities

query_deity_short

varargs string query_deity_short(string deity_name,
                                 int mid_sentence)

query_distance_rating

float query_distance_rating(string name)

query_election

mapping query_election(string word)

This method queries the current election statistics. The keys of mapping are the list of candiates and the values are the number of votes collected for them so far.

Parameters:
word - the name of the deity to check

Returns:
the election mapping

query_election_status

int query_election_status(string deity)

This method tells us what state the election is in.

Parameters:
deity - the name of the deity to check

Returns:
the election status

query_excommunicated

int query_excommunicated(string deity,
                         string who)

This method checks to see if the player has been excommunicated from the given deity

Parameters:
deity - the deity to test
who - the player name to check

Returns:
1 if the player is excommunicated, 0 if not.

query_excommunicateds

string * query_excommunicateds(string deity)

This method returns the names of everyone excommunicated from a priesthood.

Parameters:
deity - the deity to get the excommunicated for

Returns:
the string array of excommunicated priests and worshippers

query_excommunication_reason

string query_excommunication_reason(string deity,
                                    string who)

This method returns the given reason for a player's excommunication

Parameters:
deity - the deity to test
who - the player name to check

Returns:
the reason for excommunication

query_extra_finger_info

void query_extra_finger_info(string deity)

query_faith_rods

mapping query_faith_rods(string deity)

query_favour_rating

float query_favour_rating(string name)

query_gender

int query_gender(string deity_name)

This method returns the gender of the deity. The gender is the same as used elsehwere in the game. 0 for neuter, 1 for male and 2 for female.

Parameters:
deity_name - the deity name

Returns:
the gender of the deity

See also:
/std/living/gender.c and set_gender()

query_high_priest

string query_high_priest(string deity_name)

This method returns the current high priest for the deity.

Parameters:
deity_name - the name of the deity to get the high priest for

Returns:
the name of the high priest

See also:
set_high_priest()

query_highpriest_commands

mapping query_highpriest_commands(string word)

This method queries the commands given to the high priests. the keys of the mapping are the commands to be taught and the value of the mapping is the level at which they will be taught.

Parameters:
word1 - the name of the deity

Returns:
the high priest mapping

See also:
query_priest_commands()

query_highpriest_prayers

mapping query_highpriest_prayers(string word)

This method queries the rituals given by this deity to high preists. The keys of the mapping is the name of the ritual, the values is an array. The array is 3 elements long, the first is the file name associated with the ritual, the second is the level at which the ritual will be taught and the third is the skill to check for the level.

Parameters:
word - the deity to get the prayers for

Returns:
the rituals mapping

query_info

string query_info(string deity_name)

This method returns information about the deity. This is used in the finger information and when querying about joining the priesthood.

Parameters:
deity_name - the name of the deity to get information on

Returns:
information about the deity

See also:
set_info()

query_last_high_priest

string query_last_high_priest(string deity_name)

This method returns the former high priest for the deity, until a new one is elected.

Parameters:
deity_name - the name of the deity to get the high priest for

Returns:
the name of the high priest

See also:
set__high_priest()

query_max_points

int query_max_points(string deity_name)

This method returns the maximum number of points associated with the deity. This limit is increased by having more followers.

Parameters:
deity_name - the name of the deity to get the points for

Returns:
the number of points for the deity.

query_nationality

string query_nationality(string deity_name)

This method returns the deity's nationality.

Parameters:
deity_name - the name of the deity to get information on

Returns:
deity's nationality, or 0 if non-specific

See also:
set_nationality()

query_objective

string query_objective(string deity_name)

This method returns the objective for the deity.

Parameters:
deity_name - the name of the deity to get the objective of

Returns:
the objective of the deity

See also:
/std/living/gender->query_objective()

query_player_ability

int query_player_ability(string deity_name,
                         string player,
                         string ability)

This method returns whether a player has a specific ability.

Parameters:
deity_name - the name of the deity:)
player - the name of the player
ability - the ability to test for:)

Returns:
0 if that player don't have that ability, 1 if he does

See also:
add_position()

query_player_position

string query_player_position(string deity_name,
                             string player)

This method returns the position help by a player.

Parameters:
deity_name - the name of the deity:)
player - whose position should be returned

Returns:
the position help or 0 if the player doesn't hold one

See also:
add_position()

query_player_set_data

mixed query_player_set_data(string deity,
                            string key)

query_points

int query_points(string deity_name)

This method returns the number of points associated with the deity. The points are a measure of the total amount prayer that has been directed to the deity.

Parameters:
deity_name - the name of the deity to get the points for

Returns:
the number of points for the deity.

query_position

string * query_position(string deity_name,
                        string position)

This method returns the appointments for a position. You should really use query_position_appointments() instead

Parameters:
deity_name - the name of the deity:)
position - position to return

Returns:
0 if the position don't exist, an array of appointments if is does, with 0's for unfilled positions

See also:
add_position()

query_position_abilities

string * query_position_abilities(string deity_name,
                                  string position)

This method returns the abilities for a position.

Parameters:
deity_name - the name of the deity:)
position - position to return

Returns:
0 if the position don't exist, an array of appointments if is does, with 0's for unfilled positions

See also:
add_position()

query_position_appointments

string * query_position_appointments(string deity_name,
                                     string position)

This method returns the appointments for a position.

Parameters:
deity_name - the name of the deity:)
position - position to return

Returns:
0 if the position don't exist, an array of appointments if is does, with 0's for unfilled positions

See also:
add_position()

query_positions

mapping query_positions(string deity_name)

This method returns all positions for this guild.

Parameters:
deity_name - the name of the deity:)

Returns:
0 if the position don't exist, an array of appointments if is does, with 0's for unfilled positions

See also:
add_position()

query_possessive

string query_possessive(string deity_name)

This method returns the possessive for the deity.

Parameters:
deity_name - the name of the deity to get the possessive of

Returns:
the possessive of the deity

See also:
/std/living/gender->query_possessive()

query_prayers

string * query_prayers(string deity,
                       string name)

query_priest

int query_priest(string word1,
                 string word2)

This method checks to see if the player is a priest of the given deity.

Parameters:
word1 - the deity to test
word2 - the player name to chec

Returns:
1 if the player is a priest, 0 if not.

query_priest_rating

int query_priest_rating(string word1,
                        string word2)

This method returns the current rating for the priest.

Parameters:
word1 - the deity
word2 - the player name to get the rating of

Returns:
the current rating

query_priesthood

mapping query_priesthood(string word)

This method returns the current ratings mapping for the deity. The keys of the mapping are the names of the worshippers and the values are their current ratings.

Parameters:
word - the name of the deity to query

Returns:
the ratings mapping

query_priests

string * query_priests(string word)

This method returns the names of everyone in the priesthood.

Parameters:
word - the deity to get the preists for

Returns:
the string array of priests

query_pronoun

string query_pronoun(string deity_name)

This method returns the pronoun for the deity.

Parameters:
deity_name - the name of the deity to get the pronoun of

Returns:
the pronoun of the deity

See also:
/std/living/gender->query_pronoun()

query_rating

int query_rating(string deity_name)

This method returns the rating for the deity.

Parameters:
deity_name - the name of deity to get the rating for

Returns:
the current rating

query_rituals

mapping query_rituals(string word)

This method queries the rituals given by this deity. The keys of the mapping is the name of the ritual, the values is an array. The array is 3 elements long, the first is the file name associated with the ritual, the second is the level at which the ritual will be taught and the third is the skill to check for the level.

Parameters:
word - the deity to get the prayers for

Returns:
the rituals mapping

query_schism

mapping query_schism(string word)

This method queries the current schisms statistics. The keys of mapping are the list of challengers and the values are the priests who are supporting their bid.

Parameters:
word - the name of the deity to check

Returns:
the schism mapping

query_short

string query_short()

query_title

string query_title(string deity_name)

This method returns the title for the deity.

Parameters:
deity_name - the deity to get the title of

Returns:
the title of the deity

See also:
set_title()

query_title_type

int query_title_type(string deity_name)

This method returns the title type for the deity.

Parameters:
deity_name - the deity to get the title of

Returns:
the title type of the deity: 0 for comma, 1 for no comma, 2 for a pre-title

See also:
set_title()

query_totem_chats

mixed * query_totem_chats(string deity_name)

This method returns the chats of the deities totem figure.

Parameters:
deity_name - the name of the deity to get the chat for

Returns:
the chats of the deities totem figure

query_totem_description

mixed * query_totem_description(string deity_name)

This method returns the description of the deities totem figure.

Parameters:
deity_name - the name of the deity to get the description for

Returns:
the description of the deities totem figure

query_valid_al

varargs int query_valid_al(string deity_name,
                           int number,
                           int imbue)

This method determines if the alignment is valid for the deity.

Parameters:
deity_name - the deity to check
number - the alignment to check
imbue - If the check is too see if someone can use an imbue, the align restrictions are relaxed a bit.

Returns:
DEITY_ALIGN_OK if it is valid, DEITY_ALIGN_EVIL if too evil, DEITY_ALIGN_GOOD if too good

query_voted

string * query_voted(string deity_name)

This method returns a list of the priests who have voted for the the high priests.

Parameters:
deity_name - the name of the deity to check

Returns:
the array of the preist voted

query_want_priests

int query_want_priests(string deity_name)

This method tells us if the deity wants priests or not.

Parameters:
deity_name - the deity to check

Returns:
1 if the deity wants priests, 0 if not

See also:
set_want_priests()

query_want_worshippers

int query_want_worshippers(string deity_name)

This method tells us if the deity wants worshippers or not.

Parameters:
deity_name - the deity to check

Returns:
1 if the deity wants worshippers, 0 if not

See also:
set_want_worshippers()

query_worshipper

int query_worshipper(string deity_name,
                     string word2)

This method returns the information associated with the non-priest worshipper. This corresponds to the number of rituals learnable.

Parameters:
deity_name - the name of the deity
word2 - the non-priest whorshipper to check

Returns:
the number of rituals learnable

See also:
add_worshipper(), set_worshipper() and query_worshipper()

query_worshipper_quests

mixed * query_worshipper_quests(string deity_name)

This method queries the list of worshipper quests. The arrays consists of pairs of query_titles and number of rituals given if the quest is done. The function recheck_worshipper checks if the player is a worshipper and in that case it will calculate the number of rituals taught based on the quests done.

Parameters:
deity_name - the deity to get the quests for

Returns:
the array as described above

See also:
recheck_worshipper()

query_worshipper_rituals

mapping query_worshipper_rituals(string deity)

query_worshippers

mapping query_worshippers(string deity_name)

This method queries the mapping of non-priest worshippers. The keys of the mapping are the names and the values are number of rituals learnable.

Parameters:
deity_name - the name of the deity to query

Returns:
the mapping of non-priest worshippers

random_al

int random_al(string deity_name)

This method returns a random alignment between the limits for the given deity. This is used by the npcs to set themselves up with a correct alignment.

Parameters:
deity_name - the name of the deity to query

Returns:
a random valid alignment

recheck_worshipper

void recheck_worshipper(string player_name)

This method figures out the number of rituals the worshipper should know based on the number of quests they have done.

Parameters:
player_name - the name of the player to check

See also:
query_worshipper_quests()

remove_high_priest

void remove_high_priest(string deity,
                        string name)

This method is a generic form of removing the incumbent high priest through some external means (they have died, resigned, become inactive, etc). It handles the appropriate next steps, such as calling an election, dismissing ministers and aborting any schism.

Parameters:
deity - the deity they belong to
name - the player name to check

remove_position

int remove_position(string deity_name,
                    string position)

This method removes a position for the guild.

Parameters:
deity_name - the name of the deity:)
position - position to remove

Returns:
DEITY_POSITION_OK if successful, DEITY_POSITION_FAIL if the position didn't exist

See also:
add_position(), query_position() and query_positions()

reset_positions

void reset_positions(string deity_name)

This method removes all appointments for a guild. Used when the high priest dies.

Parameters:
deity_name - the name of the deity:)

See also:
add_position()

schism_stand

int schism_stand(string deity,
                 string name)

schism_support

int schism_support(string deity,
                   string name,
                   string challenger)

schism_withdraw

int schism_withdraw(string deity,
                    string name)

set_aka

void set_aka(string deity_name,
             string word2)

This method sets an alternate deity as the recipent for points and such. (Like the Tsortian God of Thunder is really Blind Io, with a false beard and another hammer).

Parameters:
deity_name - the deity to set the aka for
word2 - the new aka for the deity

set_al_lower

void set_al_lower(string deity_name,
                  int number)

This method sets the lower alignment limit for the given deity. Note that that's the limit to how good the deity accepts followers.

Parameters:
deity_name - the name of the deity to query

Returns:
the lower alignment limit

set_al_upper

void set_al_upper(string deity_name,
                  int number)

This method sets the upper alignment limit for the given deity. Note that that's the limit to how evil the deity accepts followers.

Parameters:
deity_name - the name of the deity to query

Returns:
the upper alignment limit

set_creator_set_data

void set_creator_set_data(string deity,
                          string key,
                          mixed value)

set_extra_finger_info

void set_extra_finger_info(string deity,
                           mixed info)

set_gender

void set_gender(string deity_name,
                int number)

This method sets the gender of the deity. The gender is the same as used elsehwere in the game. 0 for neuter, 1 for male and 2 for female.

Parameters:
the - deity name
number - the gender to set the deity to

See also:
/std/living/gender.c and query_gender()

set_high_priest

void set_high_priest(string deity_name,
                     string word)

This method sets the current high priest for the deity.

Parameters:
deity_name - the name of the deity to set the high priest for
word - the name of the new high priest

See also:
query_high_priest()

set_info

void set_info(string deity_name,
              string text)

This method sets information about the deity. This is used in the finger information and when querying about joining the priesthood.

Parameters:
deity_name - the name of the deity to set information on
text - the new value for the information

See also:
query_info()

set_nationality

void set_nationality(string deity_name,
                     string text)

This method sets the deity's nationality.

Parameters:
deity_name - the name of the deity to set information on
nationality - deity's nationality, or 0 if non-specific

See also:
query_nationality()

set_player_set_data

void set_player_set_data(string deity,
                         string key,
                         mixed value)

set_points

void set_points(string deity_name,
                int number)

This method sets the number of points associated with the deity. The points are a measure of the total amount prayer that has been directed to the deity.

Parameters:
deity_name - the name of the deity to set the points for
number - the new value of the points

set_rating

void set_rating(string deity_name,
                int number)

This method sets the rating for the deity.

Parameters:
deity_name - the name of deity to set the rating for
number - the new value of the rating

set_short

void set_short(string str)

set_title

void set_title(string deity_name,
               string text,
               int type)

This method sets the title for the deity.

Parameters:
deity_name - the deity to set the title of
text - the new title of the deity
type - the new title type of the deity

See also:
query_title()

set_totem_chats

void set_totem_chats(string deity_name,
                     mixed * chats)

This method sets the chats of the deities totem figure.

Parameters:
deity_name - the name of the deity to get the chat for
chats - the chats of the totem figure, see

See also:
/obj/monster->load_chat()

set_totem_description

void set_totem_description(string deity_name,
                           string name,
                           string short,
                           string main_plural,
                           string long,
                           mixed adjectives)

This method sets the description of the deities totem figure.

Parameters:
deity_name - the name of the deity to get the description for
name - the name of the figure
short - the short of the figure
main_plural - the main_plural of the figure
long - the long of the figure
adjectives - the adjectives of the figure

set_vote

int set_vote(string deity_name,
             string candidate,
             string voter)

This method sets the current vote for the priest to the given candidate. This returns 0 if there is no election, -1 if the preist being voted for does not exist and -2 if the priest has already voted. 3 votes for a memvber of the priesthood, 2 if you are worshipping the god and 1 if you are not.

Parameters:
deity_name - the name of the deity to vote for
candidate - the high priest to vote for
voter - the priest voting

Returns:
the status value

set_want_priests

void set_want_priests(string deity_name,
                      int number)

This method sets if the deity wants priests or not.

Parameters:
deity_name - the name of the deity to change
number - the value of the flag

See also:
query_want_priests()

set_want_worshippers

void set_want_worshippers(string deity_name,
                          int number)

This method sets if the deity wants worshippers or not.

Parameters:
deity_name - the name of the deity to change
number - the value of the flag

See also:
query_want_worshippers()

set_worshipper

void set_worshipper(string deity_name,
                    string word2,
                    int number)

This method sets the information associated with the non-priest worshipper. This corresponds to the number of rituals learnable.

Parameters:
deity_name - the name of the deity
word2 - the non-priest worshipper to check
number - the number of rituals to learn

See also:
add_worshipper(), delete_worshipper() and query_worshipper()

set_worshipper_quests

void set_worshipper_quests(string deity_name,
                           mixed * quest_list)

This method sets the list of worshipper quests. The arrays consists of pairs of query_titles and number of rituals given if the quest is done. The function recheck_worshipper checks if the player is a worshipper and in that case it will calculate the number of rituals taught based on the quests done.

Parameters:
deity_name - the deity to set the quests for
quest_list - the new list of quests for the deity

See also:
recheck_worshipper()

set_worshippers

void set_worshippers(string deity_name,
                     mapping map)

This method sets the mapping of non-priest worshippers. The keys of the mapping are the names and the values are number of rituals learnable. Except in very special circumstances set_worshipper() should be used instead.

Parameters:
deity_name - the name of the deity to set
map - the new value for the mapping

See also:
add_worshipper(), set_worshipper(), delete_worshipper() and query_worshipper()

valid_high_priest

int valid_high_priest(string priest)

This method checks to see if the high priest is valid. Checks to make make sure they exist, their guild object is set to the priest object and they worship the current deity. Makes sure they don't have the "no score" property set and they have been on recently.

Parameters:
priest - the player to check

Returns:
0 if they are not, 1 if they are

See also:
test_user(), test_deity() and test_guild()

valid_priest

int valid_priest(string priest)

This method checks to see if the priest is valid. Checks to make make sure they exist, their guild object is set to the priest object and they worship the current deity.

Parameters:
priest - the player to check

Returns:
0 if they are not, 1 if they are

See also:
test_user(), test_deity() and test_guild()

valid_worshipper

int valid_worshipper(string worshipper)

This method checks to see if the worshipper is valid. This basically checks to see if they exist and they are worshipping the current deity.

Parameters:
worshipper - the worshipper to check

Returns:
0 if they are not, 1 if they are

See also:
test_user() and test_deity()

withdraw_candidate

int withdraw_candidate(string candidate,
                       string deity)

This method withdraws a candidate from the high priest election.

Parameters:
candidate - the candidate
deity - the deity

Returns:
1 if successful, -1 if not.

Classes

• deity_cache

  class deity_cache {
                      int al_lower;
                      int al_upper;
                      int want_priests;
                      int want_worshippers;
                      string title;
                      int num_priests;
                      int num_worshippers;
                      string high_priest;
                      string short;
                      string info;
                      mixed extra_finger_info;
                      int gender;
                      mixed * totem_chats;
                      mixed * totem_description;
                      int title_type;
                      int points;
                      string aka;
                      int rating;
                      string nationality;
                      mapping excommunicated;
                      mapping pldata;
  }