Feedback for burnout of candles and torches (#41481)

CleverRaven · Jun 22, 2020 · ae2aa53 · ae2aa53
1 parent 6b26feb
commit ae2aa53
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 9 deletions.
diff --git a/data/json/flags.json b/data/json/flags.json
@@ -245,6 +245,12 @@
     "context": [ "ARMOR", "TOOL_ARMOR" ],
     "info": "This gear is equipped with an accurate hygrometer (which is used to measure humidity)."
   },
+  {
+    "id": "BURNOUT",
+    "type": "json_flag",
+    "context": [ "TOOL" ],
+    "//": "You can visually inspect how much it is burned out (candle, torch)."
+  },
   {
     "id": "IRREMOVABLE",
     "type": "json_flag",

diff --git a/data/json/items/tool/lighting.json b/data/json/items/tool/lighting.json
@@ -111,7 +111,8 @@
       "need_fire": 1,
       "menu_text": "Light",
       "type": "transform"
-    }
+    },
+    "flags": [ "BURNOUT" ]
   },
   {
     "id": "candle_lit",
@@ -134,7 +135,7 @@
       { "type": "firestarter", "moves": 100 },
       { "target": "candle", "msg": "The candle winks out.", "menu_text": "Extinguish", "type": "transform" }
     ],
-    "flags": [ "LIGHT_8", "WATER_EXTINGUISH", "TRADER_AVOID", "WIND_EXTINGUISH", "FIRESTARTER" ]
+    "flags": [ "LIGHT_8", "WATER_EXTINGUISH", "TRADER_AVOID", "WIND_EXTINGUISH", "FIRESTARTER", "BURNOUT" ]
   },
   {
     "id": "electric_lantern",
@@ -684,8 +685,8 @@
     "symbol": "/",
     "color": "brown",
     "techniques": [ "WBLOCK_1" ],
-    "initial_charges": 25,
-    "max_charges": 25,
+    "initial_charges": 20,
+    "max_charges": 20,
     "charges_per_use": 1,
     "use_action": {
       "target": "torch_lit",
@@ -694,7 +695,8 @@
       "need_fire": 1,
       "menu_text": "Light torch",
       "type": "transform"
-    }
+    },
+    "flags": [ "BURNOUT" ]
   },
   {
     "id": "torch_lit",
@@ -710,9 +712,9 @@
     "material": [ "wood" ],
     "symbol": "/",
     "color": "brown",
-    "initial_charges": 75,
-    "max_charges": 75,
-    "turns_per_charge": 40,
+    "initial_charges": 20,
+    "max_charges": 20,
+    "turns_per_charge": 60,
     "revert_to": "torch_done",
     "use_action": [
       { "type": "firestarter", "moves": 30 },
@@ -725,6 +727,6 @@
       }
     ],
     "techniques": [ "WBLOCK_1" ],
-    "flags": [ "FIRE", "LIGHT_310", "CHARGEDIM", "FLAMING", "TRADER_AVOID", "WATER_EXTINGUISH" ]
+    "flags": [ "FIRE", "LIGHT_310", "CHARGEDIM", "FLAMING", "TRADER_AVOID", "WATER_EXTINGUISH", "BURNOUT" ]
   }
 ]
diff --git a/src/item.cpp b/src/item.cpp
@@ -193,6 +193,7 @@ static const std::string flag_HIDDEN_HALLU( "HIDDEN_HALLU" );
 static const std::string flag_HIDDEN_POISON( "HIDDEN_POISON" );
 static const std::string flag_HOT( "HOT" );
 static const std::string flag_IRREMOVABLE( "IRREMOVABLE" );
+static const std::string flag_BURNOUT( "BURNOUT" );
 static const std::string flag_IS_ARMOR( "IS_ARMOR" );
 static const std::string flag_IS_PET_ARMOR( "IS_PET_ARMOR" );
 static const std::string flag_IS_UPS( "IS_UPS" );
@@ -3060,6 +3061,24 @@ void item::tool_info( std::vector<iteminfo> &info, const iteminfo_query *parts,
     } else if( has_flag( flag_USES_BIONIC_POWER ) ) {
         info.emplace_back( "DESCRIPTION",
                            _( "* This tool <info>runs on bionic power</info>." ) );
+    } else if( has_flag( flag_BURNOUT ) && parts->test( iteminfo_parts::TOOL_BURNOUT ) ) {
+        int percent_left = 100 * ammo_remaining() / type->maximum_charges();
+        std::string feedback;
+        if( percent_left == 100 ) {
+            feedback = _( "It's new, and ready to burn." );
+        } else if( percent_left >= 75 ) {
+            feedback = _( "Almost new, with much material to burn." );
+        } else if( percent_left >= 50 ) {
+            feedback = _( "More than a quarter has burned away." );
+        } else if( percent_left >= 25 ) {
+            feedback = _( "More than half has burned away." );
+        } else if( percent_left >= 10 ) {
+            feedback = _( "Less than a quarter left to burn." );
+        } else {
+            feedback = _( "Almost completely burned out." );
+        }
+        feedback = _( "<bold>Fuel</bold>: " ) + feedback;
+        info.push_back( iteminfo( "DESCRIPTION", feedback ) );
     }
 }
 

diff --git a/src/iteminfo_query.h b/src/iteminfo_query.h
@@ -147,6 +147,7 @@ enum class iteminfo_parts : size_t {
     TOOL_MAGAZINE_CURRENT,
     TOOL_MAGAZINE_COMPATIBLE,
     TOOL_CAPACITY,
+    TOOL_BURNOUT,
 
     DESCRIPTION_COMPONENTS_MADEFROM,
     DESCRIPTION_COMPONENTS_DISASSEMBLE,

diff --git a/tests/iteminfo_test.cpp b/tests/iteminfo_test.cpp
@@ -1721,6 +1721,23 @@ TEST_CASE( "tool info", "[iteminfo][tool]" )
                "<color_c_white>Charges</color>: 20\n" );
     }
 
+    SECTION( "candle with feedback on burnout" ) {
+        std::vector<iteminfo_parts> burnout = { iteminfo_parts::TOOL_BURNOUT };
+
+        item candle( "candle" );
+        REQUIRE( candle.ammo_remaining() > 0 );
+
+        candle.charges = candle.type->maximum_charges();
+        CHECK( item_info_str( candle, burnout ) ==
+               "--\n"
+               "<color_c_white>Fuel</color>: It's new, and ready to burn.\n" );
+
+        candle.charges = ( candle.type->maximum_charges() / 2 ) - 1;
+        CHECK( item_info_str( candle, burnout ) ==
+               "--\n"
+               "<color_c_white>Fuel</color>: More than half has burned away.\n" );
+    }
+
     SECTION( "UPS charged tool" ) {
         std::vector<iteminfo_parts> recharge_ups = { iteminfo_parts::DESCRIPTION_RECHARGE_UPSMODDED };