This function is part of the Sessions Interface.
Unregister a group of players with the session, freeing up space for others to join
{Result.NoChange} if the players to unregister were not found
{Result.InvalidParameters} if any of the options are incorrect
{Result.SessionsOutOfSync} if the session is out of sync and will be updated on the next connection with the backend
{Result.NotFound} if a session to be unregister players does not exist
Return Value
{Result.Success} if the unregister completes successfully
Parameters
Sessions.SessionsInterface.UnregisterPlayers
Parameter Type And Name
|
Usage Information
|
UnregisterPlayersOptions options
|
Structure containing information about the session and players to be unregistered
|
object clientData
|
Arbitrary data that is passed back to you in the CompletionDelegate
|
OnUnregisterPlayersCallback completionDelegate
|
A callback that is fired when the unregistration operation completes, either successfully or in error
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate
parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object
parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type Sessions.OnUnregisterPlayersCallback to report the results of its operation.
Function prototype definition for callbacks passed to {SessionsInterface.UnregisterPlayers}
Callback Parameters
Sessions.OnUnregisterPlayersCallback
Parameter Type And Name
|
Usage Information
|
UnregisterPlayersCallbackInfo data
|
A EOS_Sessions_UnregisterPlayersCallbackInfo containing the output information and result
|