Damage texture modifier (#9833)

Adds a new object property "damage_texture_modifier"

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 4078e21a13ea1284ea62b5b6a94da91c60d03b01..db13f4224eb99af62769023d9f86645d46c25260 100644 (file)
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -6589,6 +6589,9 @@ Player properties need to be saved manually.
         -- deleted when the block gets unloaded.
         -- The get_staticdata() callback is never called then.
         -- Defaults to 'true'.
+
+        damage_texture_modifier = "^[brighten",
+        -- Texture modifier to be applied for a short duration when object is hit
     }
 
 Entity definition

diff --git a/src/client/content_cao.cpp b/src/client/content_cao.cpp
index aadd33bb90e5c3d8822280d13f0243732b8f240d..eb1dad22bb453db2f0858aef6ce34a9ec8e4cac6 100644 (file)
--- a/src/client/content_cao.cpp
+++ b/src/client/content_cao.cpp
@@ -1532,7 +1532,7 @@ void GenericCAO::processMessage(const std::string &data)
        } else if (cmd == AO_CMD_SET_TEXTURE_MOD) {
                std::string mod = deSerializeString(is);
 
-               // immediatly reset a engine issued texture modifier if a mod sends a different one
+               // immediately reset a engine issued texture modifier if a mod sends a different one
                if (m_reset_textures_timer > 0) {
                        m_reset_textures_timer = -1;
                        updateTextures(m_previous_texture_modifier);
@@ -1646,13 +1646,11 @@ void GenericCAO::processMessage(const std::string &data)
                                                m_smgr, m_env, m_position,
                                                v2f(m_prop.visual_size.X, m_prop.visual_size.Y) * BS);
                                m_env->addSimpleObject(simple);
-                       } else if (m_reset_textures_timer < 0) {
-                               // TODO: Execute defined fast response
-                               // Flashing shall suffice as there is no definition
+                       } else if (m_reset_textures_timer < 0 && !m_prop.damage_texture_modifier.empty()) {
                                m_reset_textures_timer = 0.05;
                                if(damage >= 2)
                                        m_reset_textures_timer += 0.05 * damage;
-                               updateTextures(m_current_texture_modifier + "^[brighten");
+                               updateTextures(m_current_texture_modifier + m_prop.damage_texture_modifier);
                        }
                }
 
@@ -1723,13 +1721,11 @@ bool GenericCAO::directReportPunch(v3f dir, const ItemStack *punchitem,
                                        v2f(m_prop.visual_size.X, m_prop.visual_size.Y) * BS);
                        m_env->addSimpleObject(simple);
                }
-               // TODO: Execute defined fast response
-               // Flashing shall suffice as there is no definition
-               if (m_reset_textures_timer < 0) {
+               if (m_reset_textures_timer < 0 && !m_prop.damage_texture_modifier.empty()) {
                        m_reset_textures_timer = 0.05;
                        if (result.damage >= 2)
                                m_reset_textures_timer += 0.05 * result.damage;
-                       updateTextures(m_current_texture_modifier + "^[brighten");
+                       updateTextures(m_current_texture_modifier + m_prop.damage_texture_modifier);
                }
        }
 

diff --git a/src/object_properties.cpp b/src/object_properties.cpp
index 4cf180b18eb4ccb8bf9a4a27b73032d90f82aca4..6ff344dcee35faf9e8f41a284122b9c7523196f9 100644 (file)
--- a/src/object_properties.cpp
+++ b/src/object_properties.cpp
@@ -68,6 +68,7 @@ std::string ObjectProperties::dump()
        os << ", eye_height=" << eye_height;
        os << ", zoom_fov=" << zoom_fov;
        os << ", use_texture_alpha=" << use_texture_alpha;
+       os << ", damage_texture_modifier=" << damage_texture_modifier;
        return os.str();
 }
 
@@ -114,6 +115,7 @@ void ObjectProperties::serialize(std::ostream &os) const
        writeF32(os, eye_height);
        writeF32(os, zoom_fov);
        writeU8(os, use_texture_alpha);
+       os << serializeString(damage_texture_modifier);
 
        // Add stuff only at the bottom.
        // Never remove anything, because we don't want new versions of this
@@ -166,4 +168,7 @@ void ObjectProperties::deSerialize(std::istream &is)
        eye_height = readF32(is);
        zoom_fov = readF32(is);
        use_texture_alpha = readU8(is);
+       try {
+               damage_texture_modifier = deSerializeString(is);
+       } catch (SerializationError &e) {}
 }

diff --git a/src/object_properties.h b/src/object_properties.h
index 3895f337990c5818a04272cd5f4912f026fe5ec3..f7848f5a212b3c59a6a39d36aa36f625efcd3b0f 100644 (file)
--- a/src/object_properties.h
+++ b/src/object_properties.h
@@ -39,6 +39,7 @@ struct ObjectProperties
        std::string mesh = "";
        v3f visual_size = v3f(1, 1, 1);
        std::vector<std::string> textures;
+       std::string damage_texture_modifier = "^[brighten";
        std::vector<video::SColor> colors;
        v2s16 spritediv = v2s16(1, 1);
        v2s16 initial_sprite_basepos;

diff --git a/src/script/common/c_content.cpp b/src/script/common/c_content.cpp
index 540b7222f378a556048489bd307fdb4782445ea6..de9634c4235fc1cb9fd8559220f30d5dc4b550dc 100644 (file)
--- a/src/script/common/c_content.cpp
+++ b/src/script/common/c_content.cpp
@@ -327,6 +327,8 @@ void read_object_properties(lua_State *L, int index,
 
        getfloatfield(L, -1, "zoom_fov", prop->zoom_fov);
        getboolfield(L, -1, "use_texture_alpha", prop->use_texture_alpha);
+
+       getstringfield(L, -1, "damage_texture_modifier", prop->damage_texture_modifier);
 }
 
 /******************************************************************************/
@@ -409,6 +411,8 @@ void push_object_properties(lua_State *L, ObjectProperties *prop)
        lua_setfield(L, -2, "zoom_fov");
        lua_pushboolean(L, prop->use_texture_alpha);
        lua_setfield(L, -2, "use_texture_alpha");
+       lua_pushlstring(L, prop->damage_texture_modifier.c_str(), prop->damage_texture_modifier.size());
+       lua_setfield(L, -2, "damage_texture_modifier");
 }
 
 /******************************************************************************/