Document tags: G (#40898)

* Use more consistent and clear language in documentation

* the letter G

* the friends we made along the way

---------

Co-authored-by: iaada <iaada@users.noreply.github.com>

diff --git a/Resources/Prototypes/Entities/Clothing/base_clothing.yml b/Resources/Prototypes/Entities/Clothing/base_clothing.yml
index da9a7f8b1a904ced91f2a8d2a452da413259b67f..f02feff158ca0765a14e873e5e4d410adee13b3c 100644 (file)
--- a/Resources/Prototypes/Entities/Clothing/base_clothing.yml
+++ b/Resources/Prototypes/Entities/Clothing/base_clothing.yml
@@ -34,7 +34,7 @@
   components:
   - type: AllowSuitStorage
     whitelist:
-      tags:
+      components:
       - GasTank
 
 # for clothing that has a single item slot to insert and alt click out.

diff --git a/Resources/Prototypes/Entities/Objects/Devices/geiger.yml b/Resources/Prototypes/Entities/Objects/Devices/geiger.yml
index 518d28f2eef623b59476f92e7d758aad1363aff9..880d4d0cc1f8d51c1dff5644dcc79656a5decd91 100644 (file)
--- a/Resources/Prototypes/Entities/Objects/Devices/geiger.yml
+++ b/Resources/Prototypes/Entities/Objects/Devices/geiger.yml
@@ -35,3 +35,6 @@
   - type: PhysicalComposition
     materialComposition:
       Plastic: 100
+  - type: Tag
+    tags:
+    - GeigerCounter

diff --git a/Resources/Prototypes/Entities/Objects/Specific/Janitorial/trashbag.yml b/Resources/Prototypes/Entities/Objects/Specific/Janitorial/trashbag.yml
index 31d8d629ced1022d5ace814fe40f4901e7ac7f8d..95e8fcd3720664a230c835783b0dbc2c7fa3004f 100644 (file)
--- a/Resources/Prototypes/Entities/Objects/Specific/Janitorial/trashbag.yml
+++ b/Resources/Prototypes/Entities/Objects/Specific/Janitorial/trashbag.yml
@@ -20,7 +20,6 @@
       collection: trashBagRustle
     whitelist:
       tags:
-        - Cartridge
         - Trash
   - type: UseDelay
     delay: 0.5

diff --git a/Resources/Prototypes/Entities/Objects/Specific/Robotics/borg_modules.yml b/Resources/Prototypes/Entities/Objects/Specific/Robotics/borg_modules.yml
index 8dc7e2dde40e47e265146a153178acfeb92bbd71..fd20778e9e586e6f368ef8f29ebe6c7d4becac9d 100644 (file)
--- a/Resources/Prototypes/Entities/Objects/Specific/Robotics/borg_modules.yml
+++ b/Resources/Prototypes/Entities/Objects/Specific/Robotics/borg_modules.yml
@@ -779,8 +779,8 @@
         emptyLabel: borg-slot-beakers-empty
         emptyRepresentative: Beaker
         whitelist:
-          tags:
-          - GlassBeaker
+          components:
+          - FitsInDispenser
   - type: BorgModuleIcon
     icon: { sprite: Interface/Actions/actions_borg.rsi, state: adv-cleaning-module }
 

diff --git a/Resources/Prototypes/Entities/Objects/Tools/access_breaker.yml b/Resources/Prototypes/Entities/Objects/Tools/access_breaker.yml
index 55c74985788d550ef883e9d1040561e0f4730ced..c2cba06fa06a5dae9d6ef02379de31d0e4546ca3 100644 (file)
--- a/Resources/Prototypes/Entities/Objects/Tools/access_breaker.yml
+++ b/Resources/Prototypes/Entities/Objects/Tools/access_breaker.yml
@@ -6,6 +6,7 @@
   description: A hacked access configurator, specialized to unlock and erase access from digital locks.
   components:
   - type: Emag
+    emagImmuneTag: AccessBreakerImmune
     emagType: Access
   - type: Sprite
     sprite: Objects/Tools/access_breaker.rsi

diff --git a/Resources/Prototypes/Entities/Structures/Machines/Computers/computers.yml b/Resources/Prototypes/Entities/Structures/Machines/Computers/computers.yml
index 4e50a7e60bae39391a26415650364959346a8813..4206f8e37d5b8af7504e28c6b0ed0ef345c016fc 100644 (file)
--- a/Resources/Prototypes/Entities/Structures/Machines/Computers/computers.yml
+++ b/Resources/Prototypes/Entities/Structures/Machines/Computers/computers.yml
@@ -617,9 +617,6 @@
     radius: 1.5
     energy: 1.6
     color: "#3c5eb5"
-  - type: Tag
-    tags:
-    - AccessBreakerImmune
   - type: ItemSlots
   - type: ContainerContainer
     containers:
@@ -1718,4 +1715,4 @@
       enum.StationAiFixerConsoleUiKey.Key:
         type: StationAiFixerConsoleBoundUserInterface
       enum.WiresUiKey.Key:
-        type: WiresBoundUserInterface
\ No newline at end of file
+        type: WiresBoundUserInterface

diff --git a/Resources/Prototypes/tags.yml b/Resources/Prototypes/tags.yml
index 08539f50cfc5e1db0b07948af6bdfe0bd5151cde..9133331dbdc64d1c508b1fbbc6c222de75a55a78 100644 (file)
--- a/Resources/Prototypes/tags.yml
+++ b/Resources/Prototypes/tags.yml
@@ -4,25 +4,25 @@
 ## A ##
 
 - type: Tag
-  id: AccessBreakerImmune # This tag marks an entity as immune to emagging.
+  id: AccessBreakerImmune # Default value in EmagProviderComponent. Marks tagged entity as immune to AccessBreakerUnlimited.
 
 - type: Tag
-  id: AirAlarm # Used by AtmosAlarmableComponent for syncing devices
+  id: AirAlarm # Used by AtmosAlarmableComponent for syncing devices.
 
 - type: Tag
   id: AirAlarmElectronics # ConstructionGraph: AirAlarm
 
 - type: Tag
-  id: Airlock # Used in ConstructionGraph "Airlock" to navigate between regular, glass, and highsec airlocks
+  id: Airlock # Used in ConstructionGraph "Airlock" to navigate between regular, glass, and highsec airlocks.
 
 - type: Tag
-  id: AirSensor # Used by AtmosAlarmableComponent for syncing devices
+  id: AirSensor # Used by AtmosAlarmableComponent for syncing devices.
 
 - type: Tag
   id: AllowBiomeLoading # Entities with this tag will load terrain, even if a ghost.
 
 - type: Tag
-  id: AllowGhostShownByEvent # Used by GhostSystem to show ghosts (usually at round end)
+  id: AllowGhostShownByEvent # Used by GhostSystem to show tagged ghosts (usually at round end).
 
 - type: Tag
   id: Ambrosia # ConstructionGraph: flowerwreath
@@ -51,7 +51,7 @@
   id: Backpack # ConstructionGraph: ClothingBagPet
 
 - type: Tag
-  id: Balloon # Used by BalloonPopperComponent/System to viciously maim helpless balloons
+  id: Balloon # Default value in BalloonPopperComponent. Tagged entities will be viscously maimed by corresponding poppers.
 
 - type: Tag
   id: Banana # CargoBounty: BountyBanana
@@ -84,7 +84,7 @@
   id: Bloodpack # Storage whitelist: ClothingBeltMedical
 
 - type: Tag
-  id: BlueprintAutolathe # Whitelist on BlueprintReceiverComponent on the autolate for linking this entity's BlueprintComponent
+  id: BlueprintAutolathe # Whitelist on BlueprintReceiverComponent on the autolate for linking tagged entity's BlueprintComponent.
 
 - type: Tag
   id: BodyBag # Storage whitelist: BoxBodyBag
@@ -158,14 +158,14 @@
 - type: Tag
   id: BotanyShovel # Storage whitelist: ClothingBeltPlant. ItemMapper: ClothingBeltPlant
 
-- type: Tag # Used for specifically chemistry bottles
+- type: Tag # Used for specifically chemistry bottles.
   id: Bottle # Storage whitelist: ChemMaster, ChemBag, SmartFridge, ClothingBeltJanitor, ClothingBeltMedical, ClothingBeltPlant
 
 - type: Tag
   id: BoxCardboard # CargoBounty: BountyCardboardBox
 
 - type: Tag
-  id: BoxHug # Unused (Exists on BoxHug, BoxHoloclown)
+  id: BoxHug # ConstructionGraph: HugBot
 
 - type: Tag
   id: Brain # Storage whitelist: MMI. CargoBounty: BountyBrain
@@ -198,16 +198,16 @@
   id: BulletFoam # Ammo: WeaponRifleFoam, FoamCrossbow, MagazineFoamBox, BoxDonkSoftBox
 
 - type: Tag
-  id: Burnt # Storage whitelist: ashtray. Seemingly redundant
+  id: Burnt # Storage whitelist: ashtray. Seemingly redundant?
 
 - type: Tag
   id: Bun # Unused (Exists on FoodSequenceElements BunTopBurger and CottonBunTopBurger)
 
 - type: Tag
-  id: BypassDropChecks # Entities with this tag don't care about drop distance or walls (Aghost)
+  id: BypassDropChecks # Tagged entities don't care about drop distance or walls (Aghost).
 
 - type: Tag
-  id: BypassInteractionRangeChecks # Entities with this tag don't care about distance or walls when touching things (Aghost)
+  id: BypassInteractionRangeChecks # Tagged entities don't care about distance or walls when touching things (Aghost).
 
 ## C ##
 
@@ -227,10 +227,10 @@
   id: CannonBall # Ammo: WeaponLauncherPirateCannon, ShuttleGunPirateCannon
 
 - type: Tag
-  id: CannotSuicide # Used by SuicideSystem. Entities with this tag ghost when attempting to suicide
+  id: CannotSuicide # Used by SuicideSystem. Tagged entities ghost when attempting to suicide.
 
 - type: Tag
-  id: CanPilot # Used by ShuttleConsoleSystem to guard who's allowed to pilot ships
+  id: CanPilot # Used by ShuttleConsoleSystem to guard who's allowed to pilot ships.
 
 - type: Tag
   id: CaptainSabre # Storage whitelist: ClothingBeltSheath. ItemMapper: ClothingBeltSheath
@@ -247,8 +247,8 @@
 - type: Tag
   id: Carp # CargoBounty: BountyCarp
 
-- type: Tag # NOT bullets. This is for the cart to load PDA programs
-  id: Cartridge # Storage whitelist: BasePDA, TrashBag
+- type: Tag # NOT bullets. This is for the cart to load PDA programs.
+  id: Cartridge # Storage whitelist: BasePDA
 
 - type: Tag
   id: CartridgeAntiMateriel # Ammo: WeaponSniperHristov, Musket, BaseMagazineBoxAntiMateriel
@@ -284,19 +284,19 @@
   id: CartridgeRocket # Ammo: WeaponLauncherRocket, WeaponLauncherMultipleRocket
 
 - type: Tag
-  id: Catwalk # Allows you to walk over tile entities such as lava without steptrigger
+  id: Catwalk # If a tagged entity is intersecting a hazard tile entity such as lava or chasms, step triggers on those hazards are cancelled.
 
 - type: Tag
   id: CentrifugeCompatible # Storage whitelist: MachineCentrifuge
 
 - type: Tag
-  id: Chicken # MetamorphRecipe: FoodBurgerChicken
+  id: Chicken # Reproductive partner key. MetamorphRecipe: FoodBurgerChicken
 
 - type: Tag
   id: Cheese # MetamorphRecipe: FoodBurgerCheese, FoodBurgerDuck
 
 - type: Tag
-  id: ChefPilot # Allowed to control someone wearing a Chef's hat if inside their hat.
+  id: ChefPilot # Tagged entity can control someone wearing a Chef's hat if inside their hat.
 
 - type: Tag
   id: ChemDispensable # Storage whitelist: ChemDispenserEmpty, SmartFridge, BorgModuleAdvancedChemical
@@ -329,7 +329,7 @@
   id: ClownRecorder # ConstructionGraph: ClownHardsuit
 
 - type: Tag
-  id: ClownRubberStamp # Unused: RubberStampClown
+  id: ClownRubberStamp # Unused (Exists on RubberStampClown)
 
 - type: Tag
   id: ClownShoes # CargoBounty: BountyClownCostume. ConstructionGraph: Honker, BananaClownShoes
@@ -377,7 +377,7 @@
   id: CottonBurger # Food sequence key
 
 - type: Tag
-  id: Cow # Reproduction key
+  id: Cow # Reproductive partner key
 
 - type: Tag
   id: Crab # MetamorphRecipe: FoodBurgerCrab
@@ -454,7 +454,7 @@
   id: DeathAcidifier # Unused (Exists on DeathAcidifierImplant)
 
 - type: Tag
-  id: Debug # Exists on various debug / testing entities, but seemingly unused
+  id: Debug # Exists on various debug / testing entities, but seemingly unused.
 
 - type: Tag # Exists on diagonal walls and windows
   id: Diagonal # Used by TileWallsCommand and FixRotationsCommand
@@ -469,16 +469,16 @@
   id: DiscreteHealthAnalyzer # Storage whitelist: ClothingBeltMedical. ConstructionGraph: MediBot
 
 - type: Tag
-  id: DNASolutionScannable # Used by ForensicScannerSystem for scanning a solution container. Exists only on Puddle
+  id: DNASolutionScannable # Used by ForensicScannerSystem for scanning a tagged entity's solution container. Exists only on Puddle.
 
 - type: Tag
-  id: DockArrivals # Used by ArrivalsSystem for finding a priority FTL destination
+  id: DockArrivals # Used by ArrivalsSystem for finding a priority FTL destination.
 
 - type: Tag
   id: DockCargo # Unused x2
 
 - type: Tag
-  id: DockEmergency # Used bv EmergencyShuttleSystem
+  id: DockEmergency # Used bv EmergencyShuttleSystem for finding a priority FTL destination.
 
 - type: Tag
   id: Document # A superset of Paper tag. Represents a paper-like entity with writing on it, but is not necessarily writeable itself.
@@ -490,14 +490,14 @@
   id: Donut # Storage whitelist: FoodBoxDonut. CargoBounty: BountyDonut
 
 - type: Tag
-  id: DoorBumpOpener # Used by SharedDoorSystem to allow entities to open doors when they collide.
+  id: DoorBumpOpener # Used by SharedDoorSystem to allow tagged entities to open doors when they collide.
 
 - type: Tag
   id: DoorElectronics  # ConstructionGraph: PinionAirlock, BlastDoor, Windoor
                        # Used interchangeably with DoorElectronicsComponent, sometimes even in the same graph. TODO pick one
 
 - type: Tag
-  id: DoorElectronicsConfigurator # Used by ActivatableUIComponent on entity DoorElectronics to whitelist a tool to open the UI.
+  id: DoorElectronicsConfigurator # Used by ActivatableUIComponent on entity DoorElectronics to whitelist a tagged tool to open the UI.
 
 - type: Tag
   id: DrinkBottle # Storage whitelist: BoozeDispenserEmpty, SodaDispenserEmpty
@@ -506,19 +506,19 @@
   id: DrinkCan # ConstructionGraph: FireBomb
 
 - type: Tag
-  id: DrinkCup # Unused. Exists on DrinkBaseCup, DrinkWaterCup, DrinkGlass
+  id: DrinkCup # Unused (Exists on DrinkBaseCup, DrinkWaterCup, DrinkGlass)
 
 - type: Tag
-  id: DrinkGlass # Unused. Exists on DrinkGlass, DrinkShotGlass, DrinkJarWhat, DrinkShakeBase
+  id: DrinkGlass # Unused (Exists on DrinkGlass, DrinkShotGlass, DrinkJarWhat, DrinkShakeBase)
 
 - type: Tag
-  id: DrinkSpaceGlue # Unused. Exists on DrinkSpaceGlue, CrazyGlue
+  id: DrinkSpaceGlue # Unused (Exists on DrinkSpaceGlue, CrazyGlue)
 
 - type: Tag
   id: Dropper # Storage whitelist: ClothingBeltMedical, ClothingBeltPlant, ChemBag
 
 - type: Tag
-  id: Duck # Reproduction key. MetamorphRecipe: FoodBurgerDuck
+  id: Duck # Reproductive partner key. MetamorphRecipe: FoodBurgerDuck
 
 ## E ##
 
@@ -529,10 +529,10 @@
   id: Egg # Storage whitelist: FoodContainerEgg
 
 - type: Tag
-  id: EmagImmune # Default value in EmagComponent to prevent the emag
+  id: EmagImmune # Default value in EmagComponent. Marks tagged entity as immune to EmagUnlimited.
 
 - type: Tag
-  id: EmitterBolt # Default value in ContainmentFieldGeneratorComponent for collisions that power the generator
+  id: EmitterBolt # Default value in ContainmentFieldGeneratorComponent for tagged collisions that power the generator.
 
 - type: Tag
   id: EncryptionCargo # ItemMapper: TelecomServer
@@ -573,16 +573,16 @@
 ## F ##
 
 - type: Tag
-  id: FakeMindShieldImplant # Used by FakeMindShieldSystem to toggle the action when a chameleon outfit is selected
+  id: FakeMindShieldImplant # Used by FakeMindShieldSystem to toggle the tagged action when a chameleon outfit is selected.
 
 - type: Tag
-  id: FakeNukeDisk # Exists so that the fake nuke disk can be blacklisted by storages that blacklist the real disk
+  id: FakeNukeDisk # Exists so that the fake nuke disk can be blacklisted by storages that blacklist the real disk.
 
 - type: Tag
   id: Figurine # Storage whitelist: BooksBag, BorgModuleService. CargoBounty: BountyFigurine
 
 - type: Tag
-  id: FireAlarm # Used by AtmosAlarmableComponent for syncing devices
+  id: FireAlarm # Used by AtmosAlarmableComponent for syncing devices.
 
 - type: Tag
   id: FireAlarmElectronics # ConstructionGraph: FireAlarmAssembly
@@ -606,7 +606,7 @@
   id: Flashlight # Storage whitelist: ClothingBeltUtility, ClothingBeltJanitor
 
 - type: Tag
-  id: Flesh # Used by FleshKudzu to ignore contacts with flesh creatures
+  id: Flesh # Used by FleshKudzu to ignore damage contacts on tagged entities.
 
 - type: Tag
   id: Flower # CargoBounty: flowerwreath. CargoBounty: BountyFlower
@@ -618,10 +618,10 @@
   id: FoodSnack # Storage whitelist: CandyBucket, CandyBowl. ItemMapper: CandyBowl
 
 - type: Tag
-  id: FootstepSound # SharedMoverController checks for this before playing footstep sounds
+  id: FootstepSound # SharedMoverController checks for this on an entity before playing footstep sounds.
 
 - type: Tag
-  id: ForceableFollow # Used by FollowerSystem to give entities an altverb to start orbiting the user
+  id: ForceableFollow # Used by FollowerSystem to give tagged entities an altverb to start orbiting the user.
 
 - type: Tag
   id: ForceFixRotations # fixrotations command WILL target this
@@ -638,71 +638,71 @@
 ## G ##
 
 - type: Tag
-  id: Galaxythistle
+  id: Galaxythistle # CargoBounty: BountyGalaxyThistle
 
 - type: Tag
-  id: GasScrubber
+  id: GasScrubber # Used by AtmosAlarmableComponent for syncing devices.
 
 - type: Tag
-  id: GasTank
+  id: GasTank # Unused (Exists on GasTankBase)
 
 - type: Tag
-  id: GasVent
+  id: GasVent # Used by AtmosAlarmableComponent for syncing devices.
 
 - type: Tag
-  id: Gauze
+  id: Gauze # Storage whitelist: ClothingBeltMedical
 
 - type: Tag
-  id: GeigerCounter
+  id: GeigerCounter # Storage whitelist: BaseClothingBeltEngineering
 
 # Used for warps
 - type: Tag
   id: GhostOnlyWarp
 
 - type: Tag
-  id: GenderPin
+  id: GenderPin # ChameleonClothing key.
 
 - type: Tag
-  id: GlassAirlock
+  id: GlassAirlock # Used in ConstructionGraph "Airlock" to navigate between regular, glass, and highsec airlocks.
 
 - type: Tag
-  id: GlassBeaker
+  id: GlassBeaker # This tag exists for the purpose of being a common ingredient in the construction of various machines.
 
 - type: Tag
-  id: GlassShard
+  id: GlassShard # ConstructionGraph: BladedFlatcapBrown, BladedFlatcapGrey, ImprovisedArrow, ImprovisedShotgunShellGraph, Shiv, Spear
 
 - type: Tag
-  id: Goat
+  id: Goat # Reproductive partner key
 
 - type: Tag
-  id: GoldenPlunger
+  id: GoldenPlunger # Storage whitelist: JanitorialTrolley. ItemMapper: JanitorialTrolley
 
 - type: Tag
-  id: Goliath
+  id: Goliath # Blacklist on GoliathTentacle to prevent tagged entity from getting stunned (by itself)
 
 - type: Tag
-  id: GoliathPlate
+  id: GoliathPlate # CargoBounty: BountyGoliathPlates
 
 - type: Tag
-  id: GPS
+  id: GPS # Storage whitelist: BaseClothingBeltEngineering
 
-- type: Tag
-  id: Grenade
+- type: Tag # Exists for propelled explosives, not hand grenades.
+  id: Grenade # Ammo: ShuttleGunFriendship, WeaponLauncherChinaLake, WeaponLauncherHydra, BaseMagazineGrenade
 
 - type: Tag
-  id: GrenadeFlashBang
+  id: GrenadeFlashBang # Storage whitelist: ClusterBang
 
 - type: Tag
-  id: GuideEmbeded
+  id: GuideEmbeded # Applied by GuideEntityEmbed and used by GuidebookSystem. This tag hides the guidebook link when examining an entity inside a guide book.
 
 - type: Tag
-  id: GunUpgradeDamage
+  id: GunUpgradeDamage # Used by PKAUpgradeDamage:GunUpgrade to ensure mutually exclusive upgrades.
 
 - type: Tag
-  id: GunUpgradeRange
+  id: GunUpgradeRange # Used by PKAUpgradeRange:GunUpgrade to ensure mutually exclusive upgrades.
 
 - type: Tag
-  id: GunUpgradeReloadSpeed
+  id: GunUpgradeReloadSpeed # Used by PKAUpgradeFireRate:GunUpgrade to ensure mutually exclusive upgrades.
 
 ## H ##