Class ZoneState

Namespace

Valheim.Testing.Game

Assembly

Valheim.Testing.Game.dll

One zone as the client holds it: its terrain, the object instances in it and the saved objects that have none.

public sealed record ZoneState

Inheritance

object

ZoneState

Constructors

ZoneState(ZoneId, bool, bool, int, int, int, int)

One zone as the client holds it: its terrain, the object instances in it and the saved objects that have none.

public ZoneState(ZoneId Zone, bool TerrainLoaded, bool AreaReady, int Instances, int NearInstances, int Saved, int WithoutInstance)

Parameters

Zone ZoneId

TerrainLoaded bool

AreaReady bool

Whether the game considers this zone and its neighbouring saved objects ready.

Instances int

Object instances whose position is in the zone, distant ones included.

NearInstances int

Those not marked distant: while any is there, the game keeps the zone's terrain.

Saved int

Saved objects of known prefabs that this client holds for the zone.

WithoutInstance int

Of those, the ones not instantiated.

Properties

AreaReady

Whether the game considers this zone and its neighbouring saved objects ready.

public bool AreaReady { get; init; }

Property Value

bool

Instances

Object instances whose position is in the zone, distant ones included.

public int Instances { get; init; }

Property Value

int

Loaded

The terrain is loaded and every saved object of a known prefab has its instance.

public bool Loaded { get; }

Property Value

bool

NearInstances

Those not marked distant: while any is there, the game keeps the zone's terrain.

public int NearInstances { get; init; }

Property Value

int

Saved

Saved objects of known prefabs that this client holds for the zone.

public int Saved { get; init; }

Property Value

int

TerrainLoaded

public bool TerrainLoaded { get; init; }

Property Value

bool

Unloaded

Nothing of the zone is in the scene: no terrain and no object instance, distant ones included.

public bool Unloaded { get; }

Property Value

bool

WithoutInstance

Of those, the ones not instantiated.

public int WithoutInstance { get; init; }

Property Value

int

Zone

public ZoneId Zone { get; init; }

Property Value

ZoneId

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.