Class LobbyPlayerStore<TPayload>

Namespace

Wyn.Lobby

Assembly

Wyn.Lobby.Runtime.dll

Manages a NetworkList of LobbyPlayerState for lobby-phase synchronization. This is a NetworkBehaviour — attach it to the same NetworkObject as your NetworkManager or a dedicated lobby prefab spawned at session start.

Subclass this with your specific TPayload to use it:

public class MyLobbyPlayerStore : LobbyPlayerStore<MyPayload> { }

public abstract class LobbyPlayerStore<TPayload> : NetworkBehaviour where TPayload : unmanaged, INetworkSerializable, IEquatable<TPayload>

Type Parameters

TPayload

Game-specific player data type.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

NetworkBehaviour

LobbyPlayerStore<TPayload>

Inherited Members

NetworkBehaviour.__rpc_func_table

NetworkBehaviour.__rpc_name_table

NetworkBehaviour.__rpc_exec_stage

NetworkBehaviour.NetworkVariableFields

NetworkBehaviour.__getTypeName()

NetworkBehaviour.__beginSendServerRpc(uint, ServerRpcParams, RpcDelivery)

NetworkBehaviour.__endSendServerRpc(ref FastBufferWriter, uint, ServerRpcParams, RpcDelivery)

NetworkBehaviour.__beginSendClientRpc(uint, ClientRpcParams, RpcDelivery)

NetworkBehaviour.__endSendClientRpc(ref FastBufferWriter, uint, ClientRpcParams, RpcDelivery)

NetworkBehaviour.__beginSendRpc(uint, RpcParams, RpcAttribute.RpcAttributeParams, SendTo, RpcDelivery)

NetworkBehaviour.__endSendRpc(ref FastBufferWriter, uint, RpcParams, RpcAttribute.RpcAttributeParams, SendTo, RpcDelivery)

NetworkBehaviour.__createNativeList<T>()

NetworkBehaviour.GetNetworkBehaviour(ushort)

NetworkBehaviour.OnDeferringDespawn(int)

NetworkBehaviour.OnNetworkPreSpawn(ref NetworkManager)

NetworkBehaviour.OnNetworkPostSpawn()

NetworkBehaviour.InternalOnNetworkPostSpawn()

NetworkBehaviour.OnNetworkSessionSynchronized()

NetworkBehaviour.InternalOnNetworkSessionSynchronized()

NetworkBehaviour.OnInSceneObjectsSpawned()

NetworkBehaviour.OnNetworkPreDespawn()

NetworkBehaviour.OnGainedOwnership()

NetworkBehaviour.OnOwnershipChanged(ulong, ulong)

NetworkBehaviour.OnLostOwnership()

NetworkBehaviour.OnNetworkObjectParentChanged(NetworkObject)

NetworkBehaviour.__initializeVariables()

NetworkBehaviour.__initializeRpcs()

NetworkBehaviour.__registerRpc(uint, NetworkBehaviour.RpcReceiveHandler, string)

NetworkBehaviour.__registerRpc(uint, NetworkBehaviour.RpcReceiveHandler, string, RpcInvokePermission)

NetworkBehaviour.__nameNetworkVariable(NetworkVariableBase, string)

NetworkBehaviour.GetNetworkObject(ulong)

NetworkBehaviour.OnSynchronize<T>(ref BufferSerializer<T>)

NetworkBehaviour.OnReanticipate(double)

NetworkBehaviour.OnDestroy()

NetworkBehaviour.NetworkManager

NetworkBehaviour.RpcTarget

NetworkBehaviour.IsLocalPlayer

NetworkBehaviour.IsOwner

NetworkBehaviour.IsServer

NetworkBehaviour.HasAuthority

NetworkBehaviour.IsSessionOwner

NetworkBehaviour.ServerIsHost

NetworkBehaviour.IsClient

NetworkBehaviour.IsHost

NetworkBehaviour.IsOwnedByServer

NetworkBehaviour.IsSpawned

NetworkBehaviour.NetworkObject

NetworkBehaviour.HasNetworkObject

NetworkBehaviour.NetworkObjectId

NetworkBehaviour.NetworkBehaviourId

NetworkBehaviour.OwnerClientId

NetworkBehaviour.m_TargetIdBeingSynchronized

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

PlayerCount

Number of players currently in the lobby.

public int PlayerCount { get; }

Property Value

int

Players

protected abstract NetworkList<LobbyPlayerState<TPayload>> Players { get; }

Property Value

NetworkList<LobbyPlayerState<TPayload>>

ReadyCount

Number of players who are ready.

public int ReadyCount { get; }

Property Value

int

Methods

CanStartGame(out string)

Check if all players are ready and the game can start. Uses the IPlayerRule if available.

public bool CanStartGame(out string reason)

Parameters

reason string

Returns

bool

GetAllPlayers()

Get a copy of all player states as an array.

public LobbyPlayerState<TPayload>[] GetAllPlayers()

Returns

LobbyPlayerState<TPayload>[]

GetPlayerRule()

Override this to provide a custom rule for payload validation and start conditions. Return null to use default behavior (all players must be ready).

protected virtual IPlayerRule<TPayload> GetPlayerRule()

Returns

IPlayerRule<TPayload>

OnNetworkDespawn()

public override void OnNetworkDespawn()

OnNetworkSpawn()

public override void OnNetworkSpawn()

SetReadyRpc(bool, RpcParams)

[ServerRpc] Set the ready state for the calling player.

[Rpc(SendTo.Server, InvokePermission = RpcInvokePermission.Everyone)]
public void SetReadyRpc(bool isReady, RpcParams rpcParams = default)

Parameters

isReady bool

rpcParams RpcParams

UpdatePayloadRpc(TPayload, RpcParams)

[ServerRpc] Update the payload for the calling player. Override GetPlayerRule() to provide validation logic.

[Rpc(SendTo.Server, InvokePermission = RpcInvokePermission.Everyone)]
public void UpdatePayloadRpc(TPayload payload, RpcParams rpcParams = default)

Parameters

payload TPayload

rpcParams RpcParams

Events

OnPlayersUpdated

Fired when the players list changes. Provides a snapshot array.

public event Action<LobbyPlayerState<TPayload>[]> OnPlayersUpdated

Event Type

Action<LobbyPlayerState<TPayload>[]>