Get Power Generators

Get a list of all power generating buildings.

getBiomassGenerator only retrieves Biomass Generators
getCoalGenerator only retrieves Coal Generators
getFuelGenerator only retrieves Fuel Generators
getNuclearGenerator only retrieves Nuclear Power Plants
getGeothermalGenerator only retrieves Geothermal Generator

URL

Response Body

Name Type Description

ID

String

Unique ID of the Generator.

Name

String

Name of the Generator.

ClassName

String

ClassName of the Generator.

location

Object

Location details of the Generator.

{depth}  x

Float

X Location in the World.

{depth}  y

Float

Y Location in the World.

{depth}  z

Float

Z Location in the World.

{depth}  rotation

Float

Rotation of the Actor (0 - 359, 0 = North, 90 = East, 180 = South, 270 = West).

CircuitID

Integer

Connected Circuit Number

BaseProd

Float

Base Power Production

DynamicProdCapacity

Float

Production Capacity

DynamicProdDemandFactor

Float

Production Demand Factor

RegulatedDemandProd

Float

Regulated Production

IsFullBlast

Boolean

Generator Running at Full Blast

CanStart

Boolean

Can Generator Start

ProdPowerComsumption

Float

Produced Power being Consumed

CurrentPotential

Float

Speed Potential (Power Slug)

ProductionCapacity

Float

Production Capacity

DefaultProductionCapacity

Float

Default Production Capacity

PowerProductionPotential

Float

Max Current Power Potential

FuelAmount

Float

Fuel Inventory

Supplement

Object

Supplemental Fuel Object

{depth}  Name

String

Supplement Resource Used (usually water)

{depth}  ClassName

String

UE Class Name

{depth}  CurrentConsumed

Float

Rate of Supplement Consumption

{depth}  MaxConsumed

Float

Max Rate of Supplement Consumption

{depth}  PercentFull

Float

Inventory Used of Supplement Storage (in %)

FuelResource

Float

Fuel Type in Inventory

NuclearWarning

String

Nuclear Power System Alarm (Nuclear Reactors Only)

GeoMinPower

Float

Minimium Power Generated (Geothermal Generators Only)

GeoMaxPower

Float

Maximium Power Generated (Geothermal Generators Only)

AvailableFuel

Object

Available Fuel Object

{depth}  Name

String

Acceptable Fuel

{depth}  ClassName

String

UE Class Name

{depth}  EnergyValue

String

Energy Value of Fuel Used in calculations (MW for Potential / (Energy Value Adjusted by Form) * 60)

WasteInventory

Object

Waste Inventory Object

{depth}  Name

String

Nuclear Waste Inventory

{depth}  ClassName

String

UE Class Name

{depth}  Amount

Integer

Amount of Waste in Generator

BoundingBox

Object

Bounding Box information about the Actor.

{depth}  min

Object

The minimum boundary of the bounding box in the corresponding axis.

{depth}    x

Float

Value along the X-axis.

{depth}    y

Float

Value along the Y-axis.

{depth}    z

Float

Value along the Z-axis.

{depth}  max

Object

The maximum boundary of the bounding box in the corresponding axis.

{depth}    x

Float

Value along the X-axis.

{depth}    y

Float

Value along the Y-axis.

{depth}    z

Float

Value along the Z-axis.

{depth}features

Object

An object with actor coordinates and name information.

{depth}  properties

Object

Name information about the actor.

{depth}    name

String

Display Name of the Actor.

{depth}    type

String

Type of the Object.

{depth}  geometry

Object

Geometry information about the Actor.

{depth}    coordinates

Object

The Actor coordinates.

{depth}      x

Float

X Location of the Actor.

{depth}      y

Float

Y Location of the Actor.

{depth}      z

Float

Z Location of the Actor.

{depth}    type

String

It’s always "Point".

Example Response

[
   {
      "ID": 0,
      "Name": "Coal Generator",
      "ClassName": "Build_GeneratorCoal_C_32",
      "location":
      {
         "X": -98814.7578125,
         "Y": -143888.078125,
         "Z": -808.1903076171875
      },
      "CircuitID": 44,
      "BaseProd": 0,
      "DynamicProdCapacity": 75,
      "DynamicProdDemandFactor": 1,
      "RegulatedDemandProd": 75,
      "IsFullBlast": true,
      "CanStart": true,
      "LoadPercentage": 1,
      "ProdPowerComsumption": 0,
      "CurrentPotential": 1,
      "ProductionCapacity": 75,
      "DefaultProductionCapacity": 75,
      "PowerProductionPotential": 75,
      "FuelAmount": 0.79486042261123657,
      "NuclearWarning": "EGeneratorNuclearWarning::GNW_None",
      "FuelResource": "EResourceForm::RF_SOLID",
      "GeoMinPower": 0,
      "GeoMaxPower": 0,
      "AvailableFuel": [
         {
            "Name": "Coal",
            "ClassName": "Desc_Coal_C"
         },
         {
            "Name": "Compacted Coal",
            "ClassName": "Desc_CompactedCoal_C"
         },
         {
            "Name": "Petroleum Coke",
            "ClassName": "Desc_PetroleumCoke_C"
         }
      ],
      "WasteInventory": [],
      "features":
      {
         "properties":
         {
            "name": "Coal Generator",
            "type": "Power Generator"
         },
         "geometry":
         {
            "coordinates":
            {
               "X": -98814.7578125,
               "Y": -143888.078125,
               "Z": -808.1903076171875
            },
            "type": "Point"
         }
      }
   },
   {
      "ID": 0,
      "Name": "Fuel Generator",
      "ClassName": "Build_GeneratorFuel_C_2147249129",
      "location":
      {
         "X": -65431.5703125,
         "Y": -179509.546875,
         "Z": 3829.33349609375
      },
      "CircuitID": 58,
      "BaseProd": 0,
      "DynamicProdCapacity": 150,
      "DynamicProdDemandFactor": 1,
      "RegulatedDemandProd": 150,
      "IsFullBlast": true,
      "CanStart": true,
      "LoadPercentage": 1,
      "ProdPowerComsumption": 0,
      "CurrentPotential": 1,
      "ProductionCapacity": 150,
      "DefaultProductionCapacity": 150,
      "PowerProductionPotential": 150,
      "FuelAmount": 0.23114287853240967,
      "NuclearWarning": "EGeneratorNuclearWarning::GNW_None",
      "FuelResource": "EResourceForm::RF_LIQUID",
      "GeoMinPower": 0,
      "GeoMaxPower": 0,
      "AvailableFuel": [
         {
            "Name": "Fuel",
            "ClassName": "Desc_LiquidFuel_C"
         },
         {
            "Name": "Turbofuel",
            "ClassName": "Desc_LiquidTurboFuel_C"
         },
         {
            "Name": "Liquid Biofuel",
            "ClassName": "Desc_LiquidBiofuel_C"
         }
      ],
      "WasteInventory": [],
      "features":
      {
         "properties":
         {
            "name": "Fuel Generator",
            "type": "Power Generator"
         },
         "geometry":
         {
            "coordinates":
            {
               "X": -65431.5703125,
               "Y": -179509.546875,
               "Z": 3829.33349609375
            },
            "type": "Point"
         }
      }
   }
]