Show / Hide Table of Contents

Class FuelGeneratorComponent

This is used for generators that run off some kind of fuel.

Inheritance
System.Object
FuelGeneratorComponent
Namespace: Content.Shared.Power.Generator
Assembly: Content.Shared.dll
Syntax
public sealed class FuelGeneratorComponent : Component
Remarks

Generators must be anchored to be able to run.

Fields

| Improve this Doc View Source

FuelEfficiencyConstant

A constant used to calculate fuel efficiency in relation to target power output and optimal power output

Declaration
public float FuelEfficiencyConstant
Field Value
Type Description
System.Single
| Improve this Doc View Source

MaxTargetPower

The maximum target power.

Declaration
public float MaxTargetPower
Field Value
Type Description
System.Single
| Improve this Doc View Source

MinTargetPower

The minimum target power.

Declaration
public float MinTargetPower
Field Value
Type Description
System.Single
Remarks

Setting this to any value above 0 means that the generator can't idle without consuming some amount of fuel.

| Improve this Doc View Source

On

Is the generator currently running?

Declaration
public bool On
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

OptimalBurnRate

The rate at which one unit of fuel should be consumed.

Declaration
public float OptimalBurnRate
Field Value
Type Description
System.Single
| Improve this Doc View Source

OptimalPower

The "optimal" power at which the generator is considered to be at 100% efficiency.

Declaration
public float OptimalPower
Field Value
Type Description
System.Single
| Improve this Doc View Source

TargetPower

The generator's target power.

Declaration
public float TargetPower
Field Value
Type Description
System.Single

See Also

SharedGeneratorSystem
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾