Document a few atmos classes.

This commit is contained in:
Vera Aguilera Puerto
2021-08-03 14:26:34 +02:00
parent ed8dab2974
commit 2205fef06a
4 changed files with 7 additions and 2 deletions

View File

@@ -1,4 +1,3 @@
#nullable disable warnings
using System; using System;
using Content.Server.Atmos.EntitySystems; using Content.Server.Atmos.EntitySystems;
using Content.Server.Body.Respiratory; using Content.Server.Body.Respiratory;

View File

@@ -14,13 +14,14 @@ using Dependency = Robust.Shared.IoC.DependencyAttribute;
namespace Content.Server.Atmos.Components namespace Content.Server.Atmos.Components
{ {
/// <summary> /// <summary>
/// This is our SSAir equivalent. /// Internal Atmos class. Use <see cref="AtmosphereSystem"/> to interact with atmos instead.
/// </summary> /// </summary>
[ComponentReference(typeof(IAtmosphereComponent))] [ComponentReference(typeof(IAtmosphereComponent))]
[RegisterComponent, Serializable] [RegisterComponent, Serializable]
public class GridAtmosphereComponent : Component, IAtmosphereComponent, ISerializationHooks public class GridAtmosphereComponent : Component, IAtmosphereComponent, ISerializationHooks
{ {
public override string Name => "GridAtmosphere"; public override string Name => "GridAtmosphere";
public virtual bool Simulated => true; public virtual bool Simulated => true;
[ViewVariables] [ViewVariables]

View File

@@ -8,6 +8,9 @@ using Robust.Shared.Map;
namespace Content.Server.Atmos.EntitySystems namespace Content.Server.Atmos.EntitySystems
{ {
/// <summary>
/// This is our SSAir equivalent, if you need to interact with or query atmos in any way, go through this.
/// </summary>
[UsedImplicitly] [UsedImplicitly]
public partial class AtmosphereSystem : SharedAtmosphereSystem public partial class AtmosphereSystem : SharedAtmosphereSystem
{ {

View File

@@ -1,3 +1,4 @@
using Content.Server.Atmos.EntitySystems;
using Content.Shared.Atmos; using Content.Shared.Atmos;
using Content.Shared.Maps; using Content.Shared.Maps;
using Robust.Shared.Map; using Robust.Shared.Map;
@@ -8,6 +9,7 @@ namespace Content.Server.Atmos
{ {
/// <summary> /// <summary>
/// Internal Atmos class that stores data about the atmosphere in a grid. /// Internal Atmos class that stores data about the atmosphere in a grid.
/// You shouldn't use this directly, use <see cref="AtmosphereSystem"/> instead.
/// </summary> /// </summary>
public class TileAtmosphere : IGasMixtureHolder public class TileAtmosphere : IGasMixtureHolder
{ {