cmdrunematti
/
Delta-v
mirror of https://github.com/DeltaV-Station/Delta-v.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Properly document AtmosDeviceEnabled(Disabled)Event (#41613) 

kill misnomers
This commit is contained in:
ArtisticRoomba 2025-11-28 16:42:13 -08:00 committed by BarryNorfolk
parent 447b4c5109
commit fff5850a67
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs
View File

@ -1,7 +1,12 @@
namespace Content.Shared.Atmos.Piping.Components;
/// <summary>
/// Raised directed on an atmos device when it is enabled.
/// <para>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.</para>
///
/// <para>Any information that you were tracking about the grid should
/// probably be cleared out here.</para>
/// </summary>
[ByRefEvent]
public readonly record struct AtmosDeviceDisabledEvent;
public readonly record struct AtmosDeviceDisabledEvent;

10
Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs
View File

@ -1,7 +1,13 @@
namespace Content.Shared.Atmos.Piping.Components;
/// <summary>
/// Raised directed on an atmos device when it is enabled.
/// <para>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.</para>
///
/// <para>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 <see cref="GasMixture"/>s).</para>
/// </summary>
[ByRefEvent]
public readonly record struct AtmosDeviceEnabledEvent;
public readonly record struct AtmosDeviceEnabledEvent;