From 037a5598b7f258362f47f2a458e9fd9e0a263ebc Mon Sep 17 00:00:00 2001 From: ArtisticRoomba <145879011+ArtisticRoomba@users.noreply.github.com> Date: Fri, 28 Nov 2025 16:42:13 -0800 Subject: [PATCH] Properly document AtmosDeviceEnabled(Disabled)Event (#41613) kill misnomers --- .../Piping/Components/AtmosDeviceDisabledEvent.cs | 9 +++++++-- .../Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs | 10 ++++++++-- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs b/Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs index 6fe5d86df2..66aa9b0bfa 100644 --- a/Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs +++ b/Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs @@ -1,7 +1,12 @@ namespace Content.Shared.Atmos.Piping.Components; /// -/// Raised directed on an atmos device when it is enabled. +/// Raised directed on an AtmosDeviceComponent when it has been removed from +/// the GridAtmosphereComponent it was attached to. +/// This can occur when it has been requested manually or when the device has been unanchored. +/// +/// Any information that you were tracking about the grid should +/// probably be cleared out here. /// [ByRefEvent] -public readonly record struct AtmosDeviceDisabledEvent; \ No newline at end of file +public readonly record struct AtmosDeviceDisabledEvent; diff --git a/Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs b/Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs index d656367245..5f829c7d59 100644 --- a/Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs +++ b/Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs @@ -1,7 +1,13 @@ namespace Content.Shared.Atmos.Piping.Components; /// -/// Raised directed on an atmos device when it is enabled. +/// Raised directed on an AtmosDeviceComponent when it has been added to +/// a GridAtmosphereComponent. +/// This can occur when it has been requested manually or when the device has been anchored. +/// +/// You can use this to cache specific information about the grid the device is on, +/// though be careful with caching references to objects that can be removed or changed at any time +/// (such as s). /// [ByRefEvent] -public readonly record struct AtmosDeviceEnabledEvent; \ No newline at end of file +public readonly record struct AtmosDeviceEnabledEvent; -- 2.52.0