Files
tbd-station-14/Content.Shared/Power/Generator/FuelGeneratorComponent.cs
2023-07-31 14:42:38 -04:00

88 lines
2.6 KiB
C#

using Robust.Shared.GameStates;
using Robust.Shared.Serialization;
namespace Content.Shared.Power.Generator;
/// <summary>
/// This is used for generators that run off some kind of fuel.
/// </summary>
[RegisterComponent, NetworkedComponent, Access(typeof(SharedGeneratorSystem))]
public sealed class FuelGeneratorComponent : Component
{
/// <summary>
/// The amount of fuel left in the generator.
/// </summary>
[DataField("remainingFuel"), ViewVariables(VVAccess.ReadWrite)]
public float RemainingFuel;
/// <summary>
/// The generator's target power.
/// </summary>
[DataField("targetPower"), ViewVariables(VVAccess.ReadWrite)]
public float TargetPower = 15_000.0f;
/// <summary>
/// The maximum target power.
/// </summary>
[DataField("maxTargetPower"), ViewVariables(VVAccess.ReadWrite)]
public float MaxTargetPower = 30_000.0f;
/// <summary>
/// The "optimal" power at which the generator is considered to be at 100% efficiency.
/// </summary>
[DataField("optimalPower"), ViewVariables(VVAccess.ReadWrite)]
public float OptimalPower = 15_000.0f;
/// <summary>
/// The rate at which one unit of fuel should be consumed.
/// </summary>
[DataField("optimalBurnRate"), ViewVariables(VVAccess.ReadWrite)]
public float OptimalBurnRate = 1 / 60.0f; // Once every 60 seconds.
/// <summary>
/// A constant used to calculate fuel efficiency in relation to target power output and optimal power output
/// </summary>
[DataField("fuelEfficiencyConstant")]
public float FuelEfficiencyConstant = 1.3f;
}
/// <summary>
/// Sent to the server to adjust the targeted power level.
/// </summary>
[Serializable, NetSerializable]
public sealed class SetTargetPowerMessage : BoundUserInterfaceMessage
{
public int TargetPower;
public SetTargetPowerMessage(int targetPower)
{
TargetPower = targetPower;
}
}
/// <summary>
/// Contains network state for FuelGeneratorComponent.
/// </summary>
[Serializable, NetSerializable]
public sealed class SolidFuelGeneratorComponentBuiState : BoundUserInterfaceState
{
public float RemainingFuel;
public float TargetPower;
public float MaximumPower;
public float OptimalPower;
public SolidFuelGeneratorComponentBuiState(FuelGeneratorComponent component)
{
RemainingFuel = component.RemainingFuel;
TargetPower = component.TargetPower;
MaximumPower = component.MaxTargetPower;
OptimalPower = component.OptimalPower;
}
}
[Serializable, NetSerializable]
public enum GeneratorComponentUiKey
{
Key
}