EOS_Lobby_CreateLobby

EOS API reference page for EOS_Lobby_CreateLobby

This function is part of the Lobby Interface.

Remarks

Creates a lobby and adds the user to the lobby membership. There is no data associated with the lobby at the start and can be added vis EOS_Lobby_UpdateLobbyModification

Return Value

  • EOS_Success if the creation completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_LimitExceeded if the number of allowed lobbies is exceeded

Parameters

Parameter Type And Name

Usage Information

EOS_HLobby Handle

const EOS_Lobby_CreateLobbyOptions* Options

Required fields for the creation of a lobby such as a user count and its starting advertised state

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Lobby_OnCreateLobbyCallback CompletionDelegate

A callback that is fired when the create 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 void* 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.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Lobby_OnCreateLobbyCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_CreateLobby

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_Lobby_CreateLobbyCallbackInfo* Data

A EOS_Lobby_CreateLobby CallbackInfo containing the output information and result

Related API Members