1001 lines
58 KiB
C
1001 lines
58 KiB
C
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
#pragma once
|
|
|
|
#include "eos_lobby_types.h"
|
|
|
|
/**
|
|
* The Lobby Interface is used to manage lobbies that provide a persistent connection between users and
|
|
* notifications of data sharing/updates. Lobbies may also be found by advertising and searching with the backend service.
|
|
* All Lobby Interface calls take a handle of type EOS_HLobby as the first parameter.
|
|
* This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetLobbyInterface function.
|
|
*
|
|
* @see EOS_Platform_GetLobbyInterface
|
|
*/
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* If the lobby is successfully created with an RTC Room enabled, the lobby system will automatically join and maintain the connection to the RTC room as long as the
|
|
* local user remains in the lobby. Applications can use the EOS_Lobby_GetRTCRoomName to get the name of the RTC Room associated with a lobby, which may be used with
|
|
* many of the EOS_RTC_* suite of functions. This can be useful to: register for notifications for talking status; to mute or unmute the local user's audio output;
|
|
* to block or unblock room participants; to set local audio device settings; and more.
|
|
*
|
|
* @param Options Required fields for the creation of a lobby such as a user count and its starting advertised state
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the create operation completes, either successfully or in error
|
|
*
|
|
* @return 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
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_CreateLobby(EOS_HLobby Handle, const EOS_Lobby_CreateLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnCreateLobbyCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Destroy a lobby given a lobby ID
|
|
*
|
|
* @param Options Structure containing information about the lobby to be destroyed
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the destroy operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the destroy completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_AlreadyPending if the lobby is already marked for destroy
|
|
* EOS_NotFound if the lobby to be destroyed does not exist
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_DestroyLobby(EOS_HLobby Handle, const EOS_Lobby_DestroyLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnDestroyLobbyCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Join a lobby, creating a local instance under a given lobby ID. Backend will validate various conditions to make sure it is possible to join the lobby.
|
|
*
|
|
* If the lobby is successfully join has an RTC Room enabled, the lobby system will automatically join and maintain the connection to the RTC room as long as the
|
|
* local user remains in the lobby. Applications can use the EOS_Lobby_GetRTCRoomName to get the name of the RTC Room associated with a lobby, which may be used with
|
|
* many of the EOS_RTC_* suite of functions. This can be useful to: register for notifications for talking status; to mute or unmute the local user's audio output;
|
|
* to block or unblock room participants; to set local audio device settings; and more.
|
|
*
|
|
* @param Options Structure containing information about the lobby to be joined
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the join operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the destroy completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_JoinLobby(EOS_HLobby Handle, const EOS_Lobby_JoinLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnJoinLobbyCallback CompletionDelegate);
|
|
|
|
/**
|
|
* This is a special case of EOS_Lobby_JoinLobby. It should only be used if the lobby has had Join-by-ID enabled.
|
|
* Additionally, Join-by-ID should only be enabled to support native invites on an integrated platform.
|
|
*
|
|
* @param Options Structure containing information about the lobby to be joined
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the join operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the destroy completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
*
|
|
* @see EOS_Lobby_JoinLobby
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_JoinLobbyById(EOS_HLobby Handle, const EOS_Lobby_JoinLobbyByIdOptions* Options, void* ClientData, const EOS_Lobby_OnJoinLobbyByIdCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Leave a lobby given a lobby ID
|
|
*
|
|
* If the lobby you are leaving had an RTC Room enabled, leaving the lobby will also automatically leave the RTC room.
|
|
*
|
|
* @param Options Structure containing information about the lobby to be left
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the leave operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the leave completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_AlreadyPending if the lobby is already marked for leave
|
|
* EOS_NotFound if a lobby to be left does not exist
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_LeaveLobby(EOS_HLobby Handle, const EOS_Lobby_LeaveLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnLeaveLobbyCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Creates a lobby modification handle (EOS_HLobbyModification). The lobby modification handle is used to modify an existing lobby and can be applied with EOS_Lobby_UpdateLobby.
|
|
* The EOS_HLobbyModification must be released by calling EOS_LobbyModification_Release once it is no longer needed.
|
|
*
|
|
* @param Options Required fields such as lobby ID
|
|
* @param OutLobbyModificationHandle Pointer to a Lobby Modification Handle only set if successful
|
|
* @return EOS_Success if we successfully created the Lobby Modification Handle pointed at in OutLobbyModificationHandle, or an error result if the input data was invalid
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
*
|
|
* @see EOS_LobbyModification_Release
|
|
* @see EOS_Lobby_UpdateLobby
|
|
* @see EOS_HLobbyModification
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_UpdateLobbyModification(EOS_HLobby Handle, const EOS_Lobby_UpdateLobbyModificationOptions* Options, EOS_HLobbyModification* OutLobbyModificationHandle);
|
|
|
|
/**
|
|
* Update a lobby given a lobby modification handle created by EOS_Lobby_UpdateLobbyModification
|
|
*
|
|
* @param Options Structure containing information about the lobby to be updated
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the update operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the update completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_Lobby_NotOwner if the lobby modification contains modifications that are only allowed by the owner
|
|
* EOS_NotFound if the lobby to update does not exist
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_UpdateLobby(EOS_HLobby Handle, const EOS_Lobby_UpdateLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnUpdateLobbyCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Promote an existing member of the lobby to owner, allowing them to make lobby data modifications
|
|
*
|
|
* @param Options Structure containing information about the lobby and member to be promoted
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the promotion operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the promote completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_Lobby_NotOwner if the calling user is not the owner of the lobby
|
|
* EOS_NotFound if the lobby of interest does not exist
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_PromoteMember(EOS_HLobby Handle, const EOS_Lobby_PromoteMemberOptions* Options, void* ClientData, const EOS_Lobby_OnPromoteMemberCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Kick an existing member from the lobby
|
|
*
|
|
* @param Options Structure containing information about the lobby and member to be kicked
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the kick operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the kick completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_Lobby_NotOwner if the calling user is not the owner of the lobby
|
|
* EOS_NotFound if a lobby of interest does not exist
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_KickMember(EOS_HLobby Handle, const EOS_Lobby_KickMemberOptions* Options, void* ClientData, const EOS_Lobby_OnKickMemberCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Hard mute an existing member in the lobby, can't speak but can hear other members of the lobby
|
|
*
|
|
* @param Options Structure containing information about the lobby and member to be hard muted
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the hard mute operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the hard mute completes successfully
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_Invalid_ProductUserID if a target user is incorrect
|
|
* EOS_NotFound if lobby or target user cannot be found
|
|
* EOS_Lobby_VoiceNotEnabled if lobby has no voice enabled
|
|
* EOS_Lobby_NotOwner if the calling user is not the owner of the lobby
|
|
* EOS_NotFound if a lobby of interest does not exist
|
|
* EOS_AlreadyPending if the user is already marked for hard mute
|
|
* EOS_TooManyRequests if there are too many requests
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_HardMuteMember(EOS_HLobby Handle, const EOS_Lobby_HardMuteMemberOptions* Options, void* ClientData, const EOS_Lobby_OnHardMuteMemberCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Register to receive notifications when a lobby owner updates the attributes associated with the lobby.
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyUpdateReceived when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyUpdateReceived(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyUpdateReceivedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyUpdateReceivedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when a lobby changes its data.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyUpdateReceived(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* Register to receive notifications when a lobby member updates the attributes associated with themselves inside the lobby.
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyMemberUpdateReceived when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyMemberUpdateReceived(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyMemberUpdateReceivedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyMemberUpdateReceivedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when lobby members change their data.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyMemberUpdateReceived(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* Register to receive notifications about the changing status of lobby members.
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyMemberStatusReceived when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyMemberStatusReceived(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyMemberStatusReceivedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyMemberStatusReceivedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when lobby members status change.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyMemberStatusReceived(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* Send an invite to another user. User must be a member of the lobby or else the call will fail
|
|
*
|
|
* @param Options Structure containing information about the lobby and user to invite
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the send invite operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the send invite completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_NotFound if the lobby to send the invite from does not exist
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_SendInvite(EOS_HLobby Handle, const EOS_Lobby_SendInviteOptions* Options, void* ClientData, const EOS_Lobby_OnSendInviteCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Reject an invite from another user.
|
|
*
|
|
* @param Options Structure containing information about the invite to reject
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the reject invite operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the invite rejection completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_NotFound if the invite does not exist
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RejectInvite(EOS_HLobby Handle, const EOS_Lobby_RejectInviteOptions* Options, void* ClientData, const EOS_Lobby_OnRejectInviteCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Retrieve all existing invites for a single user
|
|
*
|
|
* @param Options Structure containing information about the invites to query
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the query invites operation completes, either successfully or in error
|
|
*
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_QueryInvites(EOS_HLobby Handle, const EOS_Lobby_QueryInvitesOptions* Options, void* ClientData, const EOS_Lobby_OnQueryInvitesCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Get the number of known invites for a given user
|
|
*
|
|
* @param Options the Options associated with retrieving the current invite count
|
|
*
|
|
* @return number of known invites for a given user or 0 if there is an error
|
|
*/
|
|
EOS_DECLARE_FUNC(uint32_t) EOS_Lobby_GetInviteCount(EOS_HLobby Handle, const EOS_Lobby_GetInviteCountOptions* Options);
|
|
|
|
/**
|
|
* Retrieve an invite ID from a list of active invites for a given user
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
*
|
|
* @return EOS_Success if the input is valid and an invite ID was returned
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_NotFound if the invite doesn't exist
|
|
*
|
|
* @see EOS_Lobby_GetInviteCount
|
|
* @see EOS_Lobby_CopyLobbyDetailsHandleByInviteId
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_GetInviteIdByIndex(EOS_HLobby Handle, const EOS_Lobby_GetInviteIdByIndexOptions* Options, char* OutBuffer, int32_t* InOutBufferLength);
|
|
|
|
/**
|
|
* Create a lobby search handle. This handle may be modified to include various search parameters.
|
|
* Searching is possible in three methods, all mutually exclusive
|
|
* - set the lobby ID to find a specific lobby
|
|
* - set the target user ID to find a specific user
|
|
* - set lobby parameters to find an array of lobbies that match the search criteria
|
|
*
|
|
* @param Options Structure containing required parameters such as the maximum number of search results
|
|
* @param OutLobbySearchHandle The new search handle or null if there was an error creating the search handle
|
|
*
|
|
* @return EOS_Success if the search creation completes successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_CreateLobbySearch(EOS_HLobby Handle, const EOS_Lobby_CreateLobbySearchOptions* Options, EOS_HLobbySearch* OutLobbySearchHandle);
|
|
|
|
/**
|
|
* Register to receive notifications about lobby invites sent to local users.
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyInviteReceived when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyInviteReceived(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyInviteReceivedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyInviteReceivedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when a user receives a lobby invitation.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyInviteReceived(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* Register to receive notifications about lobby invites accepted by local user via the overlay.
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyInviteAccepted when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyInviteAccepted(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyInviteAcceptedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyInviteAcceptedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyInviteAccepted(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* Register to receive notifications about lobby invites rejected by local user.
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyInviteRejected when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyInviteRejected(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyInviteRejectedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyInviteRejectedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when a user rejects a lobby invitation via the overlay.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyInviteRejected(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* Register to receive notifications about lobby "JOIN" performed by local user (when no invite) via the overlay.
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyJoinLobbyAccepted when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyJoinLobbyAccepted(EOS_HLobby Handle, const EOS_Lobby_AddNotifyJoinLobbyAcceptedOptions* Options, void* ClientData, const EOS_Lobby_OnJoinLobbyAcceptedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyJoinLobbyAccepted(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* Register to receive notifications about a lobby "INVITE" performed by a local user via the overlay.
|
|
* This is only needed when a configured integrated platform has EOS_IPMF_DisableSDKManagedSessions set. The EOS SDK will
|
|
* then use the state of EOS_IPMF_PreferEOSIdentity and EOS_IPMF_PreferIntegratedIdentity to determine when the NotificationFn is
|
|
* called.
|
|
*
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifySendLobbyNativeInviteRequested when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*
|
|
* @see EOS_IPMF_DisableSDKManagedSessions
|
|
* @see EOS_IPMF_PreferEOSIdentity
|
|
* @see EOS_IPMF_PreferIntegratedIdentity
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifySendLobbyNativeInviteRequested(EOS_HLobby Handle, const EOS_Lobby_AddNotifySendLobbyNativeInviteRequestedOptions* Options, void* ClientData, const EOS_Lobby_OnSendLobbyNativeInviteRequestedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when a user requests a send invite via the overlay.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifySendLobbyNativeInviteRequested(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* EOS_Lobby_CopyLobbyDetailsHandleByInviteId is used to immediately retrieve a handle to the lobby information from after notification of an invite
|
|
* If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutLobbyDetailsHandle out parameter used to receive the lobby handle
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
|
|
* EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
* EOS_NotFound If the invite ID cannot be found
|
|
*
|
|
* @see EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions
|
|
* @see EOS_LobbyDetails_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_CopyLobbyDetailsHandleByInviteId(EOS_HLobby Handle, const EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions* Options, EOS_HLobbyDetails* OutLobbyDetailsHandle);
|
|
|
|
/**
|
|
* EOS_Lobby_CopyLobbyDetailsHandleByUiEventId is used to immediately retrieve a handle to the lobby information from after notification of an join game
|
|
* If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutLobbyDetailsHandle out parameter used to receive the lobby handle
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
|
|
* EOS_InvalidParameters if you pass an invalid ui event ID
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
* EOS_NotFound If the invite ID cannot be found
|
|
*
|
|
* @see EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions
|
|
* @see EOS_LobbyDetails_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_CopyLobbyDetailsHandleByUiEventId(EOS_HLobby Handle, const EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions* Options, EOS_HLobbyDetails* OutLobbyDetailsHandle);
|
|
|
|
/**
|
|
* Create a handle to an existing lobby.
|
|
* If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.
|
|
*
|
|
* @param Options Structure containing information about the lobby to retrieve
|
|
* @param OutLobbyDetailsHandle The new active lobby handle or null if there was an error
|
|
*
|
|
* @return EOS_Success if the lobby handle was created successfully
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
* EOS_NotFound if the lobby doesn't exist
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_CopyLobbyDetailsHandle(EOS_HLobby Handle, const EOS_Lobby_CopyLobbyDetailsHandleOptions* Options, EOS_HLobbyDetails* OutLobbyDetailsHandle);
|
|
|
|
/**
|
|
* Get the name of the RTC room associated with a specific lobby a local user belongs to.
|
|
*
|
|
* This value can be used whenever you need a RoomName value in the RTC_* suite of functions. RTC Room Names must not be used with
|
|
* EOS_RTC_JoinRoom, EOS_RTC_LeaveRoom, or EOS_RTC_AddNotifyDisconnected. Doing so will return EOS_AccessDenied or
|
|
* EOS_INVALID_NOTIFICATIONID if used with those functions.
|
|
*
|
|
* This function will only succeed when called on a lobby the local user is currently a member of.
|
|
*
|
|
* @param Options Structure containing information about the RTC room name to retrieve
|
|
* @param OutBuffer The buffer to store the null-terminated room name string within
|
|
* @param InOutBufferLength In: The maximum amount of writable chars in OutBuffer, Out: The minimum amount of chars needed in OutBuffer to store the RTC room name (including the null-terminator)
|
|
*
|
|
* @return EOS_Success if a room exists for the specified lobby, there was enough space in OutBuffer, and the name was written successfully
|
|
* EOS_NotFound if the lobby does not exist
|
|
* EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created
|
|
* EOS_InvalidParameters if you pass a null pointer on invalid length for any of the parameters
|
|
* EOS_LimitExceeded The OutBuffer is not large enough to receive the room name. InOutBufferLength contains the required minimum length to perform the operation successfully.
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_GetRTCRoomName(EOS_HLobby Handle, const EOS_Lobby_GetRTCRoomNameOptions* Options, char* OutBuffer, uint32_t* InOutBufferLength);
|
|
|
|
/**
|
|
* Joins the RTC room associated with a specific lobby a local user belongs to.
|
|
*
|
|
* This function will only succeed when called on a lobby that has the RTC Room feature enabled.
|
|
* Clients may check if the RTC Room feature is enabled by inspecting the value of EOS_LobbyDetails_Info::bRTCRoomEnabled.
|
|
*
|
|
* @param Options Structure containing information about which lobby a local user should join the RTC Room for
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the join RTC Room operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if creation completes succesfully
|
|
* EOS_NotFound if the lobby does not exist
|
|
* EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created
|
|
* EOS_InvalidParameters if you pass a null pointer on invalid length for any of the parameters
|
|
* EOS_NoChange if call does not affect the state of the RTC Room
|
|
* EOS_InvalidState if call to join is made when RTC Room state is not disconnected/disconnecting
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_JoinRTCRoom(EOS_HLobby Handle, const EOS_Lobby_JoinRTCRoomOptions* Options, void* ClientData, const EOS_Lobby_OnJoinRTCRoomCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Leaves the RTC room associated with a specific lobby a local user belongs to.
|
|
*
|
|
* This function will only succeed when called on a lobby that has the RTC Room feature enabled.
|
|
* Clients may check if the RTC Room feature is enabled by inspecting the value of EOS_LobbyDetails_Info::bRTCRoomEnabled.
|
|
*
|
|
* @param Options Structure containing information about which lobby a local user should leave the RTC Room for
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the join RTC Room operation completes, either successfully or in error
|
|
* @return EOS_Success if creation completes succesfully
|
|
* EOS_NotFound if the lobby does not exist
|
|
* EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created
|
|
* EOS_InvalidParameters if you pass a null pointer on invalid length for any of the parameters
|
|
* EOS_NoChange if call does not affect the state of the RTC Room
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_LeaveRTCRoom(EOS_HLobby Handle, const EOS_Lobby_LeaveRTCRoomOptions* Options, void* ClientData, const EOS_Lobby_OnLeaveRTCRoomCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Get the current connection status of the RTC Room for a lobby.
|
|
*
|
|
* The RTC Room connection status is independent of the lobby connection status, however the lobby system will attempt to keep
|
|
* them consistent, automatically connecting to the RTC room after joining a lobby which has an associated RTC room and disconnecting
|
|
* from the RTC room when a lobby is left or disconnected.
|
|
*
|
|
* This function will only succeed when called on a lobby the local user is currently a member of.
|
|
*
|
|
* @param Options Structure containing information about the lobby to query the RTC Room connection status for
|
|
* @param bOutIsConnected If the result is EOS_Success, this will be set to EOS_TRUE if we are connected, or EOS_FALSE if we are not yet connected.
|
|
*
|
|
* @return EOS_Success if we are connected to the specified lobby, the input options and parameters were valid and we were able to write to bOutIsConnected successfully.
|
|
* EOS_NotFound if the lobby doesn't exist
|
|
* EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created
|
|
* EOS_InvalidParameters if bOutIsConnected is NULL, or any other parameters are NULL or invalid
|
|
*
|
|
* @see EOS_Lobby_AddNotifyRTCRoomConnectionChanged
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_IsRTCRoomConnected(EOS_HLobby Handle, const EOS_Lobby_IsRTCRoomConnectedOptions* Options, EOS_Bool* bOutIsConnected);
|
|
|
|
/**
|
|
* Register to receive notifications of when the RTC Room for a particular lobby has a connection status change.
|
|
*
|
|
* The RTC Room connection status is independent of the lobby connection status, however the lobby system will attempt to keep
|
|
* them consistent, automatically connecting to the RTC room after joining a lobby which has an associated RTC room and disconnecting
|
|
* from the RTC room when a lobby is left or disconnected.
|
|
*
|
|
* This notification is entirely informational and requires no action in response by the application. If the connected status is offline
|
|
* (bIsConnected is EOS_FALSE), the connection will automatically attempt to reconnect. The purpose of this notification is to allow
|
|
* applications to show the current connection status of the RTC room when the connection is not established.
|
|
*
|
|
* Unlike EOS_RTC_AddNotifyDisconnected, EOS_RTC_LeaveRoom should not be called when the RTC room is disconnected.
|
|
*
|
|
* This function will only succeed when called on a lobby the local user is currently a member of.
|
|
*
|
|
* @param Options Structure containing information about the lobby to receive updates about
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn The function to call if the RTC Room's connection status changes
|
|
*
|
|
* @return A valid notification ID if the NotificationFn was successfully registered, or EOS_INVALID_NOTIFICATIONID if the input was invalid, the lobby did not exist, or the lobby did not have an RTC room.
|
|
*
|
|
* @see EOS_Lobby_RemoveNotifyRTCRoomConnectionChanged
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyRTCRoomConnectionChanged(EOS_HLobby Handle, const EOS_Lobby_AddNotifyRTCRoomConnectionChangedOptions* Options, void* ClientData, const EOS_Lobby_OnRTCRoomConnectionChangedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when an RTC Room's connection status changes.
|
|
*
|
|
* This should be called when the local user is leaving a lobby.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*
|
|
* @see EOS_Lobby_AddNotifyRTCRoomConnectionChanged
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyRTCRoomConnectionChanged(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* Get the Connection string for an EOS lobby. The connection string describes the presence of a player in terms of game state.
|
|
* Xbox platforms expect titles to embed this into their MultiplayerActivity at creation.
|
|
* When present, the SDK will use this value to populate session presence in the social overlay and facilitate platform invitations.
|
|
*
|
|
* @param Options Structure containing the input parameters. API version, the LobbyID of the lobby to generate the string from and the PUID of the requesting user.
|
|
* @param OutBuffer The buffer to store the null-terminated ConnectString within
|
|
* @param InOutBufferLength In: The maximum amount of writable chars in OutBuffer see EOS_LOBBY_GETCONNECTSTRING_BUFFER_SIZE, Out: The minimum amount of chars needed in OutBuffer to store the ConnectString (including the null-terminator). May be set to zero depending on the error result.
|
|
*
|
|
* @return EOS_Success if retrieving the string was successful.
|
|
* EOS_InvalidParameters if the OutBuffer or InOutBufferLength are null.
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect.
|
|
* EOS_NotFound if no lobby is found matching the LobbyID and PUID provided.
|
|
* EOS_LimitExceeded if the provided InOutBufferLength is too small to contain the resulting string.
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_GetConnectString(EOS_HLobby Handle, const EOS_Lobby_GetConnectStringOptions* Options, char* OutBuffer, uint32_t* InOutBufferLength);
|
|
|
|
/**
|
|
* Parse the ConnectString for an EOS lobby invitation to extract just the lobby ID.
|
|
* Used for joining a lobby from a connection string (as generated by GetConnectString) found in a platform invitation or presence.
|
|
*
|
|
* @param Options Structure containing the input parameters. API version and ConnectString.
|
|
* @param OutBuffer The buffer to store the null-terminated lobby ID within
|
|
* @param InOutBufferLength In: The maximum amount of writable chars in OutBuffer see EOS_LOBBY_PARSECONNECTSTRING_BUFFER_SIZE, Out: The minimum amount of chars needed in OutBuffer to store the LobbyID (including the null-terminator). May be set to zero depending on the error result.
|
|
*
|
|
* @return EOS_Success if retrieving the string was successful.
|
|
* EOS_InvalidParameters if the OutBuffer or InOutBufferLength are null.
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect.
|
|
* EOS_LimitExceeded if the provided InOutBufferLength is too small to contain the resulting string.
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_ParseConnectString(EOS_HLobby Handle, const EOS_Lobby_ParseConnectStringOptions* Options, char* OutBuffer, uint32_t* InOutBufferLength);
|
|
|
|
/**
|
|
* Register to receive notifications about leave lobby requests performed by the local user via the overlay.
|
|
* When user requests to leave the lobby in the social overlay, the SDK does not automatically leave the lobby, it is up to the game to perform any necessary cleanup and call the EOS_Lobby_LeaveLobby method using the lobbyId sent in the notification function.
|
|
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLeaveLobbyRequested when you no longer wish to have your NotificationHandler called.
|
|
*
|
|
* @param Options Structure containing information about the request.
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
|
* @param NotificationFn A callback that is fired when a notification is received.
|
|
*
|
|
* @return handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLeaveLobbyRequested(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLeaveLobbyRequestedOptions* Options, void* ClientData, const EOS_Lobby_OnLeaveLobbyRequestedCallback NotificationFn);
|
|
|
|
/**
|
|
* Unregister from receiving notifications when a user performs a leave lobby action via the overlay.
|
|
*
|
|
* @param InId Handle representing the registered callback
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLeaveLobbyRequested(EOS_HLobby Handle, EOS_NotificationId InId);
|
|
|
|
/**
|
|
* To modify lobbies or the lobby member data, you must call EOS_Lobby_UpdateLobbyModification to create a Lobby Modification handle. To modify that handle, call
|
|
* EOS_HLobbyModification methods. Once you are finished, call EOS_Lobby_UpdateLobby with your handle. You must then release your Lobby Modification
|
|
* handle by calling EOS_LobbyModification_Release.
|
|
*/
|
|
|
|
/**
|
|
* Set the bucket ID associated with this lobby.
|
|
* Values such as region, game mode, etc can be combined here depending on game need.
|
|
* Setting this is strongly recommended to improve search performance.
|
|
*
|
|
* @param Options Options associated with the bucket ID of the lobby
|
|
*
|
|
* @return EOS_Success if setting this parameter was successful
|
|
* EOS_InvalidParameters if the bucket ID is invalid or null
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetBucketId(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetBucketIdOptions* Options);
|
|
|
|
/**
|
|
* Set the permissions associated with this lobby.
|
|
* The permissions range from "public" to "invite only" and are described by EOS_ELobbyPermissionLevel
|
|
*
|
|
* @param Options Options associated with the permission level of the lobby
|
|
*
|
|
* @return EOS_Success if setting this parameter was successful
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetPermissionLevel(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetPermissionLevelOptions* Options);
|
|
|
|
/**
|
|
* Set the maximum number of members allowed in this lobby.
|
|
* When updating the lobby, it is not possible to reduce this number below the current number of existing members
|
|
*
|
|
* @param Options Options associated with max number of members in this lobby
|
|
*
|
|
* @return EOS_Success if setting this parameter was successful
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetMaxMembers(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetMaxMembersOptions* Options);
|
|
|
|
/**
|
|
* Allows enabling or disabling invites for this lobby.
|
|
* The lobby will also need to have `bPresenceEnabled` true.
|
|
*
|
|
* @param Options Options associated with invites allowed flag for this lobby.
|
|
*
|
|
* @return EOS_Success if setting this parameter was successful
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetInvitesAllowed(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetInvitesAllowedOptions* Options);
|
|
|
|
/**
|
|
* Associate an attribute with this lobby
|
|
* An attribute is something may be public or private with the lobby.
|
|
* If public, it can be queried for in a search, otherwise the data remains known only to lobby members
|
|
*
|
|
* @param Options Options to set the attribute and its visibility state
|
|
*
|
|
* @return EOS_Success if setting this parameter was successful
|
|
* EOS_InvalidParameters if the attribute is missing information or otherwise invalid
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_AddAttribute(EOS_HLobbyModification Handle, const EOS_LobbyModification_AddAttributeOptions* Options);
|
|
|
|
/**
|
|
* Remove an attribute associated with the lobby
|
|
*
|
|
* @param Options Specify the key of the attribute to remove
|
|
*
|
|
* @return EOS_Success if removing this parameter was successful
|
|
* EOS_InvalidParameters if the key is null or empty
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_RemoveAttribute(EOS_HLobbyModification Handle, const EOS_LobbyModification_RemoveAttributeOptions* Options);
|
|
|
|
/**
|
|
* Associate an attribute with a member of the lobby
|
|
* Lobby member data is always private to the lobby
|
|
*
|
|
* @param Options Options to set the attribute and its visibility state
|
|
*
|
|
* @return EOS_Success if setting this parameter was successful
|
|
* EOS_InvalidParameters if the attribute is missing information or otherwise invalid
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_AddMemberAttribute(EOS_HLobbyModification Handle, const EOS_LobbyModification_AddMemberAttributeOptions* Options);
|
|
|
|
/**
|
|
* Remove an attribute associated with of member of the lobby
|
|
*
|
|
* @param Options Specify the key of the member attribute to remove
|
|
*
|
|
* @return EOS_Success if removing this parameter was successful
|
|
* EOS_InvalidParameters if the key is null or empty
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_RemoveMemberAttribute(EOS_HLobbyModification Handle, const EOS_LobbyModification_RemoveMemberAttributeOptions* Options);
|
|
|
|
/**
|
|
* Set the Allowed Platform IDs for the lobby
|
|
*
|
|
* @param Options Options associated with allowed Platform IDs for this lobby
|
|
*
|
|
* @return EOS_Success if setting this parameter was successful
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
* EOS_InvalidParameters if the AllowedPlatformIds array is null but the count is 0 or if the count is greater than 0 and the array is null.
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetAllowedPlatformIds(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetAllowedPlatformIdsOptions* Options);
|
|
|
|
#include "eos_lobby_types.h"
|
|
|
|
/**
|
|
* A "read only" representation of an existing lobby that games interact with externally.
|
|
* Both the lobby and lobby search interfaces interface use this common class for lobby management and search results
|
|
*/
|
|
|
|
/**
|
|
* Get the product user ID of the current owner for a given lobby
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
*
|
|
* @return the product user ID for the lobby owner or null if the input parameters are invalid
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_ProductUserId) EOS_LobbyDetails_GetLobbyOwner(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetLobbyOwnerOptions* Options);
|
|
|
|
/**
|
|
* EOS_LobbyDetails_CopyInfo is used to immediately retrieve a copy of lobby information from a given source such as a existing lobby or a search result.
|
|
* If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsInfo, must be passed to EOS_LobbyDetails_Info_Release to release the memory associated with it.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutLobbyDetailsInfo Out parameter used to receive the EOS_LobbyDetails_Info structure.
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutLobbyDetailsInfo
|
|
* EOS_InvalidParameters if you pass a null pointer for the out parameter
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*
|
|
* @see EOS_LobbyDetails_Info
|
|
* @see EOS_LobbyDetails_CopyInfoOptions
|
|
* @see EOS_LobbyDetails_Info_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyInfo(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyInfoOptions* Options, EOS_LobbyDetails_Info ** OutLobbyDetailsInfo);
|
|
|
|
/**
|
|
* EOS_LobbyDetails_CopyMemberInfo is used to immediately retrieve a copy of lobby member information from an existing lobby.
|
|
* If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsMemberInfo, must be passed to EOS_LobbyDetails_MemberInfo_Release to release the memory associated with it.
|
|
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutLobbyDetailsMemberInfo Out parameter used to receive the EOS_LobbyDetails_Info structure.
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutLobbyMemberDetailsInfo
|
|
* EOS_InvalidParameters if you pass a null pointer for the out parameter
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
* EOS_NotFound if searching for a target user ID returns no results
|
|
*
|
|
* @see EOS_LobbyDetails_MemberInfo
|
|
* @see EOS_LobbyDetails_CopyMemberInfoOptions
|
|
* @see EOS_LobbyDetails_MemberInfo_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyMemberInfo(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyMemberInfoOptions* Options, EOS_LobbyDetails_MemberInfo ** OutLobbyDetailsMemberInfo);
|
|
|
|
/**
|
|
* Get the number of attributes associated with this lobby
|
|
*
|
|
* @param Options the Options associated with retrieving the attribute count
|
|
*
|
|
* @return number of attributes on the lobby or 0 if there is an error
|
|
*/
|
|
EOS_DECLARE_FUNC(uint32_t) EOS_LobbyDetails_GetAttributeCount(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetAttributeCountOptions* Options);
|
|
|
|
/**
|
|
* EOS_LobbyDetails_CopyAttributeByIndex is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result.
|
|
* If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutAttribute Out parameter used to receive the EOS_Lobby_Attribute structure.
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutAttribute
|
|
* EOS_InvalidParameters if you pass a null pointer for the out parameter
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*
|
|
* @see EOS_Lobby_Attribute
|
|
* @see EOS_LobbyDetails_CopyAttributeByIndexOptions
|
|
* @see EOS_Lobby_Attribute_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyAttributeByIndex(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyAttributeByIndexOptions* Options, EOS_Lobby_Attribute ** OutAttribute);
|
|
|
|
/**
|
|
* EOS_LobbyDetails_CopyAttributeByKey is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result.
|
|
* If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutAttribute Out parameter used to receive the EOS_Lobby_Attribute structure.
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutAttribute
|
|
* EOS_InvalidParameters if you pass a null pointer for the out parameter
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*
|
|
* @see EOS_Lobby_Attribute
|
|
* @see EOS_LobbyDetails_CopyAttributeByKeyOptions
|
|
* @see EOS_Lobby_Attribute_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyAttributeByKey(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyAttributeByKeyOptions* Options, EOS_Lobby_Attribute ** OutAttribute);
|
|
|
|
/**
|
|
* Get the number of members associated with this lobby
|
|
*
|
|
* @param Options the Options associated with retrieving the member count
|
|
*
|
|
* @return number of members in the existing lobby or 0 if there is an error
|
|
*/
|
|
EOS_DECLARE_FUNC(uint32_t) EOS_LobbyDetails_GetMemberCount(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetMemberCountOptions* Options);
|
|
|
|
/**
|
|
* EOS_LobbyDetails_GetMemberByIndex is used to immediately retrieve individual members registered with a lobby.
|
|
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
*
|
|
* @return the product user ID for the registered member at a given index or null if that index is invalid
|
|
*
|
|
* @see EOS_LobbyDetails_GetMemberCount
|
|
* @see EOS_LobbyDetails_GetMemberByIndexOptions
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_ProductUserId) EOS_LobbyDetails_GetMemberByIndex(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetMemberByIndexOptions* Options);
|
|
|
|
/**
|
|
* EOS_LobbyDetails_GetMemberAttributeCount is used to immediately retrieve the attribute count for members in a lobby.
|
|
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
*
|
|
* @return the number of attributes associated with a given lobby member or 0 if that member is invalid
|
|
*
|
|
* @see EOS_LobbyDetails_GetMemberCount
|
|
* @see EOS_LobbyDetails_GetMemberAttributeCountOptions
|
|
*/
|
|
EOS_DECLARE_FUNC(uint32_t) EOS_LobbyDetails_GetMemberAttributeCount(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetMemberAttributeCountOptions* Options);
|
|
|
|
/**
|
|
* EOS_LobbyDetails_CopyMemberAttributeByIndex is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.
|
|
* If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.
|
|
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutAttribute Out parameter used to receive the EOS_Lobby_Attribute structure.
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutAttribute
|
|
* EOS_InvalidParameters if you pass a null pointer for the out parameter
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*
|
|
* @see EOS_Lobby_Attribute
|
|
* @see EOS_LobbyDetails_CopyMemberAttributeByIndexOptions
|
|
* @see EOS_Lobby_Attribute_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyMemberAttributeByIndex(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyMemberAttributeByIndexOptions* Options, EOS_Lobby_Attribute ** OutAttribute);
|
|
|
|
/**
|
|
* EOS_LobbyDetails_CopyMemberAttributeByKey is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.
|
|
* If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.
|
|
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutAttribute Out parameter used to receive the EOS_Lobby_Attribute structure.
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutAttribute
|
|
* EOS_InvalidParameters if you pass a null pointer for the out parameter
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*
|
|
* @see EOS_Lobby_Attribute
|
|
* @see EOS_LobbyDetails_CopyMemberAttributeByKeyOptions
|
|
* @see EOS_Lobby_Attribute_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyMemberAttributeByKey(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyMemberAttributeByKeyOptions* Options, EOS_Lobby_Attribute ** OutAttribute);
|
|
|
|
#include "eos_lobby_types.h"
|
|
|
|
/**
|
|
* Class responsible for the creation, setup, and execution of a search query.
|
|
* Search parameters are defined, the query is executed and the search results are returned within this object
|
|
*/
|
|
|
|
/**
|
|
* Find lobbies matching the search criteria setup via this lobby search handle.
|
|
* When the operation completes, this handle will have the search results that can be parsed
|
|
*
|
|
* @param Options Structure containing information about the search criteria to use
|
|
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
|
* @param CompletionDelegate A callback that is fired when the search operation completes, either successfully or in error
|
|
*
|
|
* @return EOS_Success if the find operation completes successfully
|
|
* EOS_NotFound if searching for an individual lobby by lobby ID or target user ID returns no results
|
|
* EOS_InvalidParameters if any of the options are incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(void) EOS_LobbySearch_Find(EOS_HLobbySearch Handle, const EOS_LobbySearch_FindOptions* Options, void* ClientData, const EOS_LobbySearch_OnFindCallback CompletionDelegate);
|
|
|
|
/**
|
|
* Set a lobby ID to find and will return at most one search result. Setting TargetUserId or SearchParameters will result in EOS_LobbySearch_Find failing
|
|
*
|
|
* @param Options A specific lobby ID for which to search
|
|
*
|
|
* @return EOS_Success if setting this lobby ID was successful
|
|
* EOS_InvalidParameters if the lobby ID is invalid or null
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_SetLobbyId(EOS_HLobbySearch Handle, const EOS_LobbySearch_SetLobbyIdOptions* Options);
|
|
|
|
/**
|
|
* Set a target user ID to find. Setting LobbyId or SearchParameters will result in EOS_LobbySearch_Find failing
|
|
* @note a search result will only be found if this user is in a public lobby
|
|
*
|
|
* @param Options a specific target user ID to find
|
|
*
|
|
* @return EOS_Success if setting this target user ID was successful
|
|
* EOS_InvalidParameters if the target user ID is invalid or null
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_SetTargetUserId(EOS_HLobbySearch Handle, const EOS_LobbySearch_SetTargetUserIdOptions* Options);
|
|
|
|
/**
|
|
* Add a parameter to an array of search criteria combined via an implicit AND operator. Setting LobbyId or TargetUserId will result in EOS_LobbySearch_Find failing
|
|
*
|
|
* @param Options a search parameter and its comparison op
|
|
*
|
|
* @return EOS_Success if setting this search parameter was successful
|
|
* EOS_InvalidParameters if the search criteria is invalid or null
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*
|
|
* @see EOS_Lobby_AttributeData
|
|
* @see EOS_EComparisonOp
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_SetParameter(EOS_HLobbySearch Handle, const EOS_LobbySearch_SetParameterOptions* Options);
|
|
|
|
/**
|
|
* Remove a parameter from the array of search criteria.
|
|
*
|
|
* @params Options a search parameter key name to remove
|
|
*
|
|
* @return EOS_Success if removing this search parameter was successful
|
|
* EOS_InvalidParameters if the search key is invalid or null
|
|
* EOS_NotFound if the parameter was not a part of the search criteria
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_RemoveParameter(EOS_HLobbySearch Handle, const EOS_LobbySearch_RemoveParameterOptions* Options);
|
|
|
|
/**
|
|
* Set the maximum number of search results to return in the query, can't be more than EOS_LOBBY_MAX_SEARCH_RESULTS
|
|
*
|
|
* @param Options maximum number of search results to return in the query
|
|
*
|
|
* @return EOS_Success if setting the max results was successful
|
|
* EOS_InvalidParameters if the number of results requested is invalid
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_SetMaxResults(EOS_HLobbySearch Handle, const EOS_LobbySearch_SetMaxResultsOptions* Options);
|
|
|
|
/**
|
|
* Get the number of search results found by the search parameters in this search
|
|
*
|
|
* @param Options Options associated with the search count
|
|
*
|
|
* @return return the number of search results found by the query or 0 if search is not complete
|
|
*/
|
|
EOS_DECLARE_FUNC(uint32_t) EOS_LobbySearch_GetSearchResultCount(EOS_HLobbySearch Handle, const EOS_LobbySearch_GetSearchResultCountOptions* Options);
|
|
|
|
/**
|
|
* EOS_LobbySearch_CopySearchResultByIndex is used to immediately retrieve a handle to the lobby information from a given search result.
|
|
* If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.
|
|
*
|
|
* @param Options Structure containing the input parameters
|
|
* @param OutLobbyDetailsHandle out parameter used to receive the lobby details handle
|
|
*
|
|
* @return EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
|
|
* EOS_InvalidParameters if you pass an invalid index or a null pointer for the out parameter
|
|
* EOS_IncompatibleVersion if the API version passed in is incorrect
|
|
*
|
|
* @see EOS_LobbySearch_CopySearchResultByIndexOptions
|
|
* @see EOS_LobbyDetails_Release
|
|
*/
|
|
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_CopySearchResultByIndex(EOS_HLobbySearch Handle, const EOS_LobbySearch_CopySearchResultByIndexOptions* Options, EOS_HLobbyDetails* OutLobbyDetailsHandle);
|