S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

WorldUnitSnapshot

Contains a point-in-time value and production rates for one world unit.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIClassAssembly CMAPI.API.dll
public sealed class WorldUnitSnapshot

Contains a point-in-time value and production rates for one world unit.

Members

KindGets the stable CMAPI unit kind.propertyValueGets the raw total value used by Planet Crafter.propertyDisplayValueGets Planet Crafter's player-facing formatted total.propertyIncreasePerSecondGets gross positive generation per second.propertyDecreasePerSecondGets gross negative generation per second.propertyNetPerSecondGets the final net change per second.property

Kind

property
public WorldUnitKind Kind

Gets the stable CMAPI unit kind.

Value

property
public double Value

Gets the raw total value used by Planet Crafter.

DisplayValue

property
public string DisplayValue

Gets Planet Crafter's player-facing formatted total.

IncreasePerSecond

property
public float IncreasePerSecond

Gets gross positive generation per second.

DecreasePerSecond

property
public float DecreasePerSecond

Gets gross negative generation per second.

NetPerSecond

property
public float NetPerSecond

Gets the final net change per second.