Added a regular and an engraved zippo (flippo) lighter (#23020)

* Added the zippo and engraved zippo. Added the engraved zippo in the detective's coat.

* Added copyright.

* Renamed to Flippo

* Gave the Flippo new sounds. Moved the lighter sound collections to their own folder in Items.

* Fixed YAML issues that showed up with moving the lighter noises to their own folder.

* Added the detective's Flippo as a thief objective, with half the weight of the forensic scanner.

Content.Server/Morgue/Components/CrematoriumComponent.cs

@@ -12,7 +12,7 @@ public sealed partial class CrematoriumComponent : Component
     public int CookTime = 5;
 
     [DataField("cremateStartSound")]
-    public SoundSpecifier CremateStartSound = new SoundPathSpecifier("/Audio/Items/lighter1.ogg");
+    public SoundSpecifier CremateStartSound = new SoundPathSpecifier("/Audio/Items/Lighters/lighter1.ogg");
 
     [DataField("crematingSound")]
     public SoundSpecifier CrematingSound = new SoundPathSpecifier("/Audio/Effects/burning.ogg");

Resources/Audio/Items/Lighters/attributions.yml

@@ -0,0 +1,4 @@
+- files: ["zippo_open.ogg", "zippo_closed.ogg"]
+  license: "CC-BY-SA-3.0"
+  copyright: "Created by BobTheBoss64 for ParadiseSS13, edited by Darkenson"
+  source: "https://github.com/ParadiseSS13/Paradise/commit/57eed9777cbd5a31b37fa83f59ad854abb9dc84a"

Resources/Prototypes/Entities/Clothing/OuterClothing/coats.yml

@@ -22,6 +22,7 @@
   - type: StorageFill
     contents:
     - id: SmokingPipeFilledTobacco
+    - id: FlippoEngravedLighter
   - type: Armor #same as regular sec armor
     modifiers:
       coefficients:

Resources/Prototypes/Entities/Mobs/NPCs/living_light.yml

@@ -199,7 +199,7 @@
     soundGunshot:
       path: /Audio/Weapons/Guns/Gunshots/laser3.ogg
     soundEmpty:
-      path: /Audio/Items/lighter_off.ogg
+      path: /Audio/Items/Lighters/lighter_off.ogg
   - type: Destructible
     thresholds:
     - trigger:

Resources/Prototypes/Entities/Objects/Tools/lighters.yml

@@ -123,3 +123,102 @@
         - ReagentId: WeldingFuel
           Quantity: 4
         maxVol: 4 #uses less fuel than a welder, so this isnt as bad as it looks
+
+- type: entity
+  name: flippo lighter
+  parent: BaseItem
+  id: FlippoLighter
+  description: "A rugged metal lighter, lasts quite a while."
+  components:
+  - type: Sprite
+    sprite: Objects/Tools/lighters.rsi
+    layers:
+    - state: zippo_top
+      map: ["top"]
+    - state: zippo_icon_base
+      map: ["base"]
+    - state: zippo_open
+      map: ["open"]
+      visible: false
+    - state: lighter_flame
+      map: ["flame"]
+      visible: false
+      shader: unshaded
+  - type: ItemToggle
+    predictable: false
+    soundActivate:
+      path: /Audio/Items/Lighters/zippo_open.ogg
+    soundDeactivate:
+      path: /Audio/Items/Lighters/zippo_close.ogg
+  - type: ItemToggleMeleeWeapon
+    activatedDamage:
+        types:
+            Heat: 1
+  - type: ItemToggleSize
+    activatedSize: Small
+  - type: ItemToggleHot
+  - type: Item
+    size: Tiny
+    sprite: Objects/Tools/lighters.rsi
+    heldPrefix: zippo
+  - type: Appearance
+  - type: GenericVisualizer
+    visuals:
+      enum.ToggleVisuals.Toggled:
+        flame:
+          True: { visible: true }
+          False: { visible: false }
+        open:
+          True: { visible: true }
+          False: { visible: false }
+        base:
+          True: { visible: false }
+          False: { visible: true }
+  - type: SolutionContainerManager
+    solutions:
+      Welder:
+        reagents:
+        - ReagentId: WeldingFuel
+          Quantity: 12
+        maxVol: 12 #uses less fuel than a welder, so this isnt as bad as it looks
+  - type: ToggleableLightVisuals
+    spriteLayer: lighter_flame
+    inhandVisuals:
+      left:
+      - state: zippo-inhand-left-flame
+        shader: unshaded
+      right:
+      - state: zippo-inhand-right-flame
+        shader: unshaded
+  - type: MeleeWeapon
+    damage:
+      types:
+        Blunt: 1 # does a little bit of damage on hit when off
+  - type: PointLight
+    enabled: false
+    netsync: false
+    radius: 1.2 #slightly stronger than the other lighters
+    color: orange
+
+- type: entity
+  name: flippo engraved lighter
+  parent: FlippoLighter
+  id: FlippoEngravedLighter
+  description: "A rugged golden lighter, lasts quite a while. Engravings serve no tactical advantage whatsoever."
+  components:
+  - type: Sprite
+    sprite: Objects/Tools/lighters.rsi
+    layers:
+    - state: zippo_top
+      map: ["top"]
+    - state: zippo_engraved_icon_base
+      map: ["base"]
+    - state: zippo_engraved_open
+      map: ["open"]
+      visible: false
+    - state: lighter_flame
+      map: ["flame"]
+      visible: false
+      shader: unshaded
+  - type: StealTarget
+    stealGroup: FlippoEngravedLighter

Resources/Prototypes/Objectives/objectiveGroups.yml

@@ -79,6 +79,7 @@
   id: ThiefObjectiveGroupItem
   weights:
     ForensicScannerStealObjective: 1                    #sec
+    FlippoEngravedLighterStealObjective: 0.5
     AmmoTechFabCircuitboardStealObjective: 1
     ClothingHeadHatWardenStealObjective: 1
     ClothingOuterHardsuitVoidParamedStealObjective: 1   #med

Resources/Prototypes/Objectives/stealTargetGroups.yml

@@ -157,6 +157,13 @@
   sprite:
     sprite: Objects/Devices/forensic_scanner.rsi
     state: forensicnew
+
+- type: stealTargetGroup
+  id: FlippoEngravedLighter
+  name: detective's Flippo engraved lighter
+  sprite:
+    sprite: Objects/Tools/lighters.rsi
+    state: zippo_engraved_icon_base
     
 - type: stealTargetGroup
   id: AmmoTechFabCircuitboard

Resources/Prototypes/Objectives/thief.yml

@@ -199,6 +199,18 @@
   - type: Objective
     difficulty: 1
 
+- type: entity                                      
+  noSpawn: true
+  parent: BaseThiefStealObjective
+  id: FlippoEngravedLighterStealObjective
+  components:
+  - type: NotJobRequirement
+    job: Detective
+  - type: StealCondition
+    stealGroup: FlippoEngravedLighter
+  - type: Objective
+    difficulty: 0.8
+
 - type: entity
   noSpawn: true
   parent: BaseThiefStealObjective

Resources/Prototypes/SoundCollections/lighter_sounds.yml

@@ -1,11 +1,11 @@
 - type: soundCollection
   id: lighterOnSounds
   files:
-  - /Audio/Items/lighter1.ogg
+  - /Audio/Items/Lighters/lighter1.ogg
-  - /Audio/Items/lighter2.ogg
+  - /Audio/Items/Lighters/lighter2.ogg
-  - /Audio/Items/lighter3.ogg
+  - /Audio/Items/Lighters/lighter3.ogg
 
 - type: soundCollection
   id: lighterOffSounds
   files:
-  - /Audio/Items/lighter_off.ogg
+  - /Audio/Items/Lighters/lighter_off.ogg

Resources/Prototypes/SoundCollections/tools.yml

@@ -1,8 +1,8 @@
 - type: soundCollection
   id: WelderOn
   files:
-    - /Audio/Items/lighter1.ogg
+    - /Audio/Items/Lighters/lighter1.ogg
-    - /Audio/Items/lighter2.ogg
+    - /Audio/Items/Lighters/lighter2.ogg
 
 - type: soundCollection
   id: WelderOff

Resources/Textures/Objects/Tools/lighters.rsi/meta.json

@@ -1,7 +1,7 @@
 {
   "version": 1,
   "license": "CC-BY-SA-3.0",
-  "copyright": "Taken from tgstation at https://github.com/tgstation/tgstation/commit/a28b24f149702527f3eb22f5c686f06c836f2f99; sprite has been edited",
+  "copyright": "Taken from tgstation at https://github.com/tgstation/tgstation/commit/a28b24f149702527f3eb22f5c686f06c836f2f99; sprite has been edited. Engraved zippo drawn by Darkenson.",
   "size": {
     "x": 32,
     "y": 32
@@ -64,9 +64,15 @@
     {
       "name": "zippo_icon_base"
     },
+    {
+      "name": "zippo_engraved_icon_base"
+    },
     {
       "name": "zippo_open"
     },
+    {
+      "name": "zippo_engraved_open"
+    },
     {
       "name": "zippo_top"
     },
@@ -85,7 +91,22 @@
     {
       "name": "inhand-right-flame",
       "directions": 4
+    },
+    {
+      "name": "zippo-inhand-left",
+      "directions": 4
+    },
+    {
+      "name": "zippo-inhand-right",
+      "directions": 4
+    },
+    {
+      "name": "zippo-inhand-left-flame",
+      "directions": 4
+    },
+    {
+      "name": "zippo-inhand-right-flame",
+      "directions": 4
     }
-
   ]
 }