62 lines
2.1 KiB
C#
62 lines
2.1 KiB
C#
using Robust.Shared.GameStates;
|
|
|
|
namespace Content.Shared.Power.Generator;
|
|
|
|
/// <summary>
|
|
/// This is used for generators that run off some kind of fuel.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// Generators must be anchored to be able to run.
|
|
/// </para>
|
|
/// </remarks>
|
|
/// <seealso cref="SharedGeneratorSystem"/>
|
|
[RegisterComponent, NetworkedComponent, AutoGenerateComponentState, Access(typeof(SharedGeneratorSystem))]
|
|
public sealed partial class FuelGeneratorComponent : Component
|
|
{
|
|
/// <summary>
|
|
/// Is the generator currently running?
|
|
/// </summary>
|
|
[DataField("on"), ViewVariables(VVAccess.ReadWrite), AutoNetworkedField]
|
|
public bool On;
|
|
|
|
/// <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 minimum target power.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Setting this to any value above 0 means that the generator can't idle without consuming some amount of fuel.
|
|
/// </remarks>
|
|
[DataField("minTargetPower"), ViewVariables(VVAccess.ReadWrite)]
|
|
public float MinTargetPower = 1_000;
|
|
|
|
/// <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;
|
|
}
|