Fix some TEG code conventions (#19259)

This commit is contained in:
Kara
2023-08-17 11:50:41 -07:00
committed by GitHub
parent 2dea8a9aed
commit 1e65eea905
6 changed files with 37 additions and 21 deletions

View File

@@ -15,55 +15,64 @@ public sealed class TegGeneratorComponent : Component
/// <remarks>
/// A value of 0.9 means that 90% of energy transferred goes to electricity.
/// </remarks>
[ViewVariables(VVAccess.ReadWrite)] [DataField("thermal_efficiency")]
[ViewVariables(VVAccess.ReadWrite)]
[DataField("thermalEfficiency")]
public float ThermalEfficiency = 0.65f;
/// <summary>
/// Simple factor that scales effective electricity generation.
/// </summary>
[ViewVariables(VVAccess.ReadWrite)] [DataField("power_factor")]
[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("last_generation")]
[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("ramp_position")]
[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("ramp_factor")]
[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("ramp_threshold")]
[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("max_visual_power")]
[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("volume_min")]
[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("volume_max")]
[ViewVariables(VVAccess.ReadWrite)]
[DataField("volumeMax")]
public float VolumeMax = -4;
}