ObjectState

public readonly struct ObjectState : IEquatable<ObjectState>

The saved state of one procedurally placed object: a rock that has been mined, a plant that has been harvested. An object with no entry is untouched, and the game draws it from its seed as it always would. Only objects that differ from that default have an entry (see ChunkState).

Value means whatever the game wants it to mean, such as units left or a growth stage. ExpiresAtUnixMs is an absolute UTC time in Unix milliseconds. When that time passes, the entry is removed and the object is untouched again ("depleted until T"). Nothing runs while the object's chunk is unloaded: the time is compared when the chunk's state is next read or loaded.

Constructors

ObjectState

public ObjectState(uint value, long expiresAtUnixMs = 0, byte[] payload = null);

An entry with a value, an optional expiry and an optional payload of at most ChunkState.MaxPayloadBytes bytes. The payload is copied, so the caller can reuse its array.

Fields

Value

public readonly uint Value;

The game's value for the object.

ExpiresAtUnixMs

public readonly long ExpiresAtUnixMs;

When the entry reverts to untouched, in UTC Unix milliseconds. 0 means it never expires. Use ChunkState.NowUnixMs to compute it, for example ChunkState.NowUnixMs + 600_000 for ten minutes from now.

Properties

Payload

public byte[] Payload { get; }

Extra bytes the game stores with the entry, or an empty array. Treat it as read-only: changing it does not change the stored entry, and it can be shared with the copy that replicated it.

PayloadLength

public int PayloadLength { get; }

Length of Payload in bytes.

Expires

public bool Expires { get; }

Whether the entry has an expiry time.

Methods

IsLiveAt

public bool IsLiveAt(long nowUnixMs);

Whether the entry still applies at nowUnixMs: it never expires, or its expiry time has not passed yet.

Equals

public bool Equals(ObjectState other);
public override bool Equals(object obj);

Compares the value, the expiry time and the payload bytes.

GetHashCode

public override int GetHashCode();

operator ==

public static bool operator ==(ObjectState a, ObjectState b);

Two entries are equal when their value, expiry time and payload bytes are equal.

operator !=

public static bool operator !=(ObjectState a, ObjectState b);

Two entries differ when their value, expiry time or payload bytes differ.

ToString

public override string ToString();