Files
tbd-station-14/Content.Server/Power/Generation/Teg/TegGeneratorComponent.cs

79 lines
2.5 KiB
C#

namespace Content.Server.Power.Generation.Teg;
/// <summary>
/// The centerpiece for the thermo-electric generator (TEG).
/// </summary>
/// <seealso cref="TegSystem"/>
[RegisterComponent]
[Access(typeof(TegSystem))]
public sealed partial class TegGeneratorComponent : Component
{
/// <summary>
/// When transferring energy from the hot to cold side,
/// determines how much of that energy can be extracted as electricity.
/// </summary>
/// <remarks>
/// A value of 0.9 means that 90% of energy transferred goes to electricity.
/// </remarks>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("thermalEfficiency")]
public float ThermalEfficiency = 0.65f;
/// <summary>
/// Simple factor that scales effective electricity generation.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("powerFactor")]
public float PowerFactor = 1;
/// <summary>
/// Amount of energy (Joules) generated by the TEG last atmos tick.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("lastGeneration")]
public float LastGeneration;
/// <summary>
/// The current target for TEG power generation.
/// Drifts towards actual power draw of the network with <see cref="PowerFactor"/>.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("rampPosition")]
public float RampPosition;
/// <summary>
/// Factor by which TEG power generation scales, both up and down.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("rampFactor")]
public float RampFactor = 1.05f;
/// <summary>
/// Minimum position for the ramp. Avoids TEG taking too long to start.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("rampMinimum")]
public float RampMinimum = 5000;
/// <summary>
/// Power output value at which the sprite appearance and sound volume should cap out.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("maxVisualPower")]
public float MaxVisualPower = 200_000;
/// <summary>
/// Minimum ambient sound volume, when we're producing just barely any power at all.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("volumeMin")]
public float VolumeMin = -9;
/// <summary>
/// Maximum ambient sound volume, when we're producing &gt;= <see cref="MaxVisualPower"/> power.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
[DataField("volumeMax")]
public float VolumeMax = -4;
}