Skip to content
Version 2.11.0
↓ Get the launcher

IPlayerStats interface

Read-only access to live player attribute values. Each tracked attribute is identified by its Zproto.EAttrType integer code (e.g. 11011 for AttrStrengthTotal). Pair with GetAttribute to resolve the localized label and GetAttributeProfile to discover the UI group. Attributes must be Subscribed before they are sampled. The probe polls only subscribed IDs each Game.Update tick — sampling all 1289 EAttrType members per frame would be wasteful. Unsubscribed IDs return null.

public interface IPlayerStats
name description
IsAvailable { get; } True once a character is loaded and the entity probe is bootstrapped.
Subscribe(…) Adds an attribute ID to the polled set. Idempotent.
TryGetAttribute(…) Returns the latest sampled value for attrId, or null if the ID is not subscribed or the player isn’t loaded. Value type is long regardless of storage size — the probe handles int/long memoization internally.
Unsubscribe(…) Removes an attribute ID from the polled set.