destroy_grid_entity function

docs/src/includes/_globals.md

@@ -459,6 +459,16 @@ Change [ENT_TYPE](#ENT_TYPE)'s spawned when [Waddler](#Waddler) dies, by default
 Max 255 types.
 Use empty table as argument to reset to the game default
 
+### destroy_grid_entity
+
+
+> Search script examples for [destroy_grid_entity](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=destroy_grid_entity)
+
+#### nil destroy_grid_entity(int uid)
+
+Destroy the grid entity, and its item entities, removing them from the grid without dropping particles or gold.
+Will also destroy monsters or items that are standing on a linked activefloor or chain, though excludes [MASK](#MASK).PLAYER to prevent crashes
+
 ### drop
 
 

src/game_api/layer.cpp

@@ -215,3 +215,35 @@ void Layer::move_grid_entity(Entity* ent, uint32_t x, uint32_t y, Layer* dest_la
         }
     }
 }
+
+void Layer::destroy_grid_entity(Entity* ent)
+{
+    if (ent)
+    {
+        auto items = ent->items.entities();
+        for (auto ptr = items.cend(); ptr != items.cbegin();)
+        {
+            ptr--;
+            Entity* item_ent = *ptr;
+            if (item_ent->type->search_flags & ~1) // if not player
+            {
+                destroy_grid_entity(item_ent);
+            }
+        }
+
+        const auto pos = ent->position();
+        const uint32_t current_grid_x = static_cast<uint32_t>(std::round(pos.first));
+        const uint32_t current_grid_y = static_cast<uint32_t>(std::round(pos.second));
+        if (current_grid_x < g_level_max_x && current_grid_y < g_level_max_y)
+        {
+            if (grid_entities[current_grid_y][current_grid_x] == ent)
+            {
+                grid_entities[current_grid_y][current_grid_x] = nullptr;
+                update_liquid_collision_at(pos.first, pos.second, false);
+            }
+        }
+
+        ent->flags |= 1U << (29 - 1); // set DEAD flag to prevent certain stuff like gold nuggets drop or particles from entities such as spikes
+        ent->destroy();
+    }
+}

src/game_api/layer.hpp

@@ -210,4 +210,6 @@ struct Layer
 
     void move_grid_entity(Entity* ent, float x, float y, Layer* dest_layer);
     void move_grid_entity(Entity* ent, uint32_t x, uint32_t y, Layer* dest_layer);
+
+    void destroy_grid_entity(Entity* ent);
 };

src/game_api/rpc.cpp

@@ -1673,6 +1673,15 @@ void move_grid_entity(int32_t uid, float x, float y, LAYER layer)
     }
 }
 
+void destroy_grid_entity(int32_t uid)
+{
+    if (auto entity = get_entity_ptr(uid))
+    {
+        auto state = State::get();
+        state.layer(entity->layer)->destroy_grid_entity(entity);
+    }
+}
+
 void add_item_to_shop(int32_t item_uid, int32_t shop_owner_uid)
 {
     Movable* item = get_entity_ptr(item_uid)->as<Movable>();

src/game_api/rpc.hpp

@@ -125,6 +125,7 @@ void change_waddler_drop(std::vector<ENT_TYPE> ent_types);
 void poison_entity(int32_t entity_uid);
 void modify_ankh_health_gain(uint8_t max_health, uint8_t beat_add_health);
 void move_grid_entity(int32_t uid, float x, float y, LAYER layer);
+void destroy_grid_entity(int32_t uid);
 void add_item_to_shop(int32_t item_uid, int32_t shop_owner_uid);
 void change_poison_timer(int16_t frames);
 void set_adventure_seed(int64_t first, int64_t second);

src/game_api/script/lua_vm.cpp

@@ -966,6 +966,9 @@ end
     lua["move_entity"] = move_entity_abs;
     /// Teleport grid entity, the destination should be whole number, this ensures that the collisions will work properly
     lua["move_grid_entity"] = move_grid_entity;
+    /// Destroy the grid entity, and its item entities, removing them from the grid without dropping particles or gold.
+    /// Will also destroy monsters or items that are standing on a linked activefloor or chain, though excludes MASK.PLAYER to prevent crashes
+    lua["destroy_grid_entity"] = destroy_grid_entity;
     /// Make an ENT_TYPE.FLOOR_DOOR_EXIT go to world `w`, level `l`, theme `t`
     lua["set_door_target"] = set_door_target;
     /// Short for [set_door_target](#set_door_target).