a160ddfdf16340e8c4d3f755034a7b3e2dc42d84
[crawl.git] / crawl-ref / source / religion.h
1 /**
2  * @file
3  * @brief Misc religion related functions.
4 **/
5
6 #pragma once
7
8 #include <vector>
9
10 #include "enum.h"
11 #include "mgen-data.h"
12 #include "player.h"
13 #include "religion-enum.h"
14
15 using std::vector;
16
17 #define MAX_PIETY      200
18 #define HALF_MAX_PIETY (MAX_PIETY / 2)
19
20 #define MAX_PENANCE    200
21
22 #define NUM_VEHUMET_GIFTS 13
23
24 #define NUM_PIETY_STARS 6
25
26 enum class lifesaving_chance
27 {
28     never,
29     sometimes,
30     always,
31 };
32
33 bool is_evil_god(god_type god);
34 bool is_good_god(god_type god);
35 bool is_chaotic_god(god_type god);
36 bool is_unknown_god(god_type god);
37 bool god_has_name(god_type god);
38
39 // Returns true if the god is not present in the current game. This is
40 // orthogonal to whether the player can worship the god in question.
41 bool is_unavailable_god(god_type god);
42
43 god_type random_god();
44
45 int piety_breakpoint(int i);
46 string god_name(god_type which_god, bool long_name = false);
47 string god_name_jiyva(bool second_name = false);
48 string wu_jian_random_sifu_name();
49 god_type str_to_god(const string &name, bool exact = true);
50
51 int initial_wrath_penance_for(god_type god);
52 bool active_penance(god_type god);
53 bool xp_penance(god_type god);
54 void dec_penance(int val);
55 void dec_penance(god_type god, int val);
56
57 void excommunication(bool voluntary = false, god_type new_god = GOD_NO_GOD);
58
59 bool gain_piety(int pgn, int denominator = 1, bool should_scale_piety = true);
60 void dock_piety(int pietyloss, int penance);
61 void god_speaks(god_type god, const char *mesg);
62 void lose_piety(int pgn);
63 void set_piety(int piety);
64 void handle_god_time(int /*time_delta*/);
65 int god_colour(god_type god);
66 colour_t god_message_altar_colour(god_type god);
67 int gozag_service_fee();
68 bool player_can_join_god(god_type which_god);
69 void join_religion(god_type which_god);
70 void god_pitch(god_type which_god);
71 god_type choose_god(god_type def_god = NUM_GODS);
72
73 static inline bool you_worship(god_type god)
74 {
75     return you.religion == god;
76 }
77
78 static inline int player_under_penance(god_type god = you.religion)
79 {
80     return you.penance[god];
81 }
82
83 /** Is the player in good (enough) standing with a particular god?
84  *
85  * @param god    The religion being asked about.
86  * @param pbreak The minimum piety breakpoint (number of stars minus one) to
87  *               consider "enough"; a negative number (the default) checks
88  *               only for worship and not for piety.
89  * @return true if the player worships the given god, is not under penance,
90  *         and has at least (pbreak + 1) stars of piety.
91  */
92 static inline bool in_good_standing(god_type god, int pbreak = -1)
93 {
94     return you_worship(god) && !player_under_penance(god)
95            && (pbreak < 0 || you.piety >= piety_breakpoint(pbreak));
96 }
97
98 int had_gods();
99 int piety_rank(int piety = you.piety);
100 int piety_scale(int piety_change);
101 bool god_likes_your_god(god_type god, god_type your_god = you.religion);
102 bool god_hates_your_god(god_type god, god_type your_god = you.religion);
103 bool god_hates_killing(god_type god, const monster& mon);
104 bool god_hates_eating(god_type god, monster_type mc);
105
106 bool god_likes_spell(spell_type spell, god_type god);
107 bool god_hates_spellcasting(god_type god);
108 bool god_hates_spell(spell_type spell, god_type god, bool fake_spell = false);
109 bool god_loathes_spell(spell_type spell, god_type god);
110 string god_spell_warn_string(spell_type spell, god_type god);
111 bool god_hates_ability(ability_type ability, god_type god);
112 lifesaving_chance elyvilon_lifesaving();
113 bool god_protects_from_harm();
114 bool jiyva_is_dead();
115 void set_penance_xp_timeout();
116 bool fedhas_protects(const monster* target);
117 bool fedhas_neutralises(const monster& target);
118 void nemelex_death_message();
119
120 void mons_make_god_gift(monster& mon, god_type god = you.religion);
121 bool mons_is_god_gift(const monster& mon, god_type god = you.religion);
122
123 int yred_random_servants(unsigned int threshold, bool force_hostile = false);
124 bool is_yred_undead_slave(const monster& mon);
125 bool is_orcish_follower(const monster& mon);
126 bool is_fellow_slime(const monster& mon);
127 bool is_follower(const monster& mon);
128
129 // Vehumet gift interface.
130 bool vehumet_is_offering(spell_type spell);
131 void vehumet_accept_gift(spell_type spell);
132
133 mgen_data hepliaklqana_ancestor_gen_data();
134 string hepliaklqana_ally_name();
135 int hepliaklqana_ally_hp();
136
137 void upgrade_hepliaklqana_ancestor(bool quiet_force = false);
138 void upgrade_hepliaklqana_weapon(monster_type mtyp, item_def &item);
139 void upgrade_hepliaklqana_shield(const monster& ancestor, item_def &item);
140
141 bool god_hates_attacking_friend(god_type god, const monster& fr);
142
143 void religion_turn_start();
144 void religion_turn_end();
145
146 int get_tension(god_type god = you.religion);
147 int get_monster_tension(const monster& mons, god_type god = you.religion);
148 int get_fuzzied_monster_difficulty(const monster& mons);
149
150 typedef void (*delayed_callback)(const mgen_data &mg, monster *&mon, int placed);
151
152 void delayed_monster(const mgen_data &mg, delayed_callback callback = nullptr);
153 void delayed_monster_done(string success,
154                           delayed_callback callback = nullptr);
155
156 bool do_god_gift(bool forced = false);
157
158 vector<god_type> temple_god_list();
159 vector<god_type> nontemple_god_list();
160
161 class god_iterator
162 {
163 public:
164     god_iterator();
165
166     operator bool() const;
167     god_type operator*() const;
168     god_type operator->() const;
169     god_iterator& operator++();
170     god_iterator operator++(int);
171
172 protected:
173     int i;
174 };
175
176 struct god_power
177 {
178     // 1-6 means it unlocks at that many stars of piety;
179     // 0 means it is always available when worshipping the god;
180     // -1 means it is available even under penance;
181     // 7 means it is a capstone.
182     int rank;
183     ability_type abil;
184
185     // These strings can be one of two types:
186     //   - a full sentence, starting with a capital letter and ending with a
187     //     a period, that will be used for the relevant description; or
188     //   - part of a sentence, starting with a lowercase letter, to which the
189     //     following strings will be prepended, depending on which variable is
190     //     being used, and "." will be appended, before it is used for a
191     //     description:
192     //         "You can now "       for `gain`
193     //         "You can no longer " for `loss`
194     //         "You can "           for `general`.
195
196     // Printed to message log when the piety threshold for the power is reached
197     const char* gain;
198     // Printed to message log when piety falls below the threshold for the power
199     const char* loss;
200     // Shown on the god powers (^) screen
201     const char* general;
202
203     god_power(int rank_, ability_type abil_, const char* gain_,
204               const char* loss_ = "", const char* general_ = "") :
205               rank{rank_}, abil{abil_}, gain{gain_},
206               loss{*loss_ ? loss_ : gain_},
207               general{*general_ ? general_ : gain_}
208     { }
209
210     god_power(int rank_, const char* gain_, const char* loss_ = "",
211               const char* general_ = "") :
212               god_power(rank_, ABIL_NON_ABILITY, gain_, loss_, general_)
213     { }
214
215     void display(bool gaining, const char* fmt) const;
216 };
217
218 void set_god_ability_slots();
219 vector<god_power> get_god_powers(god_type god);
220 const god_power* god_power_from_ability(ability_type abil);
221 bool god_power_usable(const god_power& power, bool ignore_piety=false, bool ignore_penance=false);