Added sink (#14348)

Resources/Audio/Effects/Fluids/ATTRIBUTION.txt

@@ -1,2 +0,0 @@
-blood1.ogg under CC-0 from https://freesound.org/people/kyles/sounds/453769/
-blood2.ogg under CC-BY 3.0 from https://freesound.org/people/EminYILDIRIM/sounds/554284/

Resources/Audio/Effects/Fluids/attributions.yml

@@ -0,0 +1,14 @@
+- files: ["blood1.ogg"]
+  license: "CC0-1.0"
+  copyright: "Created by Kyles"
+  source: "https://freesound.org/people/kyles/sounds/453769/"
+
+- files: ["blood2.ogg"]
+  license: "CC-BY-4.0"
+  copyright: "Created by EminYILDIRIM"
+  source: "https://freesound.org/people/EminYILDIRIM/sounds/554284/"
+
+- files: ["glug.ogg"]
+  license: "CC0-1.0"
+  copyright: "Created by brittmosel"
+  source: "https://freesound.org/people/brittmosel/sounds/529300/"

Resources/Audio/Items/Janitor/attributions.yml

@@ -0,0 +1,4 @@
+- files: ["plunger.ogg"]
+  license: "CC-BY-4.0"
+  copyright: "Created by tosha73"
+  source: "https://freesound.org/people/tosha73/sounds/540784/"

Resources/Locale/en-US/fluids/components/drain-component.ftl

@@ -0,0 +1,8 @@
+drain-component-empty-verb-using-is-empty-message = { CAPITALIZE(THE($object)) } is empty!
+drain-component-empty-verb-target-is-full-message = { CAPITALIZE(THE($object)) } is full!
+drain-component-empty-verb-inhand = Empty {$object}
+drain-component-examine-hint-full = [color="blue"]It is filled to the brim. Maybe a plunger can help?[/color]
+drain-component-examine-volume = [color="blue"]Remaining space - {$volume}u.[/color]
+drain-component-unclog-fail = { CAPITALIZE(THE($object)) } is still full.
+drain-component-unclog-success = { CAPITALIZE(THE($object)) } unclogs.
+drain-component-unclog-notapplicable = { CAPITALIZE(THE($object)) } isn't clogged.

Resources/Prototypes/Catalog/Cargo/cargo_service.yml

@@ -4,7 +4,7 @@
     sprite: Objects/Specific/Janitorial/janitorial.rsi
     state: cleaner
   product: CrateServiceJanitorialSupplies
-  cost: 500
+  cost: 560
   category: Service
   group: market
 

Resources/Prototypes/Catalog/Fills/Crates/service.yml

@@ -15,6 +15,8 @@
         amount: 2
       - id: TrashBag
         amount: 2
+      - id: Plunger
+        amount: 2
 
 - type: entity
   id: CrateServiceReplacementLights

Resources/Prototypes/Catalog/Fills/Lockers/service.yml

@@ -71,6 +71,8 @@
         amount: 2
       - id: FlashlightLantern
         amount: 2
+      - id: Plunger
+        amount: 2
 
 - type: entity
   id: ClosetLegalFilled

Resources/Prototypes/Entities/Markers/Spawners/Random/maintenance.yml

@@ -94,6 +94,7 @@
         - SheetSteel
         - SheetPlastic
         - ResearchDisk
+        - Plunger
       chance: 0.6
       offset: 0.0
 

Resources/Prototypes/Entities/Objects/Specific/Janitorial/janitor.yml

@@ -317,6 +317,26 @@
                 path: /Audio/Effects/metalbreak.ogg
     - type: ItemMapper
       mapLayers:
+        cart_plunger:
+          whitelist:
+            tags:
+              - Plunger
+        cart_mop:
+          whitelist:
+            tags:
+              - Mop
+        cart_garbage:
+          whitelist:
+            tags:
+              - TrashBag
+        cart_replacer:
+          whitelist:
+            components:
+              - LightReplacer
+        cart_spray:
+          whitelist:
+            tags:
+              - Spray
         cart_sign1: # this is like stack of floor signs
           minCount: 1
           whitelist:
@@ -337,26 +357,10 @@
           whitelist:
             tags:
               - WetFloorSign
-        cart_spray:
-          whitelist:
-            tags:
-              - Spray
-        cart_garbage:
-          whitelist:
-            tags:
-              - TrashBag
-        cart_replacer:
-          whitelist:
-            components:
-              - LightReplacer
         cart_bucket:
           whitelist:
             tags:
               - Bucket
-        cart_mop:
-          whitelist:
-            tags:
-              - Mop
       sprite: Objects/Specific/Janitorial/janitorial_cart.rsi
     - type: Appearance
     - type: SolutionContainerVisuals
@@ -392,7 +396,11 @@
     - type: Sprite
       drawdepth: FloorObjects
       sprite: Objects/Specific/Janitorial/drain.rsi
-      state: icon
+      layers:
+      - state: icon
+      - map: [ "enum.SolutionContainerLayers.Fill" ]
+        state: fill-1
+        visible: false
     - type: InteractionOutline
     - type: Clickable
     - type: Transform
@@ -400,13 +408,18 @@
     - type: Physics
       bodyType: Static
       canCollide: false
-    - type: Drain
     - type: AmbientSound
       enabled: false
       volume: -8
       range: 8
       sound:
         path: /Audio/Ambience/Objects/drain.ogg
+    - type: Drain
+    - type: Appearance
+    - type: SolutionContainerVisuals
+      maxFillLevels: 1
+      fillBaseName: fill-
+      solutionName: drainBuffer
     - type: SolutionContainerManager
       solutions:
         drainBuffer:
@@ -433,6 +446,24 @@
             - !type:PlaySoundBehavior
               sound:
                 path: /Audio/Effects/metalbreak.ogg
+
+- type: entity
+  name: plunger
+  id: Plunger
+  parent: BaseItem
+  description: A plunger with a red plastic suction-cup and a wooden handle. Used to unclog drains.
+  components:
+    - type: Tag
+      tags:
+        - Plunger
+    - type: Sprite
+      netsync: false
+      sprite: Objects/Specific/Janitorial/janitorial.rsi
+      state: plunger
+    - type: Item
+      sprite: Objects/Specific/Janitorial/janitorial.rsi
+      heldPrefix: plunger
+    - type: ItemCooldown
     - type: GuideHelp
       guides:
       - Janitorial

Resources/Prototypes/Entities/Structures/Furniture/sink.yml

@@ -10,9 +10,21 @@
   - type: InteractionOutline
   - type: Sprite
     sprite: Structures/Furniture/sink.rsi
-    state: sink_stem
+    layers:
+      - state: sink_stem
+      - map: [ "enum.SolutionContainerLayers.Fill" ]
+        state: sink-fill-1
+        visible: false
+    netsync: false
+  - type: Appearance
+  - type: SolutionContainerVisuals
+    maxFillLevels: 1
+    fillBaseName: sink-fill-
+    solutionName: drainBuffer
   - type: SolutionContainerManager
     solutions:
+      drainBuffer:
+        maxVol: 100
       tank:
         maxVol: 500
   - type: SolutionRegeneration
@@ -24,6 +36,8 @@
   - type: DrainableSolution
     solution: tank
   - type: ReagentTank
+  - type: Drain
+    autoDrain: false
   - type: Damageable
     damageContainer: Inorganic
     damageModifierSet: Metallic
@@ -44,6 +58,13 @@
           - !type:PlaySoundBehavior
             sound:
               path: /Audio/Effects/metalbreak.ogg
+  - type: AmbientSound
+    enabled: false
+    volume: -8
+    range: 8
+    sound:
+      path: /Audio/Ambience/Objects/drain.ogg
+
 
 - type: entity
   name: sink
@@ -53,6 +74,8 @@
   components:
   - type: SolutionContainerManager
     solutions:
+      drainBuffer:
+        maxVol: 200
       tank:
         reagents:
         - ReagentId: Water
@@ -63,9 +86,17 @@
   id: SinkWide
   parent: Sink
   components:
-  - type: Sprite
-    sprite: Structures/Furniture/sink.rsi
-    state: sink_wide
+    - type: Sprite
+      sprite: Structures/Furniture/sink.rsi
+      layers:
+        - state: sink_wide
+        - map: [ "enum.SolutionContainerLayers.Fill" ]
+          state: sink_wide-fill-1
+          visible: false
+    - type: SolutionContainerVisuals
+      maxFillLevels: 1
+      fillBaseName: sink_wide-fill-
+      solutionName: drainBuffer
 
 #Stemless Sink
 
@@ -76,7 +107,11 @@
   components:
   - type: Sprite
     sprite: Structures/Furniture/sink.rsi
-    state: sink
+    layers:
+      - state: sink
+      - map: [ "enum.SolutionContainerLayers.Fill" ]
+        state: sink-fill-1
+        visible: false
 
 - type: entity
   name: sink
@@ -86,6 +121,8 @@
   components:
   - type: SolutionContainerManager
     solutions:
+      drainBuffer:
+        maxVol: 100
       tank:
         reagents:
         - ReagentId: Water

Resources/Prototypes/Entities/Structures/Furniture/toilet.yml

@@ -22,6 +22,8 @@
       stash: !type:ContainerSlot {}
   - type: SolutionContainerManager
     solutions:
+      drainBuffer:
+        maxVol: 500
       toilet:
         maxVol: 250
   - type: Transform
@@ -32,6 +34,12 @@
     graph: Toilet
     node: toilet
   - type: Appearance
+  - type: Drain
+    autoDrain: false
+  - type: SolutionContainerVisuals
+    maxFillLevels: 1
+    fillBaseName: fill-
+    solutionName: drainBuffer
   - type: StaticPrice
     price: 25
 

Resources/Prototypes/Recipes/Lathes/janitorial.yml

@@ -18,7 +18,7 @@
   result: Bucket
   completetime: 2
   materials:
-    Plastic: 100
+    Steel: 100
 
 - type: latheRecipe
   id: WetFloorSign
@@ -81,6 +81,14 @@
     Steel: 100
     Glass: 100
 
+- type: latheRecipe
+  id: Plunger
+  result: Plunger
+  completetime: 2
+  materials:
+    Plastic: 50
+    Wood: 200
+
 - type: latheRecipe
   id: WeaponSprayNozzle
   result: WeaponSprayNozzle

Resources/Prototypes/tags.yml

@@ -631,9 +631,13 @@
 - type: Tag
   id: Plastic
 
+- type: Tag
+  id: Plunger
+  
 - type: Tag
   id: PlushieGhost
 
+
 - type: Tag
   id: Powerdrill
 

Resources/Textures/Objects/Specific/Janitorial/drain.rsi/meta.json

@@ -5,11 +5,15 @@
       "y":32
    },
    "license":"CC-BY-SA-3.0",
-   "copyright":"Created by EmoGarbage",
+   "copyright":"Created by EmoGarbage, fill-1 created by Topy for SS14",
    "states":[
       {
          "name":"icon",
          "directions": 4
-      }
+      },
+	  {
+		  "name": "fill-1",
+		  "directions": 4
+	  }
    ]
 }

Resources/Textures/Objects/Specific/Janitorial/janitorial.rsi/meta.json

@@ -24,6 +24,9 @@
     },
     {
       "name": "mopbucket_water-3"
+    },
+	{
+      "name": "plunger"
     },
     {
       "name": "inhand-left",
@@ -36,6 +39,14 @@
     {
       "name": "equipped-BELT",
       "directions": 4
+    },
+	{
+      "name": "plunger-inhand-left",
+	  "directions": 4
+    },
+	{
+      "name": "plunger-inhand-right",
+	  "directions": 4
     }
   ]
 }

Resources/Textures/Objects/Specific/Janitorial/janitorial_cart.rsi/meta.json

@@ -46,6 +46,10 @@
         {
             "name": "cart_spray",
             "directions": 4
+        },
+		{
+            "name": "cart_plunger",
+            "directions": 4
         },
         {
             "name": "cart_water-1",

Resources/Textures/Structures/Furniture/sink.rsi/meta.json

@@ -5,7 +5,7 @@
         "y": 32
     },
     "license": "CC-BY-SA-3.0",
-    "copyright": "Taken from tgstation https://github.com/tgstation/tgstation/commit/f01afc7edd39b28dd718407d5bbfca3a5dfe995f#diff-378d1b8f0f0a73185e7c82e4ccfdb65102561992a7abb306090ce851f8419780",
+    "copyright": "Taken from tgstation https://github.com/tgstation/tgstation/commit/f01afc7edd39b28dd718407d5bbfca3a5dfe995f#diff-378d1b8f0f0a73185e7c82e4ccfdb65102561992a7abb306090ce851f8419780, sink-fill-1 and sink_wide-fill-1 made by Topy for SS14",
     "states": [
         {
             "name": "sink",
@@ -18,6 +18,14 @@
         {
             "name": "sink_stem",
             "directions": 4
+        },
+		{
+            "name": "sink-fill-1",
+            "directions": 4
+        },
+        {
+            "name": "sink_wide-fill-1",
+            "directions": 4
         }
     ]
 }