Class WorldPlayerRegistry

Namespace

Shard.Gameplay.Universe.Players

Assembly

Shard.Gameplay.Universe.dll

Owns committed Player registrations and safe avatar access for one loaded World.

public sealed class WorldPlayerRegistry

Inheritance

object

WorldPlayerRegistry

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Count

Gets the number of Players with usable committed membership in this World.

public int Count { get; }

Property Value

int

Remarks

Counts current registrations on demand, so use it for reporting rather than work performed each tick.

Methods

ForEachAvatarAsync(PlayerAvatarAction)

Runs one synchronous avatar callback for each currently usable Player in this World.

public ValueTask ForEachAvatarAsync(PlayerAvatarAction action)

Parameters

action PlayerAvatarAction

Returns

ValueTask

Remarks

The committed membership snapshot is queued as one World operation. Each registration is checked again on the World thread, so a revoked membership is skipped and a retired Store cannot be used. The callback must not retain its Store or avatar Entity.

Snapshot()

Gets a materialized snapshot of the Players committed to this World.

public IReadOnlyList<Player> Snapshot()

Returns

IReadOnlyList<Player>

Remarks

The snapshot is detached from later roster changes. A returned Player may disconnect after the snapshot is created, so use ForEachAvatarAsync(PlayerAvatarAction) for avatar work.

TryGet(Guid, out Player?)

Resolves the Player committed to this World at the instant of lookup.

public bool TryGet(Guid playerId, out Player? player)

Parameters

playerId Guid

player Player

Returns

bool

Remarks

The returned Player may disconnect after lookup. Use Player.InCurrentWorldAsync for avatar work.