Edit

Share via

Class PlayFabMultiplayer

public class PlayFabMultiplayer

Public Members

name description
PlayFabMultiplayer() The default constructor.
static IsInitialized { get; } Returns true if the library has been initialized.
static LogLevel { get; set; } Gets or sets the amount of logging currently enabled.
const LobbyClientRequestedSearchResultCountUpperLimit The maximum number of search results that client-entity callers may request when performing a FindLobbies operation.
const LobbyMaxLobbyPropertyCount The maximum number of concurrent properties which can be stored for the lobby and which aren't owned by any specific member.
const LobbyMaxMemberCountLowerLimit The minimum allowed value for MaxMemberCount and MaxMemberCount.
const LobbyMaxMemberCountUpperLimit The maximum allowed value for MaxMemberCount and MaxMemberCount.
const LobbyMaxMemberPropertyCount The maximum number of concurrent properties allowed for each member in the lobby.
const LobbyMaxSearchPropertyCount The maximum number of concurrent search properties which can be stored for the lobby.
static event OnAddMemberCompleted Event triggered when a add member is completed.
static event OnError Event triggered when an there is an error calling another API to be used for debugging purposes.
static event OnForceRemoveMemberCompleted Event triggered when a force remove member is completed.
static event OnLobbyCreateAndJoinCompleted Event triggered when a previous call to CreateAndJoinLobby completed.
static event OnLobbyDisconnected Event triggered when a client has disconnected from a lobby.
static event OnLobbyFindLobbiesCompleted Event triggered when the operation started by a previous call to FindLobbies completed.
static event OnLobbyInviteListenerStatusChanged Event triggered when an invite listener's status has changed.
static event OnLobbyInviteReceived Event triggered when an entity on this client has received an invite to a lobby.
static event OnLobbyJoinArrangedLobbyCompleted Event triggered when the operation started by a previous call to JoinArrangedLobby completed.
static event OnLobbyJoinCompleted Event triggered when the operation started by a previous call to JoinLobby completed.
static event OnLobbyLeaveCompleted Event triggered when the operation started by a previous call to Leave completed.
static event OnLobbyMemberAdded Event triggered when a PlayFab entity was added to a lobby as a member.
static event OnLobbyMemberRemoved Event triggered when a PlayFab entity was removed from a lobby as a member.
static event OnLobbyPostUpdateCompleted Event triggered when the operation started by a previous call to PostUpdate completed.
static event OnLobbySendInviteCompleted Event triggered when the operation started by a previous call to SendInvite completed.
static event OnLobbyUpdated Event triggered when the lobby was updated.
static event OnMatchmakingTicketCompleted Event triggered when a matchmaking ticket status has completed
static event OnMatchmakingTicketStatusChanged Event triggered when a matchmaking ticket status has changed.
static CreateAndJoinLobby(…) Create a new lobby and add the creating PlayFab entity to it. (2 methods)
static CreateMatchmakingTicket(…) Creates a matchmaking ticket for one or more local users. (3 methods)
static FindLobbies(…) Search for lobbies on behalf of the local user. (2 methods)
static GetLobbyInviteListenerStatus(…) Retrieve the status of the entity's invite listener. (2 methods)
static Initialize() Initializes an instance of the PlayFab Multiplayer library.
static JoinArrangedLobby(…) Joins a lobby using an arrangement string provided by another service, such as matchmaking. If no one has joined the lobby yet, the lobby is initialized using the configuration parameters. (2 methods)
static JoinLobby(…) Join a lobby as the local PlayFab entity. (2 methods)
static JoinMatchmakingTicketFromId(…) Joins one or more multiple local users to a matchmaking ticket using a ticket ID and queue name. (2 methods)
static ProcessLobbyStateChanges() Triggers all the lobby related PlayFabMultiplayer.OnLobby* events since the last such call.
static ProcessMatchmakingStateChanges() Triggers all the lobby related PlayFabMultiplayer.OnMatchmaking* events since the last such call.
static SetEntityToken(…) Sets the token that should be used for authentication when performing library actions on behalf of an entity. If a token has previously been set for the entity, this replaces its previous token. (2 methods)
static StartListeningForLobbyInvites(…) Enables the Lobby invite listener for a given entity. (2 methods)
static StopListeningForLobbyInvites(…) Disables the Lobby invite listener for a given entity. (2 methods)
static Uninitialize() Immediately reclaims all resources associated with all Multiplayer library objects.
delegate OnAddMemberCompletedHandler Handler for when the operation started by a previous call to AddMember completed
delegate OnErrorEventHandler Handler for when there is an error calling another API to be used for debugging purposes.
delegate OnForceRemoveMemberCompletedHandler Handler for when the operation started by a previous call to ForceRemoveMember completed.
delegate OnLobbyCreateAndJoinCompletedHandler Handler for when the operation started by a previous call to CreateAndJoinLobby completed.
delegate OnLobbyDisconnectedHandler Handler for when the client has disconnected from a lobby.
delegate OnLobbyFindLobbiesCompletedHandler Handler for when the operation started by a previous call to FindLobbies completed.
delegate OnLobbyInviteListenerStatusChangedHandler Handler for when an invite listener's status has changed.
delegate OnLobbyInviteReceivedHandler Handler for when an entity on this client has received an invite to a lobby.
delegate OnLobbyJoinArrangedLobbyCompletedHandler Handler for when the operation started by a previous call to JoinArrangedLobby completed.
delegate OnLobbyJoinCompletedHandler Handler for when the operation started by a previous call to JoinLobby completed.
delegate OnLobbyLeaveCompletedHandler Handler for when the operation started by a previous call to Leave completed.
delegate OnLobbyMemberAddedHandler Handler for when a local PlayFab entity was added to lobby as a member.
delegate OnLobbyMemberRemovedHandler Handler for when a PlayFab entity was removed from a lobby as a member.
delegate OnLobbyPostUpdateCompletedHandler Handler for when the operation started by a previous call to PostUpdate completed.
delegate OnLobbySendInviteCompletedHandler Handler for when the operation started by a previous call to SendInvite completed.
delegate OnLobbyUpdatedHandler Handler for when a lobby was updated.
delegate OnMatchmakingTicketCompletedHandler Handler for when a matchmaking ticket status has changed.
delegate OnMatchmakingTicketStatusChangedHandler Handler for when a matchmaking ticket status has changed.
class PlayFabMultiplayerServer Class for all server lobby functionalities.

See Also

  • Last updated on