S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

PlayerVitals

Contains a read-only snapshot of a player's survival gauges.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIStructAssembly CMAPI.API.dll
public readonly struct PlayerVitals

Contains a read-only snapshot of a player's survival gauges.

Members

OxygenGets the current oxygen value.propertyWaterGets the current water value used by the game's thirst gauge.propertyHealthGets the current health value.propertyToxicityGets the current toxicity value.propertyIsDyingGets whether oxygen, water, or health has reached the game's dying threshold.propertyPlayerVitalsCreates a survival-gauge snapshot.method

Oxygen

property
public float Oxygen

Gets the current oxygen value.

Water

property
public float Water

Gets the current water value used by the game's thirst gauge.

Health

property
public float Health

Gets the current health value.

Toxicity

property
public float Toxicity

Gets the current toxicity value.

IsDying

property
public bool IsDying

Gets whether oxygen, water, or health has reached the game's dying threshold.

PlayerVitals

method
public PlayerVitals( float oxygen, float water, float health, float toxicity, bool isDying)

Creates a survival-gauge snapshot.