Rename another function

creature_is_immune_to_spell_effect instead of creature_is_immune_to_spell_flags

Clean-up game_loop.c comments

src/creature_instances.c

@@ -1347,7 +1347,7 @@ TbBool validate_target_non_idle(struct Thing* source, struct Thing* target, CrIn
     long state_type = get_creature_state_type(target);
     if ((state_type != CrStTyp_Idle)
     && !creature_under_spell_effect(target, spconf->spell_flags)
-    && !creature_is_immune_to_spell_flags(target, spconf->spell_flags))
+    && !creature_is_immune_to_spell_effect(target, spconf->spell_flags))
     {
         return true;
     }
@@ -1384,7 +1384,7 @@ TbBool validate_target_even_in_prison
     struct SpellConfig *spconf = get_spell_config(inst_inf->func_params[0]);
     if (spell_config_is_invalid(spconf)
     || creature_under_spell_effect(target, spconf->spell_flags)
-    || creature_is_immune_to_spell_flags(target, spconf->spell_flags))
+    || creature_is_immune_to_spell_effect(target, spconf->spell_flags))
     {
         // If this instance has wrong spell, or the target has been affected by this spell, return false.
         SYNCDBG(12, "%s(%d) is not a valid target for %s because it has been affected by the spell.",

src/game_loop.c

@@ -86,7 +86,7 @@ void process_dungeon_destroy(struct Thing* heartng)
     struct Dungeon* dungeon = get_dungeon(plyr_idx);
     struct Thing* soultng = thing_get(dungeon->free_soul_idx);
     struct ObjectConfigStats* objst = get_object_model_stats(heartng->model);
-    struct CreatureControl* sctrl; // For 'soultng' strange case.
+    struct CreatureControl* sctrl;
     if (dungeon->heart_destroy_state == 0)
     {
         return;
@@ -129,7 +129,7 @@ void process_dungeon_destroy(struct Thing* heartng)
             }
             else if (dungeon->heart_destroy_turn == 20)
             {
-                // Strange case, not sure why it's required.
+                // Sets soultng to be invisible for a short amount of time.
                 sctrl = creature_control_get_from_thing(soultng);
                 set_flag(sctrl->spell_flags, CSAfF_Invisibility);
                 sctrl->force_visible = 0;
@@ -146,13 +146,13 @@ void process_dungeon_destroy(struct Thing* heartng)
             }
             else if (dungeon->heart_destroy_turn == 28)
             {
-                // Strange case, not sure why it's required.
+                // Clears soultng invisibility.
                 sctrl = creature_control_get_from_thing(soultng);
                 clear_flag(sctrl->spell_flags, CSAfF_Invisibility);
                 sctrl->force_visible = 0;
             }
             else if (dungeon->heart_destroy_turn == 30)
-            { // 'soultng' is deleted shortly after so why even bother making it invisible with spell flags? Perhaps it could use rendering flag instead?
+            {
                 dungeon->free_soul_idx = 0;
                 delete_thing_structure(soultng, 0);
             }

src/lvl_script_value.c

@@ -172,7 +172,7 @@ TbResult script_use_spell_on_creature(PlayerNumber plyr_idx, ThingModel crmodel,
     }
     SpellKind spkind = (fmcl_bytes >> 8) & 255;
     struct SpellConfig *spconf = get_spell_config(spkind);
-    if ((spconf->caster_affected) && (!creature_is_immune_to_spell_flags(thing, spconf->spell_flags)))
+    if ((spconf->caster_affected) && (!creature_is_immune_to_spell_effect(thing, spconf->spell_flags)))
     { // Immunity is handled in 'apply_spell_effect_to_thing', but this command plays sounds, so check for it.
         if (thing_is_picked_up(thing))
         {

src/magic.c

@@ -1318,7 +1318,7 @@ static TbResult magic_use_power_apply_spell(PowerKind power_kind, PlayerNumber p
         }
     }
     // Check if the creature kind isn't affected by that spell.
-    if (creature_is_immune_to_spell_flags(thing, spconf->spell_flags))
+    if (creature_is_immune_to_spell_effect(thing, spconf->spell_flags))
     {
         thing_play_sample(thing, 58, 20, 0, 3, 0, 2, 128);
         return Lb_SUCCESS;

src/player_compchecks.c

@@ -788,7 +788,7 @@ struct Thing *computer_check_creatures_in_room_for_accelerate(struct Computer2 *
         i = cctrl->next_in_room;
         // Per creature code
         if (!creature_under_spell_effect(thing, CSAfF_Speed)
-        && !creature_is_immune_to_spell_flags(thing, CSAfF_Speed))
+        && !creature_is_immune_to_spell_effect(thing, CSAfF_Speed))
         {
             long n = get_creature_state_besides_move(thing);
             struct StateInfo* stati = get_thing_state_info_num(n);
@@ -828,7 +828,7 @@ struct Thing *computer_check_creatures_in_room_for_flight(struct Computer2 *comp
         i = cctrl->next_in_room;
         // Per creature code
         if (!creature_under_spell_effect(thing, CSAfF_Flying)
-        && !creature_is_immune_to_spell_flags(thing, CSAfF_Flying))
+        && !creature_is_immune_to_spell_effect(thing, CSAfF_Flying))
         {
             long n = get_creature_state_besides_move(thing);
             struct StateInfo* stati = get_thing_state_info_num(n);
@@ -868,7 +868,7 @@ struct Thing *computer_check_creatures_in_room_for_vision(struct Computer2 *comp
         i = cctrl->next_in_room;
         // Per creature code
         if (!creature_under_spell_effect(thing, CSAfF_Sight)
-        && !creature_is_immune_to_spell_flags(thing, CSAfF_Sight))
+        && !creature_is_immune_to_spell_effect(thing, CSAfF_Sight))
         {
             long n = get_creature_state_besides_move(thing);
             struct StateInfo* stati = get_thing_state_info_num(n);

src/player_compevents.c

@@ -438,7 +438,7 @@ PowerKind computer_choose_attack_spell(struct Computer2 *comp, struct ComputerEv
             powerst = get_power_model_stats(caspl->pwkind);
             spconf = get_spell_config(powerst->spell_idx);
             if (!creature_under_spell_effect(creatng, spconf->spell_flags)
-            && !creature_is_immune_to_spell_flags(creatng, spconf->spell_flags))
+            && !creature_is_immune_to_spell_effect(creatng, spconf->spell_flags))
             {
                 if (computer_able_to_use_power(comp, caspl->pwkind, cevent->param1, caspl->amount_able)) {
                     cevent->param3 = i;
@@ -830,7 +830,7 @@ long computer_event_check_imps_in_danger(struct Computer2 *comp, struct Computer
                 if ((CREATURE_RANDOM(creatng, 150) == 1)
                 && computer_able_to_use_power(comp, PwrK_CONCEAL, 8, 1)
                 && !creature_under_spell_effect(creatng, CSAfF_Invisibility)
-                && !creature_is_immune_to_spell_flags(creatng, CSAfF_Invisibility))
+                && !creature_is_immune_to_spell_effect(creatng, CSAfF_Invisibility))
                 { // TODO: check if PwrK_CONCEAL is still applying Invisibility, in case it changes?
                     magic_use_available_power_on_thing(creatng->owner, PwrK_CONCEAL, 8, 0, 0, creatng, PwMod_Default);
                 }

src/player_comptask.c

@@ -3115,7 +3115,7 @@ long task_magic_speed_up(struct Computer2 *comp, struct ComputerTask *ctask)
     }
     if (computer_able_to_use_power(comp, PwrK_SPEEDCRTR, ctask->attack_magic.splevel, 1)
     && !creature_under_spell_effect(creatng, CSAfF_Speed)
-    && !creature_is_immune_to_spell_flags(creatng, CSAfF_Speed))
+    && !creature_is_immune_to_spell_effect(creatng, CSAfF_Speed))
     {
         if (try_game_action(comp, dungeon->owner, GA_UsePwrSpeedUp, ctask->attack_magic.splevel, 0, 0, ctask->attack_magic.target_thing_idx, 0) > Lb_OK)
         {
@@ -3124,7 +3124,7 @@ long task_magic_speed_up(struct Computer2 *comp, struct ComputerTask *ctask)
     }
     else if (computer_able_to_use_power(comp, PwrK_PROTECT, ctask->attack_magic.splevel, 1)
     && !creature_under_spell_effect(creatng, CSAfF_Armour)
-    && !creature_is_immune_to_spell_flags(creatng, CSAfF_Armour))
+    && !creature_is_immune_to_spell_effect(creatng, CSAfF_Armour))
     {
         if (try_game_action(comp, dungeon->owner, GA_UsePwrArmour, ctask->attack_magic.splevel, 0, 0, ctask->attack_magic.target_thing_idx, 0) > Lb_OK)
         {
@@ -3133,7 +3133,7 @@ long task_magic_speed_up(struct Computer2 *comp, struct ComputerTask *ctask)
     }
     else if (computer_able_to_use_power(comp, PwrK_REBOUND, ctask->attack_magic.splevel, 1)
     && !creature_under_spell_effect(creatng, CSAfF_Rebound)
-    && !creature_is_immune_to_spell_flags(creatng, CSAfF_Rebound))
+    && !creature_is_immune_to_spell_effect(creatng, CSAfF_Rebound))
     {
         if (try_game_action(comp, dungeon->owner, GA_UsePwrRebound, ctask->attack_magic.splevel, 0, 0, ctask->attack_magic.target_thing_idx, 0) > Lb_OK)
         {
@@ -3142,7 +3142,7 @@ long task_magic_speed_up(struct Computer2 *comp, struct ComputerTask *ctask)
     }
     if (computer_able_to_use_power(comp, PwrK_FLIGHT, ctask->attack_magic.splevel, 1)
     && !creature_under_spell_effect(creatng, CSAfF_Flying)
-    && !creature_is_immune_to_spell_flags(creatng, CSAfF_Flying))
+    && !creature_is_immune_to_spell_effect(creatng, CSAfF_Flying))
     {
         if (try_game_action(comp, dungeon->owner, GA_UsePwrFlight, ctask->attack_magic.splevel, 0, 0, ctask->attack_magic.target_thing_idx, 0) > Lb_OK)
         {
@@ -3151,7 +3151,7 @@ long task_magic_speed_up(struct Computer2 *comp, struct ComputerTask *ctask)
     }
     if (computer_able_to_use_power(comp, PwrK_VISION, ctask->attack_magic.splevel, 1)
     && !creature_under_spell_effect(creatng, CSAfF_Sight)
-    && !creature_is_immune_to_spell_flags(creatng, CSAfF_Sight))
+    && !creature_is_immune_to_spell_effect(creatng, CSAfF_Sight))
     {
         if (try_game_action(comp, dungeon->owner, GA_UsePwrVision, ctask->attack_magic.splevel, 0, 0, ctask->attack_magic.target_thing_idx, 0) > Lb_OK)
         {

src/power_process.c

@@ -215,7 +215,7 @@ void process_disease(struct Thing *creatng)
                 && ((get_creature_model_flags(thing) & CMF_IsSpecDigger) == 0)
                 && (thing->owner != cctrl->disease_caster_plyridx)
                 && !creature_under_spell_effect(thing, CSAfF_Disease)
-                && !creature_is_immune_to_spell_flags(thing, CSAfF_Disease)
+                && !creature_is_immune_to_spell_effect(thing, CSAfF_Disease)
                 && (cctrl->disease_caster_plyridx != game.neutral_player_num))
                 { // Apply the spell kind stored in 'active_disease_spell'.
                     apply_spell_effect_to_thing(thing, cctrl->active_disease_spell, cctrl->explevel);

src/thing_creature.c

@@ -694,7 +694,7 @@ TbBool creature_under_spell_effect_f(const struct Thing *thing, unsigned long sp
 /* Returns if the creature kind is immune to spell flags.
  * @param thing The thing to be checked.
  * @param spell_flags The spell flags to be checked. */
-TbBool creature_is_immune_to_spell_flags_f(const struct Thing *thing, unsigned long spell_flags, const char *func_name)
+TbBool creature_is_immune_to_spell_effect_f(const struct Thing *thing, unsigned long spell_flags, const char *func_name)
 {
     struct CreatureStats *crstat = creature_stats_get(thing->model);
     if (creature_stats_invalid(crstat))
@@ -876,7 +876,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
     struct Thing *ntng;
     TbBool affected = false;
     if (flag_is_set(spconf->spell_flags, CSAfF_Slow)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Slow)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Slow)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Slow))
         {
@@ -887,7 +887,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Speed)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Speed)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Speed)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Speed))
         {
@@ -897,7 +897,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Armour)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Armour)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Armour)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Armour))
         {
@@ -927,7 +927,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Rebound)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Rebound)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Rebound)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Rebound))
         {
@@ -936,7 +936,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Flying)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Flying)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Flying)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Flying))
         {
@@ -946,7 +946,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Invisibility)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Invisibility)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Invisibility)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Invisibility))
         {
@@ -956,7 +956,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Sight)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Sight)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Sight)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Sight))
         {
@@ -965,7 +965,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Light)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Light)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Light)))
     {
         if (!crstat->illuminated)
         {
@@ -978,7 +978,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         }
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Disease)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Disease)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Disease)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Disease))
         {
@@ -1019,7 +1019,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Chicken)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Chicken)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Chicken)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Chicken))
         {
@@ -1035,7 +1035,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_MadKilling)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_MadKilling)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_MadKilling)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_MadKilling))
         {
@@ -1044,7 +1044,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_UseMePlease)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_UseMePlease)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_UseMePlease)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_UseMePlease))
         {
@@ -1053,7 +1053,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Teleport)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Teleport)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Teleport)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Teleport))
         {
@@ -1064,7 +1064,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Timebomb)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Timebomb)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Timebomb)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Timebomb))
         {
@@ -1075,7 +1075,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Freeze)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Freeze)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Freeze)))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Freeze))
         {
@@ -1091,7 +1091,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Fear)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Fear))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Fear))
     && (crstat->fear_stronger > 0))
     {
         if (!creature_under_spell_effect(thing, CSAfF_Fear))
@@ -1129,7 +1129,7 @@ TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTur
         affected = true;
     }
     if (flag_is_set(spconf->spell_flags, CSAfF_Heal)
-    && (!creature_is_immune_to_spell_flags(thing, CSAfF_Heal)))
+    && (!creature_is_immune_to_spell_effect(thing, CSAfF_Heal)))
     {
         // 'CSAfF_Heal' is only for checking config or immunity, flag is never set to creature.
         HitPoints healing_recovery;
@@ -1417,7 +1417,7 @@ void apply_spell_effect_to_thing(struct Thing *thing, SpellKind spell_idx, long
         ERRORLOG("Spell %s config is invalid", spell_code_name(spell_idx));
         return; // Exit the function, spell config is invalid.
     }
-    if (creature_is_immune_to_spell_flags(thing, spconf->spell_flags))
+    if (creature_is_immune_to_spell_effect(thing, spconf->spell_flags))
     {
         SYNCDBG(7, "Creature %s index %d is immune to all spell flags %d set on %s", thing_model_name(thing), (int)thing->index, (uint)spconf->spell_flags, spell_code_name(spell_idx));
         return; // Exit the function, creature is immune to all spell flags set on spell_idx.
@@ -4876,7 +4876,7 @@ long player_list_creature_filter_in_fight_and_not_affected_by_spell(const struct
         {
             return -1;
         }
-        if (creature_is_immune_to_spell_flags(thing, spconf->spell_flags))
+        if (creature_is_immune_to_spell_effect(thing, spconf->spell_flags))
         {
             return -1;
         }

src/thing_creature.h

@@ -152,8 +152,8 @@ TbBool remove_creature_lair(struct Thing *thing);
 TbBool creature_affected_by_slap(const struct Thing *thing);
 TbBool creature_under_spell_effect_f(const struct Thing *thing, unsigned long spell_flags, const char *func_name);
 #define creature_under_spell_effect(thing, spell_flags) creature_under_spell_effect_f(thing, spell_flags, __func__)
-TbBool creature_is_immune_to_spell_flags_f(const struct Thing *thing, unsigned long spell_flags, const char *func_name);
-#define creature_is_immune_to_spell_flags(thing, spell_flags) creature_is_immune_to_spell_flags_f(thing, spell_flags, __func__)
+TbBool creature_is_immune_to_spell_effect_f(const struct Thing *thing, unsigned long spell_flags, const char *func_name);
+#define creature_is_immune_to_spell_effect(thing, spell_flags) creature_is_immune_to_spell_effect_f(thing, spell_flags, __func__)
 
 TbBool set_thing_spell_flags_f(struct Thing *thing, SpellKind spell_idx, GameTurnDelta duration, long spell_lev, const char *func_name);
 #define set_thing_spell_flags(thing, spell_idx, duration, spell_lev) set_thing_spell_flags_f(thing, spell_idx, duration, spell_lev, __func__)