Diggers and Special diggers configurable (#3209)

- who is an imp now?
- I know I am but what are you?

Also, new script command: 'SET_DIGGER([player],(creature])`

Author: PieterVdc

config/creatrs/imp.cfg

@@ -113,7 +113,8 @@ SpellImmunity = 0
 ;   FLYING - creature normally isn't touching ground when moving and can move up and down.
 ;   SEE_INVISIBLE - creature has natural ability which works like Sight spell.
 ;   PASS_LOCKED_DOORS - creature can move through locked doors and won't fight with doors.
-;   SPECIAL_DIGGER - creature can dig and perform other dungeon tasks.
+;   SPECIAL_DIGGER - creature is different from 'real' creatures can dig and perform other dungeon tasks. Like an Imp.
+;   DIGGING_CREATURE - creature is a 'real' creature but can also dig and perform other dungeon task. Like a Tunneller.
 ;   ARACHNID - creature is kind of spider.
 ;   DIPTERA - creature is kind of fly.
 ;   LORD - creature is lord of the land, usually arrives to level as final boss, and at arrival you can hear "beware, the lord of the land approaches".

config/creatrs/tunneller.cfg

@@ -30,7 +30,7 @@ DamageToBoulder = 20
 ; Creature thing size - XY and Z, one cube is 256x256.
 ThingSize = 240 400
 LairObject = LAIR_TUNLR
-Properties = BLEEDS HUMANOID_SKELETON SPECIAL_DIGGER
+Properties = BLEEDS HUMANOID_SKELETON DIGGING_CREATURE
 
 [attraction]
 EntranceRoom = NULL NULL NULL

src/config_creature.c

@@ -2005,6 +2005,11 @@ TbBool set_creature_available(PlayerNumber plyr_idx, ThingModel crtr_model, long
 
 ThingModel get_players_special_digger_model(PlayerNumber plyr_idx)
 {
+    struct PlayerInfo* player = get_player(plyr_idx);
+
+    if(player->special_digger != 0)
+        return player->special_digger;
+
     ThingModel crmodel;
 
     if (player_is_roaming(plyr_idx))
@@ -2198,9 +2203,9 @@ CreatureJob get_job_for_subtile(const struct Thing *creatng, MapSubtlCoord stl_x
     }
     if (creatng->owner == slabmap_owner(slb))
     {
-        if (thing_is_creature_special_digger(creatng))
+        if (thing_is_creature_digger(creatng)) 
         {
-            if (creatng->model == get_players_special_digger_model(creatng->owner))
+            if (creature_is_for_dungeon_diggers_list(creatng))
             {
                 required_kind_flags |= JoKF_OwnedDiggers;
             }
@@ -2223,7 +2228,7 @@ CreatureJob get_job_for_subtile(const struct Thing *creatng, MapSubtlCoord stl_x
         }
     } else
     {
-        if (creatng->model == get_players_special_digger_model(creatng->owner)) {
+        if (creature_is_for_dungeon_diggers_list(creatng)) {
             required_kind_flags |= JoKF_EnemyDiggers;
         } else {
             required_kind_flags |= JoKF_EnemyCreatures;

src/config_creature.h

@@ -41,26 +41,27 @@ extern "C" {
 #define CREATURE_PROPERTY_INCREASE_ON_EXP  35
 /******************************************************************************/
 enum CreatureModelFlags {
-    CMF_IsSpecDigger     = 0x000001, // Imp and Tunneller.
-    CMF_IsArachnid       = 0x000002, // Simply, Spider.
-    CMF_IsDiptera        = 0x000004, // Simply, Fly.
-    CMF_IsLordOfLand     = 0x000008, // Simply, Knight and Avatar.
-    CMF_IsSpectator      = 0x000010, // Simply, Floating Spirit.
-    CMF_IsEvil           = 0x000020, // All evil creatures.
-    CMF_ImmuneToBoulder  = 0x000040, // Boulder traps are destroyed at the moment they touch the creature.
-    CMF_NoCorpseRotting  = 0x000080, // Corpse cannot rot in graveyard.
-    CMF_NoEnmHeartAttack = 0x000100, // Creature will not attack enemy heart on sight.
-    CMF_Trembling        = 0x000200, // Creature causes ground to tremble when dropped.
-    CMF_Fat              = 0x000400, // Creature too fat to walk a full animation.
-    CMF_Female           = 0x000800, // Creature is female.
-    CMF_Insect           = 0x001000, // Creature is kind of insect.
-    CMF_OneOfKind        = 0x002000, // Only one creature of that kind may exist on one level. Unit name is type name.
-    CMF_NoImprisonment   = 0x004000, // Creature will not faint.
-    CMF_NoResurrect      = 0x008000, // Creature will not resurrect.
-    CMF_NoTransfer       = 0x010000, // Creature cannot be transferred.
-    CMF_NoStealHero      = 0x020000, // Prevent the creature from being stolen with the Steal Hero special.
-    CMF_PreferSteal      = 0x040000, // The creature can be generated from Steal Hero special if there's nothing to steal.
-    CMF_EventfulDeath    = 0x080000, // The LAST_DEATH_EVENT[] script location is updated on death.
+    CMF_IsSpecDigger      = 0x000001, // is a dedicated digger that doesn't do things normal units do (like imp)
+    CMF_IsArachnid        = 0x000002, // Simply, Spider.
+    CMF_IsDiptera         = 0x000004, // Simply, Fly.
+    CMF_IsLordOfLand      = 0x000008, // Simply, Knight and Avatar.
+    CMF_IsSpectator       = 0x000010, // Simply, Floating Spirit.
+    CMF_IsEvil            = 0x000020, // All evil creatures.
+    CMF_ImmuneToBoulder   = 0x000040, // Boulder traps are destroyed at the moment they touch the creature.
+    CMF_NoCorpseRotting   = 0x000080, // Corpse cannot rot in graveyard.
+    CMF_NoEnmHeartAttack  = 0x000100, // Creature will not attack enemy heart on sight.
+    CMF_Trembling         = 0x000200, // Creature causes ground to tremble when dropped.
+    CMF_Fat               = 0x000400, // Creature too fat to walk a full animation.
+    CMF_Female            = 0x000800, // Creature is female.
+    CMF_Insect            = 0x001000, // Creature is kind of insect.
+    CMF_OneOfKind         = 0x002000, // Only one creature of that kind may exist on one level. Unit name is type name.
+    CMF_NoImprisonment    = 0x004000, // Creature will not faint.
+    CMF_NoResurrect       = 0x008000, // Creature will not resurrect.
+    CMF_NoTransfer        = 0x010000, // Creature cannot be transferred.
+    CMF_NoStealHero       = 0x020000, // Prevent the creature from being stolen with the Steal Hero special.
+    CMF_PreferSteal       = 0x040000, // The creature can be generated from Steal Hero special if there's nothing to steal.
+    CMF_EventfulDeath     = 0x080000, // The LAST_DEATH_EVENT[] script location is updated on death.
+    CMF_IsDiggingCreature = 0x100000, // unit still counts as a regular creature but can also do digger tasks (like tunneler)
 };
 
 // Before C23 standard, we cannot specify the underlaying type (in this case we want 64bit int) of enum.

src/config_crtrmodel.c

@@ -126,6 +126,7 @@ const struct NamedCommand creatmodel_properties_commands[] = {
   {"NO_STEAL_HERO",     32},
   {"PREFER_STEAL",      33},
   {"EVENTFUL_DEATH",    34},
+  {"DIGGING_CREATURE",  35},
   {NULL,                 0},
   };
 
@@ -748,6 +749,10 @@ TbBool parse_creaturemodel_attributes_blocks(long crtr_model,char *buf,long len,
                 crconf->model_flags |= CMF_EventfulDeath;
                 n++;
                 break;
+            case 35: // DIGGING_CREATURE
+                crconf->model_flags |= CMF_IsDiggingCreature;
+                n++;
+                break;
             default:
               CONFWRNLOG("Incorrect value of \"%s\" parameter \"%s\" in [%s] block of %s %s file.",
                   COMMAND_TEXT(cmd_num),word_buf,block_buf, creature_code_name(crtr_model), config_textname);
@@ -904,7 +909,7 @@ TbBool parse_creaturemodel_attributes_blocks(long crtr_model,char *buf,long len,
   }
 #undef COMMAND_TEXT
   // If the creature is a special breed, then update an attribute in CreatureConfig struct
-  if ((crconf->model_flags & CMF_IsSpecDigger) != 0)
+  if ((crconf->model_flags & (CMF_IsSpecDigger|CMF_IsDiggingCreature)) != 0)
   {
       if ((crconf->model_flags & CMF_IsEvil) != 0) {
           game.conf.crtr_conf.special_digger_evil = crtr_model;
@@ -917,7 +922,7 @@ TbBool parse_creaturemodel_attributes_blocks(long crtr_model,char *buf,long len,
       game.conf.crtr_conf.spectator_breed = crtr_model;
   }
   // Set creature start states based on the flags
-  if ((crconf->model_flags & CMF_IsSpecDigger) != 0)
+  if ((crconf->model_flags & (CMF_IsSpecDigger|CMF_IsDiggingCreature)) != 0)
   {
       crstat->evil_start_state = CrSt_ImpDoingNothing;
       crstat->good_start_state = CrSt_TunnellerDoingNothing;

src/creature_groups.c

@@ -324,7 +324,7 @@ TbBool remove_creature_from_group_without_leader_consideration(struct Thing *cre
 static short creature_could_be_lead_digger(struct Thing* creatng, struct CreatureControl* cctrl)
 {
     short potential_leader = 0;
-    if (thing_is_creature_special_digger(creatng))
+    if (thing_is_creature_digger(creatng))
     {
         if (cctrl->party_objective != CHeroTsk_DefendParty)
         {
@@ -406,7 +406,7 @@ struct Thing* get_best_creature_to_lead_group(struct Thing* grptng)
         TRACE_THING(ctng);
         if (has_digger > 0)
         {
-            is_digger = thing_is_creature_special_digger(ctng);
+            is_digger = thing_is_creature_digger(ctng);
         }
         cctrl = creature_control_get_from_thing(ctng);
         struct CreatureControl* bcctrl = creature_control_get_from_thing(best_creatng);

src/creature_jobs.c

@@ -496,7 +496,7 @@ TbBool is_correct_owner_to_perform_job(const struct Thing *creatng, PlayerNumber
     // We need to check for it later in upper function, because lack of related room may generate message for the player
     if (creatng->owner == plyr_idx)
     {
-        if (creatng->model == get_players_special_digger_model(creatng->owner)) {
+        if (creature_is_for_dungeon_diggers_list(creatng)) {
             if ((get_flags_for_job(new_job) & JoKF_OwnedDiggers) == 0)
                 return false;
         } else {
@@ -505,7 +505,7 @@ TbBool is_correct_owner_to_perform_job(const struct Thing *creatng, PlayerNumber
         }
     } else
     {
-        if (creatng->model == get_players_special_digger_model(creatng->owner)) {
+        if (creature_is_for_dungeon_diggers_list(creatng)) {
             if ((get_flags_for_job(new_job) & JoKF_EnemyDiggers) == 0)
                 return false;
         } else {
@@ -995,7 +995,7 @@ TbBool attempt_job_work_in_room_near_pos(struct Thing *creatng, MapSubtlCoord st
     }
     creatng->continue_state = get_arrive_at_state_for_job(new_job);
     cctrl->target_room_id = room->index;
-    if (thing_is_creature_special_digger(creatng))
+    if (thing_is_creature_digger(creatng))
     {
         cctrl->digger.task_repeats = 0;
         cctrl->job_assigned = new_job;
@@ -1020,7 +1020,7 @@ TbBool attempt_job_work_in_room_and_cure_near_pos(struct Thing *creatng, MapSubt
     creatng->continue_state = get_arrive_at_state_for_job(new_job);
     cctrl->target_room_id = room->index;
     process_temple_cure(creatng);
-    if (thing_is_creature_special_digger(creatng))
+    if (thing_is_creature_digger(creatng))
     {
         cctrl->digger.task_repeats = 0;
         cctrl->job_assigned = new_job;

src/creature_states.c

@@ -479,8 +479,8 @@ struct StateInfo states[CREATURE_STATES_COUNT] = {
  * - 1: Working.
  * - 2: Fighting.
  */
-long const state_type_to_gui_state[] = {
-    0, 1, 0, 0, 0, 2, 0, 0, 1, 0, 0, 2, 2, 1, 1, 0,
+long const state_type_to_gui_state[STATE_TYPES_COUNT] = {
+    0, 1, 0, 0, 0, 2, 0, 0, 1, 0, 0, 2, 2, 1, 1,
 };
 
 /******************************************************************************/
@@ -1539,7 +1539,7 @@ short creature_being_dropped(struct Thing *creatng)
     if (!creature_under_spell_effect(creatng, CSAfF_Chicken))
     {
         // Special tasks for diggers
-        if ((get_creature_model_flags(creatng) & CMF_IsSpecDigger) != 0)
+        if (thing_is_creature_digger(creatng))
         {
             if ((slabmap_owner(slb) == creatng->owner) || (slabmap_owner(slb) == game.neutral_player_num))
             {
@@ -3728,7 +3728,7 @@ CrCheckRet move_check_persuade(struct Thing *creatng)
                       !thing_is_invalid(i);
                       i = thing_get(i->next_on_mapblk) )
                 {
-                    if (i->owner != creatng->owner || !thing_is_creature(i) || i == creatng || i->model == get_players_special_digger_model(creatng->owner))
+                    if (i->owner != creatng->owner || !thing_is_creature(i) || i == creatng || creature_is_for_dungeon_diggers_list(i))
                         continue;
                     i_leader = get_group_leader(i);
                     if (i_leader)
@@ -4825,7 +4825,7 @@ short set_start_state_f(struct Thing *thing,const char *func_name)
     if (player->victory_state == VicS_LostLevel)
     {
         // TODO: Correctly deal with possession of creatures not owned by the player
-        if (thing->model != get_players_special_digger_model(player->id_number))
+        if (!creature_is_for_dungeon_diggers_list(thing))
         {
             cleanup_current_thing_state(thing);
             initialise_thing_state(thing, CrSt_LeavesBecauseOwnerLost);

src/creature_states.h

@@ -21,12 +21,12 @@
 
 #include "bflib_basics.h"
 #include "globals.h"
-#include "dungeon_data.h"
 
 /** Count of creature states, originally 147. */
 #define CREATURE_STATES_COUNT CrSt_ListEnd
 
 #define FIGHT_FEAR_DELAY 160
+#define STATE_TYPES_COUNT CrStTyp_ListEnd
 
 #ifdef __cplusplus
 extern "C" {

src/creature_states_combt.c

@@ -130,7 +130,7 @@ TbBool creature_is_being_attacked_by_enemy_creature_not_digger(struct Thing *fig
     for (oppn_idx = 0; oppn_idx < COMBAT_MELEE_OPPONENTS_LIMIT; oppn_idx++)
     {
         struct Thing* enmtng = thing_get(figctrl->opponents_melee[oppn_idx]);
-        if (!thing_is_invalid(enmtng) && !thing_is_creature_special_digger(enmtng))
+        if (!thing_is_invalid(enmtng) && !thing_is_creature_digger(enmtng))
         {
             if (players_are_enemies(fightng->owner,enmtng->owner)) {
                 return true;
@@ -141,7 +141,7 @@ TbBool creature_is_being_attacked_by_enemy_creature_not_digger(struct Thing *fig
     for (oppn_idx = 0; oppn_idx < COMBAT_RANGED_OPPONENTS_LIMIT; oppn_idx++)
     {
         struct Thing* enmtng = thing_get(figctrl->opponents_ranged[oppn_idx]);
-        if (!thing_is_invalid(enmtng) && !thing_is_creature_special_digger(enmtng))
+        if (!thing_is_invalid(enmtng) && !thing_is_creature_digger(enmtng))
         {
             if (players_are_enemies(fightng->owner,enmtng->owner)) {
                 return true;