Upload folder using huggingface_hub (part 11)
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- .gitattributes +1 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Linux/eos_Linux.h +8 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Linux/eos_Linux_base.h +8 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Mac/eos_Mac.h +3 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Mac/eos_Mac_base.h +8 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Windows/eos_Windows.h +22 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Windows/eos_Windows_base.h +8 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_achievements.h +291 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_achievements_types.h +397 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_achievements_types_deprecated.inl +189 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatclient.h +335 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatclient_types.h +414 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatclient_types_deprecated.inl +26 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatcommon_types.h +631 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatserver.h +417 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatserver_types.h +250 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_auth.h +243 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_auth_types.h +727 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_auth_types_deprecated.inl +22 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_base.h +149 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_common.h +554 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_connect.h +472 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_connect_types.h +802 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_custominvites.h +314 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_custominvites_types.h +484 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_ecom.h +565 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_ecom_types.h +1178 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_friends.h +166 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_friends_types.h +369 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_init.h +161 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_integratedplatform.h +134 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_integratedplatform_types.h +384 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_kws.h +167 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_kws_types.h +310 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_leaderboards.h +187 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_leaderboards_types.h +378 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_leaderboards_types_deprecated.inl +16 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_lobby.h +1120 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_lobby_types.h +1827 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_logging.h +92 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_logging_categories.h +95 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_metrics.h +41 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_metrics_types.h +89 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_mods.h +83 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_mods_types.h +247 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_p2p.h +391 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_p2p_types.h +604 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_platform_prereqs.h +63 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_playerdatastorage.h +190 -0
- Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_playerdatastorage_types.h +484 -0
.gitattributes
CHANGED
|
@@ -54,3 +54,4 @@
|
|
| 54 |
Content/Vehicles/SportsCar/SM_SportsCar.FBX filter=lfs diff=lfs merge=lfs -text
|
| 55 |
Content/Vehicles/SportsCar/SM_SportsCar_Wheel.FBX filter=lfs diff=lfs merge=lfs -text
|
| 56 |
Plugins/EOS/Resources/AudioTests/AudioTestBundle.oodle filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
| 54 |
Content/Vehicles/SportsCar/SM_SportsCar.FBX filter=lfs diff=lfs merge=lfs -text
|
| 55 |
Content/Vehicles/SportsCar/SM_SportsCar_Wheel.FBX filter=lfs diff=lfs merge=lfs -text
|
| 56 |
Plugins/EOS/Resources/AudioTests/AudioTestBundle.oodle filter=lfs diff=lfs merge=lfs -text
|
| 57 |
+
Plugins/librime/Source/ThirdParty/rime-33e7814-Windows-msvc-x64/share/rime-data/opencc/STPhrases.ocd2 filter=lfs diff=lfs merge=lfs -text
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Linux/eos_Linux.h
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
/********************************************************************
|
| 6 |
+
* Provided to allow EOS_BUILD_PLATFORM_NAME to be defined even for
|
| 7 |
+
* platforms that do not require it when using eos_platform_prereqs.h
|
| 8 |
+
********************************************************************/
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Linux/eos_Linux_base.h
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
/********************************************************************
|
| 6 |
+
* Provided to allow EOS_BUILD_PLATFORM_NAME to be defined even for
|
| 7 |
+
* platforms that do not require it when using eos_platform_prereqs.h
|
| 8 |
+
********************************************************************/
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Mac/eos_Mac.h
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Mac/eos_Mac_base.h
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
/********************************************************************
|
| 6 |
+
* Provided to allow EOS_BUILD_PLATFORM_NAME to be defined even for
|
| 7 |
+
* platforms that do not require it when using eos_platform_prereqs.h
|
| 8 |
+
********************************************************************/
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Windows/eos_Windows.h
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_types.h"
|
| 5 |
+
|
| 6 |
+
#pragma pack(push, 8)
|
| 7 |
+
|
| 8 |
+
/** The most recent version of the EOS_Windows_RTCOptions structure. */
|
| 9 |
+
#define EOS_WINDOWS_RTCOPTIONS_API_LATEST 1
|
| 10 |
+
|
| 11 |
+
/**
|
| 12 |
+
* Options for initializing rtc functionality required for some platforms.
|
| 13 |
+
*/
|
| 14 |
+
EOS_STRUCT(EOS_Windows_RTCOptions, (
|
| 15 |
+
/** API Version: Set this to EOS_WINDOWS_RTCOPTIONS_API_LATEST. */
|
| 16 |
+
int32_t ApiVersion;
|
| 17 |
+
|
| 18 |
+
/** The absolute path to a `xaudio2_9redist.dll` dependency, including the file name. */
|
| 19 |
+
const char* XAudio29DllPath;
|
| 20 |
+
));
|
| 21 |
+
|
| 22 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/Windows/eos_Windows_base.h
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
/********************************************************************
|
| 6 |
+
* Provided to allow EOS_BUILD_PLATFORM_NAME to be defined even for
|
| 7 |
+
* platforms that do not require it when using eos_platform_prereqs.h
|
| 8 |
+
********************************************************************/
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_achievements.h
ADDED
|
@@ -0,0 +1,291 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_achievements_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The following EOS_Achievements_* functions allow you to query existing achievement definitions that have been defined for your application.
|
| 8 |
+
* You can also query achievement progress data for users.
|
| 9 |
+
* In addition, you can also unlock one or more achievements directly.
|
| 10 |
+
* You can also receive notifications when achievements are unlocked.
|
| 11 |
+
*/
|
| 12 |
+
|
| 13 |
+
/**
|
| 14 |
+
* Query for a list of definitions for all existing achievements, including localized text, icon IDs and whether an achievement is hidden.
|
| 15 |
+
*
|
| 16 |
+
* @note When the Social Overlay is enabled then this will be called automatically. The Social Overlay is enabled by default (see EOS_PF_DISABLE_SOCIAL_OVERLAY).
|
| 17 |
+
*
|
| 18 |
+
* @param Options Structure containing information about the application whose achievement definitions we're retrieving.
|
| 19 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 20 |
+
* @param CompletionDelegate This function is called when the query definitions operation completes.
|
| 21 |
+
*
|
| 22 |
+
* @see EOS_Achievements_QueryDefinitionsOptions
|
| 23 |
+
* @see EOS_Achievements_OnQueryDefinitionsCompleteCallback
|
| 24 |
+
*/
|
| 25 |
+
EOS_DECLARE_FUNC(void) EOS_Achievements_QueryDefinitions(EOS_HAchievements Handle, const EOS_Achievements_QueryDefinitionsOptions* Options, void* ClientData, const EOS_Achievements_OnQueryDefinitionsCompleteCallback CompletionDelegate);
|
| 26 |
+
|
| 27 |
+
/**
|
| 28 |
+
* Fetch the number of achievement definitions that are cached locally.
|
| 29 |
+
*
|
| 30 |
+
* @param Options The Options associated with retrieving the achievement definition count
|
| 31 |
+
*
|
| 32 |
+
* @see EOS_Achievements_GetAchievementDefinitionCountOptions
|
| 33 |
+
* @see EOS_Achievements_CopyAchievementDefinitionByIndex
|
| 34 |
+
*
|
| 35 |
+
* @return Number of achievement definitions or 0 if there is an error
|
| 36 |
+
*/
|
| 37 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Achievements_GetAchievementDefinitionCount(EOS_HAchievements Handle, const EOS_Achievements_GetAchievementDefinitionCountOptions* Options);
|
| 38 |
+
|
| 39 |
+
/**
|
| 40 |
+
* Fetches an achievement definition from a given index.
|
| 41 |
+
*
|
| 42 |
+
* @param Options Structure containing the index being accessed
|
| 43 |
+
* @param OutDefinition The achievement definition for the given index, if it exists and is valid, use EOS_Achievements_Definition_Release when finished
|
| 44 |
+
*
|
| 45 |
+
* @see EOS_Achievements_CopyAchievementDefinitionV2ByIndexOptions
|
| 46 |
+
* @see EOS_Achievements_DefinitionV2
|
| 47 |
+
* @see EOS_Achievements_DefinitionV2_Release
|
| 48 |
+
*
|
| 49 |
+
* @return EOS_EResult containing the result of the operation.
|
| 50 |
+
* Possible result codes:
|
| 51 |
+
* - EOS_Success if the information is available and passed out in OutDefinition
|
| 52 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 53 |
+
* - EOS_NotFound if the achievement definition is not found
|
| 54 |
+
* - EOS_Invalid_ProductUserID if any of the userid options are incorrect
|
| 55 |
+
*/
|
| 56 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Achievements_CopyAchievementDefinitionV2ByIndex(EOS_HAchievements Handle, const EOS_Achievements_CopyAchievementDefinitionV2ByIndexOptions* Options, EOS_Achievements_DefinitionV2 ** OutDefinition);
|
| 57 |
+
|
| 58 |
+
/**
|
| 59 |
+
* Fetches an achievement definition from a given achievement ID.
|
| 60 |
+
*
|
| 61 |
+
* @param Options Structure containing the achievement ID being accessed
|
| 62 |
+
* @param OutDefinition The achievement definition for the given achievement ID, if it exists and is valid, use EOS_Achievements_Definition_Release when finished
|
| 63 |
+
*
|
| 64 |
+
* @see EOS_Achievements_CopyAchievementDefinitionV2ByAchievementIdOptions
|
| 65 |
+
* @see EOS_Achievements_DefinitionV2
|
| 66 |
+
* @see EOS_Achievements_DefinitionV2_Release
|
| 67 |
+
*
|
| 68 |
+
* @return EOS_EResult containing the result of the operation.
|
| 69 |
+
* Possible result codes:
|
| 70 |
+
* - EOS_Success if the information is available and passed out in OutDefinition
|
| 71 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 72 |
+
* - EOS_NotFound if the achievement definition is not found
|
| 73 |
+
* - EOS_Invalid_ProductUserID if any of the userid options are incorrect
|
| 74 |
+
*/
|
| 75 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId(EOS_HAchievements Handle, const EOS_Achievements_CopyAchievementDefinitionV2ByAchievementIdOptions* Options, EOS_Achievements_DefinitionV2 ** OutDefinition);
|
| 76 |
+
|
| 77 |
+
/**
|
| 78 |
+
* Query for a list of achievements for a specific player, including progress towards completion for each achievement.
|
| 79 |
+
* Note: By default, this query will not return locked hidden achievements. To return all achievements, call EOS_Achievements_QueryDefinitions first.
|
| 80 |
+
*
|
| 81 |
+
* @note When the Social Overlay is enabled then this will be called automatically. The Social Overlay is enabled by default (see EOS_PF_DISABLE_SOCIAL_OVERLAY).
|
| 82 |
+
*
|
| 83 |
+
* @param Options Structure containing information about the player whose achievements we're retrieving.
|
| 84 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 85 |
+
* @param CompletionDelegate This function is called when the query player achievements operation completes.
|
| 86 |
+
*
|
| 87 |
+
* @see EOS_Achievements_QueryPlayerAchievementsOptions
|
| 88 |
+
* @see EOS_Achievements_OnQueryPlayerAchievementsCompleteCallback
|
| 89 |
+
*/
|
| 90 |
+
EOS_DECLARE_FUNC(void) EOS_Achievements_QueryPlayerAchievements(EOS_HAchievements Handle, const EOS_Achievements_QueryPlayerAchievementsOptions* Options, void* ClientData, const EOS_Achievements_OnQueryPlayerAchievementsCompleteCallback CompletionDelegate);
|
| 91 |
+
|
| 92 |
+
/**
|
| 93 |
+
* Fetch the number of player achievements that are cached locally.
|
| 94 |
+
*
|
| 95 |
+
* @param Options The Options associated with retrieving the player achievement count
|
| 96 |
+
*
|
| 97 |
+
* @see EOS_Achievements_GetPlayerAchievementCountOptions
|
| 98 |
+
* @see EOS_Achievements_CopyPlayerAchievementByIndex
|
| 99 |
+
*
|
| 100 |
+
* @return Number of player achievements or 0 if there is an error
|
| 101 |
+
*/
|
| 102 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Achievements_GetPlayerAchievementCount(EOS_HAchievements Handle, const EOS_Achievements_GetPlayerAchievementCountOptions* Options);
|
| 103 |
+
|
| 104 |
+
/**
|
| 105 |
+
* Fetches a player achievement from a given index.
|
| 106 |
+
*
|
| 107 |
+
* @param Options Structure containing the Product User ID and index being accessed
|
| 108 |
+
* @param OutAchievement The player achievement data for the given index, if it exists and is valid, use EOS_Achievements_PlayerAchievement_Release when finished
|
| 109 |
+
*
|
| 110 |
+
* @see EOS_Achievements_CopyPlayerAchievementByIndexOptions
|
| 111 |
+
* @see EOS_Achievements_PlayerAchievement
|
| 112 |
+
* @see EOS_Achievements_PlayerAchievement_Release
|
| 113 |
+
*
|
| 114 |
+
* @return EOS_EResult containing the result of the operation.
|
| 115 |
+
* Possible result codes:
|
| 116 |
+
* - EOS_Success if the information is available and passed out in OutAchievement
|
| 117 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 118 |
+
* - EOS_NotFound if the player achievement is not found
|
| 119 |
+
* - EOS_Invalid_ProductUserID if you pass an invalid user ID
|
| 120 |
+
*/
|
| 121 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Achievements_CopyPlayerAchievementByIndex(EOS_HAchievements Handle, const EOS_Achievements_CopyPlayerAchievementByIndexOptions* Options, EOS_Achievements_PlayerAchievement ** OutAchievement);
|
| 122 |
+
|
| 123 |
+
/**
|
| 124 |
+
* Fetches a player achievement from a given achievement ID.
|
| 125 |
+
*
|
| 126 |
+
* @param Options Structure containing the Product User ID and achievement ID being accessed
|
| 127 |
+
* @param OutAchievement The player achievement data for the given achievement ID, if it exists and is valid, use EOS_Achievements_PlayerAchievement_Release when finished
|
| 128 |
+
*
|
| 129 |
+
* @see EOS_Achievements_CopyPlayerAchievementByAchievementIdOptions
|
| 130 |
+
* @see EOS_Achievements_PlayerAchievement
|
| 131 |
+
* @see EOS_Achievements_PlayerAchievement_Release
|
| 132 |
+
*
|
| 133 |
+
* @return EOS_EResult containing the result of the operation.
|
| 134 |
+
* Possible result codes:
|
| 135 |
+
* - EOS_Success if the information is available and passed out in OutAchievement
|
| 136 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 137 |
+
* - EOS_NotFound if the player achievement is not found
|
| 138 |
+
* - EOS_Invalid_ProductUserID if you pass an invalid user ID
|
| 139 |
+
*/
|
| 140 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Achievements_CopyPlayerAchievementByAchievementId(EOS_HAchievements Handle, const EOS_Achievements_CopyPlayerAchievementByAchievementIdOptions* Options, EOS_Achievements_PlayerAchievement ** OutAchievement);
|
| 141 |
+
|
| 142 |
+
/**
|
| 143 |
+
* Unlocks a number of achievements for a specific player.
|
| 144 |
+
*
|
| 145 |
+
* @param Options Structure containing information about the achievements and the player whose achievements we're unlocking.
|
| 146 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 147 |
+
* @param CompletionDelegate This function is called when the unlock achievements operation completes.
|
| 148 |
+
*
|
| 149 |
+
* @see EOS_Achievements_UnlockAchievementsOptions
|
| 150 |
+
* @see EOS_Achievements_OnUnlockAchievementsCompleteCallback
|
| 151 |
+
*/
|
| 152 |
+
EOS_DECLARE_FUNC(void) EOS_Achievements_UnlockAchievements(EOS_HAchievements Handle, const EOS_Achievements_UnlockAchievementsOptions* Options, void* ClientData, const EOS_Achievements_OnUnlockAchievementsCompleteCallback CompletionDelegate);
|
| 153 |
+
|
| 154 |
+
/**
|
| 155 |
+
* Register to receive achievement unlocked notifications.
|
| 156 |
+
* @note If the returned NotificationId is valid, you must call EOS_Achievements_RemoveNotifyAchievementsUnlocked when you no longer wish to have your NotificationHandler called.
|
| 157 |
+
*
|
| 158 |
+
* @see EOS_Achievements_AddNotifyAchievementsUnlockedV2Options
|
| 159 |
+
* @see EOS_Achievements_OnAchievementsUnlockedCallbackV2
|
| 160 |
+
* @see EOS_Achievements_RemoveNotifyAchievementsUnlocked
|
| 161 |
+
*
|
| 162 |
+
* @param Options Structure containing information about the achievement unlocked notification
|
| 163 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 164 |
+
* @param NotificationFn A callback that is fired when an achievement unlocked notification for a user has been received
|
| 165 |
+
*
|
| 166 |
+
* @return handle representing the registered callback
|
| 167 |
+
*/
|
| 168 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Achievements_AddNotifyAchievementsUnlockedV2(EOS_HAchievements Handle, const EOS_Achievements_AddNotifyAchievementsUnlockedV2Options* Options, void* ClientData, const EOS_Achievements_OnAchievementsUnlockedCallbackV2 NotificationFn);
|
| 169 |
+
|
| 170 |
+
/**
|
| 171 |
+
* Unregister from receiving achievement unlocked notifications.
|
| 172 |
+
*
|
| 173 |
+
* @see EOS_Achievements_AddNotifyAchievementsUnlocked
|
| 174 |
+
*
|
| 175 |
+
* @param InId Handle representing the registered callback
|
| 176 |
+
*/
|
| 177 |
+
EOS_DECLARE_FUNC(void) EOS_Achievements_RemoveNotifyAchievementsUnlocked(EOS_HAchievements Handle, EOS_NotificationId InId);
|
| 178 |
+
|
| 179 |
+
/**
|
| 180 |
+
* DEPRECATED! Use EOS_Achievements_CopyAchievementDefinitionV2ByIndex instead.
|
| 181 |
+
*
|
| 182 |
+
* Fetches an achievement definition from a given index.
|
| 183 |
+
*
|
| 184 |
+
* @param Options Structure containing the index being accessed
|
| 185 |
+
* @param OutDefinition The achievement definition for the given index, if it exists and is valid, use EOS_Achievements_Definition_Release when finished
|
| 186 |
+
*
|
| 187 |
+
* @see EOS_Achievements_CopyAchievementDefinitionByIndexOptions
|
| 188 |
+
* @see EOS_Achievements_Definition
|
| 189 |
+
* @see EOS_Achievements_CopyAchievementDefinitionV2ByIndex
|
| 190 |
+
* @see EOS_Achievements_Definition_Release
|
| 191 |
+
*
|
| 192 |
+
* @return EOS_EResult containing the result of the operation.
|
| 193 |
+
* Possible result codes:
|
| 194 |
+
* - EOS_Success if the information is available and passed out in OutDefinition
|
| 195 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 196 |
+
* - EOS_NotFound if the achievement definition is not found
|
| 197 |
+
*/
|
| 198 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Achievements_CopyAchievementDefinitionByIndex(EOS_HAchievements Handle, const EOS_Achievements_CopyAchievementDefinitionByIndexOptions* Options, EOS_Achievements_Definition ** OutDefinition);
|
| 199 |
+
|
| 200 |
+
/**
|
| 201 |
+
* DEPRECATED! Use EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId instead.
|
| 202 |
+
*
|
| 203 |
+
* Fetches an achievement definition from a given achievement ID.
|
| 204 |
+
*
|
| 205 |
+
* @param Options Structure containing the achievement ID being accessed
|
| 206 |
+
* @param OutDefinition The achievement definition for the given achievement ID, if it exists and is valid, use EOS_Achievements_Definition_Release when finished
|
| 207 |
+
*
|
| 208 |
+
* @see EOS_Achievements_CopyAchievementDefinitionByAchievementIdOptions
|
| 209 |
+
* @see EOS_Achievements_Definition
|
| 210 |
+
* @see EOS_Achievements_Definition_Release
|
| 211 |
+
* @see EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId
|
| 212 |
+
*
|
| 213 |
+
* @return EOS_EResult containing the result of the operation.
|
| 214 |
+
* Possible result codes:
|
| 215 |
+
* - EOS_Success if the information is available and passed out in OutDefinition
|
| 216 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 217 |
+
* - EOS_NotFound if the achievement definition is not found
|
| 218 |
+
*/
|
| 219 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Achievements_CopyAchievementDefinitionByAchievementId(EOS_HAchievements Handle, const EOS_Achievements_CopyAchievementDefinitionByAchievementIdOptions* Options, EOS_Achievements_Definition ** OutDefinition);
|
| 220 |
+
|
| 221 |
+
/**
|
| 222 |
+
* DEPRECATED! Use EOS_Achievements_GetPlayerAchievementCount, EOS_Achievements_CopyPlayerAchievementByIndex and filter for unlocked instead.
|
| 223 |
+
*
|
| 224 |
+
* Fetch the number of unlocked achievements that are cached locally.
|
| 225 |
+
*
|
| 226 |
+
* @param Options The Options associated with retrieving the unlocked achievement count
|
| 227 |
+
*
|
| 228 |
+
* @see EOS_Achievements_GetUnlockedAchievementCountOptions
|
| 229 |
+
* @see EOS_Achievements_CopyUnlockedAchievementByIndex
|
| 230 |
+
*
|
| 231 |
+
* @return Number of unlocked achievements or 0 if there is an error
|
| 232 |
+
*/
|
| 233 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Achievements_GetUnlockedAchievementCount(EOS_HAchievements Handle, const EOS_Achievements_GetUnlockedAchievementCountOptions* Options);
|
| 234 |
+
|
| 235 |
+
/**
|
| 236 |
+
* DEPRECATED! Use EOS_Achievements_CopyPlayerAchievementByAchievementId instead.
|
| 237 |
+
*
|
| 238 |
+
* Fetches an unlocked achievement from a given index.
|
| 239 |
+
*
|
| 240 |
+
* @param Options Structure containing the Product User ID and index being accessed
|
| 241 |
+
* @param OutAchievement The unlocked achievement data for the given index, if it exists and is valid, use EOS_Achievements_UnlockedAchievement_Release when finished
|
| 242 |
+
*
|
| 243 |
+
* @see EOS_Achievements_CopyUnlockedAchievementByIndexOptions
|
| 244 |
+
* @see EOS_Achievements_UnlockedAchievement
|
| 245 |
+
* @see EOS_Achievements_UnlockedAchievement_Release
|
| 246 |
+
*
|
| 247 |
+
* @return EOS_EResult containing the result of the operation.
|
| 248 |
+
* Possible result codes:
|
| 249 |
+
* - EOS_Success if the information is available and passed out in OutAchievement
|
| 250 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 251 |
+
* - EOS_NotFound if the unlocked achievement is not found
|
| 252 |
+
*/
|
| 253 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Achievements_CopyUnlockedAchievementByIndex(EOS_HAchievements Handle, const EOS_Achievements_CopyUnlockedAchievementByIndexOptions* Options, EOS_Achievements_UnlockedAchievement ** OutAchievement);
|
| 254 |
+
|
| 255 |
+
/**
|
| 256 |
+
* DEPRECATED! Use EOS_Achievements_CopyPlayerAchievementByAchievementId instead.
|
| 257 |
+
*
|
| 258 |
+
* Fetches an unlocked achievement from a given achievement ID.
|
| 259 |
+
*
|
| 260 |
+
* @param Options Structure containing the Product User ID and achievement ID being accessed
|
| 261 |
+
* @param OutAchievement The unlocked achievement data for the given achievement ID, if it exists and is valid, use EOS_Achievements_UnlockedAchievement_Release when finished
|
| 262 |
+
*
|
| 263 |
+
* @see EOS_Achievements_CopyUnlockedAchievementByAchievementIdOptions
|
| 264 |
+
* @see EOS_Achievements_UnlockedAchievement
|
| 265 |
+
* @see EOS_Achievements_UnlockedAchievement_Release
|
| 266 |
+
*
|
| 267 |
+
* @return EOS_EResult containing the result of the operation.
|
| 268 |
+
* Possible result codes:
|
| 269 |
+
* - EOS_Success if the information is available and passed out in OutAchievement
|
| 270 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 271 |
+
* - EOS_NotFound if the unlocked achievement is not found
|
| 272 |
+
*/
|
| 273 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Achievements_CopyUnlockedAchievementByAchievementId(EOS_HAchievements Handle, const EOS_Achievements_CopyUnlockedAchievementByAchievementIdOptions* Options, EOS_Achievements_UnlockedAchievement ** OutAchievement);
|
| 274 |
+
|
| 275 |
+
/**
|
| 276 |
+
* DEPRECATED! Use EOS_Achievements_AddNotifyAchievementsUnlockedV2 instead.
|
| 277 |
+
*
|
| 278 |
+
* Register to receive achievement unlocked notifications.
|
| 279 |
+
* @note If the returned NotificationId is valid, you must call EOS_Achievements_RemoveNotifyAchievementsUnlocked when you no longer wish to have your NotificationHandler called.
|
| 280 |
+
*
|
| 281 |
+
* @see EOS_Achievements_AddNotifyAchievementsUnlockedOptions
|
| 282 |
+
* @see EOS_Achievements_OnAchievementsUnlockedCallback
|
| 283 |
+
* @see EOS_Achievements_RemoveNotifyAchievementsUnlocked
|
| 284 |
+
*
|
| 285 |
+
* @param Options Structure containing information about the achievement unlocked notification
|
| 286 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 287 |
+
* @param NotificationFn A callback that is fired when an achievement unlocked notification for a user has been received
|
| 288 |
+
*
|
| 289 |
+
* @return handle representing the registered callback
|
| 290 |
+
*/
|
| 291 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Achievements_AddNotifyAchievementsUnlocked(EOS_HAchievements Handle, const EOS_Achievements_AddNotifyAchievementsUnlockedOptions* Options, void* ClientData, const EOS_Achievements_OnAchievementsUnlockedCallback NotificationFn);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_achievements_types.h
ADDED
|
@@ -0,0 +1,397 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
EOS_EXTERN_C typedef struct EOS_AchievementsHandle* EOS_HAchievements;
|
| 10 |
+
|
| 11 |
+
/** The most recent version of the EOS_Achievements_QueryDefinitions struct. */
|
| 12 |
+
#define EOS_ACHIEVEMENTS_QUERYDEFINITIONS_API_LATEST 3
|
| 13 |
+
|
| 14 |
+
/**
|
| 15 |
+
* Input parameters for the EOS_Achievements_QueryDefinitions function.
|
| 16 |
+
*/
|
| 17 |
+
EOS_STRUCT(EOS_Achievements_QueryDefinitionsOptions, (
|
| 18 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_QUERYDEFINITIONS_API_LATEST. */
|
| 19 |
+
int32_t ApiVersion;
|
| 20 |
+
/**
|
| 21 |
+
* Product User ID for user who is querying definitions.
|
| 22 |
+
* The localized text returned will be based on the locale code of the given user if they have a linked Epic Account ID.
|
| 23 |
+
* The localized text returned can also be overridden using EOS_Platform_SetOverrideLocaleCode to override the locale.
|
| 24 |
+
* If the locale code is not overridden and LocalUserId is not valid, default text will be returned.
|
| 25 |
+
*/
|
| 26 |
+
EOS_ProductUserId LocalUserId;
|
| 27 |
+
/** Deprecated */
|
| 28 |
+
EOS_EpicAccountId EpicUserId_DEPRECATED;
|
| 29 |
+
/** Deprecated */
|
| 30 |
+
const char** HiddenAchievementIds_DEPRECATED;
|
| 31 |
+
/** Deprecated */
|
| 32 |
+
uint32_t HiddenAchievementsCount_DEPRECATED;
|
| 33 |
+
));
|
| 34 |
+
|
| 35 |
+
/** The most recent version of the EOS_Achievements_StatThresholds struct. */
|
| 36 |
+
#define EOS_ACHIEVEMENTS_STATTHRESHOLDS_API_LATEST 1
|
| 37 |
+
|
| 38 |
+
/** DEPRECATED! Use EOS_ACHIEVEMENTS_STATTHRESHOLDS_API_LATEST instead. */
|
| 39 |
+
#define EOS_ACHIEVEMENTS_STATTHRESHOLD_API_LATEST EOS_ACHIEVEMENTS_STATTHRESHOLDS_API_LATEST
|
| 40 |
+
|
| 41 |
+
/**
|
| 42 |
+
* Contains information about a collection of stat threshold data.
|
| 43 |
+
*
|
| 44 |
+
* The threshold will depend on the stat aggregate type:
|
| 45 |
+
* LATEST (Tracks the latest value)
|
| 46 |
+
* MAX (Tracks the maximum value)
|
| 47 |
+
* MIN (Tracks the minimum value)
|
| 48 |
+
* SUM (Generates a rolling sum of the value)
|
| 49 |
+
*
|
| 50 |
+
* @see EOS_Achievements_Definition
|
| 51 |
+
*/
|
| 52 |
+
EOS_STRUCT(EOS_Achievements_StatThresholds, (
|
| 53 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_STATTHRESHOLDS_API_LATEST. */
|
| 54 |
+
int32_t ApiVersion;
|
| 55 |
+
/** The name of the stat. */
|
| 56 |
+
const char* Name;
|
| 57 |
+
/** The value that the stat must surpass to satisfy the requirement for unlocking an achievement. */
|
| 58 |
+
int32_t Threshold;
|
| 59 |
+
));
|
| 60 |
+
|
| 61 |
+
/** The most recent version of the EOS_Achievements_PlayerStatInfo struct. */
|
| 62 |
+
#define EOS_ACHIEVEMENTS_PLAYERSTATINFO_API_LATEST 1
|
| 63 |
+
|
| 64 |
+
/**
|
| 65 |
+
* Contains information about a collection of stat info data.
|
| 66 |
+
*
|
| 67 |
+
* @see EOS_Achievements_PlayerAchievement
|
| 68 |
+
*/
|
| 69 |
+
EOS_STRUCT(EOS_Achievements_PlayerStatInfo, (
|
| 70 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_PLAYERSTATINFO_API_LATEST. */
|
| 71 |
+
int32_t ApiVersion;
|
| 72 |
+
/** The name of the stat. */
|
| 73 |
+
const char* Name;
|
| 74 |
+
/** The current value of the stat. */
|
| 75 |
+
int32_t CurrentValue;
|
| 76 |
+
/** The threshold value of the stat, used in determining when to unlock an achievement. */
|
| 77 |
+
int32_t ThresholdValue;
|
| 78 |
+
));
|
| 79 |
+
|
| 80 |
+
/** The most recent version of the EOS_Achievements_DefinitionV2 struct. */
|
| 81 |
+
#define EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST 2
|
| 82 |
+
|
| 83 |
+
/**
|
| 84 |
+
* Contains information about a single achievement definition with localized text.
|
| 85 |
+
*/
|
| 86 |
+
EOS_STRUCT(EOS_Achievements_DefinitionV2, (
|
| 87 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST. */
|
| 88 |
+
int32_t ApiVersion;
|
| 89 |
+
/** Achievement ID that can be used to uniquely identify the achievement. */
|
| 90 |
+
const char* AchievementId;
|
| 91 |
+
/** Localized display name for the achievement when it has been unlocked. */
|
| 92 |
+
const char* UnlockedDisplayName;
|
| 93 |
+
/** Localized description for the achievement when it has been unlocked. */
|
| 94 |
+
const char* UnlockedDescription;
|
| 95 |
+
/** Localized display name for the achievement when it is locked or hidden. */
|
| 96 |
+
const char* LockedDisplayName;
|
| 97 |
+
/** Localized description for the achievement when it is locked or hidden. */
|
| 98 |
+
const char* LockedDescription;
|
| 99 |
+
/** Localized flavor text that can be used by the game in an arbitrary manner. This may be null if there is no data configured in the dev portal. */
|
| 100 |
+
const char* FlavorText;
|
| 101 |
+
/** URL of an icon to display for the achievement when it is unlocked. This may be null if there is no data configured in the dev portal. */
|
| 102 |
+
const char* UnlockedIconURL;
|
| 103 |
+
/** URL of an icon to display for the achievement when it is locked or hidden. This may be null if there is no data configured in the dev portal. */
|
| 104 |
+
const char* LockedIconURL;
|
| 105 |
+
/** EOS_TRUE if the achievement is hidden; EOS_FALSE otherwise. */
|
| 106 |
+
EOS_Bool bIsHidden;
|
| 107 |
+
/** The number of stat thresholds used to monitor progress towards this achievement. */
|
| 108 |
+
uint32_t StatThresholdsCount;
|
| 109 |
+
/** Array of `EOS_Achievements_StatThresholds` that need to be satisfied to unlock this achievement. Consists of Name and Threshold Value. */
|
| 110 |
+
const EOS_Achievements_StatThresholds* StatThresholds;
|
| 111 |
+
));
|
| 112 |
+
|
| 113 |
+
/**
|
| 114 |
+
* Release the memory associated with EOS_Achievements_DefinitionV2. This must be called on data retrieved from
|
| 115 |
+
* EOS_Achievements_CopyAchievementDefinitionV2ByIndex or EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId.
|
| 116 |
+
*
|
| 117 |
+
* @param AchievementDefinition - The achievement definition to release.
|
| 118 |
+
*
|
| 119 |
+
* @see EOS_Achievements_DefinitionV2
|
| 120 |
+
* @see EOS_Achievements_CopyAchievementDefinitionV2ByIndex
|
| 121 |
+
* @see EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId
|
| 122 |
+
*/
|
| 123 |
+
EOS_DECLARE_FUNC(void) EOS_Achievements_DefinitionV2_Release(EOS_Achievements_DefinitionV2* AchievementDefinition);
|
| 124 |
+
|
| 125 |
+
|
| 126 |
+
/** The most recent version of the EOS_Achievements_GetAchievementDefinitionCount API. */
|
| 127 |
+
#define EOS_ACHIEVEMENTS_GETACHIEVEMENTDEFINITIONCOUNT_API_LATEST 1
|
| 128 |
+
|
| 129 |
+
/**
|
| 130 |
+
* Input parameters for the EOS_Achievements_GetAchievementDefinitionCount function.
|
| 131 |
+
*/
|
| 132 |
+
EOS_STRUCT(EOS_Achievements_GetAchievementDefinitionCountOptions, (
|
| 133 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_GETACHIEVEMENTDEFINITIONCOUNT_API_LATEST. */
|
| 134 |
+
int32_t ApiVersion;
|
| 135 |
+
));
|
| 136 |
+
|
| 137 |
+
/** The most recent version of the EOS_Achievements_CopyAchievementDefinitionByIndexOptions struct. */
|
| 138 |
+
#define EOS_ACHIEVEMENTS_COPYACHIEVEMENTDEFINITIONV2BYINDEX_API_LATEST 2
|
| 139 |
+
|
| 140 |
+
/** DEPRECATED! Use EOS_ACHIEVEMENTS_COPYACHIEVEMENTDEFINITIONV2BYINDEX_API_LATEST instead. */
|
| 141 |
+
#define EOS_ACHIEVEMENTS_COPYDEFINITIONV2BYINDEX_API_LATEST EOS_ACHIEVEMENTS_COPYACHIEVEMENTDEFINITIONV2BYINDEX_API_LATEST
|
| 142 |
+
|
| 143 |
+
/**
|
| 144 |
+
* Input parameters for the EOS_Achievements_CopyAchievementDefinitionByIndex function.
|
| 145 |
+
*/
|
| 146 |
+
EOS_STRUCT(EOS_Achievements_CopyAchievementDefinitionV2ByIndexOptions, (
|
| 147 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_COPYACHIEVEMENTDEFINITIONV2BYINDEX_API_LATEST. */
|
| 148 |
+
int32_t ApiVersion;
|
| 149 |
+
/** Index of the achievement definition to retrieve from the cache. */
|
| 150 |
+
uint32_t AchievementIndex;
|
| 151 |
+
));
|
| 152 |
+
|
| 153 |
+
/** The most recent version of the EOS_Achievements_CopyAchievementDefinitionV2ByAchievementIdOptions struct. */
|
| 154 |
+
#define EOS_ACHIEVEMENTS_COPYACHIEVEMENTDEFINITIONV2BYACHIEVEMENTID_API_LATEST 2
|
| 155 |
+
|
| 156 |
+
/** DEPRECATED! Use EOS_ACHIEVEMENTS_COPYACHIEVEMENTDEFINITIONV2BYACHIEVEMENTID_API_LATEST instead. */
|
| 157 |
+
#define EOS_ACHIEVEMENTS_COPYDEFINITIONV2BYACHIEVEMENTID_API_LATEST EOS_ACHIEVEMENTS_COPYACHIEVEMENTDEFINITIONV2BYACHIEVEMENTID_API_LATEST
|
| 158 |
+
|
| 159 |
+
/**
|
| 160 |
+
* Input parameters for the EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId function.
|
| 161 |
+
*/
|
| 162 |
+
EOS_STRUCT(EOS_Achievements_CopyAchievementDefinitionV2ByAchievementIdOptions, (
|
| 163 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_COPYACHIEVEMENTDEFINITIONV2BYACHIEVEMENTID_API_LATEST. */
|
| 164 |
+
int32_t ApiVersion;
|
| 165 |
+
/** Achievement ID to look for when copying the definition from the cache. */
|
| 166 |
+
const char* AchievementId;
|
| 167 |
+
));
|
| 168 |
+
|
| 169 |
+
/**
|
| 170 |
+
* Data containing the result information for a query definitions request.
|
| 171 |
+
*/
|
| 172 |
+
EOS_STRUCT(EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo, (
|
| 173 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 174 |
+
EOS_EResult ResultCode;
|
| 175 |
+
/** User-defined context that was passed into EOS_Achievements_QueryDefinitions. */
|
| 176 |
+
void* ClientData;
|
| 177 |
+
));
|
| 178 |
+
|
| 179 |
+
/**
|
| 180 |
+
* Function prototype definition for callbacks passed to EOS_Achievements_QueryDefinitions
|
| 181 |
+
* @param Data An EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo containing the output information and result
|
| 182 |
+
*/
|
| 183 |
+
EOS_DECLARE_CALLBACK(EOS_Achievements_OnQueryDefinitionsCompleteCallback, const EOS_Achievements_OnQueryDefinitionsCompleteCallbackInfo* Data);
|
| 184 |
+
|
| 185 |
+
|
| 186 |
+
/** The most recent version of the EOS_Achievements_QueryPlayerAchievements struct. */
|
| 187 |
+
#define EOS_ACHIEVEMENTS_QUERYPLAYERACHIEVEMENTS_API_LATEST 2
|
| 188 |
+
|
| 189 |
+
/**
|
| 190 |
+
* Input parameters for the EOS_Achievements_QueryPlayerAchievements function.
|
| 191 |
+
*/
|
| 192 |
+
EOS_STRUCT(EOS_Achievements_QueryPlayerAchievementsOptions, (
|
| 193 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_QUERYPLAYERACHIEVEMENTS_API_LATEST. */
|
| 194 |
+
int32_t ApiVersion;
|
| 195 |
+
/** The Product User ID for the user whose achievements are to be retrieved. */
|
| 196 |
+
EOS_ProductUserId TargetUserId;
|
| 197 |
+
/** The Product User ID for the user who is querying for player achievements. For a Dedicated Server this should be null. */
|
| 198 |
+
EOS_ProductUserId LocalUserId;
|
| 199 |
+
));
|
| 200 |
+
|
| 201 |
+
/** Timestamp value representing an undefined UnlockTime for EOS_Achievements_PlayerAchievement and EOS_Achievements_UnlockedAchievement */
|
| 202 |
+
#define EOS_ACHIEVEMENTS_ACHIEVEMENT_UNLOCKTIME_UNDEFINED -1
|
| 203 |
+
|
| 204 |
+
/** The most recent version of the EOS_Achievements_PlayerAchievement struct. */
|
| 205 |
+
#define EOS_ACHIEVEMENTS_PLAYERACHIEVEMENT_API_LATEST 2
|
| 206 |
+
|
| 207 |
+
/**
|
| 208 |
+
* Contains information about a single player achievement.
|
| 209 |
+
*/
|
| 210 |
+
EOS_STRUCT(EOS_Achievements_PlayerAchievement, (
|
| 211 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_PLAYERACHIEVEMENT_API_LATEST. */
|
| 212 |
+
int32_t ApiVersion;
|
| 213 |
+
/** This achievement's unique identifier. */
|
| 214 |
+
const char* AchievementId;
|
| 215 |
+
/** Progress towards completing this achievement (as a percentage). */
|
| 216 |
+
double Progress;
|
| 217 |
+
/** The POSIX timestamp when the achievement was unlocked. If the achievement has not been unlocked, this value will be EOS_ACHIEVEMENTS_ACHIEVEMENT_UNLOCKTIME_UNDEFINED. */
|
| 218 |
+
int64_t UnlockTime;
|
| 219 |
+
/** The number of player stat info entries associated with this achievement. */
|
| 220 |
+
int32_t StatInfoCount;
|
| 221 |
+
/** Array of EOS_Achievements_PlayerStatInfo structures containing information about stat thresholds used to unlock the achievement and the player's current values for those stats. */
|
| 222 |
+
const EOS_Achievements_PlayerStatInfo* StatInfo;
|
| 223 |
+
/**
|
| 224 |
+
* Localized display name for the achievement based on this specific player's current progress on the achievement.
|
| 225 |
+
* @note The current progress is updated when EOS_Achievements_QueryPlayerAchievements succeeds and when an achievement is unlocked.
|
| 226 |
+
*/
|
| 227 |
+
const char* DisplayName;
|
| 228 |
+
/**
|
| 229 |
+
* Localized description for the achievement based on this specific player's current progress on the achievement.
|
| 230 |
+
* @note The current progress is updated when EOS_Achievements_QueryPlayerAchievements succeeds and when an achievement is unlocked.
|
| 231 |
+
*/
|
| 232 |
+
const char* Description;
|
| 233 |
+
/**
|
| 234 |
+
* URL of an icon to display for the achievement based on this specific player's current progress on the achievement. This may be null if there is no data configured in the dev portal.
|
| 235 |
+
* @note The current progress is updated when EOS_Achievements_QueryPlayerAchievements succeeds and when an achievement is unlocked.
|
| 236 |
+
*/
|
| 237 |
+
const char* IconURL;
|
| 238 |
+
/** Localized flavor text that can be used by the game in an arbitrary manner. This may be null if there is no data configured in the dev portal. */
|
| 239 |
+
const char* FlavorText;
|
| 240 |
+
));
|
| 241 |
+
|
| 242 |
+
/** The most recent version of the EOS_Achievements_GetPlayerAchievementCount API. */
|
| 243 |
+
#define EOS_ACHIEVEMENTS_GETPLAYERACHIEVEMENTCOUNT_API_LATEST 1
|
| 244 |
+
|
| 245 |
+
/**
|
| 246 |
+
* Input parameters for the EOS_Achievements_GetPlayerAchievementCount function.
|
| 247 |
+
*/
|
| 248 |
+
EOS_STRUCT(EOS_Achievements_GetPlayerAchievementCountOptions, (
|
| 249 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_GETPLAYERACHIEVEMENTCOUNT_API_LATEST. */
|
| 250 |
+
int32_t ApiVersion;
|
| 251 |
+
/** The Product User ID for the user whose achievement count is being retrieved. */
|
| 252 |
+
EOS_ProductUserId UserId;
|
| 253 |
+
));
|
| 254 |
+
|
| 255 |
+
/** The most recent version of the EOS_Achievements_CopyPlayerAchievementByIndexOptions struct. */
|
| 256 |
+
#define EOS_ACHIEVEMENTS_COPYPLAYERACHIEVEMENTBYINDEX_API_LATEST 2
|
| 257 |
+
|
| 258 |
+
/**
|
| 259 |
+
* Input parameters for the EOS_Achievements_CopyPlayerAchievementByIndex function.
|
| 260 |
+
*/
|
| 261 |
+
EOS_STRUCT(EOS_Achievements_CopyPlayerAchievementByIndexOptions, (
|
| 262 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_COPYPLAYERACHIEVEMENTBYINDEX_API_LATEST. */
|
| 263 |
+
int32_t ApiVersion;
|
| 264 |
+
/** The Product User ID for the user whose achievement is to be retrieved. */
|
| 265 |
+
EOS_ProductUserId TargetUserId;
|
| 266 |
+
/** The index of the player achievement data to retrieve from the cache. */
|
| 267 |
+
uint32_t AchievementIndex;
|
| 268 |
+
/** The Product User ID for the user who is querying for a player achievement. For a Dedicated Server this should be null. */
|
| 269 |
+
EOS_ProductUserId LocalUserId;
|
| 270 |
+
));
|
| 271 |
+
|
| 272 |
+
/** The most recent version of the EOS_Achievements_CopyPlayerAchievementByAchievementIdOptions struct. */
|
| 273 |
+
#define EOS_ACHIEVEMENTS_COPYPLAYERACHIEVEMENTBYACHIEVEMENTID_API_LATEST 2
|
| 274 |
+
|
| 275 |
+
/**
|
| 276 |
+
* Input parameters for the EOS_Achievements_CopyPlayerAchievementByAchievementId function.
|
| 277 |
+
*/
|
| 278 |
+
EOS_STRUCT(EOS_Achievements_CopyPlayerAchievementByAchievementIdOptions, (
|
| 279 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_COPYPLAYERACHIEVEMENTBYACHIEVEMENTID_API_LATEST. */
|
| 280 |
+
int32_t ApiVersion;
|
| 281 |
+
/** The Product User ID for the user whose achievement is to be retrieved. */
|
| 282 |
+
EOS_ProductUserId TargetUserId;
|
| 283 |
+
/** Achievement ID to search for when retrieving player achievement data from the cache. */
|
| 284 |
+
const char* AchievementId;
|
| 285 |
+
/** The Product User ID for the user who is querying for a player achievement. For a Dedicated Server this should be null. */
|
| 286 |
+
EOS_ProductUserId LocalUserId;
|
| 287 |
+
));
|
| 288 |
+
|
| 289 |
+
/**
|
| 290 |
+
* Release the memory associated with a player achievement. This must be called on data retrieved from
|
| 291 |
+
* EOS_Achievements_CopyPlayerAchievementByIndex or EOS_Achievements_CopyPlayerAchievementByAchievementId.
|
| 292 |
+
*
|
| 293 |
+
* @param Achievement - The achievement data to release.
|
| 294 |
+
*
|
| 295 |
+
* @see EOS_Achievements_PlayerAchievement
|
| 296 |
+
* @see EOS_Achievements_CopyPlayerAchievementByIndex
|
| 297 |
+
* @see EOS_Achievements_CopyPlayerAchievementByAchievementId
|
| 298 |
+
*/
|
| 299 |
+
EOS_DECLARE_FUNC(void) EOS_Achievements_PlayerAchievement_Release(EOS_Achievements_PlayerAchievement* Achievement);
|
| 300 |
+
|
| 301 |
+
/**
|
| 302 |
+
* Data containing the result information for querying a player's achievements request.
|
| 303 |
+
*/
|
| 304 |
+
EOS_STRUCT(EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo, (
|
| 305 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 306 |
+
EOS_EResult ResultCode;
|
| 307 |
+
/** Context that was passed into EOS_Achievements_QueryPlayerAchievements. */
|
| 308 |
+
void* ClientData;
|
| 309 |
+
/** The Product User ID whose achievements were retrieved. */
|
| 310 |
+
EOS_ProductUserId TargetUserId;
|
| 311 |
+
/** The Product User ID of the user who initiated this request. For a Dedicated Server this should be null. */
|
| 312 |
+
EOS_ProductUserId LocalUserId;
|
| 313 |
+
));
|
| 314 |
+
|
| 315 |
+
/**
|
| 316 |
+
* Function prototype definition for callbacks passed to EOS_Achievements_QueryPlayerAchievements
|
| 317 |
+
*
|
| 318 |
+
* @param Data An EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo containing the output information and result
|
| 319 |
+
*
|
| 320 |
+
* @see EOS_Achievements_PlayerAchievement_Release
|
| 321 |
+
*/
|
| 322 |
+
EOS_DECLARE_CALLBACK(EOS_Achievements_OnQueryPlayerAchievementsCompleteCallback, const EOS_Achievements_OnQueryPlayerAchievementsCompleteCallbackInfo* Data);
|
| 323 |
+
|
| 324 |
+
|
| 325 |
+
/** The most recent version of the EOS_Achievements_UnlockAchievements struct. */
|
| 326 |
+
#define EOS_ACHIEVEMENTS_UNLOCKACHIEVEMENTS_API_LATEST 1
|
| 327 |
+
|
| 328 |
+
/**
|
| 329 |
+
* Input parameters for the EOS_Achievements_UnlockAchievements function.
|
| 330 |
+
*/
|
| 331 |
+
EOS_STRUCT(EOS_Achievements_UnlockAchievementsOptions, (
|
| 332 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_UNLOCKACHIEVEMENTS_API_LATEST. */
|
| 333 |
+
int32_t ApiVersion;
|
| 334 |
+
/** The Product User ID for the user whose achievements we want to unlock. */
|
| 335 |
+
EOS_ProductUserId UserId;
|
| 336 |
+
/** An array of Achievement IDs to unlock. */
|
| 337 |
+
const char** AchievementIds;
|
| 338 |
+
/** The number of achievements to unlock. */
|
| 339 |
+
uint32_t AchievementsCount;
|
| 340 |
+
));
|
| 341 |
+
|
| 342 |
+
/**
|
| 343 |
+
* Data containing the result information for unlocking achievements request.
|
| 344 |
+
*/
|
| 345 |
+
EOS_STRUCT(EOS_Achievements_OnUnlockAchievementsCompleteCallbackInfo, (
|
| 346 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 347 |
+
EOS_EResult ResultCode;
|
| 348 |
+
/** Context that was passed into EOS_Achievements_UnlockAchievements. */
|
| 349 |
+
void* ClientData;
|
| 350 |
+
/** The Product User ID of the user who initiated this request. */
|
| 351 |
+
EOS_ProductUserId UserId;
|
| 352 |
+
/** The number of achievements that the operation unlocked. */
|
| 353 |
+
uint32_t AchievementsCount;
|
| 354 |
+
));
|
| 355 |
+
|
| 356 |
+
/**
|
| 357 |
+
* Function prototype definition for callbacks passed to EOS_Achievements_UnlockAchievements
|
| 358 |
+
* @param Data An EOS_Achievements_OnUnlockAchievementsCompleteCallbackInfo containing the output information and result
|
| 359 |
+
*/
|
| 360 |
+
EOS_DECLARE_CALLBACK(EOS_Achievements_OnUnlockAchievementsCompleteCallback, const EOS_Achievements_OnUnlockAchievementsCompleteCallbackInfo* Data);
|
| 361 |
+
|
| 362 |
+
/** The most recent version of the EOS_Achievements_AddNotifyAchievementsUnlockedV2 API. */
|
| 363 |
+
#define EOS_ACHIEVEMENTS_ADDNOTIFYACHIEVEMENTSUNLOCKEDV2_API_LATEST 2
|
| 364 |
+
|
| 365 |
+
/**
|
| 366 |
+
* Input parameters for the EOS_Achievements_AddNotifyAchievementsUnlocked function.
|
| 367 |
+
*/
|
| 368 |
+
EOS_STRUCT(EOS_Achievements_AddNotifyAchievementsUnlockedV2Options, (
|
| 369 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_ADDNOTIFYACHIEVEMENTSUNLOCKEDV2_API_LATEST. */
|
| 370 |
+
int32_t ApiVersion;
|
| 371 |
+
));
|
| 372 |
+
|
| 373 |
+
/**
|
| 374 |
+
* Output parameters for the EOS_Achievements_OnAchievementsUnlockedCallbackV2 Function.
|
| 375 |
+
*/
|
| 376 |
+
EOS_STRUCT(EOS_Achievements_OnAchievementsUnlockedCallbackV2Info, (
|
| 377 |
+
/** Context that was passed into EOS_Achievements_AddNotifyAchievementsUnlocked */
|
| 378 |
+
void* ClientData;
|
| 379 |
+
/** The Product User ID for the user who received the unlocked achievements notification */
|
| 380 |
+
EOS_ProductUserId UserId;
|
| 381 |
+
/** The Achievement ID for the achievement that was unlocked. Pass this to EOS_Achievements_CopyPlayerAchievementByAchievementId to get the full achievement information. */
|
| 382 |
+
const char* AchievementId;
|
| 383 |
+
/** POSIX timestamp when the achievement was unlocked. */
|
| 384 |
+
int64_t UnlockTime;
|
| 385 |
+
));
|
| 386 |
+
|
| 387 |
+
/**
|
| 388 |
+
* Function prototype definition for notifications that come from EOS_Achievements_AddNotifyAchievementsUnlockedV2
|
| 389 |
+
*
|
| 390 |
+
* @param Data An EOS_Achievements_OnAchievementsUnlockedCallbackV2Info containing the output information and result
|
| 391 |
+
*/
|
| 392 |
+
EOS_DECLARE_CALLBACK(EOS_Achievements_OnAchievementsUnlockedCallbackV2, const EOS_Achievements_OnAchievementsUnlockedCallbackV2Info* Data);
|
| 393 |
+
|
| 394 |
+
|
| 395 |
+
#pragma pack(pop)
|
| 396 |
+
|
| 397 |
+
#include "eos_achievements_types_deprecated.inl"
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_achievements_types_deprecated.inl
ADDED
|
@@ -0,0 +1,189 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
/**
|
| 8 |
+
* This file contains the deprecated types for EOS Achievements. In a future version, these types will be removed.
|
| 9 |
+
*/
|
| 10 |
+
|
| 11 |
+
#pragma pack(push, 8)
|
| 12 |
+
|
| 13 |
+
/** The most recent version of the EOS_Achievements_Definition struct. */
|
| 14 |
+
#define EOS_ACHIEVEMENTS_DEFINITION_API_LATEST 1
|
| 15 |
+
|
| 16 |
+
/**
|
| 17 |
+
* Contains information about a single achievement definition with localized text.
|
| 18 |
+
*/
|
| 19 |
+
EOS_STRUCT(EOS_Achievements_Definition, (
|
| 20 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_DEFINITION_API_LATEST. */
|
| 21 |
+
int32_t ApiVersion;
|
| 22 |
+
/** Achievement ID that can be used to uniquely identify the achievement. */
|
| 23 |
+
const char* AchievementId;
|
| 24 |
+
/** Text representing the Name to display in-game when achievement has been unlocked. */
|
| 25 |
+
const char* DisplayName;
|
| 26 |
+
/** Text representing the description to display in-game when achievement has been unlocked. */
|
| 27 |
+
const char* Description;
|
| 28 |
+
/** Text representing the name to display in-game when achievement is locked. */
|
| 29 |
+
const char* LockedDisplayName;
|
| 30 |
+
/** Text representing the description of what needs to be done to trigger the unlock of this achievement. */
|
| 31 |
+
const char* LockedDescription;
|
| 32 |
+
/** Text representing the description to display in-game when achievement is hidden. */
|
| 33 |
+
const char* HiddenDescription;
|
| 34 |
+
/** Text representing the description of what happens when the achievement is unlocked. */
|
| 35 |
+
const char* CompletionDescription;
|
| 36 |
+
/** Text representing the icon to display in-game when achievement is unlocked. */
|
| 37 |
+
const char* UnlockedIconId;
|
| 38 |
+
/** Text representing the icon to display in-game when achievement is locked. */
|
| 39 |
+
const char* LockedIconId;
|
| 40 |
+
/** True if achievement is hidden, false otherwise. */
|
| 41 |
+
EOS_Bool bIsHidden;
|
| 42 |
+
/** The number of stat thresholds. */
|
| 43 |
+
int32_t StatThresholdsCount;
|
| 44 |
+
/** Array of stat thresholds that need to be satisfied to unlock the achievement. */
|
| 45 |
+
const EOS_Achievements_StatThresholds* StatThresholds;
|
| 46 |
+
));
|
| 47 |
+
|
| 48 |
+
/**
|
| 49 |
+
* Release the memory associated with achievement definitions. This must be called on data retrieved from
|
| 50 |
+
* EOS_Achievements_CopyAchievementDefinitionByIndex or EOS_Achievements_CopyAchievementDefinitionByAchievementId.
|
| 51 |
+
*
|
| 52 |
+
* @param AchievementDefinition - The achievement definition to release.
|
| 53 |
+
*
|
| 54 |
+
* @see EOS_Achievements_Definition
|
| 55 |
+
* @see EOS_Achievements_CopyAchievementDefinitionByIndex
|
| 56 |
+
* @see EOS_Achievements_CopyAchievementDefinitionByAchievementId
|
| 57 |
+
*/
|
| 58 |
+
EOS_DECLARE_FUNC(void) EOS_Achievements_Definition_Release(EOS_Achievements_Definition* AchievementDefinition);
|
| 59 |
+
|
| 60 |
+
/** The most recent version of the EOS_Achievements_CopyAchievementDefinitionByIndexOptions struct. */
|
| 61 |
+
#define EOS_ACHIEVEMENTS_COPYDEFINITIONBYINDEX_API_LATEST 1
|
| 62 |
+
|
| 63 |
+
/**
|
| 64 |
+
* Input parameters for the EOS_Achievements_CopyAchievementDefinitionByIndex function.
|
| 65 |
+
*/
|
| 66 |
+
EOS_STRUCT(EOS_Achievements_CopyAchievementDefinitionByIndexOptions, (
|
| 67 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_COPYDEFINITIONBYINDEX_API_LATEST. */
|
| 68 |
+
int32_t ApiVersion;
|
| 69 |
+
/** Index of the achievement definition to retrieve from the cache */
|
| 70 |
+
uint32_t AchievementIndex;
|
| 71 |
+
));
|
| 72 |
+
|
| 73 |
+
/** The most recent version of the EOS_Achievements_CopyAchievementDefinitionByAchievementIdOptions struct. */
|
| 74 |
+
#define EOS_ACHIEVEMENTS_COPYDEFINITIONBYACHIEVEMENTID_API_LATEST 1
|
| 75 |
+
|
| 76 |
+
/**
|
| 77 |
+
* Input parameters for the EOS_Achievements_CopyAchievementDefinitionByAchievementId function.
|
| 78 |
+
*/
|
| 79 |
+
EOS_STRUCT(EOS_Achievements_CopyAchievementDefinitionByAchievementIdOptions, (
|
| 80 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_COPYDEFINITIONBYACHIEVEMENTID_API_LATEST. */
|
| 81 |
+
int32_t ApiVersion;
|
| 82 |
+
/** Achievement ID to look for when copying definition from the cache */
|
| 83 |
+
const char* AchievementId;
|
| 84 |
+
));
|
| 85 |
+
|
| 86 |
+
/** The most recent version of the EOS_Achievements_UnlockedAchievement struct. */
|
| 87 |
+
#define EOS_ACHIEVEMENTS_UNLOCKEDACHIEVEMENT_API_LATEST 1
|
| 88 |
+
|
| 89 |
+
/**
|
| 90 |
+
* Contains information about a single unlocked achievement.
|
| 91 |
+
*/
|
| 92 |
+
EOS_STRUCT(EOS_Achievements_UnlockedAchievement, (
|
| 93 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_UNLOCKEDACHIEVEMENT_API_LATEST. */
|
| 94 |
+
int32_t ApiVersion;
|
| 95 |
+
/** Achievement ID that can be used to uniquely identify the unlocked achievement. */
|
| 96 |
+
const char* AchievementId;
|
| 97 |
+
/** If not EOS_ACHIEVEMENTS_ACHIEVEMENT_UNLOCKTIME_UNDEFINED then this is the POSIX timestamp that the achievement was unlocked. */
|
| 98 |
+
int64_t UnlockTime;
|
| 99 |
+
));
|
| 100 |
+
|
| 101 |
+
/** The most recent version of the EOS_Achievements_GetUnlockedAchievementCount API. */
|
| 102 |
+
#define EOS_ACHIEVEMENTS_GETUNLOCKEDACHIEVEMENTCOUNT_API_LATEST 1
|
| 103 |
+
|
| 104 |
+
/**
|
| 105 |
+
* Input parameters for the EOS_Achievements_GetUnlockedAchievementCount function.
|
| 106 |
+
*/
|
| 107 |
+
EOS_STRUCT(EOS_Achievements_GetUnlockedAchievementCountOptions, (
|
| 108 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_GETUNLOCKEDACHIEVEMENTCOUNT_API_LATEST. */
|
| 109 |
+
int32_t ApiVersion;
|
| 110 |
+
/** Product User ID for which to retrieve the unlocked achievement count */
|
| 111 |
+
EOS_ProductUserId UserId;
|
| 112 |
+
));
|
| 113 |
+
|
| 114 |
+
/** The most recent version of the EOS_Achievements_CopyUnlockedAchievementByIndexOptions struct. */
|
| 115 |
+
#define EOS_ACHIEVEMENTS_COPYUNLOCKEDACHIEVEMENTBYINDEX_API_LATEST 1
|
| 116 |
+
|
| 117 |
+
/**
|
| 118 |
+
* Input parameters for the EOS_Achievements_CopyUnlockedAchievementByIndex function.
|
| 119 |
+
*/
|
| 120 |
+
EOS_STRUCT(EOS_Achievements_CopyUnlockedAchievementByIndexOptions, (
|
| 121 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_COPYUNLOCKEDACHIEVEMENTBYINDEX_API_LATEST. */
|
| 122 |
+
int32_t ApiVersion;
|
| 123 |
+
/** The Product User ID for the user who is copying the unlocked achievement */
|
| 124 |
+
EOS_ProductUserId UserId;
|
| 125 |
+
/** Index of the unlocked achievement to retrieve from the cache */
|
| 126 |
+
uint32_t AchievementIndex;
|
| 127 |
+
));
|
| 128 |
+
|
| 129 |
+
/** The most recent version of the EOS_Achievements_CopyUnlockedAchievementByAchievementIdOptions struct. */
|
| 130 |
+
#define EOS_ACHIEVEMENTS_COPYUNLOCKEDACHIEVEMENTBYACHIEVEMENTID_API_LATEST 1
|
| 131 |
+
|
| 132 |
+
/**
|
| 133 |
+
* Input parameters for the EOS_Achievements_CopyUnlockedAchievementByAchievementId function.
|
| 134 |
+
*/
|
| 135 |
+
EOS_STRUCT(EOS_Achievements_CopyUnlockedAchievementByAchievementIdOptions, (
|
| 136 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_COPYUNLOCKEDACHIEVEMENTBYACHIEVEMENTID_API_LATEST. */
|
| 137 |
+
int32_t ApiVersion;
|
| 138 |
+
/** The Product User ID for the user who is copying the unlocked achievement */
|
| 139 |
+
EOS_ProductUserId UserId;
|
| 140 |
+
/** AchievementId of the unlocked achievement to retrieve from the cache */
|
| 141 |
+
const char* AchievementId;
|
| 142 |
+
));
|
| 143 |
+
|
| 144 |
+
|
| 145 |
+
/** The most recent version of the EOS_Achievements_AddNotifyAchievementsUnlocked API. */
|
| 146 |
+
#define EOS_ACHIEVEMENTS_ADDNOTIFYACHIEVEMENTSUNLOCKED_API_LATEST 1
|
| 147 |
+
|
| 148 |
+
/**
|
| 149 |
+
* Input parameters for the EOS_Achievements_AddNotifyAchievementsUnlocked function.
|
| 150 |
+
*/
|
| 151 |
+
EOS_STRUCT(EOS_Achievements_AddNotifyAchievementsUnlockedOptions, (
|
| 152 |
+
/** API Version: Set this to EOS_ACHIEVEMENTS_ADDNOTIFYACHIEVEMENTSUNLOCKED_API_LATEST. */
|
| 153 |
+
int32_t ApiVersion;
|
| 154 |
+
));
|
| 155 |
+
|
| 156 |
+
/**
|
| 157 |
+
* Output parameters for the EOS_Achievements_OnAchievementsUnlockedCallback Function.
|
| 158 |
+
*/
|
| 159 |
+
EOS_STRUCT(EOS_Achievements_OnAchievementsUnlockedCallbackInfo, (
|
| 160 |
+
/** Context that was passed into EOS_Achievements_AddNotifyAchievementsUnlocked */
|
| 161 |
+
void* ClientData;
|
| 162 |
+
/** The Product User ID for the user who received the unlocked achievements notification */
|
| 163 |
+
EOS_ProductUserId UserId;
|
| 164 |
+
/** The number of achievements. */
|
| 165 |
+
uint32_t AchievementsCount;
|
| 166 |
+
/** This member is not used and will always be set to NULL. */
|
| 167 |
+
const char** AchievementIds;
|
| 168 |
+
));
|
| 169 |
+
|
| 170 |
+
/**
|
| 171 |
+
* Function prototype definition for notifications that come from EOS_Achievements_AddNotifyAchievementsUnlocked
|
| 172 |
+
*
|
| 173 |
+
* @param Data A EOS_Achievements_OnAchievementsUnlockedCallbackInfo containing the output information and result
|
| 174 |
+
*/
|
| 175 |
+
EOS_DECLARE_CALLBACK(EOS_Achievements_OnAchievementsUnlockedCallback, const EOS_Achievements_OnAchievementsUnlockedCallbackInfo* Data);
|
| 176 |
+
|
| 177 |
+
/**
|
| 178 |
+
* Release the memory associated with an unlocked achievement. This must be called on data retrieved from
|
| 179 |
+
* EOS_Achievements_CopyUnlockedAchievementByIndex or EOS_Achievements_CopyUnlockedAchievementByAchievementId.
|
| 180 |
+
*
|
| 181 |
+
* @param Achievement - The unlocked achievement data to release.
|
| 182 |
+
*
|
| 183 |
+
* @see EOS_Achievements_UnlockedAchievement
|
| 184 |
+
* @see EOS_Achievements_CopyUnlockedAchievementByIndex
|
| 185 |
+
* @see EOS_Achievements_CopyUnlockedAchievementByAchievementId
|
| 186 |
+
*/
|
| 187 |
+
EOS_DECLARE_FUNC(void) EOS_Achievements_UnlockedAchievement_Release(EOS_Achievements_UnlockedAchievement* Achievement);
|
| 188 |
+
|
| 189 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatclient.h
ADDED
|
@@ -0,0 +1,335 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_anticheatclient_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* Add a callback issued when a new message must be dispatched to the game server. The bound function will only be called
|
| 8 |
+
* between a successful call to EOS_AntiCheatClient_BeginSession and the matching EOS_AntiCheatClient_EndSession call in mode EOS_ACCM_ClientServer.
|
| 9 |
+
* Mode: EOS_ACCM_ClientServer.
|
| 10 |
+
*
|
| 11 |
+
* @param Options Structure containing input data
|
| 12 |
+
* @param ClientData This value is returned to the caller when NotificationFn is invoked
|
| 13 |
+
* @param NotificationFn The callback to be fired
|
| 14 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 15 |
+
*/
|
| 16 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_AntiCheatClient_AddNotifyMessageToServer(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_AddNotifyMessageToServerOptions* Options, void* ClientData, EOS_AntiCheatClient_OnMessageToServerCallback NotificationFn);
|
| 17 |
+
|
| 18 |
+
/**
|
| 19 |
+
* Remove a previously bound EOS_AntiCheatClient_AddNotifyMessageToServer handler.
|
| 20 |
+
* Mode: Any.
|
| 21 |
+
*
|
| 22 |
+
* @param NotificationId The previously bound notification ID
|
| 23 |
+
*/
|
| 24 |
+
EOS_DECLARE_FUNC(void) EOS_AntiCheatClient_RemoveNotifyMessageToServer(EOS_HAntiCheatClient Handle, EOS_NotificationId NotificationId);
|
| 25 |
+
|
| 26 |
+
/**
|
| 27 |
+
* Add a callback issued when a new message must be dispatched to a connected peer. The bound function will only be called
|
| 28 |
+
* between a successful call to EOS_AntiCheatClient_BeginSession and the matching EOS_AntiCheatClient_EndSession call in mode EOS_ACCM_PeerToPeer.
|
| 29 |
+
* Mode: EOS_ACCM_PeerToPeer.
|
| 30 |
+
*
|
| 31 |
+
* @param Options Structure containing input data
|
| 32 |
+
* @param ClientData This value is returned to the caller when NotificationFn is invoked
|
| 33 |
+
* @param NotificationFn The callback to be fired
|
| 34 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 35 |
+
*/
|
| 36 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_AntiCheatClient_AddNotifyMessageToPeer(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_AddNotifyMessageToPeerOptions* Options, void* ClientData, EOS_AntiCheatClient_OnMessageToPeerCallback NotificationFn);
|
| 37 |
+
|
| 38 |
+
/**
|
| 39 |
+
* Remove a previously bound EOS_AntiCheatClient_AddNotifyMessageToPeer handler.
|
| 40 |
+
* Mode: Any.
|
| 41 |
+
*
|
| 42 |
+
* @param NotificationId The previously bound notification ID
|
| 43 |
+
*/
|
| 44 |
+
EOS_DECLARE_FUNC(void) EOS_AntiCheatClient_RemoveNotifyMessageToPeer(EOS_HAntiCheatClient Handle, EOS_NotificationId NotificationId);
|
| 45 |
+
|
| 46 |
+
/**
|
| 47 |
+
* Add a callback issued when an action must be applied to a connected client. The bound function will only be called
|
| 48 |
+
* between a successful call to EOS_AntiCheatClient_BeginSession and the matching EOS_AntiCheatClient_EndSession call in mode EOS_ACCM_PeerToPeer.
|
| 49 |
+
* Mode: EOS_ACCM_PeerToPeer.
|
| 50 |
+
*
|
| 51 |
+
* @param Options Structure containing input data
|
| 52 |
+
* @param ClientData This value is returned to the caller when NotificationFn is invoked
|
| 53 |
+
* @param NotificationFn The callback to be fired
|
| 54 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 55 |
+
*/
|
| 56 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_AntiCheatClient_AddNotifyPeerActionRequired(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_AddNotifyPeerActionRequiredOptions* Options, void* ClientData, EOS_AntiCheatClient_OnPeerActionRequiredCallback NotificationFn);
|
| 57 |
+
|
| 58 |
+
/**
|
| 59 |
+
* Remove a previously bound EOS_AntiCheatClient_AddNotifyPeerActionRequired handler.
|
| 60 |
+
* Mode: Any.
|
| 61 |
+
*
|
| 62 |
+
* @param NotificationId The previously bound notification ID
|
| 63 |
+
*/
|
| 64 |
+
EOS_DECLARE_FUNC(void) EOS_AntiCheatClient_RemoveNotifyPeerActionRequired(EOS_HAntiCheatClient Handle, EOS_NotificationId NotificationId);
|
| 65 |
+
|
| 66 |
+
/**
|
| 67 |
+
* Add an optional callback issued when a connected peer's authentication status changes. The bound function will only be called
|
| 68 |
+
* between a successful call to EOS_AntiCheatClient_BeginSession and the matching EOS_AntiCheatClient_EndSession call in mode EOS_ACCM_PeerToPeer.
|
| 69 |
+
* Mode: EOS_ACCM_PeerToPeer.
|
| 70 |
+
*
|
| 71 |
+
* @param Options Structure containing input data
|
| 72 |
+
* @param ClientData This value is returned to the caller when NotificationFn is invoked
|
| 73 |
+
* @param NotificationFn The callback to be fired
|
| 74 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 75 |
+
*/
|
| 76 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_AntiCheatClient_AddNotifyPeerAuthStatusChanged(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_AddNotifyPeerAuthStatusChangedOptions* Options, void* ClientData, EOS_AntiCheatClient_OnPeerAuthStatusChangedCallback NotificationFn);
|
| 77 |
+
|
| 78 |
+
/**
|
| 79 |
+
* Remove a previously bound EOS_AntiCheatClient_AddNotifyPeerAuthStatusChanged handler.
|
| 80 |
+
* Mode: Any.
|
| 81 |
+
*
|
| 82 |
+
* @param NotificationId The previously bound notification ID
|
| 83 |
+
*/
|
| 84 |
+
EOS_DECLARE_FUNC(void) EOS_AntiCheatClient_RemoveNotifyPeerAuthStatusChanged(EOS_HAntiCheatClient Handle, EOS_NotificationId NotificationId);
|
| 85 |
+
|
| 86 |
+
/**
|
| 87 |
+
* Add a callback when a message must be displayed to the local client informing them on a local integrity violation,
|
| 88 |
+
* which will prevent further online play.
|
| 89 |
+
* Mode: Any.
|
| 90 |
+
*
|
| 91 |
+
* @param Options Structure containing input data
|
| 92 |
+
* @param ClientData This value is returned to the caller when NotificationFn is invoked
|
| 93 |
+
* @param NotificationFn The callback to be fired
|
| 94 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 95 |
+
*/
|
| 96 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_AntiCheatClient_AddNotifyClientIntegrityViolated(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_AddNotifyClientIntegrityViolatedOptions* Options, void* ClientData, EOS_AntiCheatClient_OnClientIntegrityViolatedCallback NotificationFn);
|
| 97 |
+
|
| 98 |
+
/**
|
| 99 |
+
* Remove a previously bound EOS_AntiCheatClient_AddNotifyClientIntegrityViolated handler.
|
| 100 |
+
* Mode: Any.
|
| 101 |
+
*
|
| 102 |
+
* @param NotificationId The previously bound notification ID
|
| 103 |
+
*/
|
| 104 |
+
EOS_DECLARE_FUNC(void) EOS_AntiCheatClient_RemoveNotifyClientIntegrityViolated(EOS_HAntiCheatClient Handle, EOS_NotificationId NotificationId);
|
| 105 |
+
|
| 106 |
+
/**
|
| 107 |
+
* Begins a multiplayer game session. After this call returns successfully, the client is ready to exchange
|
| 108 |
+
* anti-cheat messages with a game server or peer(s). When leaving one game session and connecting to a
|
| 109 |
+
* different one, a new anti-cheat session must be created by calling EOS_AntiCheatClient_EndSession and EOS_AntiCheatClient_BeginSession again.
|
| 110 |
+
* Mode: All
|
| 111 |
+
*
|
| 112 |
+
* @param Options Structure containing input data.
|
| 113 |
+
*
|
| 114 |
+
* @return EOS_EResult containing the result of the operation.
|
| 115 |
+
* Possible result codes:
|
| 116 |
+
* - EOS_Success - If the session was started successfully
|
| 117 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 118 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 119 |
+
*/
|
| 120 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_BeginSession(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_BeginSessionOptions* Options);
|
| 121 |
+
|
| 122 |
+
/**
|
| 123 |
+
* Ends a multiplayer game session, either by leaving an ongoing session or shutting it down entirely.
|
| 124 |
+
* Mode: All
|
| 125 |
+
*
|
| 126 |
+
* Must be called when the multiplayer session ends, or when the local user leaves a session in progress.
|
| 127 |
+
*
|
| 128 |
+
* @param Options Structure containing input data.
|
| 129 |
+
*
|
| 130 |
+
* @return EOS_EResult containing the result of the operation.
|
| 131 |
+
* Possible result codes:
|
| 132 |
+
* - EOS_Success - If the session was ended normally
|
| 133 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 134 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 135 |
+
*/
|
| 136 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_EndSession(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_EndSessionOptions* Options);
|
| 137 |
+
|
| 138 |
+
/**
|
| 139 |
+
* Polls for changes in client integrity status.
|
| 140 |
+
* Mode: All
|
| 141 |
+
*
|
| 142 |
+
* The purpose of this function is to allow the game to display information
|
| 143 |
+
* about anti-cheat integrity problems to the user. These are often the result of a
|
| 144 |
+
* corrupt game installation rather than cheating attempts. This function does not
|
| 145 |
+
* check for violations, it only provides information about violations which have
|
| 146 |
+
* automatically been discovered by the anti-cheat client. Such a violation may occur
|
| 147 |
+
* at any time and afterwards the user will be unable to join any protected multiplayer
|
| 148 |
+
* session until after restarting the game. Note that this function returns EOS_NotFound
|
| 149 |
+
* when everything is normal and there is no violation to display.
|
| 150 |
+
*
|
| 151 |
+
* NOTE: This API is deprecated. In order to get client status updates,
|
| 152 |
+
* use AddNotifyClientIntegrityViolated to register a callback that will
|
| 153 |
+
* be called when violations are triggered.
|
| 154 |
+
*
|
| 155 |
+
* @param Options Structure containing input data.
|
| 156 |
+
* @param OutViolationType On success, receives a code describing the violation that occurred.
|
| 157 |
+
* @param OutMessage On success, receives a string describing the violation which should be displayed to the user.
|
| 158 |
+
*
|
| 159 |
+
* @return EOS_EResult containing the result of the operation.
|
| 160 |
+
* Possible result codes:
|
| 161 |
+
* - EOS_Success - If violation information was returned successfully
|
| 162 |
+
* - EOS_LimitExceeded - If OutMessage is too small to receive the message string. Call again with a larger OutMessage.
|
| 163 |
+
* - EOS_NotFound - If no violation has occurred since the last call
|
| 164 |
+
*/
|
| 165 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_PollStatus(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_PollStatusOptions* Options, EOS_EAntiCheatClientViolationType* OutViolationType, char* OutMessage);
|
| 166 |
+
|
| 167 |
+
/**
|
| 168 |
+
* This function is reserved for future use and must not be called.
|
| 169 |
+
*
|
| 170 |
+
* @param Options Structure containing input data.
|
| 171 |
+
* @param OutValue Reserved.
|
| 172 |
+
*
|
| 173 |
+
* @return EOS_NotImplemented - Always
|
| 174 |
+
*/
|
| 175 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_Reserved01(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_Reserved01Options* Options, int32_t* OutValue);
|
| 176 |
+
|
| 177 |
+
/**
|
| 178 |
+
* This function is reserved for future use and must not be called.
|
| 179 |
+
*
|
| 180 |
+
* @param Options Structure containing input data.
|
| 181 |
+
*
|
| 182 |
+
* @return EOS_NotImplemented - Always
|
| 183 |
+
*/
|
| 184 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_Reserved02(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_Reserved02Options* Options);
|
| 185 |
+
|
| 186 |
+
/**
|
| 187 |
+
* Get the build id of the loaded anti-cheat client module.
|
| 188 |
+
* Mode: All
|
| 189 |
+
*
|
| 190 |
+
* NOTE: This is intended for analytics or troubleshooting purposes only. The build identifier should be treated as an arbitrary value
|
| 191 |
+
* and never used in relative comparisons. For example, it is incorrect to assume that a change in the behavior of the anti-cheat module
|
| 192 |
+
* introduced with build N is also present in build N+1 because we may backport bugfixes and compatibility fixes to older releases.
|
| 193 |
+
*
|
| 194 |
+
* @param Options Structure containing input data.
|
| 195 |
+
* @param OutModuleBuildId On success, the build id of the loaded anti-cheat client module.
|
| 196 |
+
*
|
| 197 |
+
* @return EOS_EResult containing the result of the operation.
|
| 198 |
+
* Possible result codes:
|
| 199 |
+
* - EOS_Success - If the build id was provided successfully
|
| 200 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 201 |
+
* - EOS_NotImplemented - If the platform does not use anti-cheat client modules or the loaded anti-cheat client module is too old to support this function.
|
| 202 |
+
* - EOS_NotFound - If the platform supports anti-cheat client modules but none is currently loaded (failsafe NullClient mode, launched without bootstrapper, etc).
|
| 203 |
+
*/
|
| 204 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_GetModuleBuildId(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_GetModuleBuildIdOptions* Options, uint32_t* OutModuleBuildId);
|
| 205 |
+
|
| 206 |
+
/**
|
| 207 |
+
* Optional. Adds an integrity catalog and certificate pair from outside the game directory,
|
| 208 |
+
* for example to support mods that load from elsewhere.
|
| 209 |
+
* Mode: All
|
| 210 |
+
*
|
| 211 |
+
* @param Options Structure containing input data.
|
| 212 |
+
*
|
| 213 |
+
* @return EOS_EResult containing the result of the operation.
|
| 214 |
+
* Possible result codes:
|
| 215 |
+
* - EOS_Success - If the integrity catalog was added successfully
|
| 216 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 217 |
+
*/
|
| 218 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_AddExternalIntegrityCatalog(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_AddExternalIntegrityCatalogOptions* Options);
|
| 219 |
+
|
| 220 |
+
/**
|
| 221 |
+
* Call when an anti-cheat message is received from the game server.
|
| 222 |
+
* Mode: EOS_ACCM_ClientServer.
|
| 223 |
+
*
|
| 224 |
+
* @param Options Structure containing input data.
|
| 225 |
+
*
|
| 226 |
+
* @return EOS_EResult containing the result of the operation.
|
| 227 |
+
* Possible result codes:
|
| 228 |
+
* - EOS_Success - If the message was processed successfully
|
| 229 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 230 |
+
* - EOS_InvalidRequest - If message contents were corrupt and could not be processed
|
| 231 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 232 |
+
*/
|
| 233 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_ReceiveMessageFromServer(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_ReceiveMessageFromServerOptions* Options);
|
| 234 |
+
|
| 235 |
+
/**
|
| 236 |
+
* Optional NetProtect feature for game message encryption.
|
| 237 |
+
* Calculates the required decrypted buffer size for a given input data length.
|
| 238 |
+
* This will not change for a given SDK version, and allows one time allocation of reusable buffers.
|
| 239 |
+
* Mode: EOS_ACCM_ClientServer.
|
| 240 |
+
*
|
| 241 |
+
* @param Options Structure containing input data.
|
| 242 |
+
* @param OutBufferSizeBytes On success, the OutBuffer length in bytes that is required to call ProtectMessage on the given input size.
|
| 243 |
+
*
|
| 244 |
+
* @return EOS_EResult containing the result of the operation.
|
| 245 |
+
* Possible result codes:
|
| 246 |
+
* - EOS_Success - If the output length was calculated successfully
|
| 247 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 248 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 249 |
+
*/
|
| 250 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_GetProtectMessageOutputLength(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_GetProtectMessageOutputLengthOptions* Options, uint32_t* OutBufferSizeBytes);
|
| 251 |
+
|
| 252 |
+
/**
|
| 253 |
+
* Optional NetProtect feature for game message encryption.
|
| 254 |
+
* Encrypts an arbitrary message that will be sent to the game server and decrypted on the other side.
|
| 255 |
+
* Mode: EOS_ACCM_ClientServer.
|
| 256 |
+
*
|
| 257 |
+
* Options.Data and OutBuffer may refer to the same buffer to encrypt in place.
|
| 258 |
+
*
|
| 259 |
+
* @param Options Structure containing input data.
|
| 260 |
+
* @param OutBuffer On success, buffer where encrypted message data will be written.
|
| 261 |
+
* @param OutBytesWritten On success, the number of bytes that were written to OutBuffer.
|
| 262 |
+
*
|
| 263 |
+
* @return EOS_EResult containing the result of the operation.
|
| 264 |
+
* Possible result codes:
|
| 265 |
+
* - EOS_Success - If the message was protected successfully
|
| 266 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 267 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 268 |
+
*/
|
| 269 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_ProtectMessage(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_ProtectMessageOptions* Options, void* OutBuffer, uint32_t* OutBytesWritten);
|
| 270 |
+
|
| 271 |
+
/**
|
| 272 |
+
* Optional NetProtect feature for game message encryption.
|
| 273 |
+
* Decrypts an encrypted message received from the game server.
|
| 274 |
+
* Mode: EOS_ACCM_ClientServer.
|
| 275 |
+
*
|
| 276 |
+
* Options.Data and OutBuffer may refer to the same buffer to decrypt in place.
|
| 277 |
+
*
|
| 278 |
+
* @param Options Structure containing input data.
|
| 279 |
+
* @param OutBuffer On success, buffer where encrypted message data will be written.
|
| 280 |
+
* @param OutBytesWritten On success, the number of bytes that were written to OutBuffer.
|
| 281 |
+
*
|
| 282 |
+
* @return EOS_EResult containing the result of the operation.
|
| 283 |
+
* Possible result codes:
|
| 284 |
+
* - EOS_Success - If the message was unprotected successfully
|
| 285 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 286 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 287 |
+
*/
|
| 288 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_UnprotectMessage(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_UnprotectMessageOptions* Options, void* OutBuffer, uint32_t* OutBytesWritten);
|
| 289 |
+
|
| 290 |
+
/**
|
| 291 |
+
* Registers a connected peer-to-peer client.
|
| 292 |
+
* Mode: EOS_ACCM_PeerToPeer.
|
| 293 |
+
*
|
| 294 |
+
* Must be paired with a call to EOS_AntiCheatClient_UnregisterPeer if this user leaves the session
|
| 295 |
+
* in progress, or EOS_AntiCheatClient_EndSession if the entire session is ending.
|
| 296 |
+
*
|
| 297 |
+
* @param Options Structure containing input data.
|
| 298 |
+
*
|
| 299 |
+
* @return EOS_EResult containing the result of the operation.
|
| 300 |
+
* Possible result codes:
|
| 301 |
+
* - EOS_Success - If the player was registered successfully
|
| 302 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 303 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 304 |
+
*/
|
| 305 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_RegisterPeer(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_RegisterPeerOptions* Options);
|
| 306 |
+
|
| 307 |
+
/**
|
| 308 |
+
* Unregisters a disconnected peer-to-peer client.
|
| 309 |
+
* Mode: EOS_ACCM_PeerToPeer.
|
| 310 |
+
*
|
| 311 |
+
* Must be called when a user leaves a session in progress.
|
| 312 |
+
*
|
| 313 |
+
* @param Options Structure containing input data.
|
| 314 |
+
*
|
| 315 |
+
* @return EOS_EResult containing the result of the operation.
|
| 316 |
+
* Possible result codes:
|
| 317 |
+
* - EOS_Success - If the player was unregistered successfully
|
| 318 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 319 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 320 |
+
*/
|
| 321 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_UnregisterPeer(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_UnregisterPeerOptions* Options);
|
| 322 |
+
|
| 323 |
+
/**
|
| 324 |
+
* Call when an anti-cheat message is received from a peer.
|
| 325 |
+
* Mode: EOS_ACCM_PeerToPeer.
|
| 326 |
+
*
|
| 327 |
+
* @param Options Structure containing input data.
|
| 328 |
+
*
|
| 329 |
+
* @return EOS_EResult containing the result of the operation.
|
| 330 |
+
* Possible result codes:
|
| 331 |
+
* - EOS_Success - If the message was processed successfully
|
| 332 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 333 |
+
* - EOS_AntiCheat_InvalidMode - If the current mode does not support this function
|
| 334 |
+
*/
|
| 335 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatClient_ReceiveMessageFromPeer(EOS_HAntiCheatClient Handle, const EOS_AntiCheatClient_ReceiveMessageFromPeerOptions* Options);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatclient_types.h
ADDED
|
@@ -0,0 +1,414 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
#include "eos_anticheatcommon_types.h"
|
| 7 |
+
|
| 8 |
+
#pragma pack(push, 8)
|
| 9 |
+
|
| 10 |
+
EOS_EXTERN_C typedef struct EOS_AntiCheatClientHandle* EOS_HAntiCheatClient;
|
| 11 |
+
|
| 12 |
+
/** Operating modes */
|
| 13 |
+
EOS_ENUM(EOS_EAntiCheatClientMode,
|
| 14 |
+
/** Not used */
|
| 15 |
+
EOS_ACCM_Invalid = 0,
|
| 16 |
+
/** Dedicated or listen server mode */
|
| 17 |
+
EOS_ACCM_ClientServer = 1,
|
| 18 |
+
/** Full mesh peer-to-peer mode */
|
| 19 |
+
EOS_ACCM_PeerToPeer = 2
|
| 20 |
+
);
|
| 21 |
+
|
| 22 |
+
/** Anti-cheat integrity violation types */
|
| 23 |
+
EOS_ENUM(EOS_EAntiCheatClientViolationType,
|
| 24 |
+
/** Not used */
|
| 25 |
+
EOS_ACCVT_Invalid = 0,
|
| 26 |
+
/** An anti-cheat asset integrity catalog file could not be found */
|
| 27 |
+
EOS_ACCVT_IntegrityCatalogNotFound = 1,
|
| 28 |
+
/** An anti-cheat asset integrity catalog file is corrupt or invalid */
|
| 29 |
+
EOS_ACCVT_IntegrityCatalogError = 2,
|
| 30 |
+
/** An anti-cheat asset integrity catalog file's certificate has been revoked. */
|
| 31 |
+
EOS_ACCVT_IntegrityCatalogCertificateRevoked = 3,
|
| 32 |
+
/**
|
| 33 |
+
* The primary anti-cheat asset integrity catalog does not include an entry for the game's
|
| 34 |
+
* main executable, which is required.
|
| 35 |
+
*/
|
| 36 |
+
EOS_ACCVT_IntegrityCatalogMissingMainExecutable = 4,
|
| 37 |
+
/** A disallowed game file modification was detected */
|
| 38 |
+
EOS_ACCVT_GameFileMismatch = 5,
|
| 39 |
+
/** A disallowed game file removal was detected */
|
| 40 |
+
EOS_ACCVT_RequiredGameFileNotFound = 6,
|
| 41 |
+
/** A disallowed game file addition was detected */
|
| 42 |
+
EOS_ACCVT_UnknownGameFileForbidden = 7,
|
| 43 |
+
/** A system file failed an integrity check */
|
| 44 |
+
EOS_ACCVT_SystemFileUntrusted = 8,
|
| 45 |
+
/** A disallowed code module was loaded into the game process */
|
| 46 |
+
EOS_ACCVT_ForbiddenModuleLoaded = 9,
|
| 47 |
+
/** A disallowed game process memory modification was detected */
|
| 48 |
+
EOS_ACCVT_CorruptedMemory = 10,
|
| 49 |
+
/** A disallowed tool was detected running in the system */
|
| 50 |
+
EOS_ACCVT_ForbiddenToolDetected = 11,
|
| 51 |
+
/** An internal anti-cheat integrity check failed */
|
| 52 |
+
EOS_ACCVT_InternalAntiCheatViolation = 12,
|
| 53 |
+
/** Integrity checks on messages between the game client and game server, or between peers, failed */
|
| 54 |
+
EOS_ACCVT_CorruptedNetworkMessageFlow = 13,
|
| 55 |
+
/** The game is running inside a disallowed virtual machine */
|
| 56 |
+
EOS_ACCVT_VirtualMachineNotAllowed = 14,
|
| 57 |
+
/** A forbidden operating system configuration was detected */
|
| 58 |
+
EOS_ACCVT_ForbiddenSystemConfiguration = 15
|
| 59 |
+
);
|
| 60 |
+
|
| 61 |
+
/**
|
| 62 |
+
* Structure containing details about a new message that must be dispatched to the game server.
|
| 63 |
+
*/
|
| 64 |
+
EOS_STRUCT(EOS_AntiCheatClient_OnMessageToServerCallbackInfo, (
|
| 65 |
+
/** Caller-specified context data */
|
| 66 |
+
void* ClientData;
|
| 67 |
+
/** The message data that must be sent to the server */
|
| 68 |
+
const void* MessageData;
|
| 69 |
+
/** The size in bytes of MessageData */
|
| 70 |
+
uint32_t MessageDataSizeBytes;
|
| 71 |
+
));
|
| 72 |
+
|
| 73 |
+
/** Structure containing details about integrity violation related to the local client */
|
| 74 |
+
EOS_STRUCT(EOS_AntiCheatClient_OnClientIntegrityViolatedCallbackInfo, (
|
| 75 |
+
/** Caller-specified context data */
|
| 76 |
+
void* ClientData;
|
| 77 |
+
/** Code describing the violation that occurred */
|
| 78 |
+
EOS_EAntiCheatClientViolationType ViolationType;
|
| 79 |
+
/** String describing the violation which should be displayed to the user */
|
| 80 |
+
const char* ViolationMessage;
|
| 81 |
+
));
|
| 82 |
+
|
| 83 |
+
/**
|
| 84 |
+
* Maximum size of an individual message provided through EOS_AntiCheatClient_OnMessageToServerCallback.
|
| 85 |
+
*/
|
| 86 |
+
#define EOS_ANTICHEATCLIENT_ONMESSAGETOSERVERCALLBACK_MAX_MESSAGE_SIZE 512
|
| 87 |
+
|
| 88 |
+
/**
|
| 89 |
+
* Callback issued when a new message must be dispatched to the game server.
|
| 90 |
+
*
|
| 91 |
+
* Messages contain opaque binary data and must be transmitted
|
| 92 |
+
* to the game server using the game's own networking layer, then delivered
|
| 93 |
+
* to the server anti-cheat instance using the EOS_AntiCheatServer_ReceiveMessageFromClient function.
|
| 94 |
+
* The upper limit of the message size is EOS_ANTICHEATCLIENT_ONMESSAGETOSERVERCALLBACK_MAX_MESSAGE_SIZE.
|
| 95 |
+
*
|
| 96 |
+
* This callback is always issued from within EOS_Platform_Tick on its calling thread.
|
| 97 |
+
*/
|
| 98 |
+
EOS_DECLARE_CALLBACK(EOS_AntiCheatClient_OnMessageToServerCallback, const EOS_AntiCheatClient_OnMessageToServerCallbackInfo* Data);
|
| 99 |
+
|
| 100 |
+
/**
|
| 101 |
+
* Callback issued when the local client triggers an integrity violation.
|
| 102 |
+
*
|
| 103 |
+
* The message contains descriptive string of up to 256 characters and must be displayed to the player.
|
| 104 |
+
*
|
| 105 |
+
* This callback is always issued from within EOS_Platform_Tick on its calling thread.
|
| 106 |
+
*/
|
| 107 |
+
EOS_DECLARE_CALLBACK(EOS_AntiCheatClient_OnClientIntegrityViolatedCallback, const EOS_AntiCheatClient_OnClientIntegrityViolatedCallbackInfo* Data);
|
| 108 |
+
|
| 109 |
+
/**
|
| 110 |
+
* Maximum size of an individual message provided through EOS_AntiCheatClient_OnMessageToPeerCallback.
|
| 111 |
+
*/
|
| 112 |
+
#define EOS_ANTICHEATCLIENT_ONMESSAGETOPEERCALLBACK_MAX_MESSAGE_SIZE 512
|
| 113 |
+
|
| 114 |
+
/**
|
| 115 |
+
* Callback issued when a new message must be dispatched to a connected peer.
|
| 116 |
+
*
|
| 117 |
+
* Messages contain opaque binary data and must be transmitted
|
| 118 |
+
* to the correct peer using the game's own networking layer, then delivered
|
| 119 |
+
* to the client anti-cheat instance using the EOS_AntiCheatClient_ReceiveMessageFromPeer function.
|
| 120 |
+
* The upper limit of the message size is EOS_ANTICHEATCLIENT_ONMESSAGETOPEERCALLBACK_MAX_MESSAGE_SIZE.
|
| 121 |
+
*
|
| 122 |
+
* This callback is always issued from within EOS_Platform_Tick on its calling thread.
|
| 123 |
+
*/
|
| 124 |
+
EOS_DECLARE_CALLBACK(EOS_AntiCheatClient_OnMessageToPeerCallback, const EOS_AntiCheatCommon_OnMessageToClientCallbackInfo* Data);
|
| 125 |
+
|
| 126 |
+
/**
|
| 127 |
+
* Callback issued when an action must be applied to a connected peer.
|
| 128 |
+
* This callback is always issued from within EOS_Platform_Tick on its calling thread.
|
| 129 |
+
*/
|
| 130 |
+
EOS_DECLARE_CALLBACK(EOS_AntiCheatClient_OnPeerActionRequiredCallback, const EOS_AntiCheatCommon_OnClientActionRequiredCallbackInfo* Data);
|
| 131 |
+
|
| 132 |
+
/**
|
| 133 |
+
* Optional callback issued when a connected peer's authentication status has changed.
|
| 134 |
+
* This callback is always issued from within EOS_Platform_Tick on its calling thread.
|
| 135 |
+
*/
|
| 136 |
+
EOS_DECLARE_CALLBACK(EOS_AntiCheatClient_OnPeerAuthStatusChangedCallback, const EOS_AntiCheatCommon_OnClientAuthStatusChangedCallbackInfo* Data);
|
| 137 |
+
|
| 138 |
+
/** The most recent version of the EOS_AntiCheatClient_AddNotifyMessageToServer API. */
|
| 139 |
+
#define EOS_ANTICHEATCLIENT_ADDNOTIFYMESSAGETOSERVER_API_LATEST 1
|
| 140 |
+
|
| 141 |
+
/**
|
| 142 |
+
* Input parameters for the EOS_AntiCheatClient_AddNotifyMessageToServer function.
|
| 143 |
+
*/
|
| 144 |
+
EOS_STRUCT(EOS_AntiCheatClient_AddNotifyMessageToServerOptions, (
|
| 145 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_ADDNOTIFYMESSAGETOSERVER_API_LATEST. */
|
| 146 |
+
int32_t ApiVersion;
|
| 147 |
+
));
|
| 148 |
+
|
| 149 |
+
/** The most recent version of the EOS_AntiCheatClient_AddNotifyMessageToPeer API. */
|
| 150 |
+
#define EOS_ANTICHEATCLIENT_ADDNOTIFYMESSAGETOPEER_API_LATEST 1
|
| 151 |
+
|
| 152 |
+
/**
|
| 153 |
+
* Input parameters for the EOS_AntiCheatClient_AddNotifyMessageToPeer function.
|
| 154 |
+
*/
|
| 155 |
+
EOS_STRUCT(EOS_AntiCheatClient_AddNotifyMessageToPeerOptions, (
|
| 156 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_ADDNOTIFYMESSAGETOPEER_API_LATEST. */
|
| 157 |
+
int32_t ApiVersion;
|
| 158 |
+
));
|
| 159 |
+
|
| 160 |
+
/** The most recent version of the EOS_AntiCheatClient_AddNotifyPeerActionRequired API. */
|
| 161 |
+
#define EOS_ANTICHEATCLIENT_ADDNOTIFYPEERACTIONREQUIRED_API_LATEST 1
|
| 162 |
+
|
| 163 |
+
/**
|
| 164 |
+
* Input parameters for the EOS_AntiCheatClient_AddNotifyPeerActionRequired function.
|
| 165 |
+
*/
|
| 166 |
+
EOS_STRUCT(EOS_AntiCheatClient_AddNotifyPeerActionRequiredOptions, (
|
| 167 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_ADDNOTIFYPEERACTIONREQUIRED_API_LATEST. */
|
| 168 |
+
int32_t ApiVersion;
|
| 169 |
+
));
|
| 170 |
+
|
| 171 |
+
/** The most recent version of the EOS_AntiCheatClient_AddNotifyPeerAuthStatusChanged API. */
|
| 172 |
+
#define EOS_ANTICHEATCLIENT_ADDNOTIFYPEERAUTHSTATUSCHANGED_API_LATEST 1
|
| 173 |
+
|
| 174 |
+
/**
|
| 175 |
+
* Input parameters for the EOS_AntiCheatClient_AddNotifyPeerAuthStatusChanged function.
|
| 176 |
+
*/
|
| 177 |
+
EOS_STRUCT(EOS_AntiCheatClient_AddNotifyPeerAuthStatusChangedOptions, (
|
| 178 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_ADDNOTIFYPEERAUTHSTATUSCHANGED_API_LATEST. */
|
| 179 |
+
int32_t ApiVersion;
|
| 180 |
+
));
|
| 181 |
+
|
| 182 |
+
/** The most recent version of the EOS_AntiCheatClient_AddNotifyClientIntegrityViolated API. */
|
| 183 |
+
#define EOS_ANTICHEATCLIENT_ADDNOTIFYCLIENTINTEGRITYVIOLATED_API_LATEST 1
|
| 184 |
+
|
| 185 |
+
/**
|
| 186 |
+
* Input parameters for the EOS_AntiCheatClient_AddNotifyClientIntegrityViolated function.
|
| 187 |
+
*/
|
| 188 |
+
EOS_STRUCT(EOS_AntiCheatClient_AddNotifyClientIntegrityViolatedOptions, (
|
| 189 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_ADDNOTIFYPEERAUTHSTATUSCHANGED_API_LATEST. */
|
| 190 |
+
int32_t ApiVersion;
|
| 191 |
+
));
|
| 192 |
+
|
| 193 |
+
/** The most recent version of the EOS_AntiCheatClient_BeginSession API. */
|
| 194 |
+
#define EOS_ANTICHEATCLIENT_BEGINSESSION_API_LATEST 3
|
| 195 |
+
|
| 196 |
+
/**
|
| 197 |
+
* Input parameters for the EOS_AntiCheatClient_BeginSession function.
|
| 198 |
+
*/
|
| 199 |
+
EOS_STRUCT(EOS_AntiCheatClient_BeginSessionOptions, (
|
| 200 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_BEGINSESSION_API_LATEST. */
|
| 201 |
+
int32_t ApiVersion;
|
| 202 |
+
/** Logged in user identifier from earlier call to EOS_Connect_Login family of functions */
|
| 203 |
+
EOS_ProductUserId LocalUserId;
|
| 204 |
+
/** Operating mode */
|
| 205 |
+
EOS_EAntiCheatClientMode Mode;
|
| 206 |
+
));
|
| 207 |
+
|
| 208 |
+
/** The most recent version of the EOS_AntiCheatClient_EndSession API. */
|
| 209 |
+
#define EOS_ANTICHEATCLIENT_ENDSESSION_API_LATEST 1
|
| 210 |
+
|
| 211 |
+
/**
|
| 212 |
+
* Input parameters for the EOS_AntiCheatClient_EndSession function.
|
| 213 |
+
*/
|
| 214 |
+
EOS_STRUCT(EOS_AntiCheatClient_EndSessionOptions, (
|
| 215 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_ENDSESSION_API_LATEST. */
|
| 216 |
+
int32_t ApiVersion;
|
| 217 |
+
));
|
| 218 |
+
|
| 219 |
+
/** The most recent version of the EOS_AntiCheatClient_Reserved01 API. */
|
| 220 |
+
#define EOS_ANTICHEATCLIENT_RESERVED01_API_LATEST 1
|
| 221 |
+
|
| 222 |
+
/**
|
| 223 |
+
* Input parameters for the EOS_AntiCheatClient_Reserved01 function.
|
| 224 |
+
*/
|
| 225 |
+
EOS_STRUCT(EOS_AntiCheatClient_Reserved01Options, (
|
| 226 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_RESERVED01_API_LATEST. */
|
| 227 |
+
int32_t ApiVersion;
|
| 228 |
+
));
|
| 229 |
+
|
| 230 |
+
/** The most recent version of the EOS_AntiCheatClient_Reserved02 API. */
|
| 231 |
+
#define EOS_ANTICHEATCLIENT_RESERVED02_API_LATEST 1
|
| 232 |
+
|
| 233 |
+
/**
|
| 234 |
+
* Input parameters for the EOS_AntiCheatClient_Reserved02 function.
|
| 235 |
+
*/
|
| 236 |
+
EOS_STRUCT(EOS_AntiCheatClient_Reserved02Options, (
|
| 237 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_RESERVED02_API_LATEST. */
|
| 238 |
+
int32_t ApiVersion;
|
| 239 |
+
/** Field reserved for future use */
|
| 240 |
+
int64_t Reserved1;
|
| 241 |
+
/** Field reserved for future use */
|
| 242 |
+
uint32_t Reserved2;
|
| 243 |
+
/** Field reserved for future use */
|
| 244 |
+
uint32_t Reserved3;
|
| 245 |
+
/** Field reserved for future use */
|
| 246 |
+
const void* Reserved4;
|
| 247 |
+
));
|
| 248 |
+
|
| 249 |
+
/** The most recent version of the EOS_AntiCheatClient_GetModuleBuildId API. */
|
| 250 |
+
#define EOS_ANTICHEATCLIENT_GETMODULEBUILDID_API_LATEST 1
|
| 251 |
+
|
| 252 |
+
/**
|
| 253 |
+
* Input parameters for the EOS_AntiCheatClient_GetModuleBuildId function.
|
| 254 |
+
*/
|
| 255 |
+
EOS_STRUCT(EOS_AntiCheatClient_GetModuleBuildIdOptions, (
|
| 256 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_GETMODULEBUILDID_API_LATEST. */
|
| 257 |
+
int32_t ApiVersion;
|
| 258 |
+
));
|
| 259 |
+
|
| 260 |
+
/** The most recent version of the EOS_AntiCheatClient_AddExternalIntegrityCatalog API. */
|
| 261 |
+
#define EOS_ANTICHEATCLIENT_ADDEXTERNALINTEGRITYCATALOG_API_LATEST 1
|
| 262 |
+
|
| 263 |
+
/**
|
| 264 |
+
* Input parameters for the EOS_AntiCheatClient_AddExternalIntegrityCatalog function.
|
| 265 |
+
*/
|
| 266 |
+
EOS_STRUCT(EOS_AntiCheatClient_AddExternalIntegrityCatalogOptions, (
|
| 267 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_ADDEXTERNALINTEGRITYCATALOG_API_LATEST. */
|
| 268 |
+
int32_t ApiVersion;
|
| 269 |
+
/** UTF-8 path to the .bin catalog file to add */
|
| 270 |
+
const char* PathToBinFile;
|
| 271 |
+
));
|
| 272 |
+
|
| 273 |
+
/** The most recent version of the EOS_AntiCheatClient_ReceiveMessageFromServer API. */
|
| 274 |
+
#define EOS_ANTICHEATCLIENT_RECEIVEMESSAGEFROMSERVER_API_LATEST 1
|
| 275 |
+
|
| 276 |
+
/**
|
| 277 |
+
* Input parameters for the EOS_AntiCheatClient_ReceiveMessageFromServer function.
|
| 278 |
+
*/
|
| 279 |
+
EOS_STRUCT(EOS_AntiCheatClient_ReceiveMessageFromServerOptions, (
|
| 280 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_RECEIVEMESSAGEFROMSERVER_API_LATEST. */
|
| 281 |
+
int32_t ApiVersion;
|
| 282 |
+
/** The size of the data received */
|
| 283 |
+
uint32_t DataLengthBytes;
|
| 284 |
+
/** The data received */
|
| 285 |
+
const void* Data;
|
| 286 |
+
));
|
| 287 |
+
|
| 288 |
+
/** The most recent version of the EOS_AntiCheatClient_GetProtectMessageOutputLength API. */
|
| 289 |
+
#define EOS_ANTICHEATCLIENT_GETPROTECTMESSAGEOUTPUTLENGTH_API_LATEST 1
|
| 290 |
+
|
| 291 |
+
/**
|
| 292 |
+
* Input parameters for the EOS_AntiCheatClient_GetProtectMessageOutputLength function.
|
| 293 |
+
*/
|
| 294 |
+
EOS_STRUCT(EOS_AntiCheatClient_GetProtectMessageOutputLengthOptions, (
|
| 295 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_GETPROTECTMESSAGEOUTPUTLENGTH_API_LATEST. */
|
| 296 |
+
int32_t ApiVersion;
|
| 297 |
+
/** Length in bytes of input */
|
| 298 |
+
uint32_t DataLengthBytes;
|
| 299 |
+
));
|
| 300 |
+
|
| 301 |
+
/** The most recent version of the EOS_AntiCheatClient_ProtectMessage API. */
|
| 302 |
+
#define EOS_ANTICHEATCLIENT_PROTECTMESSAGE_API_LATEST 1
|
| 303 |
+
|
| 304 |
+
/**
|
| 305 |
+
* Input parameters for the EOS_AntiCheatClient_ProtectMessage function.
|
| 306 |
+
*/
|
| 307 |
+
EOS_STRUCT(EOS_AntiCheatClient_ProtectMessageOptions, (
|
| 308 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_PROTECTMESSAGE_API_LATEST. */
|
| 309 |
+
int32_t ApiVersion;
|
| 310 |
+
/** Length in bytes of input */
|
| 311 |
+
uint32_t DataLengthBytes;
|
| 312 |
+
/** The data to encrypt */
|
| 313 |
+
const void* Data;
|
| 314 |
+
/** The size in bytes of OutBuffer */
|
| 315 |
+
uint32_t OutBufferSizeBytes;
|
| 316 |
+
));
|
| 317 |
+
|
| 318 |
+
/** The most recent version of the EOS_AntiCheatClient_UnprotectMessage API. */
|
| 319 |
+
#define EOS_ANTICHEATCLIENT_UNPROTECTMESSAGE_API_LATEST 1
|
| 320 |
+
|
| 321 |
+
/**
|
| 322 |
+
* Input parameters for the EOS_AntiCheatClient_UnprotectMessage function.
|
| 323 |
+
*/
|
| 324 |
+
EOS_STRUCT(EOS_AntiCheatClient_UnprotectMessageOptions, (
|
| 325 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_UNPROTECTMESSAGE_API_LATEST. */
|
| 326 |
+
int32_t ApiVersion;
|
| 327 |
+
/** Length in bytes of input */
|
| 328 |
+
uint32_t DataLengthBytes;
|
| 329 |
+
/** The data to decrypt */
|
| 330 |
+
const void* Data;
|
| 331 |
+
/** The size in bytes of OutBuffer */
|
| 332 |
+
uint32_t OutBufferSizeBytes;
|
| 333 |
+
));
|
| 334 |
+
|
| 335 |
+
/**
|
| 336 |
+
* A special peer handle that represents the client itself.
|
| 337 |
+
* It does not need to be registered or unregistered and is
|
| 338 |
+
* used in OnPeerActionRequiredCallback to quickly signal to the user
|
| 339 |
+
* that they will not be able to join online play.
|
| 340 |
+
*/
|
| 341 |
+
#define EOS_ANTICHEATCLIENT_PEER_SELF (EOS_AntiCheatCommon_ClientHandle)(-1)
|
| 342 |
+
|
| 343 |
+
/** The minimum value for the AuthenticationTimeout parameter in the EOS_AntiCheatClient_RegisterPeerOptions struct. */
|
| 344 |
+
#define EOS_ANTICHEATCLIENT_REGISTERPEER_MIN_AUTHENTICATIONTIMEOUT 40
|
| 345 |
+
|
| 346 |
+
/** The maximum value for the AuthenticationTimeout parameter in the EOS_AntiCheatClient_RegisterPeerOptions struct. */
|
| 347 |
+
#define EOS_ANTICHEATCLIENT_REGISTERPEER_MAX_AUTHENTICATIONTIMEOUT 120
|
| 348 |
+
|
| 349 |
+
/** The most recent version of the EOS_AntiCheatClient_RegisterPeerOptions API. */
|
| 350 |
+
#define EOS_ANTICHEATCLIENT_REGISTERPEER_API_LATEST 3
|
| 351 |
+
|
| 352 |
+
/**
|
| 353 |
+
* Input parameters for the EOS_AntiCheatClient_RegisterPeerOptions function.
|
| 354 |
+
*/
|
| 355 |
+
EOS_STRUCT(EOS_AntiCheatClient_RegisterPeerOptions, (
|
| 356 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_REGISTERPEER_API_LATEST. */
|
| 357 |
+
int32_t ApiVersion;
|
| 358 |
+
/** Locally unique value describing the remote user (e.g. a player object pointer) */
|
| 359 |
+
EOS_AntiCheatCommon_ClientHandle PeerHandle;
|
| 360 |
+
/** Type of remote user being registered */
|
| 361 |
+
EOS_EAntiCheatCommonClientType ClientType;
|
| 362 |
+
/** Remote user's platform, if known */
|
| 363 |
+
EOS_EAntiCheatCommonClientPlatform ClientPlatform;
|
| 364 |
+
/**
|
| 365 |
+
* Time in seconds to allow newly registered peers to send the initial message containing their token.
|
| 366 |
+
* Minimum value: EOS_ANTICHEATCLIENT_REGISTERPEER_MIN_AUTHENTICATIONTIMEOUT
|
| 367 |
+
* Maximum value: EOS_ANTICHEATCLIENT_REGISTERPEER_MAX_AUTHENTICATIONTIMEOUT
|
| 368 |
+
*/
|
| 369 |
+
uint32_t AuthenticationTimeout;
|
| 370 |
+
/** Deprecated - use PeerProductUserId instead */
|
| 371 |
+
const char* AccountId_DEPRECATED;
|
| 372 |
+
/**
|
| 373 |
+
* Optional IP address for the remote user. May be null if not available.
|
| 374 |
+
* IPv4 format: "0.0.0.0"
|
| 375 |
+
* IPv6 format: "0:0:0:0:0:0:0:0"
|
| 376 |
+
*/
|
| 377 |
+
const char* IpAddress;
|
| 378 |
+
/** EOS_ProductUserId Identifier for the remote user */
|
| 379 |
+
EOS_ProductUserId PeerProductUserId;
|
| 380 |
+
));
|
| 381 |
+
|
| 382 |
+
/** The most recent version of the EOS_AntiCheatClient_UnregisterPeer API. */
|
| 383 |
+
#define EOS_ANTICHEATCLIENT_UNREGISTERPEER_API_LATEST 1
|
| 384 |
+
|
| 385 |
+
/**
|
| 386 |
+
* Input parameters for the EOS_AntiCheatClient_UnregisterPeer function.
|
| 387 |
+
*/
|
| 388 |
+
EOS_STRUCT(EOS_AntiCheatClient_UnregisterPeerOptions, (
|
| 389 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_UNREGISTERPEER_API_LATEST. */
|
| 390 |
+
int32_t ApiVersion;
|
| 391 |
+
/** Locally unique value describing the remote user, as previously passed to EOS_AntiCheatClient_RegisterPeer */
|
| 392 |
+
EOS_AntiCheatCommon_ClientHandle PeerHandle;
|
| 393 |
+
));
|
| 394 |
+
|
| 395 |
+
/** The most recent version of the EOS_AntiCheatClient_ReceiveMessageFromPeer API. */
|
| 396 |
+
#define EOS_ANTICHEATCLIENT_RECEIVEMESSAGEFROMPEER_API_LATEST 1
|
| 397 |
+
|
| 398 |
+
/**
|
| 399 |
+
* Input parameters for the EOS_AntiCheatClient_ReceiveMessageFromPeer function.
|
| 400 |
+
*/
|
| 401 |
+
EOS_STRUCT(EOS_AntiCheatClient_ReceiveMessageFromPeerOptions, (
|
| 402 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_RECEIVEMESSAGEFROMPEER_API_LATEST. */
|
| 403 |
+
int32_t ApiVersion;
|
| 404 |
+
/** The handle describing the sender of this message */
|
| 405 |
+
EOS_AntiCheatCommon_ClientHandle PeerHandle;
|
| 406 |
+
/** The size of the data received */
|
| 407 |
+
uint32_t DataLengthBytes;
|
| 408 |
+
/** The data received */
|
| 409 |
+
const void* Data;
|
| 410 |
+
));
|
| 411 |
+
|
| 412 |
+
#pragma pack(pop)
|
| 413 |
+
|
| 414 |
+
#include "eos_anticheatclient_types_deprecated.inl"
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatclient_types_deprecated.inl
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
/**
|
| 8 |
+
* This file contains the deprecated types for EOS AntiCheat Client. In a future version, these types will be removed.
|
| 9 |
+
*/
|
| 10 |
+
|
| 11 |
+
#pragma pack(push, 8)
|
| 12 |
+
|
| 13 |
+
/** The most recent version of the EOS_AntiCheatClient_PollStatus API. */
|
| 14 |
+
#define EOS_ANTICHEATCLIENT_POLLSTATUS_API_LATEST 1
|
| 15 |
+
|
| 16 |
+
/**
|
| 17 |
+
* Input parameters for the EOS_AntiCheatClient_PollStatus function.
|
| 18 |
+
*/
|
| 19 |
+
EOS_STRUCT(EOS_AntiCheatClient_PollStatusOptions, (
|
| 20 |
+
/** API Version: Set this to EOS_ANTICHEATCLIENT_POLLSTATUS_API_LATEST. */
|
| 21 |
+
int32_t ApiVersion;
|
| 22 |
+
/** The size of OutMessage in bytes. Recommended size is 256 bytes. */
|
| 23 |
+
uint32_t OutMessageLength;
|
| 24 |
+
));
|
| 25 |
+
|
| 26 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatcommon_types.h
ADDED
|
@@ -0,0 +1,631 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
/**
|
| 10 |
+
* Arbitrary data that is a unique local identifier for
|
| 11 |
+
* a single remote client or peer.
|
| 12 |
+
*
|
| 13 |
+
* Typically this is a pointer to an object describing the
|
| 14 |
+
* player, but it can be anything that is locally unique.
|
| 15 |
+
*/
|
| 16 |
+
EOS_EXTERN_C typedef void* EOS_AntiCheatCommon_ClientHandle;
|
| 17 |
+
|
| 18 |
+
/** Flags describing the type of a remote client */
|
| 19 |
+
EOS_ENUM(EOS_EAntiCheatCommonClientType,
|
| 20 |
+
/** An ordinary player that requires anti-cheat client protection to play */
|
| 21 |
+
EOS_ACCCT_ProtectedClient = 0,
|
| 22 |
+
/** The player does not need the anti-cheat client to play because of their platform or other factors */
|
| 23 |
+
EOS_ACCCT_UnprotectedClient = 1,
|
| 24 |
+
/** The client is an AI bot, not an actual human */
|
| 25 |
+
EOS_ACCCT_AIBot = 2
|
| 26 |
+
);
|
| 27 |
+
|
| 28 |
+
/** Flags describing the platform of a remote client, if known */
|
| 29 |
+
EOS_ENUM(EOS_EAntiCheatCommonClientPlatform,
|
| 30 |
+
/** Unknown platform */
|
| 31 |
+
EOS_ACCCP_Unknown = 0,
|
| 32 |
+
/** The client is playing on Windows */
|
| 33 |
+
EOS_ACCCP_Windows = 1,
|
| 34 |
+
/** The client is playing on Mac */
|
| 35 |
+
EOS_ACCCP_Mac = 2,
|
| 36 |
+
/** The client is playing on Linux */
|
| 37 |
+
EOS_ACCCP_Linux = 3,
|
| 38 |
+
/** The client is playing on an Xbox device */
|
| 39 |
+
EOS_ACCCP_Xbox = 4,
|
| 40 |
+
/** The client is playing on a PlayStation device */
|
| 41 |
+
EOS_ACCCP_PlayStation = 5,
|
| 42 |
+
/** The client is playing on a Nintendo device */
|
| 43 |
+
EOS_ACCCP_Nintendo = 6,
|
| 44 |
+
/** The client is playing on iOS */
|
| 45 |
+
EOS_ACCCP_iOS = 7,
|
| 46 |
+
/** The client is playing on Android */
|
| 47 |
+
EOS_ACCCP_Android = 8
|
| 48 |
+
);
|
| 49 |
+
|
| 50 |
+
/** Anti-cheat action values. Applicable to both clients and remote peers. */
|
| 51 |
+
EOS_ENUM(EOS_EAntiCheatCommonClientAction,
|
| 52 |
+
/** Not used */
|
| 53 |
+
EOS_ACCCA_Invalid = 0,
|
| 54 |
+
/** The client/peer must be removed from the current game session */
|
| 55 |
+
EOS_ACCCA_RemovePlayer = 1
|
| 56 |
+
);
|
| 57 |
+
|
| 58 |
+
/** Anti-cheat action reasons. Applicable to both clients and remote peers. */
|
| 59 |
+
EOS_ENUM(EOS_EAntiCheatCommonClientActionReason,
|
| 60 |
+
/** Not used */
|
| 61 |
+
EOS_ACCCAR_Invalid = 0,
|
| 62 |
+
/** An internal error occurred */
|
| 63 |
+
EOS_ACCCAR_InternalError = 1,
|
| 64 |
+
/** An anti-cheat message received from the client/peer was corrupt or invalid */
|
| 65 |
+
EOS_ACCCAR_InvalidMessage = 2,
|
| 66 |
+
/** The client/peer's anti-cheat authentication failed */
|
| 67 |
+
EOS_ACCCAR_AuthenticationFailed = 3,
|
| 68 |
+
/** The client/peer failed to load the anti-cheat module at startup */
|
| 69 |
+
EOS_ACCCAR_NullClient = 4,
|
| 70 |
+
/** The client/peer's anti-cheat heartbeat was not received */
|
| 71 |
+
EOS_ACCCAR_HeartbeatTimeout = 5,
|
| 72 |
+
/** The client/peer failed an anti-cheat client runtime check */
|
| 73 |
+
EOS_ACCCAR_ClientViolation = 6,
|
| 74 |
+
/** The client/peer failed an anti-cheat backend runtime check */
|
| 75 |
+
EOS_ACCCAR_BackendViolation = 7,
|
| 76 |
+
/** The client/peer is temporarily blocked from playing on this game server */
|
| 77 |
+
EOS_ACCCAR_TemporaryCooldown = 8,
|
| 78 |
+
/** The client/peer is temporarily banned */
|
| 79 |
+
EOS_ACCCAR_TemporaryBanned = 9,
|
| 80 |
+
/** The client/peer is permanently banned */
|
| 81 |
+
EOS_ACCCAR_PermanentBanned = 10
|
| 82 |
+
);
|
| 83 |
+
|
| 84 |
+
/** The client/peer's anti-cheat authentication status */
|
| 85 |
+
EOS_ENUM(EOS_EAntiCheatCommonClientAuthStatus,
|
| 86 |
+
/** Not used */
|
| 87 |
+
EOS_ACCCAS_Invalid = 0,
|
| 88 |
+
/** The client/peer's anti-cheat functionality has been validated by this game server */
|
| 89 |
+
EOS_ACCCAS_LocalAuthComplete = 1,
|
| 90 |
+
/** The client/peer's anti-cheat functionality has been validated by the anti-cheat backend service */
|
| 91 |
+
EOS_ACCCAS_RemoteAuthComplete = 2
|
| 92 |
+
);
|
| 93 |
+
|
| 94 |
+
/** Flags describing a remote client. These can be updated during a play session */
|
| 95 |
+
EOS_ENUM(EOS_EAntiCheatCommonClientFlags,
|
| 96 |
+
/** No particular flags relevant for this client */
|
| 97 |
+
EOS_ACCCF_None = 0,
|
| 98 |
+
/** The client has admin privileges on the game server */
|
| 99 |
+
EOS_ACCCF_Admin = (1 << 0)
|
| 100 |
+
);
|
| 101 |
+
EOS_ENUM_BOOLEAN_OPERATORS(EOS_EAntiCheatCommonClientFlags);
|
| 102 |
+
|
| 103 |
+
/** Flags describing the input device used by a remote client, if known. These can be updated during a play session. */
|
| 104 |
+
EOS_ENUM(EOS_EAntiCheatCommonClientInput,
|
| 105 |
+
/** Unknown input device */
|
| 106 |
+
EOS_ACCCI_Unknown = 0,
|
| 107 |
+
/** The client is using mouse and keyboard */
|
| 108 |
+
EOS_ACCCI_MouseKeyboard = 1,
|
| 109 |
+
/** The client is using a gamepad or game controller */
|
| 110 |
+
EOS_ACCCI_Gamepad = 2,
|
| 111 |
+
/** The client is using a touch input device (e.g. phone/tablet screen) */
|
| 112 |
+
EOS_ACCCI_TouchInput = 3
|
| 113 |
+
);
|
| 114 |
+
|
| 115 |
+
/**
|
| 116 |
+
* Types supported for custom gameplay behavior events.
|
| 117 |
+
* These have a considerable impact on performance
|
| 118 |
+
*/
|
| 119 |
+
EOS_ENUM(EOS_EAntiCheatCommonEventType,
|
| 120 |
+
/** Not used */
|
| 121 |
+
EOS_ACCET_Invalid = 0,
|
| 122 |
+
/**
|
| 123 |
+
* A general game event that is not specific to any individual player.
|
| 124 |
+
* Low memory use which is constant with respect to the number of players.
|
| 125 |
+
*/
|
| 126 |
+
EOS_ACCET_GameEvent = 1,
|
| 127 |
+
/**
|
| 128 |
+
* An event that is logically associated with a specific player. Events logged in
|
| 129 |
+
* this category require a specific ClientHandle to which they will be attached.
|
| 130 |
+
* Higher memory use which scales according to the number of players.
|
| 131 |
+
*/
|
| 132 |
+
EOS_ACCET_PlayerEvent = 2
|
| 133 |
+
);
|
| 134 |
+
|
| 135 |
+
/** Types supported for custom gameplay behavior event parameters */
|
| 136 |
+
EOS_ENUM(EOS_EAntiCheatCommonEventParamType,
|
| 137 |
+
/** Not used */
|
| 138 |
+
EOS_ACCEPT_Invalid = 0,
|
| 139 |
+
/** EOS_AntiCheatCommon_ClientHandle */
|
| 140 |
+
EOS_ACCEPT_ClientHandle = 1,
|
| 141 |
+
/** const char* */
|
| 142 |
+
EOS_ACCEPT_String = 2,
|
| 143 |
+
/** uint32_t */
|
| 144 |
+
EOS_ACCEPT_UInt32 = 3,
|
| 145 |
+
/** int32_t */
|
| 146 |
+
EOS_ACCEPT_Int32 = 4,
|
| 147 |
+
/** uint64_t */
|
| 148 |
+
EOS_ACCEPT_UInt64 = 5,
|
| 149 |
+
/** int64_t */
|
| 150 |
+
EOS_ACCEPT_Int64 = 6,
|
| 151 |
+
/** EOS_AntiCheatCommon_Vec3f */
|
| 152 |
+
EOS_ACCEPT_Vector3f = 7,
|
| 153 |
+
/** EOS_AntiCheatCommon_Quat */
|
| 154 |
+
EOS_ACCEPT_Quat = 8,
|
| 155 |
+
/** float */
|
| 156 |
+
EOS_ACCEPT_Float = 9
|
| 157 |
+
);
|
| 158 |
+
|
| 159 |
+
/** Flags describing the type of competition taking place */
|
| 160 |
+
EOS_ENUM(EOS_EAntiCheatCommonGameRoundCompetitionType,
|
| 161 |
+
/** No particular competition type applies */
|
| 162 |
+
EOS_ACCGRCT_None = 0,
|
| 163 |
+
/** Casual unranked play */
|
| 164 |
+
EOS_ACCGRCT_Casual = 1,
|
| 165 |
+
/** Ranked play, usually with skill based matchmaking */
|
| 166 |
+
EOS_ACCGRCT_Ranked = 2,
|
| 167 |
+
/** Organized competitive play like a tournament */
|
| 168 |
+
EOS_ACCGRCT_Competitive = 3
|
| 169 |
+
);
|
| 170 |
+
|
| 171 |
+
/** Details of a player's movement state */
|
| 172 |
+
EOS_ENUM(EOS_EAntiCheatCommonPlayerMovementState,
|
| 173 |
+
/** No particular state applies */
|
| 174 |
+
EOS_ACCPMS_None = 0,
|
| 175 |
+
/** Player is crouching */
|
| 176 |
+
EOS_ACCPMS_Crouching = 1,
|
| 177 |
+
/** Player is prone */
|
| 178 |
+
EOS_ACCPMS_Prone = 2,
|
| 179 |
+
/** Player is mounted in a vehicle or similar */
|
| 180 |
+
EOS_ACCPMS_Mounted = 3,
|
| 181 |
+
/** Player is swimming in a fluid volume */
|
| 182 |
+
EOS_ACCPMS_Swimming = 4,
|
| 183 |
+
/** Player is falling under the effects of gravity, such as when jumping or walking off the edge of a surface */
|
| 184 |
+
EOS_ACCPMS_Falling = 5,
|
| 185 |
+
/** Player is flying, ignoring the effects of gravity */
|
| 186 |
+
EOS_ACCPMS_Flying = 6,
|
| 187 |
+
/** Player is on a ladder */
|
| 188 |
+
EOS_ACCPMS_OnLadder = 7
|
| 189 |
+
);
|
| 190 |
+
|
| 191 |
+
/** The source of a damage event */
|
| 192 |
+
EOS_ENUM(EOS_EAntiCheatCommonPlayerTakeDamageSource,
|
| 193 |
+
/** No particular source relevant */
|
| 194 |
+
EOS_ACCPTDS_None = 0,
|
| 195 |
+
/** Damage caused by a player controlled character */
|
| 196 |
+
EOS_ACCPTDS_Player = 1,
|
| 197 |
+
/** Damage caused by a non-player character such as an AI enemy */
|
| 198 |
+
EOS_ACCPTDS_NonPlayerCharacter = 2,
|
| 199 |
+
/** Damage caused by the world (falling off level, into lava, etc) */
|
| 200 |
+
EOS_ACCPTDS_World = 3
|
| 201 |
+
);
|
| 202 |
+
|
| 203 |
+
/** Type of damage applied in a damage event */
|
| 204 |
+
EOS_ENUM(EOS_EAntiCheatCommonPlayerTakeDamageType,
|
| 205 |
+
/** No particular type relevant */
|
| 206 |
+
EOS_ACCPTDT_None = 0,
|
| 207 |
+
/** Damage caused by a point source such as a bullet or melee attack */
|
| 208 |
+
EOS_ACCPTDT_PointDamage = 1,
|
| 209 |
+
/** Damage caused by a radial source such as an explosion */
|
| 210 |
+
EOS_ACCPTDT_RadialDamage = 2,
|
| 211 |
+
/** Damage over time such as bleeding, poison, etc */
|
| 212 |
+
EOS_ACCPTDT_DamageOverTime = 3
|
| 213 |
+
);
|
| 214 |
+
|
| 215 |
+
/** The result of a damage event, if any */
|
| 216 |
+
EOS_ENUM(EOS_EAntiCheatCommonPlayerTakeDamageResult,
|
| 217 |
+
/** No direct state change consequence for the victim */
|
| 218 |
+
EOS_ACCPTDR_None = 0,
|
| 219 |
+
/** Deprecated - use more specific values below instead */
|
| 220 |
+
EOS_ACCPTDR_Downed_DEPRECATED = 1,
|
| 221 |
+
/** Deprecated - use more specific values below instead */
|
| 222 |
+
EOS_ACCPTDR_Eliminated_DEPRECATED = 2,
|
| 223 |
+
/** Player character transitioned from a normal state to temporarily incapacitated and requires assistance to recover. */
|
| 224 |
+
EOS_ACCPTDR_NormalToDowned = 3,
|
| 225 |
+
/** Player character transitioned from a normal state to permanently incapacitated and cannot recover (e.g. dead). */
|
| 226 |
+
EOS_ACCPTDR_NormalToEliminated = 4,
|
| 227 |
+
/** Player character transitioned from a temporarily incapacitated state to permanently incapacitated and cannot recover (e.g. dead). */
|
| 228 |
+
EOS_ACCPTDR_DownedToEliminated = 5
|
| 229 |
+
);
|
| 230 |
+
|
| 231 |
+
/** Vector using left-handed coordinate system (as in Unreal Engine) */
|
| 232 |
+
EOS_STRUCT(EOS_AntiCheatCommon_Vec3f, (
|
| 233 |
+
/** X axis coordinate - forward direction */
|
| 234 |
+
float x;
|
| 235 |
+
/** Y axis coordinate - right direction */
|
| 236 |
+
float y;
|
| 237 |
+
/** Z axis coordinate - up direction */
|
| 238 |
+
float z;
|
| 239 |
+
));
|
| 240 |
+
|
| 241 |
+
/** Quaternion using left-handed coordinate system (as in Unreal Engine) */
|
| 242 |
+
EOS_STRUCT(EOS_AntiCheatCommon_Quat, (
|
| 243 |
+
/** W component - scalar part */
|
| 244 |
+
float w;
|
| 245 |
+
/** X component - forward direction */
|
| 246 |
+
float x;
|
| 247 |
+
/** Y component - right direction */
|
| 248 |
+
float y;
|
| 249 |
+
/** Z component - up direction */
|
| 250 |
+
float z;
|
| 251 |
+
));
|
| 252 |
+
|
| 253 |
+
/**
|
| 254 |
+
* Structure containing details about a new message that must be dispatched to a connected client/peer.
|
| 255 |
+
*/
|
| 256 |
+
EOS_STRUCT(EOS_AntiCheatCommon_OnMessageToClientCallbackInfo, (
|
| 257 |
+
/** Caller-specified context data */
|
| 258 |
+
void* ClientData;
|
| 259 |
+
/** The identifier of the client/peer that this message must be delivered to. See the RegisterClient and RegisterPeer functions. */
|
| 260 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 261 |
+
/** The message data that must be sent to the client */
|
| 262 |
+
const void* MessageData;
|
| 263 |
+
/** The size in bytes of MessageData */
|
| 264 |
+
uint32_t MessageDataSizeBytes;
|
| 265 |
+
));
|
| 266 |
+
|
| 267 |
+
/** Structure containing details about a required client/peer action */
|
| 268 |
+
EOS_STRUCT(EOS_AntiCheatCommon_OnClientActionRequiredCallbackInfo, (
|
| 269 |
+
/** Caller-specified context data */
|
| 270 |
+
void* ClientData;
|
| 271 |
+
/** The identifier of the client/peer that this action applies to. See the RegisterClient and RegisterPeer functions. */
|
| 272 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 273 |
+
/** The action that must be applied to the specified client/peer */
|
| 274 |
+
EOS_EAntiCheatCommonClientAction ClientAction;
|
| 275 |
+
/** Code indicating the reason for the action. This can be displayed to the affected player. */
|
| 276 |
+
EOS_EAntiCheatCommonClientActionReason ActionReasonCode;
|
| 277 |
+
/** String containing details about the action reason. This can be displayed to the affected player. */
|
| 278 |
+
const char* ActionReasonDetailsString;
|
| 279 |
+
));
|
| 280 |
+
|
| 281 |
+
/** Structure containing details about a client/peer authentication status change */
|
| 282 |
+
EOS_STRUCT(EOS_AntiCheatCommon_OnClientAuthStatusChangedCallbackInfo, (
|
| 283 |
+
/** Caller-specified context data */
|
| 284 |
+
void* ClientData;
|
| 285 |
+
/** The identifier of the client/peer that this status change applies to. See the RegisterClient and RegisterPeer functions. */
|
| 286 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 287 |
+
/** The client/peer's new authentication status */
|
| 288 |
+
EOS_EAntiCheatCommonClientAuthStatus ClientAuthStatus;
|
| 289 |
+
));
|
| 290 |
+
|
| 291 |
+
/** The most recent version of the EOS_AntiCheatCommon_SetClientDetailsOptions struct. */
|
| 292 |
+
#define EOS_ANTICHEATCOMMON_SETCLIENTDETAILS_API_LATEST 1
|
| 293 |
+
|
| 294 |
+
/**
|
| 295 |
+
* Input parameters for the EOS_AntiCheatServer_SetClientDetails function.
|
| 296 |
+
*/
|
| 297 |
+
EOS_STRUCT(EOS_AntiCheatCommon_SetClientDetailsOptions, (
|
| 298 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_SETCLIENTDETAILS_API_LATEST. */
|
| 299 |
+
int32_t ApiVersion;
|
| 300 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 301 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 302 |
+
/** General flags associated with this client, if any */
|
| 303 |
+
EOS_EAntiCheatCommonClientFlags ClientFlags;
|
| 304 |
+
/** Input device being used by this client, if known */
|
| 305 |
+
EOS_EAntiCheatCommonClientInput ClientInputMethod;
|
| 306 |
+
));
|
| 307 |
+
|
| 308 |
+
/** The most recent version of the EOS_AntiCheatCommon_SetGameSessionIdOptions struct. */
|
| 309 |
+
#define EOS_ANTICHEATCOMMON_SETGAMESESSIONID_API_LATEST 1
|
| 310 |
+
|
| 311 |
+
/**
|
| 312 |
+
* Input parameters for the EOS_AntiCheatServer_SetGameSessionId function.
|
| 313 |
+
*/
|
| 314 |
+
EOS_STRUCT(EOS_AntiCheatCommon_SetGameSessionIdOptions, (
|
| 315 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_SETGAMESESSIONID_API_LATEST. */
|
| 316 |
+
int32_t ApiVersion;
|
| 317 |
+
/** Game session identifier */
|
| 318 |
+
const char* GameSessionId;
|
| 319 |
+
));
|
| 320 |
+
|
| 321 |
+
/** Min value for EventId in EOS_AntiCheatCommon_RegisterEventOptions. */
|
| 322 |
+
#define EOS_ANTICHEATCOMMON_REGISTEREVENT_CUSTOMEVENTBASE 0x10000000
|
| 323 |
+
|
| 324 |
+
/** Max value for ParamDefsCount in EOS_AntiCheatCommon_RegisterEventOptions. */
|
| 325 |
+
#define EOS_ANTICHEATCOMMON_REGISTEREVENT_MAX_PARAMDEFSCOUNT 12
|
| 326 |
+
|
| 327 |
+
/**
|
| 328 |
+
* Register Event Parameter Definition.
|
| 329 |
+
*/
|
| 330 |
+
EOS_STRUCT(EOS_AntiCheatCommon_RegisterEventParamDef, (
|
| 331 |
+
/** Parameter name. Allowed characters are 0-9, A-Z, a-z, '_', '-' */
|
| 332 |
+
const char* ParamName;
|
| 333 |
+
/** Parameter type */
|
| 334 |
+
EOS_EAntiCheatCommonEventParamType ParamType;
|
| 335 |
+
));
|
| 336 |
+
|
| 337 |
+
/** The most recent version of the EOS_AntiCheatCommon_RegisterEventOptions struct. */
|
| 338 |
+
#define EOS_ANTICHEATCOMMON_REGISTEREVENT_API_LATEST 1
|
| 339 |
+
|
| 340 |
+
/**
|
| 341 |
+
* Input parameters for the EOS_AntiCheatServer_RegisterEvent function.
|
| 342 |
+
*/
|
| 343 |
+
EOS_STRUCT(EOS_AntiCheatCommon_RegisterEventOptions, (
|
| 344 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_REGISTEREVENT_API_LATEST. */
|
| 345 |
+
int32_t ApiVersion;
|
| 346 |
+
/** Unique event identifier. Must be `>= EOS_ANTICHEATCOMMON_REGISTEREVENT_CUSTOMEVENTBASE`. */
|
| 347 |
+
uint32_t EventId;
|
| 348 |
+
/** Name of the custom event. Allowed characters are 0-9, A-Z, a-z, '_', '-' */
|
| 349 |
+
const char* EventName;
|
| 350 |
+
/** Type of the custom event */
|
| 351 |
+
EOS_EAntiCheatCommonEventType EventType;
|
| 352 |
+
/** Number of parameters described in ParamDefs. Must be equal to or less than EOS_ANTICHEATCOMMON_REGISTEREVENT_MAX_PARAMDEFSCOUNT. */
|
| 353 |
+
uint32_t ParamDefsCount;
|
| 354 |
+
/** Pointer to an array of EOS_AntiCheatCommon_RegisterEventParamDef with ParamDefsCount elements */
|
| 355 |
+
const EOS_AntiCheatCommon_RegisterEventParamDef* ParamDefs;
|
| 356 |
+
));
|
| 357 |
+
|
| 358 |
+
/** Max string length for a log event param value. */
|
| 359 |
+
#define EOS_ANTICHEATCOMMON_LOGEVENT_STRING_MAX_LENGTH 39
|
| 360 |
+
|
| 361 |
+
/**
|
| 362 |
+
* Log Event Parameter.
|
| 363 |
+
*/
|
| 364 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogEventParamPair, (
|
| 365 |
+
/** Parameter type */
|
| 366 |
+
EOS_EAntiCheatCommonEventParamType ParamValueType;
|
| 367 |
+
/** Parameter value */
|
| 368 |
+
union
|
| 369 |
+
{
|
| 370 |
+
/** Client handle. */
|
| 371 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 372 |
+
/**
|
| 373 |
+
* The value as a string.
|
| 374 |
+
* Will be truncated if longer than EOS_ANTICHEATCOMMON_LOGEVENT_STRING_MAX_LENGTH bytes.
|
| 375 |
+
*/
|
| 376 |
+
const char* String;
|
| 377 |
+
/** The value as a uint32_t. */
|
| 378 |
+
uint32_t UInt32;
|
| 379 |
+
/** The value as an int32_t. */
|
| 380 |
+
int32_t Int32;
|
| 381 |
+
/** The value as a uint64_t. */
|
| 382 |
+
uint64_t UInt64;
|
| 383 |
+
/** The value as an int64_t. */
|
| 384 |
+
int64_t Int64;
|
| 385 |
+
/** The value as an EOS_AntiCheatCommon_Vec3f. */
|
| 386 |
+
EOS_AntiCheatCommon_Vec3f Vec3f;
|
| 387 |
+
/** The value as an EOS_AntiCheatCommon_Quat. */
|
| 388 |
+
EOS_AntiCheatCommon_Quat Quat;
|
| 389 |
+
/** The value as a float. */
|
| 390 |
+
float Float;
|
| 391 |
+
} ParamValue;
|
| 392 |
+
));
|
| 393 |
+
|
| 394 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogEventOptions struct. */
|
| 395 |
+
#define EOS_ANTICHEATCOMMON_LOGEVENT_API_LATEST 1
|
| 396 |
+
|
| 397 |
+
/**
|
| 398 |
+
* Input parameters for the EOS_AntiCheatServer_LogEvent function.
|
| 399 |
+
*/
|
| 400 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogEventOptions, (
|
| 401 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGEVENT_API_LATEST. */
|
| 402 |
+
int32_t ApiVersion;
|
| 403 |
+
/** Optional client who this event is primarily associated with. If not applicable, use 0. */
|
| 404 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 405 |
+
/** Unique event identifier previously configured in RegisterEvent */
|
| 406 |
+
uint32_t EventId;
|
| 407 |
+
/** Number of parameters described in Params */
|
| 408 |
+
uint32_t ParamsCount;
|
| 409 |
+
/** Set of parameter types previously configured in RegisterEvent, and their values */
|
| 410 |
+
const EOS_AntiCheatCommon_LogEventParamPair* Params;
|
| 411 |
+
));
|
| 412 |
+
|
| 413 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogGameRoundStartOptions struct. */
|
| 414 |
+
#define EOS_ANTICHEATCOMMON_LOGGAMEROUNDSTART_API_LATEST 2
|
| 415 |
+
|
| 416 |
+
/**
|
| 417 |
+
* Input parameters for the EOS_AntiCheatServer_LogGameRoundStart function.
|
| 418 |
+
*/
|
| 419 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogGameRoundStartOptions, (
|
| 420 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGGAMEROUNDSTART_API_LATEST. */
|
| 421 |
+
int32_t ApiVersion;
|
| 422 |
+
/** Optional game session or match identifier useful for some backend API integrations */
|
| 423 |
+
const char* SessionIdentifier;
|
| 424 |
+
/** Optional name of the map being played */
|
| 425 |
+
const char* LevelName;
|
| 426 |
+
/** Optional name of the game mode being played */
|
| 427 |
+
const char* ModeName;
|
| 428 |
+
/** Optional length of the game round to be played, in seconds. If none, use 0. */
|
| 429 |
+
uint32_t RoundTimeSeconds;
|
| 430 |
+
/** Type of competition for this game round */
|
| 431 |
+
EOS_EAntiCheatCommonGameRoundCompetitionType CompetitionType;
|
| 432 |
+
));
|
| 433 |
+
|
| 434 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogGameRoundEndOptions struct. */
|
| 435 |
+
#define EOS_ANTICHEATCOMMON_LOGGAMEROUNDEND_API_LATEST 1
|
| 436 |
+
|
| 437 |
+
/**
|
| 438 |
+
* Input parameters for the EOS_AntiCheatServer_LogGameRoundEnd function.
|
| 439 |
+
*/
|
| 440 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogGameRoundEndOptions, (
|
| 441 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGGAMEROUNDEND_API_LATEST. */
|
| 442 |
+
int32_t ApiVersion;
|
| 443 |
+
/** Optional identifier for the winning team */
|
| 444 |
+
uint32_t WinningTeamId;
|
| 445 |
+
));
|
| 446 |
+
|
| 447 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogPlayerSpawnOptions struct. */
|
| 448 |
+
#define EOS_ANTICHEATCOMMON_LOGPLAYERSPAWN_API_LATEST 1
|
| 449 |
+
|
| 450 |
+
/**
|
| 451 |
+
* Input parameters for the EOS_AntiCheatServer_LogPlayerSpawn function.
|
| 452 |
+
*/
|
| 453 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogPlayerSpawnOptions, (
|
| 454 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERSPAWN_API_LATEST. */
|
| 455 |
+
int32_t ApiVersion;
|
| 456 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 457 |
+
EOS_AntiCheatCommon_ClientHandle SpawnedPlayerHandle;
|
| 458 |
+
/** Optional identifier for the player's team. If none, use 0. */
|
| 459 |
+
uint32_t TeamId;
|
| 460 |
+
/** Optional identifier for the player's character. If none, use 0. */
|
| 461 |
+
uint32_t CharacterId;
|
| 462 |
+
));
|
| 463 |
+
|
| 464 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogPlayerDespawnOptions struct. */
|
| 465 |
+
#define EOS_ANTICHEATCOMMON_LOGPLAYERDESPAWN_API_LATEST 1
|
| 466 |
+
|
| 467 |
+
/**
|
| 468 |
+
* Input parameters for the EOS_AntiCheatServer_LogPlayerDespawn function.
|
| 469 |
+
*/
|
| 470 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogPlayerDespawnOptions, (
|
| 471 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERDESPAWN_API_LATEST. */
|
| 472 |
+
int32_t ApiVersion;
|
| 473 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 474 |
+
EOS_AntiCheatCommon_ClientHandle DespawnedPlayerHandle;
|
| 475 |
+
));
|
| 476 |
+
|
| 477 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogPlayerReviveOptions struct. */
|
| 478 |
+
#define EOS_ANTICHEATCOMMON_LOGPLAYERREVIVE_API_LATEST 1
|
| 479 |
+
|
| 480 |
+
/**
|
| 481 |
+
* Input parameters for the EOS_AntiCheatServer_LogPlayerRevive function.
|
| 482 |
+
*/
|
| 483 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogPlayerReviveOptions, (
|
| 484 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERREVIVE_API_LATEST. */
|
| 485 |
+
int32_t ApiVersion;
|
| 486 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 487 |
+
EOS_AntiCheatCommon_ClientHandle RevivedPlayerHandle;
|
| 488 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 489 |
+
EOS_AntiCheatCommon_ClientHandle ReviverPlayerHandle;
|
| 490 |
+
));
|
| 491 |
+
|
| 492 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogPlayerTickOptions struct. */
|
| 493 |
+
#define EOS_ANTICHEATCOMMON_LOGPLAYERTICK_API_LATEST 3
|
| 494 |
+
|
| 495 |
+
/**
|
| 496 |
+
* Input parameters for the EOS_AntiCheatServer_LogPlayerTick function.
|
| 497 |
+
*/
|
| 498 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogPlayerTickOptions, (
|
| 499 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERTICK_API_LATEST. */
|
| 500 |
+
int32_t ApiVersion;
|
| 501 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 502 |
+
EOS_AntiCheatCommon_ClientHandle PlayerHandle;
|
| 503 |
+
/** Player character's current world position as a 3D vector. This should be the center of the character. */
|
| 504 |
+
EOS_AntiCheatCommon_Vec3f* PlayerPosition;
|
| 505 |
+
/** Player camera's current world rotation as a quaternion. */
|
| 506 |
+
EOS_AntiCheatCommon_Quat* PlayerViewRotation;
|
| 507 |
+
/** True if the player's view is zoomed (e.g. using a sniper rifle), otherwise false */
|
| 508 |
+
EOS_Bool bIsPlayerViewZoomed;
|
| 509 |
+
/** Player's current health value */
|
| 510 |
+
float PlayerHealth;
|
| 511 |
+
/** Any movement state applicable */
|
| 512 |
+
EOS_EAntiCheatCommonPlayerMovementState PlayerMovementState;
|
| 513 |
+
/** Player camera's current world position as a 3D vector. */
|
| 514 |
+
EOS_AntiCheatCommon_Vec3f* PlayerViewPosition;
|
| 515 |
+
));
|
| 516 |
+
|
| 517 |
+
/** Max weapon name length in EOS_AntiCheatCommon_LogPlayerUseWeaponData. */
|
| 518 |
+
#define EOS_ANTICHEATCOMMON_LOGPLAYERUSEWEAPON_WEAPONNAME_MAX_LENGTH 32
|
| 519 |
+
|
| 520 |
+
/**
|
| 521 |
+
* Log Player Use Weapon Data.
|
| 522 |
+
*/
|
| 523 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogPlayerUseWeaponData, (
|
| 524 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 525 |
+
EOS_AntiCheatCommon_ClientHandle PlayerHandle;
|
| 526 |
+
/** Attack origin world position as a 3D vector */
|
| 527 |
+
EOS_AntiCheatCommon_Vec3f* PlayerPosition;
|
| 528 |
+
/** Attack direction as a quaternion */
|
| 529 |
+
EOS_AntiCheatCommon_Quat* PlayerViewRotation;
|
| 530 |
+
/** True if the player's view is zoomed (e.g. using a sniper rifle), otherwise false */
|
| 531 |
+
EOS_Bool bIsPlayerViewZoomed;
|
| 532 |
+
/** Set to true if the player is using a melee attack, otherwise false */
|
| 533 |
+
EOS_Bool bIsMeleeAttack;
|
| 534 |
+
/** Name of the weapon used. Will be truncated to EOS_ANTICHEATCOMMON_LOGPLAYERUSEWEAPON_WEAPONNAME_MAX_LENGTH bytes if longer. */
|
| 535 |
+
const char* WeaponName;
|
| 536 |
+
));
|
| 537 |
+
|
| 538 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogPlayerUseWeaponOptions struct. */
|
| 539 |
+
#define EOS_ANTICHEATCOMMON_LOGPLAYERUSEWEAPON_API_LATEST 2
|
| 540 |
+
|
| 541 |
+
/**
|
| 542 |
+
* Input parameters for the EOS_AntiCheatServer_LogPlayerUseWeapon function.
|
| 543 |
+
*/
|
| 544 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogPlayerUseWeaponOptions, (
|
| 545 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERUSEWEAPON_API_LATEST. */
|
| 546 |
+
int32_t ApiVersion;
|
| 547 |
+
/** Struct containing detailed information about a weapon use event */
|
| 548 |
+
EOS_AntiCheatCommon_LogPlayerUseWeaponData* UseWeaponData;
|
| 549 |
+
));
|
| 550 |
+
|
| 551 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogPlayerUseAbilityOptions struct. */
|
| 552 |
+
#define EOS_ANTICHEATCOMMON_LOGPLAYERUSEABILITY_API_LATEST 1
|
| 553 |
+
|
| 554 |
+
/**
|
| 555 |
+
* Input parameters for the EOS_AntiCheatServer_LogPlayerUseAbility function.
|
| 556 |
+
*/
|
| 557 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogPlayerUseAbilityOptions, (
|
| 558 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERUSEABILITY_API_LATEST. */
|
| 559 |
+
int32_t ApiVersion;
|
| 560 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 561 |
+
EOS_AntiCheatCommon_ClientHandle PlayerHandle;
|
| 562 |
+
/** Game defined unique identifier for the ability being used */
|
| 563 |
+
uint32_t AbilityId;
|
| 564 |
+
/** Duration of the ability effect in milliseconds. If not applicable, use 0. */
|
| 565 |
+
uint32_t AbilityDurationMs;
|
| 566 |
+
/** Cooldown until the ability can be used again in milliseconds. If not applicable, use 0. */
|
| 567 |
+
uint32_t AbilityCooldownMs;
|
| 568 |
+
));
|
| 569 |
+
|
| 570 |
+
/** The most recent version of the EOS_AntiCheatCommon_LogPlayerTakeDamageOptions struct. */
|
| 571 |
+
#define EOS_ANTICHEATCOMMON_LOGPLAYERTAKEDAMAGE_API_LATEST 4
|
| 572 |
+
|
| 573 |
+
/**
|
| 574 |
+
* Input parameters for the EOS_AntiCheatServer_LogPlayerTakeDamage function.
|
| 575 |
+
*/
|
| 576 |
+
EOS_STRUCT(EOS_AntiCheatCommon_LogPlayerTakeDamageOptions, (
|
| 577 |
+
/** API Version: Set this to EOS_ANTICHEATCOMMON_LOGPLAYERTAKEDAMAGE_API_LATEST. */
|
| 578 |
+
int32_t ApiVersion;
|
| 579 |
+
/** Locally unique value used in RegisterClient/RegisterPeer */
|
| 580 |
+
EOS_AntiCheatCommon_ClientHandle VictimPlayerHandle;
|
| 581 |
+
/** Victim player character's world position as a 3D vector. This should be the center of the character. */
|
| 582 |
+
EOS_AntiCheatCommon_Vec3f* VictimPlayerPosition;
|
| 583 |
+
/** Victim player camera's world rotation as a quaternion. */
|
| 584 |
+
EOS_AntiCheatCommon_Quat* VictimPlayerViewRotation;
|
| 585 |
+
/** Locally unique value used in RegisterClient/RegisterPeer if applicable, otherwise 0. */
|
| 586 |
+
EOS_AntiCheatCommon_ClientHandle AttackerPlayerHandle;
|
| 587 |
+
/** Attacker player character's world position as a 3D vector if applicable, otherwise NULL. */
|
| 588 |
+
EOS_AntiCheatCommon_Vec3f* AttackerPlayerPosition;
|
| 589 |
+
/** Attacker player camera's world rotation as a quaternion if applicable, otherwise NULL. */
|
| 590 |
+
EOS_AntiCheatCommon_Quat* AttackerPlayerViewRotation;
|
| 591 |
+
/**
|
| 592 |
+
* True if the damage was applied instantly at the time of attack from the game
|
| 593 |
+
* simulation's perspective, otherwise false (simulated ballistics, arrow, etc).
|
| 594 |
+
*/
|
| 595 |
+
EOS_Bool bIsHitscanAttack;
|
| 596 |
+
/**
|
| 597 |
+
* True if there is a visible line of sight between the attacker and the victim at the time
|
| 598 |
+
* that damage is being applied, false if there is an obstacle like a wall or terrain in
|
| 599 |
+
* the way. For some situations like melee or hitscan weapons this is trivially
|
| 600 |
+
* true, for others like projectiles with simulated physics it may not be e.g. a player
|
| 601 |
+
* could fire a slow moving projectile and then move behind cover before it strikes.
|
| 602 |
+
*
|
| 603 |
+
* This can be an estimate, or can simply be always set to true if it is not feasible
|
| 604 |
+
* to compute in your game.
|
| 605 |
+
*/
|
| 606 |
+
EOS_Bool bHasLineOfSight;
|
| 607 |
+
/** True if this was a critical hit that causes extra damage (e.g. headshot) */
|
| 608 |
+
EOS_Bool bIsCriticalHit;
|
| 609 |
+
/** Deprecated - use DamagePosition instead */
|
| 610 |
+
uint32_t HitBoneId_DEPRECATED;
|
| 611 |
+
/** Number of health points that the victim lost due to this damage event */
|
| 612 |
+
float DamageTaken;
|
| 613 |
+
/** Number of health points that the victim has remaining after this damage event */
|
| 614 |
+
float HealthRemaining;
|
| 615 |
+
/** Source of the damage event */
|
| 616 |
+
EOS_EAntiCheatCommonPlayerTakeDamageSource DamageSource;
|
| 617 |
+
/** Type of the damage being applied */
|
| 618 |
+
EOS_EAntiCheatCommonPlayerTakeDamageType DamageType;
|
| 619 |
+
/** Result of the damage for the victim, if any */
|
| 620 |
+
EOS_EAntiCheatCommonPlayerTakeDamageResult DamageResult;
|
| 621 |
+
/** PlayerUseWeaponData associated with this damage event if available, otherwise NULL */
|
| 622 |
+
EOS_AntiCheatCommon_LogPlayerUseWeaponData* PlayerUseWeaponData;
|
| 623 |
+
/** Time in milliseconds since the associated PlayerUseWeaponData event occurred if available, otherwise 0 */
|
| 624 |
+
uint32_t TimeSincePlayerUseWeaponMs;
|
| 625 |
+
/** World position where damage hit the victim as a 3D vector if available, otherwise NULL */
|
| 626 |
+
EOS_AntiCheatCommon_Vec3f* DamagePosition;
|
| 627 |
+
/** Attacker player camera's world position as a 3D vector if applicable, otherwise NULL */
|
| 628 |
+
EOS_AntiCheatCommon_Vec3f* AttackerPlayerViewPosition;
|
| 629 |
+
));
|
| 630 |
+
|
| 631 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatserver.h
ADDED
|
@@ -0,0 +1,417 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_anticheatserver_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* Add a callback issued when a new message must be dispatched to a connected client. The bound function
|
| 8 |
+
* will only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
|
| 9 |
+
*
|
| 10 |
+
* @param Options Structure containing input data
|
| 11 |
+
* @param ClientData This value is returned to the caller when NotificationFn is invoked
|
| 12 |
+
* @param NotificationFn The callback to be fired
|
| 13 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 14 |
+
*/
|
| 15 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_AntiCheatServer_AddNotifyMessageToClient(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_AddNotifyMessageToClientOptions* Options, void* ClientData, EOS_AntiCheatServer_OnMessageToClientCallback NotificationFn);
|
| 16 |
+
|
| 17 |
+
/**
|
| 18 |
+
* Remove a previously bound EOS_AntiCheatServer_AddNotifyMessageToClient handler.
|
| 19 |
+
*
|
| 20 |
+
* @param NotificationId The previously bound notification ID
|
| 21 |
+
*/
|
| 22 |
+
EOS_DECLARE_FUNC(void) EOS_AntiCheatServer_RemoveNotifyMessageToClient(EOS_HAntiCheatServer Handle, EOS_NotificationId NotificationId);
|
| 23 |
+
|
| 24 |
+
/**
|
| 25 |
+
* Add a callback issued when an action must be applied to a connected client. The bound function
|
| 26 |
+
* will only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
|
| 27 |
+
*
|
| 28 |
+
* @param Options Structure containing input data
|
| 29 |
+
* @param ClientData This value is returned to the caller when NotificationFn is invoked
|
| 30 |
+
* @param NotificationFn The callback to be fired
|
| 31 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 32 |
+
*/
|
| 33 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_AntiCheatServer_AddNotifyClientActionRequired(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_AddNotifyClientActionRequiredOptions* Options, void* ClientData, EOS_AntiCheatServer_OnClientActionRequiredCallback NotificationFn);
|
| 34 |
+
|
| 35 |
+
/**
|
| 36 |
+
* Remove a previously bound EOS_AntiCheatServer_AddNotifyClientActionRequired handler.
|
| 37 |
+
*
|
| 38 |
+
* @param NotificationId The previously bound notification ID
|
| 39 |
+
*/
|
| 40 |
+
EOS_DECLARE_FUNC(void) EOS_AntiCheatServer_RemoveNotifyClientActionRequired(EOS_HAntiCheatServer Handle, EOS_NotificationId NotificationId);
|
| 41 |
+
|
| 42 |
+
/**
|
| 43 |
+
* Add an optional callback issued when a connected client's authentication status changes. The bound function
|
| 44 |
+
* will only be called between a successful call to EOS_AntiCheatServer_BeginSession and the matching EOS_AntiCheatServer_EndSession call.
|
| 45 |
+
*
|
| 46 |
+
* @param Options Structure containing input data
|
| 47 |
+
* @param ClientData This value is returned to the caller when NotificationFn is invoked
|
| 48 |
+
* @param NotificationFn The callback to be fired
|
| 49 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 50 |
+
*/
|
| 51 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_AntiCheatServer_AddNotifyClientAuthStatusChanged(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_AddNotifyClientAuthStatusChangedOptions* Options, void* ClientData, EOS_AntiCheatServer_OnClientAuthStatusChangedCallback NotificationFn);
|
| 52 |
+
|
| 53 |
+
/**
|
| 54 |
+
* Remove a previously bound EOS_AntiCheatServer_AddNotifyClientAuthStatusChanged handler.
|
| 55 |
+
*
|
| 56 |
+
* @param NotificationId The previously bound notification ID
|
| 57 |
+
*/
|
| 58 |
+
EOS_DECLARE_FUNC(void) EOS_AntiCheatServer_RemoveNotifyClientAuthStatusChanged(EOS_HAntiCheatServer Handle, EOS_NotificationId NotificationId);
|
| 59 |
+
|
| 60 |
+
/**
|
| 61 |
+
* Begin the gameplay session. Event callbacks must be configured with EOS_AntiCheatServer_AddNotifyMessageToClient
|
| 62 |
+
* and EOS_AntiCheatServer_AddNotifyClientActionRequired before calling this function.
|
| 63 |
+
*
|
| 64 |
+
* @param Options Structure containing input data.
|
| 65 |
+
*
|
| 66 |
+
* @return EOS_EResult containing the result of the operation.
|
| 67 |
+
* Possible result codes:
|
| 68 |
+
* - EOS_Success - If the initialization succeeded
|
| 69 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 70 |
+
*/
|
| 71 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_BeginSession(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_BeginSessionOptions* Options);
|
| 72 |
+
|
| 73 |
+
/**
|
| 74 |
+
* End the gameplay session. Should be called when the server is shutting down or entering an idle state.
|
| 75 |
+
*
|
| 76 |
+
* @param Options Structure containing input data.
|
| 77 |
+
*
|
| 78 |
+
* @return EOS_EResult containing the result of the operation.
|
| 79 |
+
* Possible result codes:
|
| 80 |
+
* - EOS_Success - If the initialization succeeded
|
| 81 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 82 |
+
*/
|
| 83 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_EndSession(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_EndSessionOptions* Options);
|
| 84 |
+
|
| 85 |
+
/**
|
| 86 |
+
* Register a connected client. Must be paired with a call to UnregisterClient.
|
| 87 |
+
*
|
| 88 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 89 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 90 |
+
*
|
| 91 |
+
* @param Options Structure containing input data.
|
| 92 |
+
*
|
| 93 |
+
* @return EOS_EResult containing the result of the operation.
|
| 94 |
+
* Possible result codes:
|
| 95 |
+
* - EOS_Success - If the player was registered successfully
|
| 96 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 97 |
+
*/
|
| 98 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_RegisterClient(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_RegisterClientOptions* Options);
|
| 99 |
+
|
| 100 |
+
/**
|
| 101 |
+
* Unregister a disconnected client.
|
| 102 |
+
*
|
| 103 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 104 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 105 |
+
*
|
| 106 |
+
* @param Options Structure containing input data.
|
| 107 |
+
*
|
| 108 |
+
* @return EOS_EResult containing the result of the operation.
|
| 109 |
+
* Possible result codes:
|
| 110 |
+
* - EOS_Success - If the player was unregistered successfully
|
| 111 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 112 |
+
*/
|
| 113 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_UnregisterClient(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_UnregisterClientOptions* Options);
|
| 114 |
+
|
| 115 |
+
/**
|
| 116 |
+
* Call when an anti-cheat message is received from a client.
|
| 117 |
+
*
|
| 118 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 119 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 120 |
+
*
|
| 121 |
+
* @param Options Structure containing input data.
|
| 122 |
+
*
|
| 123 |
+
* @return EOS_EResult containing the result of the operation.
|
| 124 |
+
* Possible result codes:
|
| 125 |
+
* - EOS_Success - If the message was processed successfully
|
| 126 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 127 |
+
* - EOS_InvalidRequest - If message contents were corrupt and could not be processed
|
| 128 |
+
*/
|
| 129 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_ReceiveMessageFromClient(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_ReceiveMessageFromClientOptions* Options);
|
| 130 |
+
|
| 131 |
+
/**
|
| 132 |
+
* Optional. Sets or updates client details including input device and admin status.
|
| 133 |
+
*
|
| 134 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 135 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 136 |
+
*
|
| 137 |
+
* @param Options Structure containing input data.
|
| 138 |
+
*
|
| 139 |
+
* @return EOS_EResult containing the result of the operation.
|
| 140 |
+
* Possible result codes:
|
| 141 |
+
* - EOS_Success - If the flags were updated successfully
|
| 142 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 143 |
+
*/
|
| 144 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_SetClientDetails(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_SetClientDetailsOptions* Options);
|
| 145 |
+
|
| 146 |
+
/**
|
| 147 |
+
* Optional. Sets or updates a game session identifier which can be attached to other data for reference.
|
| 148 |
+
* The identifier can be updated at any time for currently and subsequently registered clients.
|
| 149 |
+
*
|
| 150 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 151 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 152 |
+
*
|
| 153 |
+
* @param Options Structure containing input data.
|
| 154 |
+
*
|
| 155 |
+
* @return EOS_EResult containing the result of the operation.
|
| 156 |
+
* Possible result codes:
|
| 157 |
+
* - EOS_Success - If the game session identifier was set successfully
|
| 158 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 159 |
+
*/
|
| 160 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_SetGameSessionId(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_SetGameSessionIdOptions* Options);
|
| 161 |
+
|
| 162 |
+
/**
|
| 163 |
+
* Optional. Can be used to indicate that a client is legitimately known to be
|
| 164 |
+
* temporarily unable to communicate, for example as a result of loading a new level.
|
| 165 |
+
*
|
| 166 |
+
* The bIsNetworkActive flag must be set back to true when users enter normal
|
| 167 |
+
* gameplay, otherwise anti-cheat enforcement will not work correctly.
|
| 168 |
+
*
|
| 169 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 170 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 171 |
+
*
|
| 172 |
+
* @param Options Structure containing input data.
|
| 173 |
+
*
|
| 174 |
+
* @return EOS_EResult containing the result of the operation.
|
| 175 |
+
* Possible result codes:
|
| 176 |
+
* - EOS_Success - If the network state was updated successfully
|
| 177 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 178 |
+
*/
|
| 179 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_SetClientNetworkState(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_SetClientNetworkStateOptions* Options);
|
| 180 |
+
|
| 181 |
+
/**
|
| 182 |
+
* Optional NetProtect feature for game message encryption.
|
| 183 |
+
* Calculates the required decrypted buffer size for a given input data length.
|
| 184 |
+
* This will not change for a given SDK version, and allows one time allocation of reusable buffers.
|
| 185 |
+
*
|
| 186 |
+
* @param Options Structure containing input data.
|
| 187 |
+
* @param OutBufferSizeBytes On success, the OutBuffer length in bytes that is required to call ProtectMessage on the given input size.
|
| 188 |
+
*
|
| 189 |
+
* @return EOS_EResult containing the result of the operation.
|
| 190 |
+
* Possible result codes:
|
| 191 |
+
* - EOS_Success - If the output length was calculated successfully
|
| 192 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 193 |
+
*/
|
| 194 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_GetProtectMessageOutputLength(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_GetProtectMessageOutputLengthOptions* Options, uint32_t* OutBufferSizeBytes);
|
| 195 |
+
|
| 196 |
+
/**
|
| 197 |
+
* Optional NetProtect feature for game message encryption.
|
| 198 |
+
* Encrypts an arbitrary message that will be sent to a game client and decrypted on the other side.
|
| 199 |
+
*
|
| 200 |
+
* Options.Data and OutBuffer may refer to the same buffer to encrypt in place.
|
| 201 |
+
*
|
| 202 |
+
* @param Options Structure containing input data.
|
| 203 |
+
* @param OutBuffer On success, buffer where encrypted message data will be written.
|
| 204 |
+
* @param OutBytesWritten On success, the number of bytes that were written to OutBuffer.
|
| 205 |
+
*
|
| 206 |
+
* @return EOS_EResult containing the result of the operation.
|
| 207 |
+
* Possible result codes:
|
| 208 |
+
* - EOS_Success - If the message was protected successfully
|
| 209 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 210 |
+
* - EOS_InvalidUser - If the specified ClientHandle was invalid or not currently registered. See RegisterClient.
|
| 211 |
+
*/
|
| 212 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_ProtectMessage(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_ProtectMessageOptions* Options, void* OutBuffer, uint32_t* OutBytesWritten);
|
| 213 |
+
|
| 214 |
+
/**
|
| 215 |
+
* Optional NetProtect feature for game message encryption.
|
| 216 |
+
* Decrypts an encrypted message received from a game client.
|
| 217 |
+
*
|
| 218 |
+
* Options.Data and OutBuffer may refer to the same buffer to decrypt in place.
|
| 219 |
+
*
|
| 220 |
+
* @param Options Structure containing input data.
|
| 221 |
+
* @param OutBuffer On success, buffer where encrypted message data will be written.
|
| 222 |
+
* @param OutBytesWritten On success, the number of bytes that were written to OutBuffer.
|
| 223 |
+
*
|
| 224 |
+
* @return EOS_EResult containing the result of the operation.
|
| 225 |
+
* Possible result codes:
|
| 226 |
+
* - EOS_Success - If the message was unprotected successfully
|
| 227 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 228 |
+
*/
|
| 229 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_UnprotectMessage(EOS_HAntiCheatServer Handle, const EOS_AntiCheatServer_UnprotectMessageOptions* Options, void* OutBuffer, uint32_t* OutBytesWritten);
|
| 230 |
+
|
| 231 |
+
/**
|
| 232 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 233 |
+
* Registers a custom gameplay event.
|
| 234 |
+
*
|
| 235 |
+
* All custom game events must be registered before EOS_AntiCheatServer_BeginSession is called for the first time.
|
| 236 |
+
* After the first call to EOS_AntiCheatServer_BeginSession, this function cannot be called any longer.
|
| 237 |
+
*
|
| 238 |
+
* @param Options Structure containing input data.
|
| 239 |
+
*
|
| 240 |
+
* @return EOS_EResult containing the result of the operation.
|
| 241 |
+
* Possible result codes:
|
| 242 |
+
* - EOS_Success - If the event was registered successfully
|
| 243 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 244 |
+
*/
|
| 245 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_RegisterEvent(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_RegisterEventOptions* Options);
|
| 246 |
+
|
| 247 |
+
/**
|
| 248 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 249 |
+
* Logs a custom gameplay event.
|
| 250 |
+
*
|
| 251 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 252 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 253 |
+
*
|
| 254 |
+
* @param Options Structure containing input data.
|
| 255 |
+
*
|
| 256 |
+
* @return EOS_EResult containing the result of the operation.
|
| 257 |
+
* Possible result codes:
|
| 258 |
+
* - EOS_Success - If the event was logged successfully
|
| 259 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 260 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 261 |
+
*/
|
| 262 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogEvent(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogEventOptions* Options);
|
| 263 |
+
|
| 264 |
+
/**
|
| 265 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 266 |
+
* Logs a new game round start.
|
| 267 |
+
*
|
| 268 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 269 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 270 |
+
*
|
| 271 |
+
* @param Options Structure containing input data.
|
| 272 |
+
*
|
| 273 |
+
* @return EOS_EResult containing the result of the operation.
|
| 274 |
+
* Possible result codes:
|
| 275 |
+
* - EOS_Success - If the event was logged successfully
|
| 276 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 277 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 278 |
+
*/
|
| 279 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogGameRoundStart(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogGameRoundStartOptions* Options);
|
| 280 |
+
|
| 281 |
+
/**
|
| 282 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 283 |
+
* Logs a game round's end and outcome.
|
| 284 |
+
*
|
| 285 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 286 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 287 |
+
*
|
| 288 |
+
* @param Options Structure containing input data.
|
| 289 |
+
*
|
| 290 |
+
* @return EOS_EResult containing the result of the operation.
|
| 291 |
+
* Possible result codes:
|
| 292 |
+
* - EOS_Success - If the event was logged successfully
|
| 293 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 294 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 295 |
+
*/
|
| 296 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogGameRoundEnd(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogGameRoundEndOptions* Options);
|
| 297 |
+
|
| 298 |
+
/**
|
| 299 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 300 |
+
* Logs a player spawning into the game.
|
| 301 |
+
*
|
| 302 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 303 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 304 |
+
*
|
| 305 |
+
* @param Options Structure containing input data.
|
| 306 |
+
*
|
| 307 |
+
* @return EOS_EResult containing the result of the operation.
|
| 308 |
+
* Possible result codes:
|
| 309 |
+
* - EOS_Success - If the event was logged successfully
|
| 310 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 311 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 312 |
+
*/
|
| 313 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogPlayerSpawn(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogPlayerSpawnOptions* Options);
|
| 314 |
+
|
| 315 |
+
/**
|
| 316 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 317 |
+
* Logs a player despawning in the game, for example as a result of the character's death,
|
| 318 |
+
* switching to spectator mode, etc.
|
| 319 |
+
*
|
| 320 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 321 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 322 |
+
*
|
| 323 |
+
* @param Options Structure containing input data.
|
| 324 |
+
*
|
| 325 |
+
* @return EOS_EResult containing the result of the operation.
|
| 326 |
+
* Possible result codes:
|
| 327 |
+
* - EOS_Success - If the event was logged successfully
|
| 328 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 329 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 330 |
+
*/
|
| 331 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogPlayerDespawn(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogPlayerDespawnOptions* Options);
|
| 332 |
+
|
| 333 |
+
/**
|
| 334 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 335 |
+
* Logs a player being revived after being downed (see EOS_AntiCheatServer_LogPlayerTakeDamage options).
|
| 336 |
+
*
|
| 337 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 338 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 339 |
+
*
|
| 340 |
+
* @param Options Structure containing input data.
|
| 341 |
+
*
|
| 342 |
+
* @return EOS_EResult containing the result of the operation.
|
| 343 |
+
* Possible result codes:
|
| 344 |
+
* - EOS_Success - If the event was logged successfully
|
| 345 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 346 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 347 |
+
*/
|
| 348 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogPlayerRevive(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogPlayerReviveOptions* Options);
|
| 349 |
+
|
| 350 |
+
/**
|
| 351 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 352 |
+
* Logs a player's general state including position and view direction.
|
| 353 |
+
*
|
| 354 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 355 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 356 |
+
*
|
| 357 |
+
* @param Options Structure containing input data.
|
| 358 |
+
*
|
| 359 |
+
* @return EOS_EResult containing the result of the operation.
|
| 360 |
+
* Possible result codes:
|
| 361 |
+
* - EOS_Success - If the event was logged successfully
|
| 362 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 363 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 364 |
+
*/
|
| 365 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogPlayerTick(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogPlayerTickOptions* Options);
|
| 366 |
+
|
| 367 |
+
/**
|
| 368 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 369 |
+
* Logs that a player has used a weapon, for example firing one bullet or making one melee attack.
|
| 370 |
+
*
|
| 371 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 372 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 373 |
+
*
|
| 374 |
+
* @param Options Structure containing input data.
|
| 375 |
+
*
|
| 376 |
+
* @return EOS_EResult containing the result of the operation.
|
| 377 |
+
* Possible result codes:
|
| 378 |
+
* - EOS_Success - If the event was logged successfully
|
| 379 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 380 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 381 |
+
*/
|
| 382 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogPlayerUseWeapon(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogPlayerUseWeaponOptions* Options);
|
| 383 |
+
|
| 384 |
+
/**
|
| 385 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 386 |
+
* Logs that a player has used a special ability or item which affects their character's capabilities,
|
| 387 |
+
* for example temporarily increasing their speed or allowing them to see nearby players behind walls.
|
| 388 |
+
*
|
| 389 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 390 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 391 |
+
*
|
| 392 |
+
* @param Options Structure containing input data.
|
| 393 |
+
*
|
| 394 |
+
* @return EOS_EResult containing the result of the operation.
|
| 395 |
+
* Possible result codes:
|
| 396 |
+
* - EOS_Success - If the event was logged successfully
|
| 397 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 398 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 399 |
+
*/
|
| 400 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogPlayerUseAbility(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogPlayerUseAbilityOptions* Options);
|
| 401 |
+
|
| 402 |
+
/**
|
| 403 |
+
* Optional Cerberus feature for gameplay data collection.
|
| 404 |
+
* Logs that a player has taken damage.
|
| 405 |
+
*
|
| 406 |
+
* This function may only be called between a successful call to EOS_AntiCheatServer_BeginSession and
|
| 407 |
+
* the matching EOS_AntiCheatServer_EndSession call.
|
| 408 |
+
*
|
| 409 |
+
* @param Options Structure containing input data.
|
| 410 |
+
*
|
| 411 |
+
* @return EOS_EResult containing the result of the operation.
|
| 412 |
+
* Possible result codes:
|
| 413 |
+
* - EOS_Success - If the event was logged successfully
|
| 414 |
+
* - EOS_InvalidParameters - If input data was invalid
|
| 415 |
+
* - EOS_NotConfigured - If called outside of BeginSession/EndSession boundaries
|
| 416 |
+
*/
|
| 417 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_AntiCheatServer_LogPlayerTakeDamage(EOS_HAntiCheatServer Handle, const EOS_AntiCheatCommon_LogPlayerTakeDamageOptions* Options);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_anticheatserver_types.h
ADDED
|
@@ -0,0 +1,250 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
#include "eos_anticheatcommon_types.h"
|
| 7 |
+
|
| 8 |
+
#pragma pack(push, 8)
|
| 9 |
+
|
| 10 |
+
EOS_EXTERN_C typedef struct EOS_AntiCheatServerHandle* EOS_HAntiCheatServer;
|
| 11 |
+
|
| 12 |
+
/**
|
| 13 |
+
* Maximum size of an individual message provided through EOS_AntiCheatServer_OnMessageToClientCallback.
|
| 14 |
+
*/
|
| 15 |
+
#define EOS_ANTICHEATSERVER_ONMESSAGETOCLIENTCALLBACK_MAX_MESSAGE_SIZE 512
|
| 16 |
+
|
| 17 |
+
/**
|
| 18 |
+
* Callback issued when a new message must be dispatched to a connected client.
|
| 19 |
+
*
|
| 20 |
+
* Messages contain opaque binary data and must be transmitted to the correct client
|
| 21 |
+
* using the game's own networking layer, then delivered to the client anti-cheat instance
|
| 22 |
+
* using the EOS_AntiCheatClient_ReceiveMessageFromServer function.
|
| 23 |
+
* The upper limit of the message size is EOS_ANTICHEATSERVER_ONMESSAGETOCLIENTCALLBACK_MAX_MESSAGE_SIZE.
|
| 24 |
+
*
|
| 25 |
+
* This callback is always issued from within EOS_Platform_Tick on its calling thread.
|
| 26 |
+
*/
|
| 27 |
+
EOS_DECLARE_CALLBACK(EOS_AntiCheatServer_OnMessageToClientCallback, const EOS_AntiCheatCommon_OnMessageToClientCallbackInfo* Data);
|
| 28 |
+
|
| 29 |
+
/**
|
| 30 |
+
* Callback issued when an action must be applied to a connected client.
|
| 31 |
+
* This callback is always issued from within EOS_Platform_Tick on its calling thread.
|
| 32 |
+
*/
|
| 33 |
+
EOS_DECLARE_CALLBACK(EOS_AntiCheatServer_OnClientActionRequiredCallback, const EOS_AntiCheatCommon_OnClientActionRequiredCallbackInfo* Data);
|
| 34 |
+
|
| 35 |
+
/**
|
| 36 |
+
* Optional callback issued when a connected client's authentication status has changed.
|
| 37 |
+
* This callback is always issued from within EOS_Platform_Tick on its calling thread.
|
| 38 |
+
*/
|
| 39 |
+
EOS_DECLARE_CALLBACK(EOS_AntiCheatServer_OnClientAuthStatusChangedCallback, const EOS_AntiCheatCommon_OnClientAuthStatusChangedCallbackInfo* Data);
|
| 40 |
+
|
| 41 |
+
/** The most recent version of the EOS_AntiCheatServer_AddNotifyMessageToClient API. */
|
| 42 |
+
#define EOS_ANTICHEATSERVER_ADDNOTIFYMESSAGETOCLIENT_API_LATEST 1
|
| 43 |
+
|
| 44 |
+
/**
|
| 45 |
+
* Input parameters for the EOS_AntiCheatServer_AddNotifyMessageToClient function.
|
| 46 |
+
*/
|
| 47 |
+
EOS_STRUCT(EOS_AntiCheatServer_AddNotifyMessageToClientOptions, (
|
| 48 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_ADDNOTIFYMESSAGETOCLIENT_API_LATEST. */
|
| 49 |
+
int32_t ApiVersion;
|
| 50 |
+
));
|
| 51 |
+
|
| 52 |
+
/** The most recent version of the EOS_AntiCheatServer_AddNotifyClientActionRequired API. */
|
| 53 |
+
#define EOS_ANTICHEATSERVER_ADDNOTIFYCLIENTACTIONREQUIRED_API_LATEST 1
|
| 54 |
+
|
| 55 |
+
/**
|
| 56 |
+
* Input parameters for the EOS_AntiCheatServer_AddNotifyClientActionRequired function.
|
| 57 |
+
*/
|
| 58 |
+
EOS_STRUCT(EOS_AntiCheatServer_AddNotifyClientActionRequiredOptions, (
|
| 59 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_ADDNOTIFYCLIENTACTIONREQUIRED_API_LATEST. */
|
| 60 |
+
int32_t ApiVersion;
|
| 61 |
+
));
|
| 62 |
+
|
| 63 |
+
/** The most recent version of the EOS_AntiCheatServer_AddNotifyClientAuthStatusChanged API. */
|
| 64 |
+
#define EOS_ANTICHEATSERVER_ADDNOTIFYCLIENTAUTHSTATUSCHANGED_API_LATEST 1
|
| 65 |
+
|
| 66 |
+
/**
|
| 67 |
+
* Input parameters for the EOS_AntiCheatServer_AddNotifyClientAuthStatusChanged function.
|
| 68 |
+
*/
|
| 69 |
+
EOS_STRUCT(EOS_AntiCheatServer_AddNotifyClientAuthStatusChangedOptions, (
|
| 70 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_ADDNOTIFYCLIENTAUTHSTATUSCHANGED_API_LATEST. */
|
| 71 |
+
int32_t ApiVersion;
|
| 72 |
+
));
|
| 73 |
+
|
| 74 |
+
/** The minimum value for the RegisterTimeoutSeconds parameter in the EOS_AntiCheatServer_BeginSessionOptions struct. */
|
| 75 |
+
#define EOS_ANTICHEATSERVER_BEGINSESSION_MIN_REGISTERTIMEOUT 10
|
| 76 |
+
|
| 77 |
+
/** The maximum value for the RegisterTimeoutSeconds parameter in the EOS_AntiCheatServer_BeginSessionOptions struct. */
|
| 78 |
+
#define EOS_ANTICHEATSERVER_BEGINSESSION_MAX_REGISTERTIMEOUT 120
|
| 79 |
+
|
| 80 |
+
/** The most recent version of the EOS_AntiCheatServer_BeginSession API. */
|
| 81 |
+
#define EOS_ANTICHEATSERVER_BEGINSESSION_API_LATEST 3
|
| 82 |
+
|
| 83 |
+
/**
|
| 84 |
+
* Input parameters for the EOS_AntiCheatServer_BeginSession function.
|
| 85 |
+
*/
|
| 86 |
+
EOS_STRUCT(EOS_AntiCheatServer_BeginSessionOptions, (
|
| 87 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_BEGINSESSION_API_LATEST. */
|
| 88 |
+
int32_t ApiVersion;
|
| 89 |
+
/**
|
| 90 |
+
* Time in seconds to allow newly registered clients to complete anti-cheat authentication.
|
| 91 |
+
* Recommended value: 60
|
| 92 |
+
* Minimum value: EOS_ANTICHEATSERVER_BEGINSESSION_MIN_REGISTERTIMEOUT
|
| 93 |
+
* Maximum value: EOS_ANTICHEATSERVER_BEGINSESSION_MAX_REGISTERTIMEOUT
|
| 94 |
+
*/
|
| 95 |
+
uint32_t RegisterTimeoutSeconds;
|
| 96 |
+
/** Optional name of this game server */
|
| 97 |
+
const char* ServerName;
|
| 98 |
+
/**
|
| 99 |
+
* Gameplay data collection APIs such as LogPlayerTick will be enabled if set to true.
|
| 100 |
+
* If you do not use these APIs you should set this value to false to reduce memory use.
|
| 101 |
+
*/
|
| 102 |
+
EOS_Bool bEnableGameplayData;
|
| 103 |
+
/** The Product User ID of the local user who is associated with this session. Dedicated servers should set this to null. */
|
| 104 |
+
EOS_ProductUserId LocalUserId;
|
| 105 |
+
));
|
| 106 |
+
|
| 107 |
+
/** The most recent version of the EOS_AntiCheatServer_EndSession API. */
|
| 108 |
+
#define EOS_ANTICHEATSERVER_ENDSESSION_API_LATEST 1
|
| 109 |
+
|
| 110 |
+
/**
|
| 111 |
+
* Input parameters for the EOS_AntiCheatServer_EndSession function.
|
| 112 |
+
*/
|
| 113 |
+
EOS_STRUCT(EOS_AntiCheatServer_EndSessionOptions, (
|
| 114 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_ENDSESSION_API_LATEST. */
|
| 115 |
+
int32_t ApiVersion;
|
| 116 |
+
));
|
| 117 |
+
|
| 118 |
+
/** The most recent version of the EOS_AntiCheatServer_RegisterClient API. */
|
| 119 |
+
#define EOS_ANTICHEATSERVER_REGISTERCLIENT_API_LATEST 3
|
| 120 |
+
|
| 121 |
+
/**
|
| 122 |
+
* Input parameters for the EOS_AntiCheatServer_RegisterClient function.
|
| 123 |
+
*/
|
| 124 |
+
EOS_STRUCT(EOS_AntiCheatServer_RegisterClientOptions, (
|
| 125 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_REGISTERCLIENT_API_LATEST. */
|
| 126 |
+
int32_t ApiVersion;
|
| 127 |
+
/** Locally unique value describing the remote user (e.g. a player object pointer) */
|
| 128 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 129 |
+
/** Type of remote user being registered */
|
| 130 |
+
EOS_EAntiCheatCommonClientType ClientType;
|
| 131 |
+
/** Remote user's platform, if known */
|
| 132 |
+
EOS_EAntiCheatCommonClientPlatform ClientPlatform;
|
| 133 |
+
/**
|
| 134 |
+
* DEPRECATED - New code should set this to null and specify UserId instead.
|
| 135 |
+
*
|
| 136 |
+
* Identifier for the remote user. This is typically a string representation of an
|
| 137 |
+
* account ID, but it can be any string which is both unique (two different users will never
|
| 138 |
+
* have the same string) and consistent (if the same user connects to this game session
|
| 139 |
+
* twice, the same string will be used) in the scope of a single protected game session.
|
| 140 |
+
*/
|
| 141 |
+
const char* AccountId_DEPRECATED;
|
| 142 |
+
/**
|
| 143 |
+
* Optional IP address for the remote user. May be null if not available.
|
| 144 |
+
* IPv4 format: "0.0.0.0"
|
| 145 |
+
* IPv6 format: "0:0:0:0:0:0:0:0"
|
| 146 |
+
*/
|
| 147 |
+
const char* IpAddress;
|
| 148 |
+
/** The Product User ID for the remote user who is being registered. */
|
| 149 |
+
EOS_ProductUserId UserId;
|
| 150 |
+
/** Reserved for future use. Must be set to 0. */
|
| 151 |
+
int32_t Reserved01;
|
| 152 |
+
));
|
| 153 |
+
|
| 154 |
+
/** The most recent version of the EOS_AntiCheatServer_UnregisterClient API. */
|
| 155 |
+
#define EOS_ANTICHEATSERVER_UNREGISTERCLIENT_API_LATEST 1
|
| 156 |
+
|
| 157 |
+
/**
|
| 158 |
+
* Input parameters for the EOS_AntiCheatServer_UnregisterClient function.
|
| 159 |
+
*/
|
| 160 |
+
EOS_STRUCT(EOS_AntiCheatServer_UnregisterClientOptions, (
|
| 161 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_UNREGISTERCLIENT_API_LATEST. */
|
| 162 |
+
int32_t ApiVersion;
|
| 163 |
+
/** Locally unique value describing the remote user, as previously passed to RegisterClient */
|
| 164 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 165 |
+
));
|
| 166 |
+
|
| 167 |
+
/** The most recent version of the EOS_AntiCheatServer_ReceiveMessageFromClient API. */
|
| 168 |
+
#define EOS_ANTICHEATSERVER_RECEIVEMESSAGEFROMCLIENT_API_LATEST 1
|
| 169 |
+
|
| 170 |
+
/**
|
| 171 |
+
* Input parameters for the EOS_AntiCheatServer_ReceiveMessageFromClient function.
|
| 172 |
+
*/
|
| 173 |
+
EOS_STRUCT(EOS_AntiCheatServer_ReceiveMessageFromClientOptions, (
|
| 174 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_RECEIVEMESSAGEFROMCLIENT_API_LATEST. */
|
| 175 |
+
int32_t ApiVersion;
|
| 176 |
+
/** Locally unique value describing the corresponding remote user, as previously passed to RegisterClient */
|
| 177 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 178 |
+
/** The size of the data received */
|
| 179 |
+
uint32_t DataLengthBytes;
|
| 180 |
+
/** The data received */
|
| 181 |
+
const void* Data;
|
| 182 |
+
));
|
| 183 |
+
|
| 184 |
+
/** The most recent version of the EOS_AntiCheatServer_SetClientNetworkState API. */
|
| 185 |
+
#define EOS_ANTICHEATSERVER_SETCLIENTNETWORKSTATE_API_LATEST 1
|
| 186 |
+
|
| 187 |
+
/**
|
| 188 |
+
* Input parameters for the EOS_AntiCheatServer_SetClientNetworkState function.
|
| 189 |
+
*/
|
| 190 |
+
EOS_STRUCT(EOS_AntiCheatServer_SetClientNetworkStateOptions, (
|
| 191 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_SETCLIENTNETWORKSTATE_API_LATEST. */
|
| 192 |
+
int32_t ApiVersion;
|
| 193 |
+
/** Locally unique value describing the remote user (e.g. a player object pointer) */
|
| 194 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 195 |
+
/** True if the network is functioning normally, false if temporarily interrupted */
|
| 196 |
+
EOS_Bool bIsNetworkActive;
|
| 197 |
+
));
|
| 198 |
+
|
| 199 |
+
/** The most recent version of the EOS_AntiCheatServer_GetProtectMessageOutputLength API. */
|
| 200 |
+
#define EOS_ANTICHEATSERVER_GETPROTECTMESSAGEOUTPUTLENGTH_API_LATEST 1
|
| 201 |
+
|
| 202 |
+
/**
|
| 203 |
+
* Input parameters for the EOS_AntiCheatServer_GetProtectMessageOutputLength function.
|
| 204 |
+
*/
|
| 205 |
+
EOS_STRUCT(EOS_AntiCheatServer_GetProtectMessageOutputLengthOptions, (
|
| 206 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_GETPROTECTMESSAGEOUTPUTLENGTH_API_LATEST. */
|
| 207 |
+
int32_t ApiVersion;
|
| 208 |
+
/** Length in bytes of input */
|
| 209 |
+
uint32_t DataLengthBytes;
|
| 210 |
+
));
|
| 211 |
+
|
| 212 |
+
/** The most recent version of the EOS_AntiCheatServer_ProtectMessage API. */
|
| 213 |
+
#define EOS_ANTICHEATSERVER_PROTECTMESSAGE_API_LATEST 1
|
| 214 |
+
|
| 215 |
+
/**
|
| 216 |
+
* Input parameters for the EOS_AntiCheatServer_ProtectMessage function.
|
| 217 |
+
*/
|
| 218 |
+
EOS_STRUCT(EOS_AntiCheatServer_ProtectMessageOptions, (
|
| 219 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_PROTECTMESSAGE_API_LATEST. */
|
| 220 |
+
int32_t ApiVersion;
|
| 221 |
+
/** Locally unique value describing the remote user to whom the message will be sent */
|
| 222 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 223 |
+
/** Length in bytes of input */
|
| 224 |
+
uint32_t DataLengthBytes;
|
| 225 |
+
/** The data to encrypt */
|
| 226 |
+
const void* Data;
|
| 227 |
+
/** The size in bytes of OutBuffer */
|
| 228 |
+
uint32_t OutBufferSizeBytes;
|
| 229 |
+
));
|
| 230 |
+
|
| 231 |
+
/** The most recent version of the EOS_AntiCheatServer_UnprotectMessage API. */
|
| 232 |
+
#define EOS_ANTICHEATSERVER_UNPROTECTMESSAGE_API_LATEST 1
|
| 233 |
+
|
| 234 |
+
/**
|
| 235 |
+
* Input parameters for the EOS_AntiCheatServer_UnprotectMessage function.
|
| 236 |
+
*/
|
| 237 |
+
EOS_STRUCT(EOS_AntiCheatServer_UnprotectMessageOptions, (
|
| 238 |
+
/** API Version: Set this to EOS_ANTICHEATSERVER_UNPROTECTMESSAGE_API_LATEST. */
|
| 239 |
+
int32_t ApiVersion;
|
| 240 |
+
/** Locally unique value describing the remote user from whom the message was received */
|
| 241 |
+
EOS_AntiCheatCommon_ClientHandle ClientHandle;
|
| 242 |
+
/** Length in bytes of input */
|
| 243 |
+
uint32_t DataLengthBytes;
|
| 244 |
+
/** The data to decrypt */
|
| 245 |
+
const void* Data;
|
| 246 |
+
/** The size in bytes of OutBuffer */
|
| 247 |
+
uint32_t OutBufferSizeBytes;
|
| 248 |
+
));
|
| 249 |
+
|
| 250 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_auth.h
ADDED
|
@@ -0,0 +1,243 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_auth_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Auth Interface is used to manage local user permissions and access to backend services through the verification of various forms of credentials.
|
| 8 |
+
* All Auth Interface calls take a handle of type EOS_HAuth as the first parameter.
|
| 9 |
+
* This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetAuthInterface function.
|
| 10 |
+
*
|
| 11 |
+
* @see EOS_Platform_GetAuthInterface
|
| 12 |
+
*/
|
| 13 |
+
|
| 14 |
+
/**
|
| 15 |
+
* Login/Authenticate with user credentials.
|
| 16 |
+
*
|
| 17 |
+
* @param Options structure containing the account credentials to use during the login operation
|
| 18 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 19 |
+
* @param CompletionDelegate a callback that is fired when the login operation completes, either successfully or in error
|
| 20 |
+
*
|
| 21 |
+
* @see EOS_Auth_LoginOptions
|
| 22 |
+
* @see EOS_Auth_OnLoginCallback
|
| 23 |
+
*/
|
| 24 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_Login(EOS_HAuth Handle, const EOS_Auth_LoginOptions* Options, void* ClientData, const EOS_Auth_OnLoginCallback CompletionDelegate);
|
| 25 |
+
|
| 26 |
+
/**
|
| 27 |
+
* Signs the player out of the online service.
|
| 28 |
+
*
|
| 29 |
+
* @param Options structure containing information about which account to log out.
|
| 30 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 31 |
+
* @param CompletionDelegate a callback that is fired when the logout operation completes, either successfully or in error
|
| 32 |
+
*
|
| 33 |
+
* @see EOS_Auth_LogoutOptions
|
| 34 |
+
* @see EOS_Auth_OnLogoutCallback
|
| 35 |
+
*/
|
| 36 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_Logout(EOS_HAuth Handle, const EOS_Auth_LogoutOptions* Options, void* ClientData, const EOS_Auth_OnLogoutCallback CompletionDelegate);
|
| 37 |
+
|
| 38 |
+
/**
|
| 39 |
+
* Link external account by continuing previous login attempt with a continuance token.
|
| 40 |
+
*
|
| 41 |
+
* The user will be presented with Epic Accounts onboarding flow managed by the SDK.
|
| 42 |
+
*
|
| 43 |
+
* On success, the user will be logged in at the completion of this action.
|
| 44 |
+
* This will commit this external account to the Epic Account and cannot be undone in the SDK.
|
| 45 |
+
*
|
| 46 |
+
* @param Options structure containing the account credentials to use during the link account operation
|
| 47 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 48 |
+
* @param CompletionDelegate a callback that is fired when the link account operation completes, either successfully or in error
|
| 49 |
+
*
|
| 50 |
+
* @see EOS_Auth_LinkAccountOptions
|
| 51 |
+
* @see EOS_Auth_OnLinkAccountCallback
|
| 52 |
+
*/
|
| 53 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_LinkAccount(EOS_HAuth Handle, const EOS_Auth_LinkAccountOptions* Options, void* ClientData, const EOS_Auth_OnLinkAccountCallback CompletionDelegate);
|
| 54 |
+
|
| 55 |
+
/**
|
| 56 |
+
* Deletes a previously received and locally stored persistent auth access token for the currently logged in user of the local device.
|
| 57 |
+
*
|
| 58 |
+
* On Desktop and Mobile platforms, the access token is deleted from the keychain of the local user and a backend request is made to revoke the token on the authentication server.
|
| 59 |
+
* On Console platforms, even though the caller is responsible for storing and deleting the access token on the local device,
|
| 60 |
+
* this function should still be called with the access token before its deletion to make the best effort in attempting to also revoke it on the authentication server.
|
| 61 |
+
* If the function would fail on Console, the caller should still proceed as normal to delete the access token locally as intended.
|
| 62 |
+
*
|
| 63 |
+
* @param Options structure containing operation input parameters
|
| 64 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 65 |
+
* @param CompletionDelegate a callback that is fired when the deletion operation completes, either successfully or in error
|
| 66 |
+
*
|
| 67 |
+
* @see EOS_Auth_DeletePersistentAuthOptions
|
| 68 |
+
* @see EOS_Auth_OnDeletePersistentAuthCallback
|
| 69 |
+
*/
|
| 70 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_DeletePersistentAuth(EOS_HAuth Handle, const EOS_Auth_DeletePersistentAuthOptions* Options, void* ClientData, const EOS_Auth_OnDeletePersistentAuthCallback CompletionDelegate);
|
| 71 |
+
|
| 72 |
+
/**
|
| 73 |
+
* Contact the backend service to verify validity of an existing user auth token.
|
| 74 |
+
* This function is intended for server-side use only.
|
| 75 |
+
*
|
| 76 |
+
* @param Options structure containing information about the auth token being verified
|
| 77 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 78 |
+
* @param CompletionDelegate a callback that is fired when the logout operation completes, either successfully or in error
|
| 79 |
+
*
|
| 80 |
+
* @see EOS_Auth_VerifyUserAuthOptions
|
| 81 |
+
* @see EOS_Auth_OnVerifyUserAuthCallback
|
| 82 |
+
* @see EOS_Auth_CopyUserAuthToken
|
| 83 |
+
*/
|
| 84 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_VerifyUserAuth(EOS_HAuth Handle, const EOS_Auth_VerifyUserAuthOptions* Options, void* ClientData, const EOS_Auth_OnVerifyUserAuthCallback CompletionDelegate);
|
| 85 |
+
|
| 86 |
+
/**
|
| 87 |
+
* Fetch the number of accounts that are logged in.
|
| 88 |
+
*
|
| 89 |
+
* @return the number of accounts logged in.
|
| 90 |
+
*/
|
| 91 |
+
EOS_DECLARE_FUNC(int32_t) EOS_Auth_GetLoggedInAccountsCount(EOS_HAuth Handle);
|
| 92 |
+
|
| 93 |
+
/**
|
| 94 |
+
* Fetch an Epic Account ID that is logged in.
|
| 95 |
+
*
|
| 96 |
+
* @param Index An index into the list of logged in accounts. If the index is out of bounds, the returned Epic Account ID will be invalid.
|
| 97 |
+
*
|
| 98 |
+
* @return The Epic Account ID associated with the index passed
|
| 99 |
+
*/
|
| 100 |
+
EOS_DECLARE_FUNC(EOS_EpicAccountId) EOS_Auth_GetLoggedInAccountByIndex(EOS_HAuth Handle, int32_t Index);
|
| 101 |
+
|
| 102 |
+
/**
|
| 103 |
+
* Fetches the login status for an Epic Account ID.
|
| 104 |
+
*
|
| 105 |
+
* @param LocalUserId The Epic Account ID of the user being queried
|
| 106 |
+
*
|
| 107 |
+
* @return The enum value of a user's login status
|
| 108 |
+
*/
|
| 109 |
+
EOS_DECLARE_FUNC(EOS_ELoginStatus) EOS_Auth_GetLoginStatus(EOS_HAuth Handle, EOS_EpicAccountId LocalUserId);
|
| 110 |
+
|
| 111 |
+
/**
|
| 112 |
+
* Fetch a user auth token for an Epic Account ID.
|
| 113 |
+
*
|
| 114 |
+
* A user authentication token allows any code with possession (backend/client) to perform certain actions on behalf of the user.
|
| 115 |
+
* Because of this, for the purposes of user identity verification, the EOS_Auth_CopyIdToken API should be used instead.
|
| 116 |
+
*
|
| 117 |
+
* @param Options Structure containing the api version of CopyUserAuthToken to use
|
| 118 |
+
* @param LocalUserId The Epic Account ID of the user being queried
|
| 119 |
+
* @param OutUserAuthToken The auth token for the given user, if it exists and is valid; use EOS_Auth_Token_Release when finished
|
| 120 |
+
*
|
| 121 |
+
* @see EOS_Auth_CopyUserAuthTokenOptions
|
| 122 |
+
* @see EOS_Auth_Token
|
| 123 |
+
* @see EOS_Auth_Token_Release
|
| 124 |
+
*
|
| 125 |
+
* @return EOS_EResult containing the result of the operation.
|
| 126 |
+
* Possible result codes:
|
| 127 |
+
* - EOS_Success if the information is available and passed out in OutUserAuthToken
|
| 128 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 129 |
+
* - EOS_NotFound if the auth token is not found or expired.
|
| 130 |
+
*
|
| 131 |
+
*/
|
| 132 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Auth_CopyUserAuthToken(EOS_HAuth Handle, const EOS_Auth_CopyUserAuthTokenOptions* Options, EOS_EpicAccountId LocalUserId, EOS_Auth_Token ** OutUserAuthToken);
|
| 133 |
+
|
| 134 |
+
/**
|
| 135 |
+
* Fetch an ID token for an Epic Account ID.
|
| 136 |
+
*
|
| 137 |
+
* ID tokens are used to securely verify user identities with online services.
|
| 138 |
+
* The most common use case is using an ID token to authenticate the local user by their selected account ID,
|
| 139 |
+
* which is the account ID that should be used to access any game-scoped data for the current application.
|
| 140 |
+
*
|
| 141 |
+
* An ID token for the selected account ID of a locally authenticated user will always be readily available.
|
| 142 |
+
* To retrieve it for the selected account ID, you can use EOS_Auth_CopyIdToken directly after a successful user login.
|
| 143 |
+
*
|
| 144 |
+
* @param Options Structure containing the account ID for which to copy an ID token.
|
| 145 |
+
* @param OutIdToken An ID token for the given user, if it exists and is valid; use EOS_Auth_IdToken_Release when finished.
|
| 146 |
+
*
|
| 147 |
+
* @see EOS_Auth_CopyIdTokenOptions
|
| 148 |
+
* @see EOS_Auth_IdToken
|
| 149 |
+
* @see EOS_Auth_IdToken_Release
|
| 150 |
+
*
|
| 151 |
+
* @return EOS_EResult containing the result of the operation.
|
| 152 |
+
* Possible result codes:
|
| 153 |
+
* - EOS_Success if the information is available and passed out in OutUserIdToken
|
| 154 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 155 |
+
* - EOS_NotFound if the Id token is not found or expired.
|
| 156 |
+
*
|
| 157 |
+
*/
|
| 158 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Auth_CopyIdToken(EOS_HAuth Handle, const EOS_Auth_CopyIdTokenOptions* Options, EOS_Auth_IdToken ** OutIdToken);
|
| 159 |
+
|
| 160 |
+
/**
|
| 161 |
+
* Query the backend for an ID token that describes one of the merged account IDs of a local authenticated user.
|
| 162 |
+
*
|
| 163 |
+
* The ID token can be used to impersonate a merged account ID when communicating with online services.
|
| 164 |
+
*
|
| 165 |
+
* An ID token for the selected account ID of a locally authenticated user will always be readily available and does not need to be queried explicitly.
|
| 166 |
+
*
|
| 167 |
+
* @param Options Structure containing the merged account ID for which to query an ID token.
|
| 168 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 169 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error.
|
| 170 |
+
*
|
| 171 |
+
* @see EOS_Auth_QueryIdTokenOptions
|
| 172 |
+
* @see EOS_Auth_OnQueryIdTokenCallback
|
| 173 |
+
*/
|
| 174 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_QueryIdToken(EOS_HAuth Handle, const EOS_Auth_QueryIdTokenOptions* Options, void* ClientData, const EOS_Auth_OnQueryIdTokenCallback CompletionDelegate);
|
| 175 |
+
|
| 176 |
+
/**
|
| 177 |
+
* Verify a given ID token for authenticity and validity.
|
| 178 |
+
*
|
| 179 |
+
* @param Options Structure containing information about the ID token to verify.
|
| 180 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 181 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error.
|
| 182 |
+
*
|
| 183 |
+
* @see EOS_Auth_VerifyIdTokenOptions
|
| 184 |
+
* @see EOS_Auth_OnVerifyIdTokenCallback
|
| 185 |
+
*/
|
| 186 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_VerifyIdToken(EOS_HAuth Handle, const EOS_Auth_VerifyIdTokenOptions* Options, void* ClientData, const EOS_Auth_OnVerifyIdTokenCallback CompletionDelegate);
|
| 187 |
+
|
| 188 |
+
/**
|
| 189 |
+
* Fetch the selected account ID to the current application for a local authenticated user.
|
| 190 |
+
*
|
| 191 |
+
* @param LocalUserId The account ID of a currently logged in account.
|
| 192 |
+
* @param OutSelectedAccountId The selected account ID corresponding to the given account ID.
|
| 193 |
+
*
|
| 194 |
+
* @return EOS_EResult containing the result of the operation.
|
| 195 |
+
* Possible result codes:
|
| 196 |
+
* - EOS_Success if the user is logged in and the information is available.
|
| 197 |
+
* - EOS_InvalidParameters if the output parameter is NULL.
|
| 198 |
+
* - EOS_InvalidUser if the input account ID is not locally known.
|
| 199 |
+
* - EOS_InvalidAuth if the input account ID is not locally logged in.
|
| 200 |
+
* - EOS_NotFound otherwise.
|
| 201 |
+
*/
|
| 202 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Auth_GetSelectedAccountId(EOS_HAuth Handle, const EOS_EpicAccountId LocalUserId, EOS_EpicAccountId* OutSelectedAccountId);
|
| 203 |
+
|
| 204 |
+
/**
|
| 205 |
+
* Fetch the number of merged accounts for a given logged in account.
|
| 206 |
+
*
|
| 207 |
+
* @param LocalUserId The account ID of a currently logged in account.
|
| 208 |
+
*
|
| 209 |
+
* @return the number of merged accounts for the logged in account.
|
| 210 |
+
*/
|
| 211 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Auth_GetMergedAccountsCount(EOS_HAuth Handle, const EOS_EpicAccountId LocalUserId);
|
| 212 |
+
|
| 213 |
+
/**
|
| 214 |
+
* Fetch one of the merged account IDs for a given logged in account.
|
| 215 |
+
*
|
| 216 |
+
* @param LocalUserId The account ID of a currently logged in account.
|
| 217 |
+
* @param Index An index into the list of merged accounts. If the index is out of bounds, the returned Epic Account ID will be invalid.
|
| 218 |
+
*
|
| 219 |
+
* @return The Epic Account ID associated with the index passed.
|
| 220 |
+
*/
|
| 221 |
+
EOS_DECLARE_FUNC(EOS_EpicAccountId) EOS_Auth_GetMergedAccountByIndex(EOS_HAuth Handle, const EOS_EpicAccountId LocalUserId, const uint32_t Index);
|
| 222 |
+
|
| 223 |
+
/**
|
| 224 |
+
* Register to receive login status updates.
|
| 225 |
+
* @note If the returned NotificationId is valid, you must call EOS_Auth_RemoveNotifyLoginStatusChanged when you no longer wish to have your NotificationHandler called.
|
| 226 |
+
*
|
| 227 |
+
* @param Options structure containing the api version of AddNotifyLoginStatusChanged to use
|
| 228 |
+
* @param ClientData arbitrary data that is passed back to you in the callback
|
| 229 |
+
* @param Notification a callback that is fired when the login status for a user changes
|
| 230 |
+
*
|
| 231 |
+
* @see EOS_Auth_AddNotifyLoginStatusChangedOptions
|
| 232 |
+
* @see EOS_Auth_OnLoginStatusChangedCallback
|
| 233 |
+
*
|
| 234 |
+
* @return handle representing the registered callback
|
| 235 |
+
*/
|
| 236 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Auth_AddNotifyLoginStatusChanged(EOS_HAuth Handle, const EOS_Auth_AddNotifyLoginStatusChangedOptions* Options, void* ClientData, const EOS_Auth_OnLoginStatusChangedCallback Notification);
|
| 237 |
+
|
| 238 |
+
/**
|
| 239 |
+
* Unregister from receiving login status updates.
|
| 240 |
+
*
|
| 241 |
+
* @param InId handle representing the registered callback
|
| 242 |
+
*/
|
| 243 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_RemoveNotifyLoginStatusChanged(EOS_HAuth Handle, EOS_NotificationId InId);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_auth_types.h
ADDED
|
@@ -0,0 +1,727 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_auth_types_deprecated.inl"
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
EOS_EXTERN_C typedef struct EOS_AuthHandle* EOS_HAuth;
|
| 10 |
+
|
| 11 |
+
/**
|
| 12 |
+
* All possible types of login methods, availability depends on permissions granted to the client.
|
| 13 |
+
*
|
| 14 |
+
* @see EOS_Auth_Login
|
| 15 |
+
* @see EOS_Auth_Credentials
|
| 16 |
+
*/
|
| 17 |
+
EOS_ENUM(EOS_ELoginCredentialType,
|
| 18 |
+
/**
|
| 19 |
+
* Login using account email address and password.
|
| 20 |
+
*
|
| 21 |
+
* Note: This login method is restricted to Epic Games internal use only. Do not use.
|
| 22 |
+
*/
|
| 23 |
+
EOS_LCT_Password = 0,
|
| 24 |
+
/**
|
| 25 |
+
* A short-lived one-time use exchange code to login the local user.
|
| 26 |
+
*
|
| 27 |
+
* @details Typically retrieved via command-line parameters provided by a launcher that generated the exchange code for this application.
|
| 28 |
+
* When started, the application is expected to consume the exchange code by using the EOS_Auth_Login API as soon as possible.
|
| 29 |
+
* This is needed in order to authenticate the local user before the exchange code would expire.
|
| 30 |
+
* Attempting to consume an already expired exchange code will return EOS_EResult::EOS_Auth_ExchangeCodeNotFound error by the EOS_Auth_Login API.
|
| 31 |
+
*/
|
| 32 |
+
EOS_LCT_ExchangeCode = 1,
|
| 33 |
+
/**
|
| 34 |
+
* Used by standalone applications distributed outside the supported game platforms such as Epic Games Store or Steam, and on Nintendo Switch.
|
| 35 |
+
*
|
| 36 |
+
* Persistent Auth is used in conjunction with the EOS_LCT_AccountPortal login method for automatic login of the local user across multiple runs of the application.
|
| 37 |
+
*
|
| 38 |
+
* Standalone applications implement the login sequence as follows:
|
| 39 |
+
* 1. Application calls EOS_Auth_Login with EOS_LCT_PersistentAuth, using a previously stored Epic refresh token for an automatic user login.
|
| 40 |
+
* 2. If automatic login fails, the application discards the Epic refresh token used as defunct, and proceeds to call EOS_Auth_Login with EOS_LCT_AccountPortal to prompt the user for manual login.
|
| 41 |
+
*
|
| 42 |
+
* @note On Desktop and Mobile platforms, the persistent refresh token is automatically managed by the SDK that stores it in the keychain of the currently logged in user of the local device.
|
| 43 |
+
* On Nintendo Switch, after a successful login the refresh token must be retrieved using the EOS_Auth_CopyUserAuthToken API and stored by the application specifically for the active Nintendo Switch user.
|
| 44 |
+
*
|
| 45 |
+
* @see EOS_LCT_AccountPortal
|
| 46 |
+
*/
|
| 47 |
+
EOS_LCT_PersistentAuth = 2,
|
| 48 |
+
/**
|
| 49 |
+
* Not supported. Superseded by EOS_LCT_ExternalAuth login method.
|
| 50 |
+
*
|
| 51 |
+
* @see EOS_LCT_ExternalAuth
|
| 52 |
+
*/
|
| 53 |
+
EOS_LCT_DeviceCode = 3,
|
| 54 |
+
/**
|
| 55 |
+
* Login with named credentials hosted by the EOS SDK Developer Authentication Tool.
|
| 56 |
+
*
|
| 57 |
+
* @note Used for development purposes only.
|
| 58 |
+
*/
|
| 59 |
+
EOS_LCT_Developer = 4,
|
| 60 |
+
/**
|
| 61 |
+
* Refresh token that was retrieved from a previous call to EOS_Auth_Login API in another local process context.
|
| 62 |
+
* Mainly used in conjunction with custom desktop launcher applications.
|
| 63 |
+
*
|
| 64 |
+
* @details Can be used for example when launching the game from Epic Games Launcher and having an intermediate process
|
| 65 |
+
* in-between that requires authenticating the user before eventually starting the actual game client application.
|
| 66 |
+
* In such scenario, an intermediate launcher will log in the user by consuming the exchange code it received from the
|
| 67 |
+
* Epic Games Launcher. To allow the game client to also authenticate the user, it can copy the refresh token using the
|
| 68 |
+
* EOS_Auth_CopyUserAuthToken API and pass it via launch parameters to the started game client. The game client can then
|
| 69 |
+
* use the refresh token to log in the user.
|
| 70 |
+
*/
|
| 71 |
+
EOS_LCT_RefreshToken = 5,
|
| 72 |
+
/**
|
| 73 |
+
* Used by standalone applications distributed outside the supported game platforms such as Epic Games Store or Steam, and on Nintendo Switch.
|
| 74 |
+
*
|
| 75 |
+
* Login using the built-in user onboarding experience provided by the SDK, which will automatically store a persistent
|
| 76 |
+
* refresh token to enable automatic user login for consecutive application runs on the local device. Applications are
|
| 77 |
+
* expected to attempt automatic login using the EOS_LCT_PersistentAuth login method, and fall back to EOS_LCT_AccountPortal
|
| 78 |
+
* to prompt users for manual login.
|
| 79 |
+
*
|
| 80 |
+
* @note On Windows, using this login method requires applications to be started through the EOS Bootstrapper application
|
| 81 |
+
* and to have the local Epic Online Services redistributable installed on the local system. See EOS_Platform_GetDesktopCrossplayStatus
|
| 82 |
+
* for adding a readiness check prior to calling EOS_Auth_Login.
|
| 83 |
+
*
|
| 84 |
+
* @see EOS_LCT_PersistentAuth
|
| 85 |
+
*/
|
| 86 |
+
EOS_LCT_AccountPortal = 6,
|
| 87 |
+
/**
|
| 88 |
+
* Login using external account provider credentials, such as PlayStation(TM)Network, Steam, and Xbox Live.
|
| 89 |
+
*
|
| 90 |
+
* This is the intended login method on PlayStation® and Xbox console devices.
|
| 91 |
+
* On Desktop and Mobile, used when launched through any of the commonly supported platform clients.
|
| 92 |
+
*
|
| 93 |
+
* @details The user is seamlessly logged in to their Epic account using an external account access token.
|
| 94 |
+
* If the local platform account is already linked with the user's Epic account, the login will succeed and EOS_EResult::EOS_Success is returned.
|
| 95 |
+
* When the local platform account has not been linked with an Epic account yet,
|
| 96 |
+
* EOS_EResult::EOS_InvalidUser is returned and the EOS_ContinuanceToken will be set in the EOS_Auth_LoginCallbackInfo data.
|
| 97 |
+
* If EOS_EResult::EOS_InvalidUser is returned,
|
| 98 |
+
* the application should proceed to call the EOS_Auth_LinkAccount API with the EOS_ContinuanceToken to continue with the external account login
|
| 99 |
+
* and to link the external account at the end of the login flow.
|
| 100 |
+
*
|
| 101 |
+
* @details Login flow when the platform user account has not been linked with an Epic account yet:
|
| 102 |
+
* 1. Game calls EOS_Auth_Login with the EOS_LCT_ExternalAuth credential type.
|
| 103 |
+
* 2. EOS_Auth_Login returns EOS_EResult::EOS_InvalidUser with a non-null EOS_ContinuanceToken in the EOS_Auth_LoginCallbackInfo data.
|
| 104 |
+
* 3. Game calls EOS_Auth_LinkAccount with the EOS_ContinuanceToken to initiate the login flow for linking the platform account with the user's Epic account.
|
| 105 |
+
* 4. The user is taken automatically to the Epic accounts user onboarding flow managed by the SDK.
|
| 106 |
+
* 5. Once the user completes the login, cancels it or if the login flow times out, EOS_Auth_LinkAccount invokes the completion callback to the caller.
|
| 107 |
+
* - If the user was logged in successfully, EOS_EResult::EOS_Success is returned in the EOS_Auth_LoginCallbackInfo. Otherwise, an error result code is returned accordingly.
|
| 108 |
+
*
|
| 109 |
+
* @note On Windows, using this login method requires applications to be started through the EOS Bootstrapper application
|
| 110 |
+
* and to have the local Epic Online Services redistributable installed on the local system. See EOS_Platform_GetDesktopCrossplayStatus
|
| 111 |
+
* for adding a readiness check prior to calling EOS_Auth_Login.
|
| 112 |
+
*/
|
| 113 |
+
EOS_LCT_ExternalAuth = 7
|
| 114 |
+
);
|
| 115 |
+
|
| 116 |
+
/** The most recent version of the EOS_Auth_Token struct. */
|
| 117 |
+
#define EOS_AUTH_TOKEN_API_LATEST 2
|
| 118 |
+
|
| 119 |
+
/**
|
| 120 |
+
* Types of auth tokens
|
| 121 |
+
*
|
| 122 |
+
* @see EOS_Auth_CopyUserAuthToken
|
| 123 |
+
* @see EOS_Auth_Token
|
| 124 |
+
*/
|
| 125 |
+
EOS_ENUM(EOS_EAuthTokenType,
|
| 126 |
+
/** Auth token is for a validated client */
|
| 127 |
+
EOS_ATT_Client = 0,
|
| 128 |
+
/** Auth token is for a validated user */
|
| 129 |
+
EOS_ATT_User = 1
|
| 130 |
+
);
|
| 131 |
+
|
| 132 |
+
/**
|
| 133 |
+
* A structure that contains an auth token.
|
| 134 |
+
* These structures are created by EOS_Auth_CopyUserAuthToken and must be passed to EOS_Auth_Token_Release.
|
| 135 |
+
*/
|
| 136 |
+
EOS_STRUCT(EOS_Auth_Token, (
|
| 137 |
+
/** API Version: Set this to EOS_AUTH_TOKEN_API_LATEST. */
|
| 138 |
+
int32_t ApiVersion;
|
| 139 |
+
/** Name of the app related to the client ID involved with this token */
|
| 140 |
+
const char* App;
|
| 141 |
+
/** Client ID that requested this token */
|
| 142 |
+
const char* ClientId;
|
| 143 |
+
/** The Epic Account ID associated with this auth token */
|
| 144 |
+
EOS_EpicAccountId AccountId;
|
| 145 |
+
/** Access token for the current user login session */
|
| 146 |
+
const char* AccessToken;
|
| 147 |
+
/** Time before the access token expires, in seconds, relative to the call to EOS_Auth_CopyUserAuthToken */
|
| 148 |
+
double ExpiresIn;
|
| 149 |
+
/** Absolute time in UTC before the access token expires, in ISO 8601 format */
|
| 150 |
+
const char* ExpiresAt;
|
| 151 |
+
/** Type of auth token */
|
| 152 |
+
EOS_EAuthTokenType AuthType;
|
| 153 |
+
/**
|
| 154 |
+
* Refresh token.
|
| 155 |
+
*
|
| 156 |
+
* @see EOS_ELoginCredentialType::EOS_LCT_RefreshToken
|
| 157 |
+
*/
|
| 158 |
+
const char* RefreshToken;
|
| 159 |
+
/** Time before the access token expires, in seconds, relative to the call to EOS_Auth_CopyUserAuthToken */
|
| 160 |
+
double RefreshExpiresIn;
|
| 161 |
+
/** Absolute time in UTC before the refresh token expires, in ISO 8601 format */
|
| 162 |
+
const char* RefreshExpiresAt;
|
| 163 |
+
));
|
| 164 |
+
|
| 165 |
+
/**
|
| 166 |
+
* Release the memory associated with an EOS_Auth_Token structure. This must be called on data retrieved from EOS_Auth_CopyUserAuthToken.
|
| 167 |
+
*
|
| 168 |
+
* @param AuthToken The auth token structure to be released.
|
| 169 |
+
*
|
| 170 |
+
* @see EOS_Auth_Token
|
| 171 |
+
* @see EOS_Auth_CopyUserAuthToken
|
| 172 |
+
*/
|
| 173 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_Token_Release(EOS_Auth_Token* AuthToken);
|
| 174 |
+
|
| 175 |
+
/** The most recent version of the EOS_Auth_Credentials struct. */
|
| 176 |
+
#define EOS_AUTH_CREDENTIALS_API_LATEST 4
|
| 177 |
+
|
| 178 |
+
/**
|
| 179 |
+
* Login credentials filled as part of the EOS_Auth_LoginOptions struct for EOS_Auth_Login API.
|
| 180 |
+
*
|
| 181 |
+
* Required input parameters to be set depend on the login credential type.
|
| 182 |
+
* Any parameters not being used must be set to NULL. Otherwise, EOS_InvalidParameters error is returned.
|
| 183 |
+
*
|
| 184 |
+
* EOS_LCT_Password | ID is the email address, and Token is the password.
|
| 185 |
+
* EOS_LCT_ExchangeCode | Set ID to NULL. Token is the exchange code.
|
| 186 |
+
* EOS_LCT_PersistentAuth | Set ID to NULL. On console platforms, Token is the long-lived refresh token. Otherwise, set to NULL.
|
| 187 |
+
* EOS_LCT_Developer | Set ID as the host (e.g. localhost:6547). Token is the credential name registered in the EOS Developer Authentication Tool.
|
| 188 |
+
* EOS_LCT_RefreshToken | Set ID to NULL. Token is the refresh token.
|
| 189 |
+
* EOS_LCT_AccountPortal | Set ID and Token to NULL. SystemAuthCredentialsOptions may be required on mobile platforms.
|
| 190 |
+
* EOS_LCT_ExternalAuth | Set ID to NULL or the External Account ID that belongs to the external auth token. Token is the external auth token specified by ExternalType. External Account IDs set to the ID are expected as either base-10 numeric strings for integer-based external Account IDs, or the actual string for everything else. If ID is provided, login will automatically be cancelled if the EOS SDK is able to and does detect the external account signing-out. If ID is provided, it must match the external account ID belonging to the auth-token, or login will fail.
|
| 191 |
+
*
|
| 192 |
+
* @see EOS_ELoginCredentialType
|
| 193 |
+
* @see EOS_Auth_Login
|
| 194 |
+
* @see EOS_Auth_DeletePersistentAuthOptions
|
| 195 |
+
*/
|
| 196 |
+
EOS_STRUCT(EOS_Auth_Credentials, (
|
| 197 |
+
/** API Version: Set this to EOS_AUTH_CREDENTIALS_API_LATEST. */
|
| 198 |
+
int32_t ApiVersion;
|
| 199 |
+
/**
|
| 200 |
+
* Authentication ID value based on the used EOS_ELoginCredentialType.
|
| 201 |
+
* If not used, must be set to NULL.
|
| 202 |
+
*/
|
| 203 |
+
const char* Id;
|
| 204 |
+
/**
|
| 205 |
+
* Authentication Token value based on the used EOS_ELoginCredentialType.
|
| 206 |
+
* If not used, must be set to NULL.
|
| 207 |
+
*/
|
| 208 |
+
const char* Token;
|
| 209 |
+
/** Login credentials type based on the authentication method used. */
|
| 210 |
+
EOS_ELoginCredentialType Type;
|
| 211 |
+
/**
|
| 212 |
+
* This field is for system specific options, if any.
|
| 213 |
+
*
|
| 214 |
+
* If provided, the structure will be located in (System)/eos_(system).h.
|
| 215 |
+
* The structure will be named EOS_(System)_Auth_CredentialsOptions.
|
| 216 |
+
*/
|
| 217 |
+
void* SystemAuthCredentialsOptions;
|
| 218 |
+
/**
|
| 219 |
+
* Type of external login. Needed to identify the external auth method to use.
|
| 220 |
+
* Used when login type is set to EOS_LCT_ExternalAuth, ignored for other EOS_ELoginCredentialType methods.
|
| 221 |
+
*/
|
| 222 |
+
EOS_EExternalCredentialType ExternalType;
|
| 223 |
+
));
|
| 224 |
+
|
| 225 |
+
/** The most recent version of the EOS_Auth_PinGrantInfo struct. */
|
| 226 |
+
#define EOS_AUTH_PINGRANTINFO_API_LATEST 2
|
| 227 |
+
|
| 228 |
+
/**
|
| 229 |
+
* Intermediate data for completing Epic account login, when neither the in-game overlay or a platform browser is used.
|
| 230 |
+
* The EOS_Auth_PinGrantInfo struct is returned as part of the EOS_Auth_LoginCallbackInfo and EOS_Auth_LinkAccountCallbackInfo structs.
|
| 231 |
+
* The data inside should be exposed to the user for entry on a secondary device.
|
| 232 |
+
* All data must be copied out before the completion of this callback.
|
| 233 |
+
*/
|
| 234 |
+
EOS_STRUCT(EOS_Auth_PinGrantInfo, (
|
| 235 |
+
/** API Version: Set this to EOS_AUTH_PINGRANTINFO_API_LATEST. */
|
| 236 |
+
int32_t ApiVersion;
|
| 237 |
+
/** Code the user must input on an external device to activate the login. */
|
| 238 |
+
const char* UserCode;
|
| 239 |
+
/** The end-user verification URI. Users can be asked to manually type this into their browser. */
|
| 240 |
+
const char* VerificationURI;
|
| 241 |
+
/** Time the user has, in seconds, to complete the process or else timeout. */
|
| 242 |
+
int32_t ExpiresIn;
|
| 243 |
+
/** A verification URI that includes the user code. Useful for non-textual transmission. */
|
| 244 |
+
const char* VerificationURIComplete;
|
| 245 |
+
));
|
| 246 |
+
|
| 247 |
+
/** Flags that describe user permissions */
|
| 248 |
+
EOS_ENUM(EOS_EAuthScopeFlags,
|
| 249 |
+
/** Default value, no permissions required */
|
| 250 |
+
EOS_AS_NoFlags = 0x0,
|
| 251 |
+
/** Permissions to see your account ID, display name, and language */
|
| 252 |
+
EOS_AS_BasicProfile = 0x1,
|
| 253 |
+
/** Permissions to see a list of your friends who use this application */
|
| 254 |
+
EOS_AS_FriendsList = 0x2,
|
| 255 |
+
/** Permissions to set your online presence and see presence of your friends */
|
| 256 |
+
EOS_AS_Presence = 0x4,
|
| 257 |
+
/** Permissions to manage the Epic friends list. This scope is restricted to Epic first party products, and attempting to use it will result in authentication failures. */
|
| 258 |
+
EOS_AS_FriendsManagement = 0x8,
|
| 259 |
+
/** Permissions to see email in the response when fetching information for a user. This scope is restricted to Epic first party products, and attempting to use it will result in authentication failures. */
|
| 260 |
+
EOS_AS_Email = 0x10,
|
| 261 |
+
/** Permissions to see your country */
|
| 262 |
+
EOS_AS_Country = 0x20
|
| 263 |
+
);
|
| 264 |
+
|
| 265 |
+
EOS_ENUM_BOOLEAN_OPERATORS(EOS_EAuthScopeFlags)
|
| 266 |
+
|
| 267 |
+
/** Optional login flags used in EOS_Auth_Login. */
|
| 268 |
+
|
| 269 |
+
/**
|
| 270 |
+
* Specify login to be performed without SDK provided user interface.
|
| 271 |
+
*
|
| 272 |
+
* By default, and without this flag, the SDK uses the overlay or a system browser to show user interfaces during login
|
| 273 |
+
* when the user needs to perform some action. With this flag, an error such as EOS_Auth_UserInterfaceRequired is returned
|
| 274 |
+
* to the login callback, and no user interface is shown in those cases.
|
| 275 |
+
*/
|
| 276 |
+
#define EOS_LF_NO_USER_INTERFACE 0x00001
|
| 277 |
+
|
| 278 |
+
/** The most recent version of the EOS_Auth_Login API. */
|
| 279 |
+
#define EOS_AUTH_LOGIN_API_LATEST 3
|
| 280 |
+
|
| 281 |
+
/**
|
| 282 |
+
* Input parameters for the EOS_Auth_Login function.
|
| 283 |
+
*/
|
| 284 |
+
EOS_STRUCT(EOS_Auth_LoginOptions, (
|
| 285 |
+
/** API Version: Set this to EOS_AUTH_LOGIN_API_LATEST. */
|
| 286 |
+
int32_t ApiVersion;
|
| 287 |
+
/** Credentials specified for a given login method. */
|
| 288 |
+
const EOS_Auth_Credentials* Credentials;
|
| 289 |
+
/** Auth scope flags are permissions to request from the user while they are logging in. This is a bitwise-or union of EOS_EAuthScopeFlags flags defined above. */
|
| 290 |
+
EOS_EAuthScopeFlags ScopeFlags;
|
| 291 |
+
/** Optional flags for the desired login behavior, e.g. EOS_LF_NO_USER_INTERFACE. This is a bitwise-or union of the defined flags. */
|
| 292 |
+
uint64_t LoginFlags;
|
| 293 |
+
));
|
| 294 |
+
|
| 295 |
+
/**
|
| 296 |
+
* Output parameters for the EOS_Auth_Login Function.
|
| 297 |
+
*/
|
| 298 |
+
EOS_STRUCT(EOS_Auth_LoginCallbackInfo, (
|
| 299 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 300 |
+
EOS_EResult ResultCode;
|
| 301 |
+
/** Context that was passed into EOS_Auth_Login. */
|
| 302 |
+
void* ClientData;
|
| 303 |
+
/** The Epic Account ID of the local user who has logged in. */
|
| 304 |
+
EOS_EpicAccountId LocalUserId;
|
| 305 |
+
/**
|
| 306 |
+
* Optional data that may be returned in the middle of the login flow, when neither the in-game overlay or a platform browser is used.
|
| 307 |
+
* This data is present when the ResultCode is EOS_Auth_PinGrantCode.
|
| 308 |
+
*/
|
| 309 |
+
const EOS_Auth_PinGrantInfo* PinGrantInfo;
|
| 310 |
+
/** If the user was not found with external auth credentials passed into EOS_Auth_Login, this continuance token can be passed to EOS_Auth_LinkAccount to continue the flow. */
|
| 311 |
+
EOS_ContinuanceToken ContinuanceToken;
|
| 312 |
+
/** Deprecated field that is no longer used. */
|
| 313 |
+
const EOS_Auth_AccountFeatureRestrictedInfo* AccountFeatureRestrictedInfo_DEPRECATED;
|
| 314 |
+
/**
|
| 315 |
+
* The Epic Account ID that has been previously selected to be used for the current application.
|
| 316 |
+
* Applications should use this ID to authenticate with online backend services that store game-scoped data for users.
|
| 317 |
+
*
|
| 318 |
+
* Note: This ID may be different from LocalUserId if the user has previously merged Epic accounts into the account
|
| 319 |
+
* represented by LocalUserId, and one of the accounts that got merged had game data associated with it for the application.
|
| 320 |
+
*/
|
| 321 |
+
EOS_EpicAccountId SelectedAccountId;
|
| 322 |
+
));
|
| 323 |
+
|
| 324 |
+
/**
|
| 325 |
+
* Function prototype definition for callbacks passed to EOS_Auth_Login
|
| 326 |
+
* @param Data A EOS_Auth_LoginCallbackInfo containing the output information and result
|
| 327 |
+
*/
|
| 328 |
+
EOS_DECLARE_CALLBACK(EOS_Auth_OnLoginCallback, const EOS_Auth_LoginCallbackInfo* Data);
|
| 329 |
+
|
| 330 |
+
/** The most recent version of the EOS_Auth_Logout API. */
|
| 331 |
+
#define EOS_AUTH_LOGOUT_API_LATEST 1
|
| 332 |
+
|
| 333 |
+
/**
|
| 334 |
+
* Input parameters for the EOS_Auth_Logout function.
|
| 335 |
+
*/
|
| 336 |
+
EOS_STRUCT(EOS_Auth_LogoutOptions, (
|
| 337 |
+
/** API Version: Set this to EOS_AUTH_LOGOUT_API_LATEST. */
|
| 338 |
+
int32_t ApiVersion;
|
| 339 |
+
/** The Epic Account ID of the local user who is being logged out */
|
| 340 |
+
EOS_EpicAccountId LocalUserId;
|
| 341 |
+
));
|
| 342 |
+
|
| 343 |
+
/**
|
| 344 |
+
* Output parameters for the EOS_Auth_Logout Function.
|
| 345 |
+
*/
|
| 346 |
+
EOS_STRUCT(EOS_Auth_LogoutCallbackInfo, (
|
| 347 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 348 |
+
EOS_EResult ResultCode;
|
| 349 |
+
/** Context that was passed into EOS_Auth_Login */
|
| 350 |
+
void* ClientData;
|
| 351 |
+
/** The Epic Account ID of the local user requesting the information */
|
| 352 |
+
EOS_EpicAccountId LocalUserId;
|
| 353 |
+
));
|
| 354 |
+
|
| 355 |
+
/**
|
| 356 |
+
* Function prototype definition for callbacks passed to EOS_Auth_Logout
|
| 357 |
+
* @param Data A EOS_Auth_LogoutCallbackInfo containing the output information and result
|
| 358 |
+
*/
|
| 359 |
+
EOS_DECLARE_CALLBACK(EOS_Auth_OnLogoutCallback, const EOS_Auth_LogoutCallbackInfo* Data);
|
| 360 |
+
|
| 361 |
+
/**
|
| 362 |
+
* Flags used to describe how the account linking operation is to be performed.
|
| 363 |
+
*
|
| 364 |
+
* @see EOS_Auth_LinkAccount
|
| 365 |
+
*/
|
| 366 |
+
EOS_ENUM(EOS_ELinkAccountFlags,
|
| 367 |
+
/**
|
| 368 |
+
* Default flag used for a standard account linking operation.
|
| 369 |
+
*
|
| 370 |
+
* This flag is set when using a continuance token received from a previous call to the EOS_Auth_Login API,
|
| 371 |
+
* when the local user has not yet been successfully logged in to an Epic Account yet.
|
| 372 |
+
*/
|
| 373 |
+
EOS_LA_NoFlags = 0x0,
|
| 374 |
+
/**
|
| 375 |
+
* Specified when the EOS_ContinuanceToken describes a Nintendo NSA ID account type.
|
| 376 |
+
*
|
| 377 |
+
* This flag is used only with, and must be set, when the continuance token was received from a previous call
|
| 378 |
+
* to the EOS_Auth_Login API using the EOS_EExternalCredentialType::EOS_ECT_NINTENDO_NSA_ID_TOKEN login type.
|
| 379 |
+
*/
|
| 380 |
+
EOS_LA_NintendoNsaId = 0x1
|
| 381 |
+
);
|
| 382 |
+
|
| 383 |
+
/** The most recent version of the EOS_Auth_LinkAccount API. */
|
| 384 |
+
#define EOS_AUTH_LINKACCOUNT_API_LATEST 1
|
| 385 |
+
|
| 386 |
+
/**
|
| 387 |
+
* Input parameters for the EOS_Auth_LinkAccount function.
|
| 388 |
+
*/
|
| 389 |
+
EOS_STRUCT(EOS_Auth_LinkAccountOptions, (
|
| 390 |
+
/** API Version: Set this to EOS_AUTH_LINKACCOUNT_API_LATEST. */
|
| 391 |
+
int32_t ApiVersion;
|
| 392 |
+
/**
|
| 393 |
+
* Combination of the enumeration flags to specify how the account linking operation will be performed.
|
| 394 |
+
*/
|
| 395 |
+
EOS_ELinkAccountFlags LinkAccountFlags;
|
| 396 |
+
/**
|
| 397 |
+
* Continuance token received from a previous call to the EOS_Auth_Login API.
|
| 398 |
+
*
|
| 399 |
+
* A continuance token is received in the case when the external account used for login was not found to be linked
|
| 400 |
+
* against any existing Epic Account. In such case, the application needs to proceed with an account linking operation in which case
|
| 401 |
+
* the user is first asked to create a new account or login into their existing Epic Account, and then link their external account to it.
|
| 402 |
+
* Alternatively, the application may suggest the user to login using another external account that they have already linked to their existing Epic Account.
|
| 403 |
+
* In this flow, the external account is typically the currently logged in local platform user account.
|
| 404 |
+
* It can also be another external user account that the user is offered to login with.
|
| 405 |
+
*/
|
| 406 |
+
EOS_ContinuanceToken ContinuanceToken;
|
| 407 |
+
/**
|
| 408 |
+
* The Epic Account ID of the logged in local user whose Epic Account will be linked with the local Nintendo NSA ID Account. By default set to NULL.
|
| 409 |
+
*
|
| 410 |
+
* This parameter is only used and required to be set when EOS_ELinkAccountFlags::EOS_LA_NintendoNsaId is specified.
|
| 411 |
+
* Otherwise, set to NULL, as the standard account linking and login flow using continuance token will handle logging in the user to their Epic Account.
|
| 412 |
+
*/
|
| 413 |
+
EOS_EpicAccountId LocalUserId;
|
| 414 |
+
));
|
| 415 |
+
|
| 416 |
+
/**
|
| 417 |
+
* Output parameters for the EOS_Auth_LinkAccount Function.
|
| 418 |
+
*/
|
| 419 |
+
EOS_STRUCT(EOS_Auth_LinkAccountCallbackInfo, (
|
| 420 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 421 |
+
EOS_EResult ResultCode;
|
| 422 |
+
/** Context that was passed into EOS_Auth_LinkAccount. */
|
| 423 |
+
void* ClientData;
|
| 424 |
+
/** The Epic Account ID of the local user whose account has been linked during login. */
|
| 425 |
+
EOS_EpicAccountId LocalUserId;
|
| 426 |
+
/**
|
| 427 |
+
* Optional data that may be returned in the middle of the login flow, when neither the in-game overlay or a platform browser is used.
|
| 428 |
+
* This data is present when the ResultCode is EOS_Auth_PinGrantCode.
|
| 429 |
+
*/
|
| 430 |
+
const EOS_Auth_PinGrantInfo* PinGrantInfo;
|
| 431 |
+
/**
|
| 432 |
+
* The Epic Account ID that has been previously selected to be used for the current application.
|
| 433 |
+
* Applications should use this ID to authenticate with online backend services that store game-scoped data for users.
|
| 434 |
+
*
|
| 435 |
+
* Note: This ID may be different from LocalUserId if the user has previously merged Epic accounts into the account
|
| 436 |
+
* represented by LocalUserId, and one of the accounts that got merged had game data associated with it for the application.
|
| 437 |
+
*/
|
| 438 |
+
EOS_EpicAccountId SelectedAccountId;
|
| 439 |
+
));
|
| 440 |
+
|
| 441 |
+
/**
|
| 442 |
+
* Function prototype definition for callbacks passed to EOS_Auth_LinkAccount
|
| 443 |
+
* @param Data A EOS_Auth_LinkAccountCallbackInfo containing the output information and result
|
| 444 |
+
*/
|
| 445 |
+
EOS_DECLARE_CALLBACK(EOS_Auth_OnLinkAccountCallback, const EOS_Auth_LinkAccountCallbackInfo* Data);
|
| 446 |
+
|
| 447 |
+
/** The most recent version of the EOS_Auth_VerifyUserAuth API. */
|
| 448 |
+
#define EOS_AUTH_VERIFYUSERAUTH_API_LATEST 1
|
| 449 |
+
|
| 450 |
+
/**
|
| 451 |
+
* Input parameters for the EOS_Auth_VerifyUserAuth function.
|
| 452 |
+
* This operation is destructive, the pointer will remain the same but the data pointers inside will update
|
| 453 |
+
*/
|
| 454 |
+
EOS_STRUCT(EOS_Auth_VerifyUserAuthOptions, (
|
| 455 |
+
/** API Version: Set this to EOS_AUTH_VERIFYUSERAUTH_API_LATEST. */
|
| 456 |
+
int32_t ApiVersion;
|
| 457 |
+
/** Auth token to verify against the backend service */
|
| 458 |
+
const EOS_Auth_Token* AuthToken;
|
| 459 |
+
));
|
| 460 |
+
|
| 461 |
+
/**
|
| 462 |
+
* Output parameters for the EOS_Auth_VerifyUserAuth Function.
|
| 463 |
+
*/
|
| 464 |
+
EOS_STRUCT(EOS_Auth_VerifyUserAuthCallbackInfo, (
|
| 465 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 466 |
+
EOS_EResult ResultCode;
|
| 467 |
+
/** Context that was passed into EOS_Auth_Login */
|
| 468 |
+
void* ClientData;
|
| 469 |
+
));
|
| 470 |
+
|
| 471 |
+
/**
|
| 472 |
+
* Function prototype definition for callbacks passed to EOS_Auth_VerifyUserAuth
|
| 473 |
+
* @param Data A EOS_Auth_VerifyUserAuthCallbackInfo containing the output information and result
|
| 474 |
+
*/
|
| 475 |
+
EOS_DECLARE_CALLBACK(EOS_Auth_OnVerifyUserAuthCallback, const EOS_Auth_VerifyUserAuthCallbackInfo* Data);
|
| 476 |
+
|
| 477 |
+
/** The most recent version of the EOS_Auth_CopyUserAuthToken API. */
|
| 478 |
+
#define EOS_AUTH_COPYUSERAUTHTOKEN_API_LATEST 1
|
| 479 |
+
|
| 480 |
+
/**
|
| 481 |
+
* Input parameters for the EOS_Auth_CopyUserAuthToken function.
|
| 482 |
+
*/
|
| 483 |
+
EOS_STRUCT(EOS_Auth_CopyUserAuthTokenOptions, (
|
| 484 |
+
/** API Version: Set this to EOS_AUTH_COPYUSERAUTHTOKEN_API_LATEST. */
|
| 485 |
+
int32_t ApiVersion;
|
| 486 |
+
));
|
| 487 |
+
|
| 488 |
+
/** The most recent version of the EOS_Auth_CopyIdToken API. */
|
| 489 |
+
#define EOS_AUTH_COPYIDTOKEN_API_LATEST 1
|
| 490 |
+
|
| 491 |
+
/**
|
| 492 |
+
* Input parameters for the EOS_Auth_CopyIdToken function.
|
| 493 |
+
*/
|
| 494 |
+
EOS_STRUCT(EOS_Auth_CopyIdTokenOptions, (
|
| 495 |
+
/** API Version: Set this to EOS_AUTH_COPYIDTOKEN_API_LATEST. */
|
| 496 |
+
int32_t ApiVersion;
|
| 497 |
+
/** The Epic Account ID of the user being queried. */
|
| 498 |
+
EOS_EpicAccountId AccountId;
|
| 499 |
+
));
|
| 500 |
+
|
| 501 |
+
/** The most recent version of the EOS_Auth_IdToken struct. */
|
| 502 |
+
#define EOS_AUTH_IDTOKEN_API_LATEST 1
|
| 503 |
+
|
| 504 |
+
/**
|
| 505 |
+
* A structure that contains an ID token.
|
| 506 |
+
* These structures are created by EOS_Auth_CopyIdToken and must be passed to EOS_Auth_IdToken_Release when finished.
|
| 507 |
+
*/
|
| 508 |
+
EOS_STRUCT(EOS_Auth_IdToken, (
|
| 509 |
+
/** API Version: Set this to EOS_AUTH_IDTOKEN_API_LATEST. */
|
| 510 |
+
int32_t ApiVersion;
|
| 511 |
+
/**
|
| 512 |
+
* The Epic Account ID described by the ID token.
|
| 513 |
+
* Use EOS_EpicAccountId_FromString to populate this field when validating a received ID token.
|
| 514 |
+
*/
|
| 515 |
+
EOS_EpicAccountId AccountId;
|
| 516 |
+
/** The ID token as a Json Web Token (JWT) string. */
|
| 517 |
+
const char* JsonWebToken;
|
| 518 |
+
));
|
| 519 |
+
|
| 520 |
+
/**
|
| 521 |
+
* Release the memory associated with an EOS_Auth_IdToken structure. This must be called on data retrieved from EOS_Auth_CopyIdToken.
|
| 522 |
+
*
|
| 523 |
+
* @param IdToken The ID token structure to be released.
|
| 524 |
+
*
|
| 525 |
+
* @see EOS_Auth_IdToken
|
| 526 |
+
* @see EOS_Auth_CopyIdToken
|
| 527 |
+
*/
|
| 528 |
+
EOS_DECLARE_FUNC(void) EOS_Auth_IdToken_Release(EOS_Auth_IdToken* IdToken);
|
| 529 |
+
|
| 530 |
+
/** The most recent version of the EOS_Auth_QueryIdToken API. */
|
| 531 |
+
#define EOS_AUTH_QUERYIDTOKEN_API_LATEST 1
|
| 532 |
+
|
| 533 |
+
/**
|
| 534 |
+
* Input parameters for the EOS_Auth_QueryIdToken function.
|
| 535 |
+
*/
|
| 536 |
+
EOS_STRUCT(EOS_Auth_QueryIdTokenOptions, (
|
| 537 |
+
/** API Version: Set this to EOS_AUTH_QUERYIDTOKEN_API_LATEST. */
|
| 538 |
+
int32_t ApiVersion;
|
| 539 |
+
/** The Epic Account ID of the local authenticated user. */
|
| 540 |
+
EOS_EpicAccountId LocalUserId;
|
| 541 |
+
/**
|
| 542 |
+
* The target Epic Account ID for which to query an ID token.
|
| 543 |
+
* This account id may be the same as the input LocalUserId or another merged account id associated with the local user's Epic account.
|
| 544 |
+
*
|
| 545 |
+
* An ID token for the selected account id of a locally authenticated user will always be readily available.
|
| 546 |
+
* To retrieve it for the selected account ID, you can use EOS_Auth_CopyIdToken directly after a successful user login.
|
| 547 |
+
*/
|
| 548 |
+
EOS_EpicAccountId TargetAccountId;
|
| 549 |
+
));
|
| 550 |
+
|
| 551 |
+
/**
|
| 552 |
+
* Output parameters for the EOS_Auth_QueryIdToken Function.
|
| 553 |
+
*/
|
| 554 |
+
EOS_STRUCT(EOS_Auth_QueryIdTokenCallbackInfo, (
|
| 555 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 556 |
+
EOS_EResult ResultCode;
|
| 557 |
+
/** Context that was passed into EOS_Auth_QueryIdToken */
|
| 558 |
+
void* ClientData;
|
| 559 |
+
/** The Epic Account ID of the local authenticated user. */
|
| 560 |
+
EOS_EpicAccountId LocalUserId;
|
| 561 |
+
/** The target Epic Account ID for which the ID token was retrieved. */
|
| 562 |
+
EOS_EpicAccountId TargetAccountId;
|
| 563 |
+
));
|
| 564 |
+
|
| 565 |
+
/**
|
| 566 |
+
* Function prototype definition for callbacks passed into EOS_Auth_QueryIdToken.
|
| 567 |
+
*
|
| 568 |
+
* @param Data A EOS_Auth_QueryIdTokenCallbackInfo containing the output information and result.
|
| 569 |
+
*/
|
| 570 |
+
EOS_DECLARE_CALLBACK(EOS_Auth_OnQueryIdTokenCallback, const EOS_Auth_QueryIdTokenCallbackInfo* Data);
|
| 571 |
+
|
| 572 |
+
/** The most recent version of the EOS_Auth_VerifyIdToken API. */
|
| 573 |
+
#define EOS_AUTH_VERIFYIDTOKEN_API_LATEST 1
|
| 574 |
+
|
| 575 |
+
/**
|
| 576 |
+
* Input parameters for the EOS_Auth_VerifyIdToken function.
|
| 577 |
+
*/
|
| 578 |
+
EOS_STRUCT(EOS_Auth_VerifyIdTokenOptions, (
|
| 579 |
+
/** API Version: Set this to EOS_AUTH_VERIFYIDTOKEN_API_LATEST. */
|
| 580 |
+
int32_t ApiVersion;
|
| 581 |
+
/**
|
| 582 |
+
* The ID token to verify.
|
| 583 |
+
* Use EOS_EpicAccountId_FromString to populate the AccountId field of this struct.
|
| 584 |
+
*/
|
| 585 |
+
const EOS_Auth_IdToken* IdToken;
|
| 586 |
+
));
|
| 587 |
+
|
| 588 |
+
/**
|
| 589 |
+
* Output parameters for the EOS_Auth_VerifyIdToken Function.
|
| 590 |
+
*/
|
| 591 |
+
EOS_STRUCT(EOS_Auth_VerifyIdTokenCallbackInfo, (
|
| 592 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 593 |
+
EOS_EResult ResultCode;
|
| 594 |
+
/** Context that was passed into EOS_Auth_VerifyIdToken */
|
| 595 |
+
void* ClientData;
|
| 596 |
+
/**
|
| 597 |
+
* Epic Account Services Application ID.
|
| 598 |
+
*/
|
| 599 |
+
const char* ApplicationId;
|
| 600 |
+
/**
|
| 601 |
+
* Client ID of the authorized client.
|
| 602 |
+
*/
|
| 603 |
+
const char* ClientId;
|
| 604 |
+
/**
|
| 605 |
+
* Product ID.
|
| 606 |
+
*/
|
| 607 |
+
const char* ProductId;
|
| 608 |
+
/**
|
| 609 |
+
* Sandbox ID.
|
| 610 |
+
*/
|
| 611 |
+
const char* SandboxId;
|
| 612 |
+
/**
|
| 613 |
+
* Deployment ID.
|
| 614 |
+
*/
|
| 615 |
+
const char* DeploymentId;
|
| 616 |
+
/**
|
| 617 |
+
* Epic Account display name.
|
| 618 |
+
*
|
| 619 |
+
* This value may be set to an empty string.
|
| 620 |
+
*/
|
| 621 |
+
const char* DisplayName;
|
| 622 |
+
/**
|
| 623 |
+
* Flag set to indicate whether external account information is present.
|
| 624 |
+
* Applications must always first check this value to be set before attempting
|
| 625 |
+
* to read the ExternalAccountIdType, ExternalAccountId, ExternalAccountDisplayName and Platform fields.
|
| 626 |
+
*
|
| 627 |
+
* This flag is set when the user has logged in to their Epic Account using external account credentials, e.g. through local platform authentication.
|
| 628 |
+
*/
|
| 629 |
+
EOS_Bool bIsExternalAccountInfoPresent;
|
| 630 |
+
/**
|
| 631 |
+
* The identity provider that the user logged in with to their Epic Account.
|
| 632 |
+
*
|
| 633 |
+
* If bIsExternalAccountInfoPresent is set, this field describes the external account type.
|
| 634 |
+
*/
|
| 635 |
+
EOS_EExternalAccountType ExternalAccountIdType;
|
| 636 |
+
/**
|
| 637 |
+
* The external account ID of the logged in user.
|
| 638 |
+
*
|
| 639 |
+
* This value may be set to an empty string.
|
| 640 |
+
*/
|
| 641 |
+
const char* ExternalAccountId;
|
| 642 |
+
/**
|
| 643 |
+
* The external account display name.
|
| 644 |
+
*
|
| 645 |
+
* This value may be set to an empty string.
|
| 646 |
+
*/
|
| 647 |
+
const char* ExternalAccountDisplayName;
|
| 648 |
+
/**
|
| 649 |
+
* Platform that the user is connected from.
|
| 650 |
+
*
|
| 651 |
+
* This value may be set to an empty string.
|
| 652 |
+
*/
|
| 653 |
+
const char* Platform;
|
| 654 |
+
));
|
| 655 |
+
|
| 656 |
+
/**
|
| 657 |
+
* Function prototype definition for callbacks passed into EOS_Auth_VerifyIdToken.
|
| 658 |
+
*
|
| 659 |
+
* @param Data A EOS_Auth_VerifyIdTokenCallbackInfo containing the output information and result.
|
| 660 |
+
*/
|
| 661 |
+
EOS_DECLARE_CALLBACK(EOS_Auth_OnVerifyIdTokenCallback, const EOS_Auth_VerifyIdTokenCallbackInfo* Data);
|
| 662 |
+
|
| 663 |
+
/** The most recent version of the EOS_Auth_AddNotifyLoginStatusChanged API. */
|
| 664 |
+
#define EOS_AUTH_ADDNOTIFYLOGINSTATUSCHANGED_API_LATEST 1
|
| 665 |
+
|
| 666 |
+
/**
|
| 667 |
+
* Input parameters for the EOS_Auth_AddNotifyLoginStatusChanged Function.
|
| 668 |
+
*/
|
| 669 |
+
EOS_STRUCT(EOS_Auth_AddNotifyLoginStatusChangedOptions, (
|
| 670 |
+
/** API Version: Set this to EOS_AUTH_ADDNOTIFYLOGINSTATUSCHANGED_API_LATEST. */
|
| 671 |
+
int32_t ApiVersion;
|
| 672 |
+
));
|
| 673 |
+
|
| 674 |
+
/** The most recent version of the EOS_Auth_DeletePersistentAuth API. */
|
| 675 |
+
#define EOS_AUTH_DELETEPERSISTENTAUTH_API_LATEST 2
|
| 676 |
+
|
| 677 |
+
/**
|
| 678 |
+
* Input parameters for the EOS_Auth_DeletePersistentAuth function.
|
| 679 |
+
*/
|
| 680 |
+
EOS_STRUCT(EOS_Auth_DeletePersistentAuthOptions, (
|
| 681 |
+
/** API Version: Set this to EOS_AUTH_DELETEPERSISTENTAUTH_API_LATEST. */
|
| 682 |
+
int32_t ApiVersion;
|
| 683 |
+
/**
|
| 684 |
+
* A long-lived refresh token that is used with the EOS_LCT_PersistentAuth login type and is to be revoked from the authentication server. Only used on Console platforms.
|
| 685 |
+
* On Desktop and Mobile platforms, set this parameter to NULL.
|
| 686 |
+
*/
|
| 687 |
+
const char* RefreshToken;
|
| 688 |
+
));
|
| 689 |
+
|
| 690 |
+
/**
|
| 691 |
+
* Output parameters for the EOS_Auth_DeletePersistentAuth Function.
|
| 692 |
+
*/
|
| 693 |
+
EOS_STRUCT(EOS_Auth_DeletePersistentAuthCallbackInfo, (
|
| 694 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 695 |
+
EOS_EResult ResultCode;
|
| 696 |
+
/** Context that was passed into EOS_Auth_DeletePersistentAuth */
|
| 697 |
+
void* ClientData;
|
| 698 |
+
));
|
| 699 |
+
|
| 700 |
+
/**
|
| 701 |
+
* Function prototype definition for callbacks passed to EOS_Auth_DeletePersistentAuth
|
| 702 |
+
* @param Data A EOS_Auth_DeletePersistentAuthCallbackInfo containing the output information and result
|
| 703 |
+
*/
|
| 704 |
+
EOS_DECLARE_CALLBACK(EOS_Auth_OnDeletePersistentAuthCallback, const EOS_Auth_DeletePersistentAuthCallbackInfo* Data);
|
| 705 |
+
|
| 706 |
+
/**
|
| 707 |
+
* Output parameters for the EOS_Auth_OnLoginStatusChangedCallback Function.
|
| 708 |
+
*/
|
| 709 |
+
EOS_STRUCT(EOS_Auth_LoginStatusChangedCallbackInfo, (
|
| 710 |
+
/** Context that was passed into EOS_Auth_AddNotifyLoginStatusChanged */
|
| 711 |
+
void* ClientData;
|
| 712 |
+
/** The Epic Account ID of the local user whose status has changed */
|
| 713 |
+
EOS_EpicAccountId LocalUserId;
|
| 714 |
+
/** The status prior to the change */
|
| 715 |
+
EOS_ELoginStatus PrevStatus;
|
| 716 |
+
/** The status at the time of the notification */
|
| 717 |
+
EOS_ELoginStatus CurrentStatus;
|
| 718 |
+
));
|
| 719 |
+
|
| 720 |
+
/**
|
| 721 |
+
* Function prototype definition for notifications that come from EOS_Auth_AddNotifyLoginStatusChanged
|
| 722 |
+
*
|
| 723 |
+
* @param Data A EOS_Auth_LoginStatusChangedCallbackInfo containing the output information and result
|
| 724 |
+
*/
|
| 725 |
+
EOS_DECLARE_CALLBACK(EOS_Auth_OnLoginStatusChangedCallback, const EOS_Auth_LoginStatusChangedCallbackInfo* Data);
|
| 726 |
+
|
| 727 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_auth_types_deprecated.inl
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
|
| 6 |
+
#pragma pack(push, 8)
|
| 7 |
+
|
| 8 |
+
/** The most recent version of the EOS_Auth_AccountFeatureRestrictedInfo struct. */
|
| 9 |
+
#define EOS_AUTH_ACCOUNTFEATURERESTRICTEDINFO_API_LATEST 1
|
| 10 |
+
|
| 11 |
+
/**
|
| 12 |
+
* Intermediate data needed to complete account restriction verification during login flow, returned by EOS_Auth_LoginCallbackInfo when the ResultCode is EOS_Auth_AccountFeatureRestricted.
|
| 13 |
+
* The URI inside should be exposed to the user for entry in a web browser. The URI must be copied out of this struct before completion of the callback.
|
| 14 |
+
*/
|
| 15 |
+
EOS_STRUCT(EOS_Auth_AccountFeatureRestrictedInfo, (
|
| 16 |
+
/** API Version: Set this to EOS_AUTH_ACCOUNTFEATURERESTRICTEDINFO_API_LATEST. */
|
| 17 |
+
int32_t ApiVersion;
|
| 18 |
+
/** The end-user verification URI. Users must be asked to open the page in a browser to address the restrictions. */
|
| 19 |
+
const char* VerificationURI;
|
| 20 |
+
));
|
| 21 |
+
|
| 22 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_base.h
ADDED
|
@@ -0,0 +1,149 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
|
| 6 |
+
#if !defined(EOS_MEMORY_CALL) || !defined(EOS_CALL) || !defined(EOS_USE_DLLEXPORT)
|
| 7 |
+
#if !defined(_WIN32) && !defined(_WIN64) && !defined(__ANDROID__) && !defined(__linux__) && !defined(__APPLE__)
|
| 8 |
+
#error \
|
| 9 |
+
This platform expected a `eos_<platform>_base.h` include before this header. \
|
| 10 |
+
Please refer to https://dev.epicgames.com/docs/services or `eos_platform_prereqs.h` for details.
|
| 11 |
+
#endif
|
| 12 |
+
#endif
|
| 13 |
+
|
| 14 |
+
#ifndef EOS_USE_DLLEXPORT
|
| 15 |
+
#if defined(_WIN32) || defined(__CYGWIN__)
|
| 16 |
+
#define EOS_USE_DLLEXPORT 1
|
| 17 |
+
#else
|
| 18 |
+
#define EOS_USE_DLLEXPORT 0
|
| 19 |
+
#endif
|
| 20 |
+
#endif
|
| 21 |
+
|
| 22 |
+
#ifndef EOS_CALL
|
| 23 |
+
#if defined(_WIN32) && (defined(__i386) || defined(_M_IX86))
|
| 24 |
+
#define EOS_CALL __stdcall
|
| 25 |
+
#define EOS_MEMORY_CALL __stdcall
|
| 26 |
+
#else
|
| 27 |
+
#define EOS_CALL
|
| 28 |
+
#define EOS_MEMORY_CALL
|
| 29 |
+
#endif
|
| 30 |
+
#endif
|
| 31 |
+
|
| 32 |
+
#if !defined(EOS_MEMORY_CALL) || !defined(EOS_CALL) || !defined(EOS_USE_DLLEXPORT)
|
| 33 |
+
#error \
|
| 34 |
+
The expected macros EOS_MEMORY_CALL, EOS_CALL, and EOS_USE_DLLEXPORT where not all defined. \
|
| 35 |
+
Please refer to https://dev.epicgames.com/docs/services or `eos_platform_prereqs.h` for details.
|
| 36 |
+
#endif
|
| 37 |
+
|
| 38 |
+
|
| 39 |
+
#if defined(__cplusplus)
|
| 40 |
+
#if defined(_MSC_VER) && _MSC_VER >= 1800
|
| 41 |
+
/* Visual Studio 2013 or later */
|
| 42 |
+
#include <cstdint>
|
| 43 |
+
#else
|
| 44 |
+
#include <stdint.h>
|
| 45 |
+
#include <stddef.h>
|
| 46 |
+
#endif
|
| 47 |
+
|
| 48 |
+
#if __cplusplus >= 201103L
|
| 49 |
+
#define EOS_HAS_ENUM_CLASS
|
| 50 |
+
#elif defined(_MSC_VER) && defined(_MSVC_LANG) && _MSVC_LANG >= 201103L
|
| 51 |
+
#define EOS_HAS_ENUM_CLASS
|
| 52 |
+
#endif
|
| 53 |
+
#else
|
| 54 |
+
/* C Compiler */
|
| 55 |
+
#include <stdint.h>
|
| 56 |
+
#include <stddef.h>
|
| 57 |
+
#endif
|
| 58 |
+
|
| 59 |
+
|
| 60 |
+
typedef int32_t EOS_Bool;
|
| 61 |
+
#define EOS_TRUE 1
|
| 62 |
+
#define EOS_FALSE 0
|
| 63 |
+
|
| 64 |
+
|
| 65 |
+
#if defined(EOS_BUILDING_SDK) && EOS_BUILDING_SDK > 0
|
| 66 |
+
#if EOS_USE_DLLEXPORT
|
| 67 |
+
#ifdef __GNUC__
|
| 68 |
+
#define EOS_API __attribute__ ((dllexport))
|
| 69 |
+
#else
|
| 70 |
+
#define EOS_API __declspec(dllexport)
|
| 71 |
+
#endif
|
| 72 |
+
#else
|
| 73 |
+
#if __GNUC__ >= 4
|
| 74 |
+
#define EOS_API __attribute__ ((visibility ("default")))
|
| 75 |
+
#else
|
| 76 |
+
#define EOS_API
|
| 77 |
+
#endif
|
| 78 |
+
#endif
|
| 79 |
+
|
| 80 |
+
#else
|
| 81 |
+
|
| 82 |
+
#if EOS_USE_DLLEXPORT
|
| 83 |
+
#if defined(EOS_MONOLITHIC) && EOS_MONOLITHIC > 0
|
| 84 |
+
#define EOS_API
|
| 85 |
+
#elif defined(EOS_BUILD_DLL) && EOS_BUILD_DLL > 0
|
| 86 |
+
#ifdef __GNUC__
|
| 87 |
+
#define EOS_API __attribute__ ((dllexport))
|
| 88 |
+
#else
|
| 89 |
+
#define EOS_API __declspec(dllexport)
|
| 90 |
+
#endif
|
| 91 |
+
#else
|
| 92 |
+
#ifdef __GNUC__
|
| 93 |
+
#define EOS_API __attribute__ ((dllimport))
|
| 94 |
+
#else
|
| 95 |
+
#define EOS_API __declspec(dllimport)
|
| 96 |
+
#endif
|
| 97 |
+
#endif
|
| 98 |
+
#else
|
| 99 |
+
#if __GNUC__ >= 4
|
| 100 |
+
#define EOS_API __attribute__ ((visibility ("default")))
|
| 101 |
+
#else
|
| 102 |
+
#define EOS_API
|
| 103 |
+
#endif
|
| 104 |
+
#endif
|
| 105 |
+
#endif
|
| 106 |
+
|
| 107 |
+
#ifdef __cplusplus
|
| 108 |
+
#define EOS_EXTERN_C extern "C"
|
| 109 |
+
#else
|
| 110 |
+
#define EOS_EXTERN_C
|
| 111 |
+
#endif
|
| 112 |
+
|
| 113 |
+
#define EOS_DECLARE_FUNC(return_type) EOS_EXTERN_C EOS_API return_type EOS_CALL
|
| 114 |
+
#define EOS_DECLARE_CALLBACK(CallbackName, ...) EOS_EXTERN_C typedef void (EOS_CALL * CallbackName)(__VA_ARGS__)
|
| 115 |
+
#define EOS_DECLARE_CALLBACK_RETVALUE(ReturnType, CallbackName, ...) EOS_EXTERN_C typedef ReturnType (EOS_CALL * CallbackName)(__VA_ARGS__)
|
| 116 |
+
#define EOS_PASTE(...) __VA_ARGS__
|
| 117 |
+
#define EOS_STRUCT(struct_name, struct_def) \
|
| 118 |
+
EOS_EXTERN_C typedef struct _tag ## struct_name { \
|
| 119 |
+
EOS_PASTE struct_def \
|
| 120 |
+
} struct_name
|
| 121 |
+
|
| 122 |
+
|
| 123 |
+
#ifdef EOS_HAS_ENUM_CLASS
|
| 124 |
+
#define EOS_ENUM_START(name) enum class name : int32_t {
|
| 125 |
+
#define EOS_ENUM_END(name) }
|
| 126 |
+
#else
|
| 127 |
+
#define EOS_ENUM_START(name) typedef enum name {
|
| 128 |
+
#define EOS_ENUM_END(name) , __##name##_PAD_INT32__ = 0x7FFFFFFF } name
|
| 129 |
+
#endif
|
| 130 |
+
#define EOS_ENUM(name, ...) EOS_ENUM_START(name) __VA_ARGS__ EOS_ENUM_END(name)
|
| 131 |
+
|
| 132 |
+
|
| 133 |
+
#ifdef EOS_HAS_ENUM_CLASS
|
| 134 |
+
#define EOS_ENUM_BOOLEAN_OPERATORS(name) \
|
| 135 |
+
/** A set of bitwise operators provided when the enum is provided as an `enum class`. */ \
|
| 136 |
+
inline constexpr name operator|(name Left, name Right) { return static_cast<name>((__underlying_type(name))Left | (__underlying_type(name))Right); } \
|
| 137 |
+
inline constexpr name operator&(name Left, name Right) { return static_cast<name>((__underlying_type(name))Left & (__underlying_type(name))Right); } \
|
| 138 |
+
inline constexpr name operator^(name Left, name Right) { return static_cast<name>((__underlying_type(name))Left ^ (__underlying_type(name))Right); } \
|
| 139 |
+
inline constexpr name operator~(name Left) { return static_cast<name>(~(__underlying_type(name))Left); } \
|
| 140 |
+
inline name& operator|=(name& Left, name Right) { return Left = Left | Right; } \
|
| 141 |
+
inline name& operator&=(name& Left, name Right) { return Left = Left & Right; } \
|
| 142 |
+
inline name& operator^=(name& Left, name Right) { return Left = Left ^ Right; } \
|
| 143 |
+
/**/
|
| 144 |
+
#else
|
| 145 |
+
#define EOS_ENUM_BOOLEAN_OPERATORS(name)
|
| 146 |
+
#endif
|
| 147 |
+
|
| 148 |
+
|
| 149 |
+
#undef EOS_HAS_ENUM_CLASS
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_common.h
ADDED
|
@@ -0,0 +1,554 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_base.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
#undef EOS_RESULT_VALUE
|
| 10 |
+
#undef EOS_RESULT_VALUE_LAST
|
| 11 |
+
#define EOS_RESULT_VALUE(Name, Value) Name = Value,
|
| 12 |
+
#define EOS_RESULT_VALUE_LAST(Name, Value) Name = Value
|
| 13 |
+
|
| 14 |
+
/** Enum flags for all possible result values of operations in the SDK. */
|
| 15 |
+
EOS_ENUM_START(EOS_EResult)
|
| 16 |
+
#include "eos_result.h"
|
| 17 |
+
EOS_ENUM_END(EOS_EResult);
|
| 18 |
+
|
| 19 |
+
#undef EOS_RESULT_VALUE
|
| 20 |
+
#undef EOS_RESULT_VALUE_LAST
|
| 21 |
+
|
| 22 |
+
/**
|
| 23 |
+
* Returns a string representation of an EOS_EResult.
|
| 24 |
+
* The return value is never null.
|
| 25 |
+
* The return value must not be freed.
|
| 26 |
+
*
|
| 27 |
+
* Example: EOS_EResult_ToString(EOS_Success) returns "EOS_Success"
|
| 28 |
+
*/
|
| 29 |
+
EOS_DECLARE_FUNC(const char*) EOS_EResult_ToString(EOS_EResult Result);
|
| 30 |
+
|
| 31 |
+
/**
|
| 32 |
+
* Returns whether a result is to be considered the final result, or false if the callback that returned this result
|
| 33 |
+
* will be called again either after some time or from another action.
|
| 34 |
+
*
|
| 35 |
+
* @param Result The result to check against being a final result for an operation
|
| 36 |
+
* @return True if this result means the operation is complete, false otherwise
|
| 37 |
+
*/
|
| 38 |
+
EOS_DECLARE_FUNC(EOS_Bool) EOS_EResult_IsOperationComplete(EOS_EResult Result);
|
| 39 |
+
|
| 40 |
+
/**
|
| 41 |
+
* Encode a byte array into hex encoded string
|
| 42 |
+
*
|
| 43 |
+
* @return An EOS_EResult that indicates whether the byte array was converted and copied into the OutBuffer.
|
| 44 |
+
* EOS_Success if the encoding was successful and passed out in OutBuffer
|
| 45 |
+
* EOS_InvalidParameters if you pass a null pointer on invalid length for any of the parameters
|
| 46 |
+
* EOS_LimitExceeded - The OutBuffer is not large enough to receive the encoding. InOutBufferLength contains the required minimum length to perform the operation successfully.
|
| 47 |
+
*/
|
| 48 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_ByteArray_ToString(const uint8_t* ByteArray, const uint32_t Length, char* OutBuffer, uint32_t* InOutBufferLength);
|
| 49 |
+
|
| 50 |
+
/**
|
| 51 |
+
* A handle to a user's Epic Account ID
|
| 52 |
+
* This ID is associated with a specific login associated with Epic Account Services
|
| 53 |
+
*
|
| 54 |
+
* @see EOS_Auth_Login
|
| 55 |
+
*/
|
| 56 |
+
typedef struct EOS_EpicAccountIdDetails* EOS_EpicAccountId;
|
| 57 |
+
|
| 58 |
+
/**
|
| 59 |
+
* Check whether or not the given Epic Account ID is considered valid
|
| 60 |
+
* NOTE: This will return true for any EOS_EpicAccountId created with EOS_EpicAccountId_FromString as there is no validation
|
| 61 |
+
*
|
| 62 |
+
* @param AccountId The Epic Account ID to check for validity
|
| 63 |
+
* @return EOS_TRUE if the EOS_EpicAccountId is valid, otherwise EOS_FALSE
|
| 64 |
+
*/
|
| 65 |
+
EOS_DECLARE_FUNC(EOS_Bool) EOS_EpicAccountId_IsValid(EOS_EpicAccountId AccountId);
|
| 66 |
+
|
| 67 |
+
/**
|
| 68 |
+
* Retrieve a null-terminated stringified Epic Account ID from an EOS_EpicAccountId. This is useful for replication of Epic Account IDs in multiplayer games.
|
| 69 |
+
* This string will be no larger than EOS_EPICACCOUNTID_MAX_LENGTH + 1 and will only contain UTF8-encoded printable characters as well as a null-terminator.
|
| 70 |
+
*
|
| 71 |
+
* @param AccountId The Epic Account ID for which to retrieve the stringified version.
|
| 72 |
+
* @param OutBuffer The buffer into which the character data should be written
|
| 73 |
+
* @param InOutBufferLength The size of the OutBuffer in characters.
|
| 74 |
+
* The input buffer should include enough space to be null-terminated.
|
| 75 |
+
* When the function returns, this parameter will be filled with the length of the string copied into OutBuffer including the null-termination character.
|
| 76 |
+
*
|
| 77 |
+
* @return An EOS_EResult that indicates whether the Epic Account ID string was copied into the OutBuffer.
|
| 78 |
+
* EOS_Success - The OutBuffer was filled, and InOutBufferLength contains the number of characters copied into OutBuffer including the null-terminator.
|
| 79 |
+
* EOS_InvalidParameters - Either OutBuffer or InOutBufferLength were passed as NULL parameters.
|
| 80 |
+
* EOS_InvalidUser - The AccountId is invalid and cannot be stringified.
|
| 81 |
+
* EOS_LimitExceeded - The OutBuffer is not large enough to receive the Epic Account ID string. InOutBufferLength contains the required minimum length to perform the operation successfully.
|
| 82 |
+
*/
|
| 83 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_EpicAccountId_ToString(EOS_EpicAccountId AccountId, char* OutBuffer, int32_t* InOutBufferLength);
|
| 84 |
+
|
| 85 |
+
/**
|
| 86 |
+
* Retrieve an EOS_EpicAccountId from a raw string representing an Epic Account ID. The input string must be null-terminated.
|
| 87 |
+
* NOTE: There is no validation on the string format, this should only be used with values serialized from legitimate sources such as EOS_EpicAccountId_ToString
|
| 88 |
+
*
|
| 89 |
+
* @param AccountIdString The stringified account ID for which to retrieve the Epic Account ID
|
| 90 |
+
* @return The EOS_EpicAccountId that corresponds to the AccountIdString
|
| 91 |
+
*/
|
| 92 |
+
EOS_DECLARE_FUNC(EOS_EpicAccountId) EOS_EpicAccountId_FromString(const char* AccountIdString);
|
| 93 |
+
|
| 94 |
+
/**
|
| 95 |
+
* A character buffer of this size is large enough to fit a successful output of EOS_EpicAccountId_ToString. This length does not include the null-terminator.
|
| 96 |
+
* The EpicAccountId data structure is opaque in nature and no assumptions of its structure should be inferred
|
| 97 |
+
*/
|
| 98 |
+
#define EOS_EPICACCOUNTID_MAX_LENGTH 32
|
| 99 |
+
|
| 100 |
+
/**
|
| 101 |
+
* A handle to a user's Product User ID (game services related ecosystem)
|
| 102 |
+
* This ID is associated with any of the external account providers (of which Epic Account Services is one)
|
| 103 |
+
*
|
| 104 |
+
* @see EOS_Connect_Login
|
| 105 |
+
* @see EOS_EExternalCredentialType
|
| 106 |
+
*/
|
| 107 |
+
typedef struct EOS_ProductUserIdDetails* EOS_ProductUserId;
|
| 108 |
+
|
| 109 |
+
/**
|
| 110 |
+
* Check whether or not the given account unique ID is considered valid
|
| 111 |
+
* NOTE: This will return true for any EOS_ProductUserId created with EOS_ProductUserId_FromString as there is no validation
|
| 112 |
+
*
|
| 113 |
+
* @param AccountId The Product User ID to check for validity
|
| 114 |
+
* @return EOS_TRUE if the EOS_ProductUserId is valid, otherwise EOS_FALSE
|
| 115 |
+
*/
|
| 116 |
+
EOS_DECLARE_FUNC(EOS_Bool) EOS_ProductUserId_IsValid(EOS_ProductUserId AccountId);
|
| 117 |
+
|
| 118 |
+
/**
|
| 119 |
+
* Retrieve a null-terminated stringified Product User ID from an EOS_ProductUserId. This is useful for replication of Product User IDs in multiplayer games.
|
| 120 |
+
* This string will be no larger than EOS_PRODUCTUSERID_MAX_LENGTH + 1 and will only contain UTF8-encoded printable characters as well as the null-terminator.
|
| 121 |
+
*
|
| 122 |
+
* @param AccountId The Product User ID for which to retrieve the stringified version.
|
| 123 |
+
* @param OutBuffer The buffer into which the character data should be written
|
| 124 |
+
* @param InOutBufferLength The size of the OutBuffer in characters.
|
| 125 |
+
* The input buffer should include enough space to be null-terminated.
|
| 126 |
+
* When the function returns, this parameter will be filled with the length of the string copied into OutBuffer including the null-termination character.
|
| 127 |
+
*
|
| 128 |
+
* @return An EOS_EResult that indicates whether the Product User ID string was copied into the OutBuffer.
|
| 129 |
+
* EOS_Success - The OutBuffer was filled, and InOutBufferLength contains the number of characters copied into OutBuffer including the null-terminator.
|
| 130 |
+
* EOS_InvalidParameters - Either OutBuffer or InOutBufferLength were passed as NULL parameters.
|
| 131 |
+
* EOS_InvalidUser - The AccountId is invalid and cannot be stringified.
|
| 132 |
+
* EOS_LimitExceeded - The OutBuffer is not large enough to receive the Product User ID string. InOutBufferLength contains the required minimum length to perform the operation successfully.
|
| 133 |
+
*/
|
| 134 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_ProductUserId_ToString(EOS_ProductUserId AccountId, char* OutBuffer, int32_t* InOutBufferLength);
|
| 135 |
+
|
| 136 |
+
/**
|
| 137 |
+
* Retrieve an EOS_ProductUserId from a raw string representing an Epic Online Services Product User ID. The input string must be null-terminated.
|
| 138 |
+
* NOTE: There is no validation on the string format, this should only be used with values serialized from legitimate sources such as EOS_ProductUserId_ToString
|
| 139 |
+
*
|
| 140 |
+
* @param ProductUserIdString The stringified product user ID for which to retrieve the Epic Online Services Product User ID
|
| 141 |
+
* @return The EOS_ProductUserId that corresponds to the ProductUserIdString
|
| 142 |
+
*/
|
| 143 |
+
EOS_DECLARE_FUNC(EOS_ProductUserId) EOS_ProductUserId_FromString(const char* ProductUserIdString);
|
| 144 |
+
|
| 145 |
+
/** A character buffer of this size is large enough to fit a successful output of EOS_ProductUserId_ToString. This length does not include the null-terminator. */
|
| 146 |
+
#define EOS_PRODUCTUSERID_MAX_LENGTH 32
|
| 147 |
+
|
| 148 |
+
/** Handle to an existing registered notification (0 is an invalid handle) */
|
| 149 |
+
EOS_EXTERN_C typedef uint64_t EOS_NotificationId;
|
| 150 |
+
|
| 151 |
+
/** An invalid notification ID */
|
| 152 |
+
#define EOS_INVALID_NOTIFICATIONID ((EOS_NotificationId)0)
|
| 153 |
+
|
| 154 |
+
/** A handle to a continuance token @see eos_connect.h */
|
| 155 |
+
typedef struct EOS_ContinuanceTokenDetails* EOS_ContinuanceToken;
|
| 156 |
+
|
| 157 |
+
/**
|
| 158 |
+
* Retrieve a null-terminated stringified continuance token from an EOS_ContinuanceToken.
|
| 159 |
+
*
|
| 160 |
+
* To get the required buffer size, call once with OutBuffer set to NULL, InOutBufferLength will contain the buffer size needed.
|
| 161 |
+
* Call again with valid params to get the stringified continuance token which will only contain UTF8-encoded printable characters as well as the null-terminator.
|
| 162 |
+
*
|
| 163 |
+
* @param ContinuanceToken The continuance token for which to retrieve the stringified version.
|
| 164 |
+
* @param OutBuffer The buffer into which the character data should be written
|
| 165 |
+
* @param InOutBufferLength The size of the OutBuffer in characters.
|
| 166 |
+
* The input buffer should include enough space to be null-terminated.
|
| 167 |
+
* When the function returns, this parameter will be filled with the length of the string copied into OutBuffer including the null-termination character.
|
| 168 |
+
*
|
| 169 |
+
* @return An EOS_EResult that indicates whether the continuance token string was copied into the OutBuffer.
|
| 170 |
+
* EOS_Success - The OutBuffer was filled, and InOutBufferLength contains the number of characters copied into OutBuffer including the null-terminator.
|
| 171 |
+
* EOS_InvalidParameters - Either OutBuffer or InOutBufferLength were passed as NULL parameters.
|
| 172 |
+
* EOS_InvalidUser - The AccountId is invalid and cannot be stringified.
|
| 173 |
+
* EOS_LimitExceeded - The OutBuffer is not large enough to receive the continuance token string. InOutBufferLength contains the required minimum length to perform the operation successfully.
|
| 174 |
+
*/
|
| 175 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_ContinuanceToken_ToString(EOS_ContinuanceToken ContinuanceToken, char* OutBuffer, int32_t* InOutBufferLength);
|
| 176 |
+
|
| 177 |
+
/**
|
| 178 |
+
* All possible states of a local user
|
| 179 |
+
*
|
| 180 |
+
* @see EOS_Auth_AddNotifyLoginStatusChanged
|
| 181 |
+
* @see EOS_Auth_GetLoginStatus
|
| 182 |
+
* @see EOS_Auth_Login
|
| 183 |
+
* @see EOS_Connect_AddNotifyLoginStatusChanged
|
| 184 |
+
* @see EOS_Connect_GetLoginStatus
|
| 185 |
+
* @see EOS_Connect_Login
|
| 186 |
+
*/
|
| 187 |
+
EOS_ENUM(EOS_ELoginStatus,
|
| 188 |
+
/** Player has not logged in or chosen a local profile */
|
| 189 |
+
EOS_LS_NotLoggedIn = 0,
|
| 190 |
+
/** Player is using a local profile but is not logged in */
|
| 191 |
+
EOS_LS_UsingLocalProfile = 1,
|
| 192 |
+
/** Player has been validated by the platform specific authentication service */
|
| 193 |
+
EOS_LS_LoggedIn = 2
|
| 194 |
+
);
|
| 195 |
+
|
| 196 |
+
/**
|
| 197 |
+
* Supported types of data that can be stored with inside an attribute (used by sessions/lobbies/etc)
|
| 198 |
+
*
|
| 199 |
+
* @see EOS_LobbySearch_SetParameter
|
| 200 |
+
* @see EOS_SessionSearch_SetParameter
|
| 201 |
+
*/
|
| 202 |
+
EOS_ENUM(EOS_EAttributeType,
|
| 203 |
+
/** Boolean value (true/false) */
|
| 204 |
+
EOS_AT_BOOLEAN = 0,
|
| 205 |
+
/** 64 bit integers */
|
| 206 |
+
EOS_AT_INT64 = 1,
|
| 207 |
+
/** Double/floating point precision */
|
| 208 |
+
EOS_AT_DOUBLE = 2,
|
| 209 |
+
/** UTF8 Strings */
|
| 210 |
+
EOS_AT_STRING = 3
|
| 211 |
+
);
|
| 212 |
+
|
| 213 |
+
typedef EOS_EAttributeType EOS_ESessionAttributeType;
|
| 214 |
+
typedef EOS_EAttributeType EOS_ELobbyAttributeType;
|
| 215 |
+
|
| 216 |
+
/**
|
| 217 |
+
* All comparison operators associated with attributes.
|
| 218 |
+
*
|
| 219 |
+
* @see EOS_LobbySearch_SetParameter
|
| 220 |
+
* @see EOS_SessionSearch_SetParameter
|
| 221 |
+
*/
|
| 222 |
+
EOS_ENUM(EOS_EComparisonOp,
|
| 223 |
+
/** Value must equal the one stored in the attribute */
|
| 224 |
+
EOS_CO_EQUAL = 0,
|
| 225 |
+
/** Value must not equal the one stored in the attribute */
|
| 226 |
+
EOS_CO_NOTEQUAL = 1,
|
| 227 |
+
/** Value must be strictly greater than the one stored in the attribute */
|
| 228 |
+
EOS_CO_GREATERTHAN = 2,
|
| 229 |
+
/** Value must be greater than or equal to the one stored in the attribute */
|
| 230 |
+
EOS_CO_GREATERTHANOREQUAL = 3,
|
| 231 |
+
/** Value must be strictly less than the one stored in the attribute */
|
| 232 |
+
EOS_CO_LESSTHAN = 4,
|
| 233 |
+
/** Value must be less than or equal to the one stored in the attribute */
|
| 234 |
+
EOS_CO_LESSTHANOREQUAL = 5,
|
| 235 |
+
/** Prefer values nearest the one specified ie. abs(SearchValue-SessionValue) closest to 0 */
|
| 236 |
+
EOS_CO_DISTANCE = 6,
|
| 237 |
+
/** Value stored in the attribute may be any from a specified list */
|
| 238 |
+
EOS_CO_ANYOF = 7,
|
| 239 |
+
/** Value stored in the attribute may NOT be any from a specified list */
|
| 240 |
+
EOS_CO_NOTANYOF = 8,
|
| 241 |
+
/** This one value is a part of a collection. Supported in EOS_SessionSearch_SetParameter only. */
|
| 242 |
+
EOS_CO_ONEOF = 9,
|
| 243 |
+
/** This one value is NOT part of a collection. Supported in EOS_SessionSearch_SetParameter only. */
|
| 244 |
+
EOS_CO_NOTONEOF = 10,
|
| 245 |
+
/** This value is a CASE SENSITIVE substring of an attribute */
|
| 246 |
+
EOS_CO_CONTAINS = 11,
|
| 247 |
+
/** This value is a regex match of an attribute */
|
| 248 |
+
EOS_CO_REGEXMATCH = 12,
|
| 249 |
+
/** This array or string value's size must be equal to the one stored in the attribute */
|
| 250 |
+
EOS_CO_SIZE = 13
|
| 251 |
+
);
|
| 252 |
+
|
| 253 |
+
typedef EOS_EComparisonOp EOS_EOnlineComparisonOp;
|
| 254 |
+
|
| 255 |
+
/**
|
| 256 |
+
* All supported external account providers
|
| 257 |
+
*
|
| 258 |
+
* @see EOS_Connect_QueryExternalAccountMappings
|
| 259 |
+
*/
|
| 260 |
+
EOS_ENUM(EOS_EExternalAccountType,
|
| 261 |
+
/** External account is associated with Epic Games */
|
| 262 |
+
EOS_EAT_EPIC = 0,
|
| 263 |
+
/** External account is associated with Steam */
|
| 264 |
+
EOS_EAT_STEAM = 1,
|
| 265 |
+
/** External account is associated with PlayStation(TM)Network */
|
| 266 |
+
EOS_EAT_PSN = 2,
|
| 267 |
+
/** External account is associated with Xbox Live */
|
| 268 |
+
EOS_EAT_XBL = 3,
|
| 269 |
+
/** External account is associated with Discord */
|
| 270 |
+
EOS_EAT_DISCORD = 4,
|
| 271 |
+
/** External account is associated with GOG */
|
| 272 |
+
EOS_EAT_GOG = 5,
|
| 273 |
+
/**
|
| 274 |
+
* External account is associated with Nintendo
|
| 275 |
+
*
|
| 276 |
+
* With both EOS Connect and EOS UserInfo APIs, the associated account type is Nintendo Service Account ID.
|
| 277 |
+
* Local user authentication is possible using Nintendo Account ID, while the account type does not get exposed to the SDK in queries related to linked accounts information.
|
| 278 |
+
*/
|
| 279 |
+
EOS_EAT_NINTENDO = 6,
|
| 280 |
+
/** External account is associated with Uplay */
|
| 281 |
+
EOS_EAT_UPLAY = 7,
|
| 282 |
+
/** External account is associated with an OpenID Provider */
|
| 283 |
+
EOS_EAT_OPENID = 8,
|
| 284 |
+
/** External account is associated with Apple */
|
| 285 |
+
EOS_EAT_APPLE = 9,
|
| 286 |
+
/** External account is associated with Google */
|
| 287 |
+
EOS_EAT_GOOGLE = 10,
|
| 288 |
+
/** External account is associated with Oculus */
|
| 289 |
+
EOS_EAT_OCULUS = 11,
|
| 290 |
+
/** External account is associated with itch.io */
|
| 291 |
+
EOS_EAT_ITCHIO = 12,
|
| 292 |
+
/** External account is associated with Amazon */
|
| 293 |
+
EOS_EAT_AMAZON = 13,
|
| 294 |
+
/** External account is associated with Viveport */
|
| 295 |
+
EOS_EAT_VIVEPORT = 14
|
| 296 |
+
);
|
| 297 |
+
|
| 298 |
+
/**
|
| 299 |
+
* List of the supported identity providers to authenticate a user.
|
| 300 |
+
*
|
| 301 |
+
* The type of authentication token is specific to each provider.
|
| 302 |
+
* Tokens in string format should be passed as-is to the function.
|
| 303 |
+
* Tokens retrieved as raw byte arrays should be converted into a hex-encoded UTF-8 string (e.g. "FA87097A..") before being passed to the function.
|
| 304 |
+
* EOS_ByteArray_ToString can be used for this conversion.
|
| 305 |
+
*
|
| 306 |
+
* @see EOS_Auth_Login
|
| 307 |
+
* @see EOS_Connect_Login
|
| 308 |
+
*/
|
| 309 |
+
EOS_ENUM(EOS_EExternalCredentialType,
|
| 310 |
+
/**
|
| 311 |
+
* Epic Account Services Token
|
| 312 |
+
*
|
| 313 |
+
* Using ID Token is preferred, retrieved with EOS_Auth_CopyIdToken that returns EOS_Auth_IdToken::JsonWebToken.
|
| 314 |
+
* Using Auth Token is supported for backwards compatibility, retrieved with EOS_Auth_CopyUserAuthToken that returns EOS_Auth_Token::AccessToken.
|
| 315 |
+
*
|
| 316 |
+
* Supported with EOS_Connect_Login.
|
| 317 |
+
*
|
| 318 |
+
* @see EOS_Auth_CopyIdToken
|
| 319 |
+
* @see EOS_Auth_CopyUserAuthToken
|
| 320 |
+
*/
|
| 321 |
+
EOS_ECT_EPIC = 0,
|
| 322 |
+
/**
|
| 323 |
+
* Steam Encrypted App Ticket
|
| 324 |
+
* Note that EOS_ECT_STEAM_APP_TICKET is deprecated for use with EOS_Auth_Login. Use EOS_ECT_STEAM_SESSION_TICKET instead.
|
| 325 |
+
*
|
| 326 |
+
* Generated using the ISteamUser::RequestEncryptedAppTicket API of Steamworks SDK.
|
| 327 |
+
* For ticket generation parameters, use pDataToInclude(NULL) and cbDataToInclude(0).
|
| 328 |
+
*
|
| 329 |
+
* The retrieved App Ticket byte buffer needs to be converted into a hex-encoded UTF-8 string (e.g. "FA87097A..") before passing it to the EOS_Connect_Login API.
|
| 330 |
+
* EOS_ByteArray_ToString can be used for this conversion.
|
| 331 |
+
*
|
| 332 |
+
* Supported with EOS_Connect_Login.
|
| 333 |
+
*
|
| 334 |
+
* @see EOS_ECT_STEAM_SESSION_TICKET
|
| 335 |
+
*/
|
| 336 |
+
EOS_ECT_STEAM_APP_TICKET = 1,
|
| 337 |
+
/**
|
| 338 |
+
* PlayStation(TM)Network ID Token
|
| 339 |
+
*
|
| 340 |
+
* Retrieved from the PlayStation(R) SDK. Please see first-party documentation for additional information.
|
| 341 |
+
*
|
| 342 |
+
* Supported with EOS_Auth_Login, EOS_Connect_Login.
|
| 343 |
+
*/
|
| 344 |
+
EOS_ECT_PSN_ID_TOKEN = 2,
|
| 345 |
+
/**
|
| 346 |
+
* Xbox Live XSTS Token
|
| 347 |
+
*
|
| 348 |
+
* Retrieved from the GDK and XDK. Please see first-party documentation for additional information.
|
| 349 |
+
*
|
| 350 |
+
* Supported with EOS_Auth_Login, EOS_Connect_Login.
|
| 351 |
+
*/
|
| 352 |
+
EOS_ECT_XBL_XSTS_TOKEN = 3,
|
| 353 |
+
/**
|
| 354 |
+
* Discord Access Token
|
| 355 |
+
*
|
| 356 |
+
* Retrieved using the ApplicationManager::GetOAuth2Token API of Discord SDK.
|
| 357 |
+
*
|
| 358 |
+
* Supported with EOS_Connect_Login.
|
| 359 |
+
*/
|
| 360 |
+
EOS_ECT_DISCORD_ACCESS_TOKEN = 4,
|
| 361 |
+
/**
|
| 362 |
+
* GOG Galaxy Encrypted App Ticket
|
| 363 |
+
*
|
| 364 |
+
* Generated using the IUser::RequestEncryptedAppTicket API of GOG Galaxy SDK.
|
| 365 |
+
* For ticket generation parameters, use data(NULL) and dataSize(0).
|
| 366 |
+
*
|
| 367 |
+
* The retrieved App Ticket byte buffer needs to be converted into a hex-encoded UTF-8 string (e.g. "FA87097A..") before passing it to the EOS_Connect_Login API.
|
| 368 |
+
* For C/C++ API integration, use the EOS_ByteArray_ToString API for the conversion.
|
| 369 |
+
* For C# integration, you can use <see cref="Helper.ToHexString" /> for the conversion.
|
| 370 |
+
*
|
| 371 |
+
* Supported with EOS_Connect_Login.
|
| 372 |
+
*/
|
| 373 |
+
EOS_ECT_GOG_SESSION_TICKET = 5,
|
| 374 |
+
/**
|
| 375 |
+
* Nintendo Account ID Token
|
| 376 |
+
*
|
| 377 |
+
* Identifies a Nintendo user account and is acquired through web flow authentication where the local user logs in using their email address/sign-in ID and password.
|
| 378 |
+
* This is the common Nintendo account that users login with outside the Nintendo Switch device.
|
| 379 |
+
*
|
| 380 |
+
* Supported with EOS_Auth_Login, EOS_Connect_Login.
|
| 381 |
+
*
|
| 382 |
+
* Note: EOS_Auth_Login usage is restricted to Epic first party products only, attempting to use it will result in authentication failures.
|
| 383 |
+
*/
|
| 384 |
+
EOS_ECT_NINTENDO_ID_TOKEN = 6,
|
| 385 |
+
/**
|
| 386 |
+
* Nintendo Service Account ID Token (NSA ID)
|
| 387 |
+
*
|
| 388 |
+
* The NSA ID identifies uniquely the local Nintendo Switch device. The authentication token is acquired locally without explicit user credentials.
|
| 389 |
+
* As such, it is the primary authentication method for seamless login on Nintendo Switch.
|
| 390 |
+
*
|
| 391 |
+
* The NSA ID is not exposed directly to the user and does not provide any means for login outside the local device.
|
| 392 |
+
* Because of this, Nintendo Switch users will need to link their Nintendo Account or another external user account
|
| 393 |
+
* to their Product User ID in order to share their game progression across other platforms. Otherwise, the user will
|
| 394 |
+
* not be able to login to their existing Product User ID on another platform due to missing login credentials to use.
|
| 395 |
+
* It is recommended that the game explicitly communicates this restriction to the user so that they will know to add
|
| 396 |
+
* the first linked external account on the Nintendo Switch device and then proceed with login on another platform.
|
| 397 |
+
*
|
| 398 |
+
* In addition to sharing cross-platform game progression, linking the Nintendo Account or another external account
|
| 399 |
+
* will allow preserving the game progression permanently. Otherwise, the game progression will be tied only to the
|
| 400 |
+
* local device. In case the user loses access to their local device, they will not be able to recover the game
|
| 401 |
+
* progression if it is only associated with this account type.
|
| 402 |
+
*
|
| 403 |
+
* Supported with EOS_Auth_Login, EOS_Connect_Login.
|
| 404 |
+
*
|
| 405 |
+
* Note: EOS_Auth_Login usage is restricted to Epic first party products only, attempting to use it will result in authentication failures.
|
| 406 |
+
*/
|
| 407 |
+
EOS_ECT_NINTENDO_NSA_ID_TOKEN = 7,
|
| 408 |
+
/**
|
| 409 |
+
* Uplay Access Token
|
| 410 |
+
*
|
| 411 |
+
* Supported with EOS_Connect_Login.
|
| 412 |
+
*/
|
| 413 |
+
EOS_ECT_UPLAY_ACCESS_TOKEN = 8,
|
| 414 |
+
/**
|
| 415 |
+
* OpenID Provider Access Token
|
| 416 |
+
*
|
| 417 |
+
* Supported with EOS_Connect_Login.
|
| 418 |
+
*/
|
| 419 |
+
EOS_ECT_OPENID_ACCESS_TOKEN = 9,
|
| 420 |
+
/**
|
| 421 |
+
* Device ID access token that identifies the current locally logged in user profile on the local device.
|
| 422 |
+
* The local user profile here refers to the operating system user login, for example the user's Windows Account
|
| 423 |
+
* or on a mobile device the default active user profile.
|
| 424 |
+
*
|
| 425 |
+
* This credential type is used to automatically login the local user using the EOS Connect Device ID feature.
|
| 426 |
+
*
|
| 427 |
+
* The intended use of the Device ID feature is to allow automatically logging in the user on a mobile device
|
| 428 |
+
* and to allow playing the game without requiring the user to necessarily login using a real user account at all.
|
| 429 |
+
* This makes a seamless first-time experience possible and allows linking the local device with a real external
|
| 430 |
+
* user account at a later time, sharing the same EOS_ProductUserId that is being used with the Device ID feature.
|
| 431 |
+
*
|
| 432 |
+
* Supported with EOS_Connect_Login.
|
| 433 |
+
*
|
| 434 |
+
* @see EOS_Connect_CreateDeviceId
|
| 435 |
+
*/
|
| 436 |
+
EOS_ECT_DEVICEID_ACCESS_TOKEN = 10,
|
| 437 |
+
/**
|
| 438 |
+
* Apple ID Token
|
| 439 |
+
*
|
| 440 |
+
* Supported with EOS_Connect_Login.
|
| 441 |
+
*/
|
| 442 |
+
EOS_ECT_APPLE_ID_TOKEN = 11,
|
| 443 |
+
/**
|
| 444 |
+
* Google ID Token
|
| 445 |
+
*
|
| 446 |
+
* Supported with EOS_Connect_Login.
|
| 447 |
+
*/
|
| 448 |
+
EOS_ECT_GOOGLE_ID_TOKEN = 12,
|
| 449 |
+
/**
|
| 450 |
+
* Oculus User ID and Nonce
|
| 451 |
+
*
|
| 452 |
+
* Call ovr_User_GetUserProof(), or Platform.User.GetUserProof() if you are using Unity, to retrieve the nonce.
|
| 453 |
+
* Then pass the local User ID and the Nonce as a "{UserID}|{Nonce}" formatted string for the EOS_Connect_Login Token parameter.
|
| 454 |
+
*
|
| 455 |
+
* Note that in order to successfully retrieve a valid non-zero id for the local user using ovr_User_GetUser(),
|
| 456 |
+
* your Oculus App needs to be configured in the Oculus Developer Dashboard to have the User ID feature enabled.
|
| 457 |
+
*
|
| 458 |
+
* Supported with EOS_Connect_Login.
|
| 459 |
+
*/
|
| 460 |
+
EOS_ECT_OCULUS_USERID_NONCE = 13,
|
| 461 |
+
/**
|
| 462 |
+
* itch.io JWT Access Token
|
| 463 |
+
*
|
| 464 |
+
* Use the itch.io app manifest to receive a JWT access token for the local user via the ITCHIO_API_KEY process environment variable.
|
| 465 |
+
* The itch.io access token is valid for 7 days after which the game needs to be restarted by the user as otherwise EOS Connect
|
| 466 |
+
* authentication session can no longer be refreshed.
|
| 467 |
+
*
|
| 468 |
+
* Supported with EOS_Connect_Login.
|
| 469 |
+
*/
|
| 470 |
+
EOS_ECT_ITCHIO_JWT = 14,
|
| 471 |
+
/**
|
| 472 |
+
* itch.io Key Access Token
|
| 473 |
+
*
|
| 474 |
+
* This access token type is retrieved through the OAuth 2.0 authentication flow for the itch.io application.
|
| 475 |
+
*
|
| 476 |
+
* Supported with EOS_Connect_Login.
|
| 477 |
+
*/
|
| 478 |
+
EOS_ECT_ITCHIO_KEY = 15,
|
| 479 |
+
/**
|
| 480 |
+
* Epic Games ID Token
|
| 481 |
+
*
|
| 482 |
+
* Acquired using EOS_Auth_CopyIdToken that returns EOS_Auth_IdToken::JsonWebToken.
|
| 483 |
+
*
|
| 484 |
+
* Supported with EOS_Connect_Login.
|
| 485 |
+
*/
|
| 486 |
+
EOS_ECT_EPIC_ID_TOKEN = 16,
|
| 487 |
+
/**
|
| 488 |
+
* Amazon Access Token
|
| 489 |
+
*
|
| 490 |
+
* Supported with EOS_Connect_Login.
|
| 491 |
+
*/
|
| 492 |
+
EOS_ECT_AMAZON_ACCESS_TOKEN = 17,
|
| 493 |
+
/**
|
| 494 |
+
* Steam Auth Session Ticket
|
| 495 |
+
*
|
| 496 |
+
* Generated using the ISteamUser::GetAuthTicketForWebApi API of Steamworks SDK.
|
| 497 |
+
*
|
| 498 |
+
* @attention
|
| 499 |
+
* The pchIdentity input parameter of GetAuthTicketForWebApi API must be set to a valid non-empty string value.
|
| 500 |
+
* The string value used by the game client must match identically to the backend-configured value in EOS Dev Portal.
|
| 501 |
+
* The recommended value to use is "epiconlineservices" in lowercase, matching the default value for new Steam identity provider credentials in EOS Dev Portal.
|
| 502 |
+
* This identifier is important for security reasons to prevent session hijacking. Applications must use a dedicated unique identity identifier for Session Tickets passed to the EOS SDK APIs.
|
| 503 |
+
* Session Tickets using the EOS-assigned identifier must not be used with anything else than the EOS SDK APIs. You must use a different identifier when generating Session Tickets to authenticate with other parties.
|
| 504 |
+
*
|
| 505 |
+
* @warning
|
| 506 |
+
* To update an already live game to use the new GetAuthTicketForWebApi API instead of the deprecated GetAuthSessionTicket API, follow these steps in this order to prevent breaking the live game for players:
|
| 507 |
+
* 1. Update your game client code to use the new ISteamUser::GetAuthTicketForWebApi API.
|
| 508 |
+
* 2. Publish the new game client update to end-users.
|
| 509 |
+
* 3. Update the existing Steam identity provider credentials entry in EOS Dev Portal to use the same identity string identifier as the game client.
|
| 510 |
+
*
|
| 511 |
+
* @example
|
| 512 |
+
* SteamUser()->GetAuthTicketForWebApi("epiconlineservices");
|
| 513 |
+
*
|
| 514 |
+
* The retrieved Auth Session Ticket byte buffer needs to be converted into a hex-encoded UTF-8 string (e.g. "FA87097A..") before passing it to the EOS_Auth_Login or EOS_Connect_Login APIs.
|
| 515 |
+
* EOS_ByteArray_ToString can be used for this conversion.
|
| 516 |
+
*
|
| 517 |
+
* Supported with EOS_Auth_Login, EOS_Connect_Login.
|
| 518 |
+
*
|
| 519 |
+
* @version 1.15.1+
|
| 520 |
+
*/
|
| 521 |
+
EOS_ECT_STEAM_SESSION_TICKET = 18,
|
| 522 |
+
/**
|
| 523 |
+
* VIVEPORT User Session Token
|
| 524 |
+
*
|
| 525 |
+
* Supported with EOS_Connect_Login.
|
| 526 |
+
*/
|
| 527 |
+
EOS_ECT_VIVEPORT_USER_TOKEN = 19
|
| 528 |
+
);
|
| 529 |
+
|
| 530 |
+
/**
|
| 531 |
+
* This type is used to distinguish between different supported integrated platforms.
|
| 532 |
+
* Integrated platforms which are common across multiple host platforms will be defined here.
|
| 533 |
+
*/
|
| 534 |
+
EOS_EXTERN_C typedef const char* EOS_IntegratedPlatformType;
|
| 535 |
+
/** A macro to identify an unknown integrated platform. */
|
| 536 |
+
#define EOS_IPT_Unknown (const char*)NULL
|
| 537 |
+
|
| 538 |
+
/** This type is used to distinguish between different online platforms. */
|
| 539 |
+
EOS_EXTERN_C typedef uint32_t EOS_OnlinePlatformType;
|
| 540 |
+
|
| 541 |
+
/** Unknown online platform */
|
| 542 |
+
#define EOS_OPT_Unknown 0
|
| 543 |
+
/** Epic online platform */
|
| 544 |
+
#define EOS_OPT_Epic 100
|
| 545 |
+
/** PlayStation Network online platform */
|
| 546 |
+
#define EOS_OPT_PSN 1000
|
| 547 |
+
/** Nintendo online platform */
|
| 548 |
+
#define EOS_OPT_Nintendo 2000
|
| 549 |
+
/** Xbox Live online platform */
|
| 550 |
+
#define EOS_OPT_XBL 3000
|
| 551 |
+
/** Steam online platform */
|
| 552 |
+
#define EOS_OPT_Steam 4000
|
| 553 |
+
|
| 554 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_connect.h
ADDED
|
@@ -0,0 +1,472 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_connect_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Connect Interface is used to manage local user permissions and access to backend services through the verification of various forms of credentials.
|
| 8 |
+
* It creates an association between third party providers and an internal mapping that allows Epic Online Services to represent a user agnostically.
|
| 9 |
+
* All Connect Interface calls take a handle of type EOS_HConnect as the first parameter.
|
| 10 |
+
* This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetConnectInterface function.
|
| 11 |
+
*
|
| 12 |
+
* @see EOS_Platform_GetConnectInterface
|
| 13 |
+
*/
|
| 14 |
+
|
| 15 |
+
/**
|
| 16 |
+
* Login/Authenticate given a valid set of external auth credentials.
|
| 17 |
+
*
|
| 18 |
+
* @param Options structure containing the external account credentials and type to use during the login operation.
|
| 19 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 20 |
+
* @param CompletionDelegate a callback that is fired when the login operation completes, either successfully or in error.
|
| 21 |
+
*
|
| 22 |
+
* @see EOS_Connect_LoginOptions
|
| 23 |
+
* @see EOS_Connect_OnLoginCallback
|
| 24 |
+
*/
|
| 25 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_Login(EOS_HConnect Handle, const EOS_Connect_LoginOptions* Options, void* ClientData, const EOS_Connect_OnLoginCallback CompletionDelegate);
|
| 26 |
+
|
| 27 |
+
/**
|
| 28 |
+
* Logout a currently logged in user.
|
| 29 |
+
* NOTE: Access tokens for Product User IDs cannot be revoked. This operation really just cleans up state for the Product User ID and locally discards any associated access token.
|
| 30 |
+
*
|
| 31 |
+
* @param Options Structure containing the input parameters for the operation
|
| 32 |
+
* @param ClientData Arbitrary data that is passed back to the caller in the CompletionDelegate.
|
| 33 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error.
|
| 34 |
+
*
|
| 35 |
+
* @see EOS_Connect_LogoutOptions
|
| 36 |
+
* @see EOS_Connect_OnLogoutCallback
|
| 37 |
+
*/
|
| 38 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_Logout(EOS_HConnect Handle, const EOS_Connect_LogoutOptions* Options, void* ClientData, const EOS_Connect_OnLogoutCallback CompletionDelegate);
|
| 39 |
+
|
| 40 |
+
/**
|
| 41 |
+
* Create an account association with the Epic Online Service as a product user given their external auth credentials.
|
| 42 |
+
*
|
| 43 |
+
* @param Options structure containing a continuance token from a "user not found" response during Login (always try login first).
|
| 44 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 45 |
+
* @param CompletionDelegate a callback that is fired when the create operation completes, either successfully or in error.
|
| 46 |
+
*
|
| 47 |
+
* @see EOS_Connect_CreateUserOptions
|
| 48 |
+
* @see EOS_Connect_OnCreateUserCallback
|
| 49 |
+
*/
|
| 50 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_CreateUser(EOS_HConnect Handle, const EOS_Connect_CreateUserOptions* Options, void* ClientData, const EOS_Connect_OnCreateUserCallback CompletionDelegate);
|
| 51 |
+
|
| 52 |
+
/**
|
| 53 |
+
* Link a set of external auth credentials with an existing product user on the Epic Online Service.
|
| 54 |
+
*
|
| 55 |
+
* @param Options structure containing a continuance token from a "user not found" response during Login (always try login first) and a currently logged in user not already associated with this external auth provider.
|
| 56 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 57 |
+
* @param CompletionDelegate a callback that is fired when the link operation completes, either successfully or in error.
|
| 58 |
+
*
|
| 59 |
+
* @see EOS_Connect_LinkAccountOptions
|
| 60 |
+
* @see EOS_Connect_OnLinkAccountCallback
|
| 61 |
+
*/
|
| 62 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_LinkAccount(EOS_HConnect Handle, const EOS_Connect_LinkAccountOptions* Options, void* ClientData, const EOS_Connect_OnLinkAccountCallback CompletionDelegate);
|
| 63 |
+
|
| 64 |
+
/**
|
| 65 |
+
* Unlink external auth credentials from the owning keychain of a logged in product user.
|
| 66 |
+
*
|
| 67 |
+
* This function allows recovering the user from scenarios where they have accidentally proceeded to creating
|
| 68 |
+
* a new product user for the local native user account, instead of linking it with an existing keychain that
|
| 69 |
+
* they have previously created by playing the game (or another game owned by the organization) on another platform.
|
| 70 |
+
*
|
| 71 |
+
* In such scenario, after the initial platform login and a new product user creation, the user wishes to re-login
|
| 72 |
+
* using other set of external auth credentials to connect with their existing game progression data. In order to
|
| 73 |
+
* allow automatic login also on the current platform, they will need to unlink the accidentally created new keychain
|
| 74 |
+
* and product user and then use the EOS_Connect_Login and EOS_Connect_LinkAccount APIs to link the local native platform
|
| 75 |
+
* account with that previously created existing product user and its owning keychain.
|
| 76 |
+
*
|
| 77 |
+
* In another scenario, the user may simply want to disassociate the account that they have logged in with from the current
|
| 78 |
+
* keychain that it is linked with, perhaps to link it against another keychain or to separate the game progressions again.
|
| 79 |
+
*
|
| 80 |
+
* In order to protect against account theft, it is only possible to unlink user accounts that have been authenticated
|
| 81 |
+
* and logged in to the product user in the current session. This prevents a malicious actor from gaining access to one
|
| 82 |
+
* of the linked accounts and using it to remove all other accounts linked with the keychain. This also prevents a malicious
|
| 83 |
+
* actor from replacing the unlinked account with their own corresponding account on the same platform, as the unlinking
|
| 84 |
+
* operation will ensure that any existing authentication session cannot be used to re-link and overwrite the entry without
|
| 85 |
+
* authenticating with one of the other linked accounts in the keychain. These restrictions limit the potential attack surface
|
| 86 |
+
* related to account theft scenarios.
|
| 87 |
+
*
|
| 88 |
+
* @param Options structure containing operation input parameters.
|
| 89 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 90 |
+
* @param CompletionDelegate a callback that is fired when the unlink operation completes, either successfully or in error.
|
| 91 |
+
*
|
| 92 |
+
* @see EOS_Connect_UnlinkAccountOptions
|
| 93 |
+
* @see EOS_Connect_OnUnlinkAccountCallback
|
| 94 |
+
*/
|
| 95 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_UnlinkAccount(EOS_HConnect Handle, const EOS_Connect_UnlinkAccountOptions* Options, void* ClientData, const EOS_Connect_OnUnlinkAccountCallback CompletionDelegate);
|
| 96 |
+
|
| 97 |
+
/**
|
| 98 |
+
* Create a new unique pseudo-account that can be used to identify the current user profile on the local device.
|
| 99 |
+
*
|
| 100 |
+
* This function is intended to be used by mobile games and PC games that wish to allow
|
| 101 |
+
* a new user to start playing without requiring to login to the game using any user identity.
|
| 102 |
+
* In addition to this, the Device ID feature is used to automatically login the local user
|
| 103 |
+
* also when they have linked at least one external user account(s) with the local Device ID.
|
| 104 |
+
*
|
| 105 |
+
* It is possible to link many devices with the same user's account keyring using the Device ID feature.
|
| 106 |
+
*
|
| 107 |
+
* Linking a device later or immediately with a real user account will ensure that the player
|
| 108 |
+
* will not lose their progress if they switch devices or lose the device at some point,
|
| 109 |
+
* as they will be always able to login with one of their linked real accounts and also link
|
| 110 |
+
* another new device with the user account associations keychain. Otherwise, without having
|
| 111 |
+
* at least one permanent user account linked to the Device ID, the player would lose all of their
|
| 112 |
+
* game data and progression permanently should something happen to their device or the local
|
| 113 |
+
* user profile on the device.
|
| 114 |
+
*
|
| 115 |
+
* After a successful one-time CreateDeviceId operation, the game can login the local user
|
| 116 |
+
* automatically on subsequent game starts with EOS_Connect_Login using the EOS_ECT_DEVICEID_ACCESS_TOKEN
|
| 117 |
+
* credentials type. If a Device ID already exists for the local user on the device then EOS_DuplicateNotAllowed
|
| 118 |
+
* error result is returned and the caller should proceed to calling EOS_Connect_Login directly.
|
| 119 |
+
*
|
| 120 |
+
* @param Options structure containing operation input parameters.
|
| 121 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 122 |
+
* @param CompletionDelegate a callback that is fired when the create operation completes, either successfully or in error.
|
| 123 |
+
*
|
| 124 |
+
* @see EOS_Connect_CreateDeviceIdOptions
|
| 125 |
+
* @see EOS_Connect_OnCreateDeviceIdCallback
|
| 126 |
+
*/
|
| 127 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_CreateDeviceId(EOS_HConnect Handle, const EOS_Connect_CreateDeviceIdOptions* Options, void* ClientData, const EOS_Connect_OnCreateDeviceIdCallback CompletionDelegate);
|
| 128 |
+
|
| 129 |
+
/**
|
| 130 |
+
* Delete any existing Device ID access credentials for the current user profile on the local device.
|
| 131 |
+
*
|
| 132 |
+
* The deletion is permanent and it is not possible to recover lost game data and progression
|
| 133 |
+
* if the Device ID had not been linked with at least one real external user account.
|
| 134 |
+
*
|
| 135 |
+
* On Android and iOS devices, uninstalling the application will automatically delete any local
|
| 136 |
+
* Device ID credentials created by the application.
|
| 137 |
+
*
|
| 138 |
+
* On Desktop platforms (Linux, macOS, Windows), Device ID credentials are not automatically deleted.
|
| 139 |
+
* Applications may re-use existing Device ID credentials for the local OS user when the application is
|
| 140 |
+
* re-installed, or call the DeleteDeviceId API on the first run to ensure a fresh start for the user.
|
| 141 |
+
*
|
| 142 |
+
* @param Options structure containing operation input parameters
|
| 143 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 144 |
+
* @param CompletionDelegate a callback that is fired when the delete operation completes, either successfully or in error
|
| 145 |
+
*
|
| 146 |
+
* @see EOS_Connect_DeleteDeviceIdOptions
|
| 147 |
+
* @see EOS_Connect_OnDeleteDeviceIdCallback
|
| 148 |
+
*/
|
| 149 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_DeleteDeviceId(EOS_HConnect Handle, const EOS_Connect_DeleteDeviceIdOptions* Options, void* ClientData, const EOS_Connect_OnDeleteDeviceIdCallback CompletionDelegate);
|
| 150 |
+
|
| 151 |
+
/**
|
| 152 |
+
* Transfer a Device ID pseudo-account and the product user associated with it into another
|
| 153 |
+
* keychain linked with real user accounts (such as Epic Games, PlayStation(TM)Network, Xbox Live, and other).
|
| 154 |
+
*
|
| 155 |
+
* This function allows transferring a product user, i.e. the local user's game progression
|
| 156 |
+
* backend data from a Device ID owned keychain into a keychain with real user accounts
|
| 157 |
+
* linked to it. The transfer of Device ID owned product user into a keychain of real user
|
| 158 |
+
* accounts allows persisting the user's game data on the backend in the event that they
|
| 159 |
+
* would lose access to the local device or otherwise switch to another device or platform.
|
| 160 |
+
*
|
| 161 |
+
* This function is only applicable in the situation of where the local user first plays
|
| 162 |
+
* the game using the anonymous Device ID login, then later logs in using a real user
|
| 163 |
+
* account that they have also already used to play the same game or another game under the
|
| 164 |
+
* same organization within Epic Online Services. In such situation, while normally the login
|
| 165 |
+
* attempt with a real user account would return EOS_InvalidUser and an EOS_ContinuanceToken
|
| 166 |
+
* and allow calling the EOS_Connect_LinkAccount API to link it with the Device ID's keychain,
|
| 167 |
+
* instead the login operation succeeds and finds an existing user because the association
|
| 168 |
+
* already exists. Because the user cannot have two product users simultaneously to play with,
|
| 169 |
+
* the game should prompt the user to choose which profile to keep and which one to discard
|
| 170 |
+
* permanently. Based on the user choice, the game may then proceed to transfer the Device ID
|
| 171 |
+
* login into the keychain that is persistent and backed by real user accounts, and if the user
|
| 172 |
+
* chooses so, move the product user as well into the destination keychain and overwrite the
|
| 173 |
+
* existing previous product user with it. To clarify, moving the product user with the Device ID
|
| 174 |
+
* login in this way into a persisted keychain allows to preserve the so far only locally persisted
|
| 175 |
+
* game progression and thus protect the user against a case where they lose access to the device.
|
| 176 |
+
*
|
| 177 |
+
* On success, the completion callback will return the preserved EOS_ProductUserId that remains
|
| 178 |
+
* logged in while the discarded EOS_ProductUserId has been invalidated and deleted permanently.
|
| 179 |
+
* Consecutive logins using the existing Device ID login type or the external account will
|
| 180 |
+
* connect the user to the same backend data belonging to the preserved EOS_ProductUserId.
|
| 181 |
+
*
|
| 182 |
+
* Example walkthrough: Cross-platform mobile game using the anonymous Device ID login.
|
| 183 |
+
*
|
| 184 |
+
* For onboarding new users, the game will attempt to always automatically login the local user
|
| 185 |
+
* by calling EOS_Connect_Login using the EOS_ECT_DEVICEID_ACCESS_TOKEN login type. If the local
|
| 186 |
+
* Device ID credentials are not found, and the game wants a frictionless entry for the first time
|
| 187 |
+
* user experience, the game will automatically call EOS_Connect_CreateDeviceId to create new
|
| 188 |
+
* Device ID pseudo-account and then login the local user into it. Consecutive game starts will
|
| 189 |
+
* thus automatically login the user to their locally persisted Device ID account.
|
| 190 |
+
*
|
| 191 |
+
* The user starts playing anonymously using the Device ID login type and makes significant game progress.
|
| 192 |
+
* Later, they login using an external account that they have already used previously for the
|
| 193 |
+
* same game perhaps on another platform, or another game owned by the same organization.
|
| 194 |
+
* In such case, EOS_Connect_Login will automatically login the user to their existing account
|
| 195 |
+
* linking keychain and create automatically a new empty product user for this product.
|
| 196 |
+
*
|
| 197 |
+
* In order for the user to use their existing previously created keychain and have the locally
|
| 198 |
+
* created Device ID login reference to that keychain instead, the user's current product user
|
| 199 |
+
* needs to be moved to be under that keychain so that their existing game progression will be
|
| 200 |
+
* preserved. To do so, the game can call EOS_Connect_TransferDeviceIdAccount to transfer the
|
| 201 |
+
* Device ID login and the product user associated with it into the other keychain that has real
|
| 202 |
+
* external user account(s) linked to it. Note that it is important that the game either automatically
|
| 203 |
+
* checks that the other product user does not have any meaningful progression data, or otherwise
|
| 204 |
+
* will prompt the user to make the choice on which game progression to preserve and which can
|
| 205 |
+
* be discarded permanently. The other product user will be discarded permanently and cannot be
|
| 206 |
+
* recovered, so it is very important that the user is guided to make the right choice to avoid
|
| 207 |
+
* accidental loss of all game progression.
|
| 208 |
+
*
|
| 209 |
+
* @see EOS_Connect_TransferDeviceIdAccountOptions
|
| 210 |
+
* @see EOS_Connect_OnTransferDeviceIdAccountCallback
|
| 211 |
+
* @see EOS_Connect_Login
|
| 212 |
+
* @see EOS_Connect_CreateDeviceId
|
| 213 |
+
*
|
| 214 |
+
* @param Options structure containing the logged in product users and specifying which one will be preserved.
|
| 215 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 216 |
+
* @param CompletionDelegate a callback that is fired when the transfer operation completes, either successfully or in error.
|
| 217 |
+
*/
|
| 218 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_TransferDeviceIdAccount(EOS_HConnect Handle, const EOS_Connect_TransferDeviceIdAccountOptions* Options, void* ClientData, const EOS_Connect_OnTransferDeviceIdAccountCallback CompletionDelegate);
|
| 219 |
+
|
| 220 |
+
/**
|
| 221 |
+
* Retrieve the equivalent Product User IDs from a list of external account IDs from supported account providers.
|
| 222 |
+
* The values will be cached and retrievable through EOS_Connect_GetExternalAccountMapping.
|
| 223 |
+
*
|
| 224 |
+
* @note A common use case is to query other users who are connected through the same account system as the local user.
|
| 225 |
+
* Queries using external account IDs of another account system may not be available, depending on the account system specifics.
|
| 226 |
+
*
|
| 227 |
+
* @param Options structure containing a list of external account IDs, in string form, to query for the Product User ID representation.
|
| 228 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 229 |
+
* @param CompletionDelegate a callback that is fired when the query operation completes, either successfully or in error.
|
| 230 |
+
*
|
| 231 |
+
* @see EOS_Connect_QueryExternalAccountMappingsOptions
|
| 232 |
+
* @see EOS_Connect_OnQueryExternalAccountMappingsCallback
|
| 233 |
+
*/
|
| 234 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_QueryExternalAccountMappings(EOS_HConnect Handle, const EOS_Connect_QueryExternalAccountMappingsOptions* Options, void* ClientData, const EOS_Connect_OnQueryExternalAccountMappingsCallback CompletionDelegate);
|
| 235 |
+
|
| 236 |
+
/**
|
| 237 |
+
* Retrieve the equivalent external account mappings from a list of Product User IDs.
|
| 238 |
+
*
|
| 239 |
+
* The values will be cached and retrievable via EOS_Connect_GetProductUserIdMapping, EOS_Connect_CopyProductUserExternalAccountByIndex,
|
| 240 |
+
* EOS_Connect_CopyProductUserExternalAccountByAccountType or EOS_Connect_CopyProductUserExternalAccountByAccountId.
|
| 241 |
+
*
|
| 242 |
+
* @see EOS_Connect_QueryProductUserIdMappingsOptions
|
| 243 |
+
* @see EOS_Connect_OnQueryProductUserIdMappingsCallback
|
| 244 |
+
* @see EOS_Connect_ExternalAccountInfo
|
| 245 |
+
* @see EOS_Connect_GetProductUserExternalAccountCount
|
| 246 |
+
* @see EOS_Connect_GetProductUserIdMapping
|
| 247 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByIndex
|
| 248 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByAccountType
|
| 249 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByAccountId
|
| 250 |
+
* @see EOS_Connect_CopyProductUserInfo
|
| 251 |
+
*
|
| 252 |
+
* @param Options structure containing a list of Product User IDs to query for the external account representation.
|
| 253 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 254 |
+
* @param CompletionDelegate a callback that is fired when the query operation completes, either successfully or in error.
|
| 255 |
+
*/
|
| 256 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_QueryProductUserIdMappings(EOS_HConnect Handle, const EOS_Connect_QueryProductUserIdMappingsOptions* Options, void* ClientData, const EOS_Connect_OnQueryProductUserIdMappingsCallback CompletionDelegate);
|
| 257 |
+
|
| 258 |
+
/**
|
| 259 |
+
* Fetch a Product User ID that maps to an external account ID cached from a previous query.
|
| 260 |
+
*
|
| 261 |
+
* @param Options structure containing the local user and target external account ID.
|
| 262 |
+
*
|
| 263 |
+
* @see EOS_Connect_GetExternalAccountMappingsOptions
|
| 264 |
+
*
|
| 265 |
+
* @return The Product User ID, previously retrieved from the backend service, for the given target external account.
|
| 266 |
+
*/
|
| 267 |
+
EOS_DECLARE_FUNC(EOS_ProductUserId) EOS_Connect_GetExternalAccountMapping(EOS_HConnect Handle, const EOS_Connect_GetExternalAccountMappingsOptions* Options);
|
| 268 |
+
|
| 269 |
+
/**
|
| 270 |
+
* Fetch an external account ID, in string form, that maps to a given Product User ID.
|
| 271 |
+
*
|
| 272 |
+
* @param Options structure containing the local user and target Product User ID.
|
| 273 |
+
* @param OutBuffer The buffer into which the external account ID data should be written. The buffer must be long enough to hold a string of EOS_CONNECT_EXTERNAL_ACCOUNT_ID_MAX_LENGTH.
|
| 274 |
+
* @param InOutBufferLength The size of the OutBuffer in characters.
|
| 275 |
+
* The input buffer should include enough space to be null-terminated.
|
| 276 |
+
* When the function returns, this parameter will be filled with the length of the string copied into OutBuffer.
|
| 277 |
+
*
|
| 278 |
+
* @see EOS_Connect_GetProductUserIdMappingOptions
|
| 279 |
+
*
|
| 280 |
+
* @return An EOS_EResult that indicates the external account ID was copied into the OutBuffer.
|
| 281 |
+
* - EOS_Success if the information is available and passed out in OutUserInfo.
|
| 282 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter.
|
| 283 |
+
* - EOS_NotFound if the mapping doesn't exist or hasn't been queried yet.
|
| 284 |
+
* - EOS_LimitExceeded if the OutBuffer is not large enough to receive the external account ID. InOutBufferLength contains the required minimum length to perform the operation successfully.
|
| 285 |
+
*/
|
| 286 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Connect_GetProductUserIdMapping(EOS_HConnect Handle, const EOS_Connect_GetProductUserIdMappingOptions* Options, char* OutBuffer, int32_t* InOutBufferLength);
|
| 287 |
+
|
| 288 |
+
/**
|
| 289 |
+
* Fetch the number of linked external accounts for a Product User ID.
|
| 290 |
+
*
|
| 291 |
+
* @param Options The Options associated with retrieving the external account info count.
|
| 292 |
+
*
|
| 293 |
+
* @see EOS_Connect_GetProductUserExternalAccountCountOptions
|
| 294 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByIndex
|
| 295 |
+
*
|
| 296 |
+
* @return Number of external accounts or 0 otherwise.
|
| 297 |
+
*/
|
| 298 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Connect_GetProductUserExternalAccountCount(EOS_HConnect Handle, const EOS_Connect_GetProductUserExternalAccountCountOptions* Options);
|
| 299 |
+
|
| 300 |
+
/**
|
| 301 |
+
* Fetch information about an external account linked to a Product User ID.
|
| 302 |
+
* On a successful call, the caller must release the returned structure using the EOS_Connect_ExternalAccountInfo_Release API.
|
| 303 |
+
*
|
| 304 |
+
* @param Options Structure containing the target index.
|
| 305 |
+
* @param OutExternalAccountInfo The external account info data for the user with given index.
|
| 306 |
+
*
|
| 307 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByIndexOptions
|
| 308 |
+
* @see EOS_Connect_ExternalAccountInfo
|
| 309 |
+
* @see EOS_Connect_ExternalAccountInfo_Release
|
| 310 |
+
*
|
| 311 |
+
* @return An EOS_EResult that indicates the external account data was copied into the OutExternalAccountInfo.
|
| 312 |
+
* - EOS_Success if the information is available and passed out in OutExternalAccountInfo.
|
| 313 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter.
|
| 314 |
+
* - EOS_NotFound if the account data doesn't exist or hasn't been queried yet.
|
| 315 |
+
*/
|
| 316 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Connect_CopyProductUserExternalAccountByIndex(EOS_HConnect Handle, const EOS_Connect_CopyProductUserExternalAccountByIndexOptions* Options, EOS_Connect_ExternalAccountInfo ** OutExternalAccountInfo);
|
| 317 |
+
|
| 318 |
+
/**
|
| 319 |
+
* Fetch information about an external account of a specific type linked to a Product User ID.
|
| 320 |
+
* On a successful call, the caller must release the returned structure using the EOS_Connect_ExternalAccountInfo_Release API.
|
| 321 |
+
*
|
| 322 |
+
* @param Options Structure containing the target external account type.
|
| 323 |
+
* @param OutExternalAccountInfo The external account info data for the user with given external account type.
|
| 324 |
+
*
|
| 325 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByAccountTypeOptions
|
| 326 |
+
* @see EOS_Connect_ExternalAccountInfo
|
| 327 |
+
* @see EOS_Connect_ExternalAccountInfo_Release
|
| 328 |
+
*
|
| 329 |
+
* @return An EOS_EResult that indicates the external account data was copied into the OutExternalAccountInfo.
|
| 330 |
+
* - EOS_Success if the information is available and passed out in OutExternalAccountInfo.
|
| 331 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter.
|
| 332 |
+
* - EOS_NotFound if the account data doesn't exist or hasn't been queried yet.
|
| 333 |
+
*/
|
| 334 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Connect_CopyProductUserExternalAccountByAccountType(EOS_HConnect Handle, const EOS_Connect_CopyProductUserExternalAccountByAccountTypeOptions* Options, EOS_Connect_ExternalAccountInfo ** OutExternalAccountInfo);
|
| 335 |
+
|
| 336 |
+
/**
|
| 337 |
+
* Fetch information about an external account linked to a Product User ID.
|
| 338 |
+
* On a successful call, the caller must release the returned structure using the EOS_Connect_ExternalAccountInfo_Release API.
|
| 339 |
+
*
|
| 340 |
+
* @param Options Structure containing the target external account ID.
|
| 341 |
+
* @param OutExternalAccountInfo The external account info data for the user with given external account ID.
|
| 342 |
+
*
|
| 343 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByAccountIdOptions
|
| 344 |
+
* @see EOS_Connect_ExternalAccountInfo
|
| 345 |
+
* @see EOS_Connect_ExternalAccountInfo_Release
|
| 346 |
+
*
|
| 347 |
+
* @return An EOS_EResult that indicates the external account data was copied into the OutExternalAccountInfo.
|
| 348 |
+
* - EOS_Success if the information is available and passed out in OutExternalAccountInfo.
|
| 349 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter.
|
| 350 |
+
* - EOS_NotFound if the account data doesn't exist or hasn't been queried yet.
|
| 351 |
+
*/
|
| 352 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Connect_CopyProductUserExternalAccountByAccountId(EOS_HConnect Handle, const EOS_Connect_CopyProductUserExternalAccountByAccountIdOptions* Options, EOS_Connect_ExternalAccountInfo ** OutExternalAccountInfo);
|
| 353 |
+
|
| 354 |
+
/**
|
| 355 |
+
* Fetch information about a Product User, using the external account that they most recently logged in with as the reference.
|
| 356 |
+
* On a successful call, the caller must release the returned structure using the EOS_Connect_ExternalAccountInfo_Release API.
|
| 357 |
+
*
|
| 358 |
+
* @param Options Structure containing the target external account ID.
|
| 359 |
+
* @param OutExternalAccountInfo The external account info data last logged in for the user.
|
| 360 |
+
*
|
| 361 |
+
* @see EOS_Connect_CopyProductUserInfoOptions
|
| 362 |
+
* @see EOS_Connect_ExternalAccountInfo
|
| 363 |
+
* @see EOS_Connect_ExternalAccountInfo_Release
|
| 364 |
+
*
|
| 365 |
+
* @return An EOS_EResult that indicates the external account data was copied into the OutExternalAccountInfo.
|
| 366 |
+
* - EOS_Success if the information is available and passed out in OutExternalAccountInfo.
|
| 367 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter.
|
| 368 |
+
* - EOS_NotFound if the account data doesn't exist or hasn't been queried yet.
|
| 369 |
+
*/
|
| 370 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Connect_CopyProductUserInfo(EOS_HConnect Handle, const EOS_Connect_CopyProductUserInfoOptions* Options, EOS_Connect_ExternalAccountInfo ** OutExternalAccountInfo);
|
| 371 |
+
|
| 372 |
+
/**
|
| 373 |
+
* Fetch the number of product users that are logged in.
|
| 374 |
+
*
|
| 375 |
+
* @return the number of product users logged in.
|
| 376 |
+
*/
|
| 377 |
+
EOS_DECLARE_FUNC(int32_t) EOS_Connect_GetLoggedInUsersCount(EOS_HConnect Handle);
|
| 378 |
+
|
| 379 |
+
/**
|
| 380 |
+
* Fetch a Product User ID that is logged in. This Product User ID is in the Epic Online Services namespace.
|
| 381 |
+
*
|
| 382 |
+
* @param Index an index into the list of logged in users. If the index is out of bounds, the returned Product User ID will be invalid.
|
| 383 |
+
*
|
| 384 |
+
* @return the Product User ID associated with the index passed.
|
| 385 |
+
*/
|
| 386 |
+
EOS_DECLARE_FUNC(EOS_ProductUserId) EOS_Connect_GetLoggedInUserByIndex(EOS_HConnect Handle, int32_t Index);
|
| 387 |
+
|
| 388 |
+
/**
|
| 389 |
+
* Fetches the login status for an Product User ID. This Product User ID is considered logged in as long as the underlying access token has not expired.
|
| 390 |
+
*
|
| 391 |
+
* @param LocalUserId the Product User ID of the user being queried.
|
| 392 |
+
*
|
| 393 |
+
* @return the enum value of a user's login status.
|
| 394 |
+
*/
|
| 395 |
+
EOS_DECLARE_FUNC(EOS_ELoginStatus) EOS_Connect_GetLoginStatus(EOS_HConnect Handle, EOS_ProductUserId LocalUserId);
|
| 396 |
+
|
| 397 |
+
/**
|
| 398 |
+
* Register to receive upcoming authentication expiration notifications.
|
| 399 |
+
* Notification is approximately 1 minute prior to expiration.
|
| 400 |
+
* Call EOS_Connect_Login again with valid third party credentials to refresh access.
|
| 401 |
+
*
|
| 402 |
+
* @note If the returned NotificationId is valid, you must call EOS_Connect_RemoveNotifyAuthExpiration when you no longer wish to have your NotificationHandler called.
|
| 403 |
+
*
|
| 404 |
+
* @param Options structure containing the API version of the callback to use.
|
| 405 |
+
* @param ClientData arbitrary data that is passed back to you in the callback.
|
| 406 |
+
* @param Notification a callback that is fired when the authentication is about to expire.
|
| 407 |
+
*
|
| 408 |
+
* @see EOS_Connect_AddNotifyAuthExpirationOptions
|
| 409 |
+
* @see EOS_Connect_OnAuthExpirationCallback
|
| 410 |
+
*
|
| 411 |
+
* @return handle representing the registered callback.
|
| 412 |
+
*/
|
| 413 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Connect_AddNotifyAuthExpiration(EOS_HConnect Handle, const EOS_Connect_AddNotifyAuthExpirationOptions* Options, void* ClientData, const EOS_Connect_OnAuthExpirationCallback Notification);
|
| 414 |
+
|
| 415 |
+
/**
|
| 416 |
+
* Unregister from receiving expiration notifications.
|
| 417 |
+
*
|
| 418 |
+
* @param InId handle representing the registered callback.
|
| 419 |
+
*/
|
| 420 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_RemoveNotifyAuthExpiration(EOS_HConnect Handle, EOS_NotificationId InId);
|
| 421 |
+
|
| 422 |
+
/**
|
| 423 |
+
* Register to receive user login status updates.
|
| 424 |
+
* @note If the returned NotificationId is valid, you must call EOS_Connect_RemoveNotifyLoginStatusChanged when you no longer wish to have your NotificationHandler called.
|
| 425 |
+
*
|
| 426 |
+
* @param Options structure containing the API version of the callback to use.
|
| 427 |
+
* @param ClientData arbitrary data that is passed back to you in the callback.
|
| 428 |
+
* @param Notification a callback that is fired when the login status for a user changes.
|
| 429 |
+
*
|
| 430 |
+
* @see EOS_Connect_AddNotifyLoginStatusChangedOptions
|
| 431 |
+
* @see EOS_Connect_OnLoginStatusChangedCallback
|
| 432 |
+
*
|
| 433 |
+
* @return handle representing the registered callback.
|
| 434 |
+
*/
|
| 435 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Connect_AddNotifyLoginStatusChanged(EOS_HConnect Handle, const EOS_Connect_AddNotifyLoginStatusChangedOptions* Options, void* ClientData, const EOS_Connect_OnLoginStatusChangedCallback Notification);
|
| 436 |
+
|
| 437 |
+
/**
|
| 438 |
+
* Unregister from receiving user login status updates.
|
| 439 |
+
*
|
| 440 |
+
* @param InId handle representing the registered callback.
|
| 441 |
+
*/
|
| 442 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_RemoveNotifyLoginStatusChanged(EOS_HConnect Handle, EOS_NotificationId InId);
|
| 443 |
+
|
| 444 |
+
/**
|
| 445 |
+
* Fetches an ID token for a Product User ID.
|
| 446 |
+
*
|
| 447 |
+
* @param Options Structure containing information about the ID token to copy.
|
| 448 |
+
* @param OutIdToken The ID token for the given user, if it exists and is valid; use EOS_Connect_IdToken_Release when finished.
|
| 449 |
+
*
|
| 450 |
+
* @see EOS_Connect_CopyIdTokenOptions
|
| 451 |
+
* @see EOS_Connect_IdToken
|
| 452 |
+
* @see EOS_Connect_IdToken_Release
|
| 453 |
+
*
|
| 454 |
+
* @return EOS_EResult containing the result of the operation.
|
| 455 |
+
* Possible result codes:
|
| 456 |
+
* - EOS_Success if the information is available and passed out in OutIdToken.
|
| 457 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter.
|
| 458 |
+
* - EOS_NotFound if the ID token is not found or expired.
|
| 459 |
+
*/
|
| 460 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Connect_CopyIdToken(EOS_HConnect Handle, const EOS_Connect_CopyIdTokenOptions* Options, EOS_Connect_IdToken ** OutIdToken);
|
| 461 |
+
|
| 462 |
+
/**
|
| 463 |
+
* Verify a given ID token for authenticity and validity.
|
| 464 |
+
*
|
| 465 |
+
* @param Options structure containing information about the ID token to verify.
|
| 466 |
+
* @param ClientData arbitrary data that is passed back to you in the callback.
|
| 467 |
+
* @param CompletionDelegate a callback that is fired when the operation completes, either successfully or in error.
|
| 468 |
+
*
|
| 469 |
+
* @see EOS_Connect_VerifyIdTokenOptions
|
| 470 |
+
* @see EOS_Connect_OnVerifyIdTokenCallback
|
| 471 |
+
*/
|
| 472 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_VerifyIdToken(EOS_HConnect Handle, const EOS_Connect_VerifyIdTokenOptions* Options, void* ClientData, const EOS_Connect_OnVerifyIdTokenCallback CompletionDelegate);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_connect_types.h
ADDED
|
@@ -0,0 +1,802 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
|
| 6 |
+
#pragma pack(push, 8)
|
| 7 |
+
|
| 8 |
+
EOS_EXTERN_C typedef struct EOS_ConnectHandle* EOS_HConnect;
|
| 9 |
+
|
| 10 |
+
/** Max length of an external account ID in string form */
|
| 11 |
+
#define EOS_CONNECT_EXTERNAL_ACCOUNT_ID_MAX_LENGTH 256
|
| 12 |
+
|
| 13 |
+
/** The most recent version of the EOS_Connect_Credentials struct. */
|
| 14 |
+
#define EOS_CONNECT_CREDENTIALS_API_LATEST 1
|
| 15 |
+
|
| 16 |
+
/**
|
| 17 |
+
* A structure that contains external login credentials.
|
| 18 |
+
*
|
| 19 |
+
* This is part of the input structure EOS_Connect_LoginOptions.
|
| 20 |
+
*
|
| 21 |
+
* @see EOS_EExternalCredentialType
|
| 22 |
+
* @see EOS_Connect_Login
|
| 23 |
+
*/
|
| 24 |
+
EOS_STRUCT(EOS_Connect_Credentials, (
|
| 25 |
+
/** API Version: Set this to EOS_CONNECT_CREDENTIALS_API_LATEST. */
|
| 26 |
+
int32_t ApiVersion;
|
| 27 |
+
/** External token associated with the user logging in. */
|
| 28 |
+
const char* Token;
|
| 29 |
+
/** Type of external login; identifies the auth method to use. */
|
| 30 |
+
EOS_EExternalCredentialType Type;
|
| 31 |
+
));
|
| 32 |
+
|
| 33 |
+
/** Max length of a display name, not including the terminating null. */
|
| 34 |
+
#define EOS_CONNECT_USERLOGININFO_DISPLAYNAME_MAX_LENGTH 32
|
| 35 |
+
|
| 36 |
+
/** The most recent version of the EOS_Connect_UserLoginInfo struct. */
|
| 37 |
+
#define EOS_CONNECT_USERLOGININFO_API_LATEST 2
|
| 38 |
+
|
| 39 |
+
/**
|
| 40 |
+
* Additional information about the local user.
|
| 41 |
+
*/
|
| 42 |
+
EOS_STRUCT(EOS_Connect_UserLoginInfo, (
|
| 43 |
+
/** API Version: Set this to EOS_CONNECT_USERLOGININFO_API_LATEST. */
|
| 44 |
+
int32_t ApiVersion;
|
| 45 |
+
/**
|
| 46 |
+
* The user's display name on the identity provider systems as UTF-8 encoded null-terminated string.
|
| 47 |
+
* The length of the name can be at maximum up to EOS_CONNECT_USERLOGININFO_DISPLAYNAME_MAX_LENGTH characters.
|
| 48 |
+
*
|
| 49 |
+
* As the display name passed here is client-controlled and not part of user authentication tokens,
|
| 50 |
+
* it is only treated as non-authoritative informational data to be used by some of the feature services.
|
| 51 |
+
* For example displaying player names in Leaderboards rankings.
|
| 52 |
+
*/
|
| 53 |
+
const char* DisplayName;
|
| 54 |
+
/**
|
| 55 |
+
* Nintendo Service Account ID Token (NSA ID).
|
| 56 |
+
*
|
| 57 |
+
* This field is required to be set and only used when running on the Nintendo Switch device,
|
| 58 |
+
* and the user is being authenticated using any other credential type than EOS_ECT_NINTENDO_NSA_ID_TOKEN.
|
| 59 |
+
*
|
| 60 |
+
* In order to use the Lobbies and Sessions interfaces, a valid NSA ID Token is required to be provided
|
| 61 |
+
* for the active local Nintendo Switch user. Otherwise, attempting to use either of the Lobbies or
|
| 62 |
+
* Sessions interfaces will return the EOS_Permission_OnlinePlayRestricted error result.
|
| 63 |
+
*/
|
| 64 |
+
const char* NsaIdToken;
|
| 65 |
+
));
|
| 66 |
+
|
| 67 |
+
/** The most recent version of the EOS_Connect_Login API. */
|
| 68 |
+
#define EOS_CONNECT_LOGIN_API_LATEST 2
|
| 69 |
+
|
| 70 |
+
/**
|
| 71 |
+
* Input parameters for the EOS_Connect_Login function.
|
| 72 |
+
*/
|
| 73 |
+
EOS_STRUCT(EOS_Connect_LoginOptions, (
|
| 74 |
+
/** API Version: Set this to EOS_CONNECT_LOGIN_API_LATEST. */
|
| 75 |
+
int32_t ApiVersion;
|
| 76 |
+
/** Credentials specified for a given login method */
|
| 77 |
+
const EOS_Connect_Credentials* Credentials;
|
| 78 |
+
/**
|
| 79 |
+
* Additional information about the local user.
|
| 80 |
+
*
|
| 81 |
+
* This field is required to be set and used when authenticating the user using Amazon, Apple, Google, Nintendo Account, Nintendo Service Account, Oculus or the Device ID feature login.
|
| 82 |
+
* It is also required for using the Lobbies and Sessions interfaces when running on the Nintendo Switch device, and using any other credential type than EOS_ECT_NINTENDO_NSA_ID_TOKEN.
|
| 83 |
+
* In all other cases, set this field to NULL.
|
| 84 |
+
*/
|
| 85 |
+
const EOS_Connect_UserLoginInfo* UserLoginInfo;
|
| 86 |
+
));
|
| 87 |
+
|
| 88 |
+
/**
|
| 89 |
+
* Output parameters for the EOS_Connect_Login function.
|
| 90 |
+
*/
|
| 91 |
+
EOS_STRUCT(EOS_Connect_LoginCallbackInfo, (
|
| 92 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 93 |
+
EOS_EResult ResultCode;
|
| 94 |
+
/** Context that was passed into EOS_Connect_Login. */
|
| 95 |
+
void* ClientData;
|
| 96 |
+
/** If login was successful, this is the Product User ID of the local player that logged in. */
|
| 97 |
+
EOS_ProductUserId LocalUserId;
|
| 98 |
+
/**
|
| 99 |
+
* If the user was not found with credentials passed into EOS_Connect_Login,
|
| 100 |
+
* this continuance token can be passed to either EOS_Connect_CreateUser
|
| 101 |
+
* or EOS_Connect_LinkAccount to continue the flow.
|
| 102 |
+
*/
|
| 103 |
+
EOS_ContinuanceToken ContinuanceToken;
|
| 104 |
+
));
|
| 105 |
+
|
| 106 |
+
/**
|
| 107 |
+
* Function prototype definition for callbacks passed to EOS_Connect_Login.
|
| 108 |
+
*
|
| 109 |
+
* @param Data A EOS_Connect_LoginCallbackInfo containing the output information and result.
|
| 110 |
+
*/
|
| 111 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnLoginCallback, const EOS_Connect_LoginCallbackInfo* Data);
|
| 112 |
+
|
| 113 |
+
/** The most recent version of the EOS_Connect_Logout API. */
|
| 114 |
+
#define EOS_CONNECT_LOGOUT_API_LATEST 1
|
| 115 |
+
|
| 116 |
+
/** Input parameters for the EOS_Connect_Logout API */
|
| 117 |
+
EOS_STRUCT(EOS_Connect_LogoutOptions, (
|
| 118 |
+
/** API Version: Set this to EOS_CONNECT_LOGOUT_API_LATEST. */
|
| 119 |
+
int32_t ApiVersion;
|
| 120 |
+
|
| 121 |
+
/** The Product User ID of the player to logout */
|
| 122 |
+
EOS_ProductUserId LocalUserId;
|
| 123 |
+
));
|
| 124 |
+
|
| 125 |
+
/**
|
| 126 |
+
* Output parameters for the EOS_Connect_Logout function.
|
| 127 |
+
*/
|
| 128 |
+
EOS_STRUCT(EOS_Connect_LogoutCallbackInfo, (
|
| 129 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 130 |
+
EOS_EResult ResultCode;
|
| 131 |
+
|
| 132 |
+
/** Context that was passed into EOS_Connect_Logout. */
|
| 133 |
+
void* ClientData;
|
| 134 |
+
|
| 135 |
+
/** The Product User ID of the player that is being logged out. */
|
| 136 |
+
EOS_ProductUserId LocalUserId;
|
| 137 |
+
));
|
| 138 |
+
|
| 139 |
+
/**
|
| 140 |
+
* Function prototype definition for callbacks passed to EOS_Connect_Logout
|
| 141 |
+
*
|
| 142 |
+
* @param Data A EOS_Connect_LogoutCallbackInfo containing the result.
|
| 143 |
+
*/
|
| 144 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnLogoutCallback, const EOS_Connect_LogoutCallbackInfo* Data);
|
| 145 |
+
|
| 146 |
+
/** The most recent version of the EOS_Connect_CreateUser API. */
|
| 147 |
+
#define EOS_CONNECT_CREATEUSER_API_LATEST 1
|
| 148 |
+
|
| 149 |
+
/**
|
| 150 |
+
* Input parameters for the EOS_Connect_CreateUser function.
|
| 151 |
+
*/
|
| 152 |
+
EOS_STRUCT(EOS_Connect_CreateUserOptions, (
|
| 153 |
+
/** API Version: Set this to EOS_CONNECT_CREATEUSER_API_LATEST. */
|
| 154 |
+
int32_t ApiVersion;
|
| 155 |
+
/** Continuance token from previous call to EOS_Connect_Login */
|
| 156 |
+
EOS_ContinuanceToken ContinuanceToken;
|
| 157 |
+
));
|
| 158 |
+
|
| 159 |
+
/**
|
| 160 |
+
* Output parameters for the EOS_Connect_CreateUser function.
|
| 161 |
+
*/
|
| 162 |
+
EOS_STRUCT(EOS_Connect_CreateUserCallbackInfo, (
|
| 163 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 164 |
+
EOS_EResult ResultCode;
|
| 165 |
+
/** Context that was passed into EOS_Connect_CreateUser. */
|
| 166 |
+
void* ClientData;
|
| 167 |
+
/** If the operation succeeded, this is the Product User ID of the local user who was created. */
|
| 168 |
+
EOS_ProductUserId LocalUserId;
|
| 169 |
+
));
|
| 170 |
+
|
| 171 |
+
/**
|
| 172 |
+
* Function prototype definition for callbacks passed to EOS_Connect_CreateUser.
|
| 173 |
+
*
|
| 174 |
+
* @param Data A EOS_Connect_CreateUserCallbackInfo containing the output information and result.
|
| 175 |
+
*/
|
| 176 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnCreateUserCallback, const EOS_Connect_CreateUserCallbackInfo* Data);
|
| 177 |
+
|
| 178 |
+
/** The most recent version of the EOS_Connect_LinkAccount API. */
|
| 179 |
+
#define EOS_CONNECT_LINKACCOUNT_API_LATEST 1
|
| 180 |
+
|
| 181 |
+
/**
|
| 182 |
+
* Input parameters for the EOS_Connect_LinkAccount function.
|
| 183 |
+
*/
|
| 184 |
+
EOS_STRUCT(EOS_Connect_LinkAccountOptions, (
|
| 185 |
+
/** API Version: Set this to EOS_CONNECT_LINKACCOUNT_API_LATEST. */
|
| 186 |
+
int32_t ApiVersion;
|
| 187 |
+
/** The existing logged in product user for which to link the external account described by the continuance token. */
|
| 188 |
+
EOS_ProductUserId LocalUserId;
|
| 189 |
+
/** Continuance token from previous call to EOS_Connect_Login. */
|
| 190 |
+
EOS_ContinuanceToken ContinuanceToken;
|
| 191 |
+
));
|
| 192 |
+
|
| 193 |
+
/**
|
| 194 |
+
* Output parameters for the EOS_Connect_LinkAccount function.
|
| 195 |
+
*/
|
| 196 |
+
EOS_STRUCT(EOS_Connect_LinkAccountCallbackInfo, (
|
| 197 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 198 |
+
EOS_EResult ResultCode;
|
| 199 |
+
/** Context that was passed into EOS_Connect_LinkAccount. */
|
| 200 |
+
void* ClientData;
|
| 201 |
+
/** The Product User ID of the existing, logged-in user whose account was linked (on success). */
|
| 202 |
+
EOS_ProductUserId LocalUserId;
|
| 203 |
+
));
|
| 204 |
+
|
| 205 |
+
/**
|
| 206 |
+
* Function prototype definition for callbacks passed to EOS_Connect_LinkAccount.
|
| 207 |
+
*
|
| 208 |
+
* @param Data A EOS_Connect_LinkAccountCallbackInfo containing the output information and result.
|
| 209 |
+
*/
|
| 210 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnLinkAccountCallback, const EOS_Connect_LinkAccountCallbackInfo* Data);
|
| 211 |
+
|
| 212 |
+
/** The most recent version of the EOS_Connect_UnlinkAccount API. */
|
| 213 |
+
#define EOS_CONNECT_UNLINKACCOUNT_API_LATEST 1
|
| 214 |
+
|
| 215 |
+
/**
|
| 216 |
+
* Input parameters for the EOS_Connect_UnlinkAccount Function.
|
| 217 |
+
*/
|
| 218 |
+
EOS_STRUCT(EOS_Connect_UnlinkAccountOptions, (
|
| 219 |
+
/** API Version: Set this to EOS_CONNECT_UNLINKACCOUNT_API_LATEST. */
|
| 220 |
+
int32_t ApiVersion;
|
| 221 |
+
/**
|
| 222 |
+
* Existing logged in product user that is subject for the unlinking operation.
|
| 223 |
+
* The external account that was used to login to the product user will be unlinked from the owning keychain.
|
| 224 |
+
*
|
| 225 |
+
* On a successful operation, the product user will be logged out as the external account used to authenticate the user was unlinked from the owning keychain.
|
| 226 |
+
*/
|
| 227 |
+
EOS_ProductUserId LocalUserId;
|
| 228 |
+
));
|
| 229 |
+
|
| 230 |
+
/**
|
| 231 |
+
* Output parameters for the EOS_Connect_UnlinkAccount Function.
|
| 232 |
+
*/
|
| 233 |
+
EOS_STRUCT(EOS_Connect_UnlinkAccountCallbackInfo, (
|
| 234 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 235 |
+
EOS_EResult ResultCode;
|
| 236 |
+
/** Context that was passed into EOS_Connect_UnlinkAccount. */
|
| 237 |
+
void* ClientData;
|
| 238 |
+
/**
|
| 239 |
+
* The product user that was subject for the unlinking operation.
|
| 240 |
+
*
|
| 241 |
+
* On a successful operation, the local authentication session for the product user will have been invalidated.
|
| 242 |
+
* As such, the LocalUserId value will no longer be valid in any context unless the user is logged into it again.
|
| 243 |
+
*/
|
| 244 |
+
EOS_ProductUserId LocalUserId;
|
| 245 |
+
));
|
| 246 |
+
|
| 247 |
+
/**
|
| 248 |
+
* Function prototype definition for callbacks passed to EOS_Connect_UnlinkAccount.
|
| 249 |
+
*
|
| 250 |
+
* @param Data A EOS_Connect_UnlinkAccountCallbackInfo containing the output information and result
|
| 251 |
+
*/
|
| 252 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnUnlinkAccountCallback, const EOS_Connect_UnlinkAccountCallbackInfo* Data);
|
| 253 |
+
|
| 254 |
+
/** The most recent version of the EOS_Connect_CreateDeviceId API. */
|
| 255 |
+
#define EOS_CONNECT_CREATEDEVICEID_API_LATEST 1
|
| 256 |
+
|
| 257 |
+
/** Max length of a device model name, not including the terminating null */
|
| 258 |
+
#define EOS_CONNECT_CREATEDEVICEID_DEVICEMODEL_MAX_LENGTH 64
|
| 259 |
+
|
| 260 |
+
/**
|
| 261 |
+
* Input parameters for the EOS_Connect_CreateDeviceId function.
|
| 262 |
+
*/
|
| 263 |
+
EOS_STRUCT(EOS_Connect_CreateDeviceIdOptions, (
|
| 264 |
+
/** API Version: Set this to EOS_CONNECT_CREATEDEVICEID_API_LATEST. */
|
| 265 |
+
int32_t ApiVersion;
|
| 266 |
+
/**
|
| 267 |
+
* A freeform text description identifying the device type and model,
|
| 268 |
+
* which can be used in account linking management to allow the player
|
| 269 |
+
* and customer support to identify different devices linked to an EOS
|
| 270 |
+
* user keychain. For example 'iPhone 6S' or 'PC Windows'.
|
| 271 |
+
*
|
| 272 |
+
* The input string must be in UTF-8 character format, with a maximum
|
| 273 |
+
* length of 64 characters. Longer string will be silently truncated.
|
| 274 |
+
*
|
| 275 |
+
* This field is required to be present.
|
| 276 |
+
*/
|
| 277 |
+
const char* DeviceModel;
|
| 278 |
+
));
|
| 279 |
+
|
| 280 |
+
/**
|
| 281 |
+
* Output parameters for the EOS_Connect_CreateDeviceId function.
|
| 282 |
+
*/
|
| 283 |
+
EOS_STRUCT(EOS_Connect_CreateDeviceIdCallbackInfo, (
|
| 284 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 285 |
+
EOS_EResult ResultCode;
|
| 286 |
+
/** Context that was passed into EOS_Connect_CreateDeviceId. */
|
| 287 |
+
void* ClientData;
|
| 288 |
+
));
|
| 289 |
+
|
| 290 |
+
/**
|
| 291 |
+
* Function prototype definition for callbacks passed to EOS_Connect_CreateDeviceId.
|
| 292 |
+
*
|
| 293 |
+
* @param Data A EOS_Connect_CreateDeviceIdCallbackInfo containing the output information and result.
|
| 294 |
+
*/
|
| 295 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnCreateDeviceIdCallback, const EOS_Connect_CreateDeviceIdCallbackInfo* Data);
|
| 296 |
+
|
| 297 |
+
/** The most recent version of the EOS_Connect_DeleteDeviceId API. */
|
| 298 |
+
#define EOS_CONNECT_DELETEDEVICEID_API_LATEST 1
|
| 299 |
+
|
| 300 |
+
/**
|
| 301 |
+
* Input parameters for the EOS_Connect_DeleteDeviceId function.
|
| 302 |
+
*/
|
| 303 |
+
EOS_STRUCT(EOS_Connect_DeleteDeviceIdOptions, (
|
| 304 |
+
/** API Version: Set this to EOS_CONNECT_DELETEDEVICEID_API_LATEST. */
|
| 305 |
+
int32_t ApiVersion;
|
| 306 |
+
));
|
| 307 |
+
|
| 308 |
+
/**
|
| 309 |
+
* Output parameters for the EOS_Connect_DeleteDeviceId function.
|
| 310 |
+
*/
|
| 311 |
+
EOS_STRUCT(EOS_Connect_DeleteDeviceIdCallbackInfo, (
|
| 312 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 313 |
+
EOS_EResult ResultCode;
|
| 314 |
+
/** Context that was passed into EOS_Connect_DeleteDeviceId */
|
| 315 |
+
void* ClientData;
|
| 316 |
+
));
|
| 317 |
+
|
| 318 |
+
/**
|
| 319 |
+
* Function prototype definition for callbacks passed to EOS_Connect_DeleteDeviceId.
|
| 320 |
+
*
|
| 321 |
+
* @param Data A EOS_Connect_DeleteDeviceIdCallbackInfo containing the output information and result.
|
| 322 |
+
*/
|
| 323 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnDeleteDeviceIdCallback, const EOS_Connect_DeleteDeviceIdCallbackInfo* Data);
|
| 324 |
+
|
| 325 |
+
/** The most recent version of the EOS_Connect_TransferDeviceIdAccount API. */
|
| 326 |
+
#define EOS_CONNECT_TRANSFERDEVICEIDACCOUNT_API_LATEST 1
|
| 327 |
+
|
| 328 |
+
/**
|
| 329 |
+
* Input parameters for the EOS_Connect_TransferDeviceIdAccount Function.
|
| 330 |
+
*/
|
| 331 |
+
EOS_STRUCT(EOS_Connect_TransferDeviceIdAccountOptions, (
|
| 332 |
+
/** API Version: Set this to EOS_CONNECT_TRANSFERDEVICEIDACCOUNT_API_LATEST. */
|
| 333 |
+
int32_t ApiVersion;
|
| 334 |
+
/**
|
| 335 |
+
* The primary product user id, currently logged in, that is already associated with a real external user account (such as Epic Games, PlayStation(TM)Network, Xbox Live and other).
|
| 336 |
+
*
|
| 337 |
+
* The account linking keychain that owns this product user will be preserved and receive
|
| 338 |
+
* the Device ID login credentials under it.
|
| 339 |
+
*/
|
| 340 |
+
EOS_ProductUserId PrimaryLocalUserId;
|
| 341 |
+
/**
|
| 342 |
+
* The product user id, currently logged in, that has been originally created using the anonymous local Device ID login type,
|
| 343 |
+
* and whose Device ID login will be transferred to the keychain of the PrimaryLocalUserId.
|
| 344 |
+
*/
|
| 345 |
+
EOS_ProductUserId LocalDeviceUserId;
|
| 346 |
+
/**
|
| 347 |
+
* Specifies which EOS_ProductUserId (i.e. game progression) will be preserved in the operation.
|
| 348 |
+
*
|
| 349 |
+
* After a successful transfer operation, subsequent logins using the same external account or
|
| 350 |
+
* the same local Device ID login will return user session for the ProductUserIdToPreserve.
|
| 351 |
+
*
|
| 352 |
+
* Set to either PrimaryLocalUserId or LocalDeviceUserId.
|
| 353 |
+
*/
|
| 354 |
+
EOS_ProductUserId ProductUserIdToPreserve;
|
| 355 |
+
));
|
| 356 |
+
|
| 357 |
+
/**
|
| 358 |
+
* Output parameters for the EOS_Connect_TransferDeviceIdAccount Function.
|
| 359 |
+
*/
|
| 360 |
+
EOS_STRUCT(EOS_Connect_TransferDeviceIdAccountCallbackInfo, (
|
| 361 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 362 |
+
EOS_EResult ResultCode;
|
| 363 |
+
/** Context that was passed into EOS_Connect_TransferDeviceIdAccount. */
|
| 364 |
+
void* ClientData;
|
| 365 |
+
/**
|
| 366 |
+
* The ProductUserIdToPreserve that was passed to the original EOS_Connect_TransferDeviceIdAccount call.
|
| 367 |
+
*
|
| 368 |
+
* On successful operation, this EOS_ProductUserId will have a valid authentication session
|
| 369 |
+
* and the other EOS_ProductUserId value has been discarded and lost forever.
|
| 370 |
+
*
|
| 371 |
+
* The application should remove any registered notification callbacks for the discarded EOS_ProductUserId as obsolete.
|
| 372 |
+
*/
|
| 373 |
+
EOS_ProductUserId LocalUserId;
|
| 374 |
+
));
|
| 375 |
+
|
| 376 |
+
/**
|
| 377 |
+
* Function prototype definition for callbacks passed to EOS_Connect_TransferDeviceIdAccount.
|
| 378 |
+
*
|
| 379 |
+
* @param Data A EOS_Connect_TransferDeviceIdAccountCallbackInfo containing the output information and result.
|
| 380 |
+
*/
|
| 381 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnTransferDeviceIdAccountCallback, const EOS_Connect_TransferDeviceIdAccountCallbackInfo* Data);
|
| 382 |
+
|
| 383 |
+
/** The most recent version of the EOS_Connect_QueryExternalAccountMappings API. */
|
| 384 |
+
#define EOS_CONNECT_QUERYEXTERNALACCOUNTMAPPINGS_API_LATEST 1
|
| 385 |
+
|
| 386 |
+
/** Maximum number of account IDs that can be queried at once */
|
| 387 |
+
#define EOS_CONNECT_QUERYEXTERNALACCOUNTMAPPINGS_MAX_ACCOUNT_IDS 128
|
| 388 |
+
|
| 389 |
+
/**
|
| 390 |
+
* Input parameters for the EOS_Connect_QueryExternalAccountMappings function.
|
| 391 |
+
*/
|
| 392 |
+
EOS_STRUCT(EOS_Connect_QueryExternalAccountMappingsOptions, (
|
| 393 |
+
/** API Version: Set this to EOS_CONNECT_QUERYEXTERNALACCOUNTMAPPINGS_API_LATEST. */
|
| 394 |
+
int32_t ApiVersion;
|
| 395 |
+
/** The Product User ID of the existing, logged-in user who is querying account mappings. */
|
| 396 |
+
EOS_ProductUserId LocalUserId;
|
| 397 |
+
/** External auth service supplying the account IDs in string form. */
|
| 398 |
+
EOS_EExternalAccountType AccountIdType;
|
| 399 |
+
/** An array of external account IDs to map to the product user ID representation. */
|
| 400 |
+
const char** ExternalAccountIds;
|
| 401 |
+
/** Number of account IDs to query. */
|
| 402 |
+
uint32_t ExternalAccountIdCount;
|
| 403 |
+
));
|
| 404 |
+
|
| 405 |
+
/**
|
| 406 |
+
* Output parameters for the EOS_Connect_QueryExternalAccountMappings function.
|
| 407 |
+
*/
|
| 408 |
+
EOS_STRUCT(EOS_Connect_QueryExternalAccountMappingsCallbackInfo, (
|
| 409 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 410 |
+
EOS_EResult ResultCode;
|
| 411 |
+
/** Context that was passed into EOS_Connect_QueryExternalAccountMappings. */
|
| 412 |
+
void* ClientData;
|
| 413 |
+
/** The Product User ID of the existing, logged-in user who made the request. */
|
| 414 |
+
EOS_ProductUserId LocalUserId;
|
| 415 |
+
));
|
| 416 |
+
|
| 417 |
+
/**
|
| 418 |
+
* Function prototype definition for callbacks passed to EOS_Connect_QueryExternalAccountMappings.
|
| 419 |
+
*
|
| 420 |
+
* @param Data A EOS_Connect_QueryExternalAccountMappingsCallbackInfo containing the output information and result.
|
| 421 |
+
*/
|
| 422 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnQueryExternalAccountMappingsCallback, const EOS_Connect_QueryExternalAccountMappingsCallbackInfo* Data);
|
| 423 |
+
|
| 424 |
+
/** The most recent version of the EOS_Connect_GetExternalAccountMapping API. */
|
| 425 |
+
#define EOS_CONNECT_GETEXTERNALACCOUNTMAPPING_API_LATEST 1
|
| 426 |
+
|
| 427 |
+
/** DEPRECATED! Use EOS_CONNECT_GETEXTERNALACCOUNTMAPPING_API_LATEST instead. */
|
| 428 |
+
#define EOS_CONNECT_GETEXTERNALACCOUNTMAPPINGS_API_LATEST EOS_CONNECT_GETEXTERNALACCOUNTMAPPING_API_LATEST
|
| 429 |
+
|
| 430 |
+
/**
|
| 431 |
+
* Input parameters for the EOS_Connect_GetExternalAccountMapping function.
|
| 432 |
+
*/
|
| 433 |
+
EOS_STRUCT(EOS_Connect_GetExternalAccountMappingsOptions, (
|
| 434 |
+
/** API Version: Set this to EOS_CONNECT_GETEXTERNALACCOUNTMAPPING_API_LATEST. */
|
| 435 |
+
int32_t ApiVersion;
|
| 436 |
+
/** The Product User ID of the existing, logged-in user who is querying account mappings. */
|
| 437 |
+
EOS_ProductUserId LocalUserId;
|
| 438 |
+
/** External auth service supplying the account IDs in string form. */
|
| 439 |
+
EOS_EExternalAccountType AccountIdType;
|
| 440 |
+
/** Target user to retrieve the mapping for, as an external account ID. */
|
| 441 |
+
const char* TargetExternalUserId;
|
| 442 |
+
));
|
| 443 |
+
|
| 444 |
+
/** The most recent version of the EOS_Connect_QueryProductUserIdMappings API. */
|
| 445 |
+
#define EOS_CONNECT_QUERYPRODUCTUSERIDMAPPINGS_API_LATEST 2
|
| 446 |
+
|
| 447 |
+
/**
|
| 448 |
+
* Input parameters for the EOS_Connect_QueryProductUserIdMappings function.
|
| 449 |
+
*/
|
| 450 |
+
EOS_STRUCT(EOS_Connect_QueryProductUserIdMappingsOptions, (
|
| 451 |
+
/** API Version: Set this to EOS_CONNECT_QUERYPRODUCTUSERIDMAPPINGS_API_LATEST. */
|
| 452 |
+
int32_t ApiVersion;
|
| 453 |
+
/**
|
| 454 |
+
* Game Clients set this field to the Product User ID of the local authenticated user querying account mappings.
|
| 455 |
+
* Game Servers set this field to NULL. Usage is allowed given that the configured client policy for server credentials permit it.
|
| 456 |
+
*/
|
| 457 |
+
EOS_ProductUserId LocalUserId;
|
| 458 |
+
/** Deprecated - all external mappings are included in this call, it is no longer necessary to specify this value. */
|
| 459 |
+
EOS_EExternalAccountType AccountIdType_DEPRECATED;
|
| 460 |
+
/** An array of Product User IDs to query for the given external account representation. */
|
| 461 |
+
EOS_ProductUserId* ProductUserIds;
|
| 462 |
+
/** Number of Product User IDs to query. */
|
| 463 |
+
uint32_t ProductUserIdCount;
|
| 464 |
+
));
|
| 465 |
+
|
| 466 |
+
/**
|
| 467 |
+
* Output parameters for the EOS_Connect_QueryProductUserIdMappings function.
|
| 468 |
+
*/
|
| 469 |
+
EOS_STRUCT(EOS_Connect_QueryProductUserIdMappingsCallbackInfo, (
|
| 470 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 471 |
+
EOS_EResult ResultCode;
|
| 472 |
+
/** Context that was passed into EOS_Connect_QueryProductUserIdMappings. */
|
| 473 |
+
void* ClientData;
|
| 474 |
+
/** The local Product User ID that was passed with the input options. */
|
| 475 |
+
EOS_ProductUserId LocalUserId;
|
| 476 |
+
));
|
| 477 |
+
|
| 478 |
+
/**
|
| 479 |
+
* Function prototype definition for callbacks passed to EOS_Connect_QueryProductUserIdMappings.
|
| 480 |
+
*
|
| 481 |
+
* @param Data A EOS_Connect_QueryProductUserIdMappingsCallbackInfo containing the output information and result.
|
| 482 |
+
*/
|
| 483 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnQueryProductUserIdMappingsCallback, const EOS_Connect_QueryProductUserIdMappingsCallbackInfo* Data);
|
| 484 |
+
|
| 485 |
+
/** The most recent version of the EOS_Connect_GetProductUserIdMapping API. */
|
| 486 |
+
#define EOS_CONNECT_GETPRODUCTUSERIDMAPPING_API_LATEST 1
|
| 487 |
+
|
| 488 |
+
/**
|
| 489 |
+
* Input parameters for the EOS_Connect_GetProductUserIdMapping function.
|
| 490 |
+
*/
|
| 491 |
+
EOS_STRUCT(EOS_Connect_GetProductUserIdMappingOptions, (
|
| 492 |
+
/** API Version: Set this to EOS_CONNECT_GETPRODUCTUSERIDMAPPING_API_LATEST. */
|
| 493 |
+
int32_t ApiVersion;
|
| 494 |
+
/** The Product User ID of the existing, logged-in user that is querying account mappings. */
|
| 495 |
+
EOS_ProductUserId LocalUserId;
|
| 496 |
+
/** External auth service mapping to retrieve. */
|
| 497 |
+
EOS_EExternalAccountType AccountIdType;
|
| 498 |
+
/** The Product User ID of the user whose information is being requested. */
|
| 499 |
+
EOS_ProductUserId TargetProductUserId;
|
| 500 |
+
));
|
| 501 |
+
|
| 502 |
+
/** The most recent version of the EOS_Connect_GetProductUserExternalAccountCount API. */
|
| 503 |
+
#define EOS_CONNECT_GETPRODUCTUSEREXTERNALACCOUNTCOUNT_API_LATEST 1
|
| 504 |
+
|
| 505 |
+
/**
|
| 506 |
+
* Input parameters for the EOS_Connect_GetProductUserExternalAccountCount function.
|
| 507 |
+
*/
|
| 508 |
+
EOS_STRUCT(EOS_Connect_GetProductUserExternalAccountCountOptions, (
|
| 509 |
+
/** API Version: Set this to EOS_CONNECT_GETPRODUCTUSEREXTERNALACCOUNTCOUNT_API_LATEST. */
|
| 510 |
+
int32_t ApiVersion;
|
| 511 |
+
/** The Product User ID to look for when getting external account info count from the cache. */
|
| 512 |
+
EOS_ProductUserId TargetUserId;
|
| 513 |
+
));
|
| 514 |
+
|
| 515 |
+
/** The most recent version of the EOS_Connect_CopyProductUserExternalAccountByIndex API. */
|
| 516 |
+
#define EOS_CONNECT_COPYPRODUCTUSEREXTERNALACCOUNTBYINDEX_API_LATEST 1
|
| 517 |
+
|
| 518 |
+
/**
|
| 519 |
+
* Input parameters for the EOS_Connect_CopyProductUserExternalAccountByIndex function.
|
| 520 |
+
*/
|
| 521 |
+
EOS_STRUCT(EOS_Connect_CopyProductUserExternalAccountByIndexOptions, (
|
| 522 |
+
/** API Version: Set this to EOS_CONNECT_COPYPRODUCTUSEREXTERNALACCOUNTBYINDEX_API_LATEST. */
|
| 523 |
+
int32_t ApiVersion;
|
| 524 |
+
/** The Product User ID to look for when copying external account info from the cache. */
|
| 525 |
+
EOS_ProductUserId TargetUserId;
|
| 526 |
+
/** Index of the external account info to retrieve from the cache. */
|
| 527 |
+
uint32_t ExternalAccountInfoIndex;
|
| 528 |
+
));
|
| 529 |
+
|
| 530 |
+
/** The most recent version of the EOS_Connect_CopyProductUserExternalAccountByAccountType API. */
|
| 531 |
+
#define EOS_CONNECT_COPYPRODUCTUSEREXTERNALACCOUNTBYACCOUNTTYPE_API_LATEST 1
|
| 532 |
+
|
| 533 |
+
/**
|
| 534 |
+
* Input parameters for the EOS_Connect_CopyProductUserExternalAccountByAccountType function.
|
| 535 |
+
*/
|
| 536 |
+
EOS_STRUCT(EOS_Connect_CopyProductUserExternalAccountByAccountTypeOptions, (
|
| 537 |
+
/** API Version: Set this to EOS_CONNECT_COPYPRODUCTUSEREXTERNALACCOUNTBYACCOUNTTYPE_API_LATEST. */
|
| 538 |
+
int32_t ApiVersion;
|
| 539 |
+
/** The Product User ID to look for when copying external account info from the cache. */
|
| 540 |
+
EOS_ProductUserId TargetUserId;
|
| 541 |
+
/** External auth service account type to look for when copying external account info from the cache. */
|
| 542 |
+
EOS_EExternalAccountType AccountIdType;
|
| 543 |
+
));
|
| 544 |
+
|
| 545 |
+
/** The most recent version of the EOS_Connect_CopyProductUserExternalAccountByAccountId API. */
|
| 546 |
+
#define EOS_CONNECT_COPYPRODUCTUSEREXTERNALACCOUNTBYACCOUNTID_API_LATEST 1
|
| 547 |
+
|
| 548 |
+
/**
|
| 549 |
+
* Input parameters for the EOS_Connect_CopyProductUserExternalAccountByAccountId function.
|
| 550 |
+
*/
|
| 551 |
+
EOS_STRUCT(EOS_Connect_CopyProductUserExternalAccountByAccountIdOptions, (
|
| 552 |
+
/** API Version: Set this to EOS_CONNECT_COPYPRODUCTUSEREXTERNALACCOUNTBYACCOUNTID_API_LATEST. */
|
| 553 |
+
int32_t ApiVersion;
|
| 554 |
+
/** The Product User ID to look for when copying external account info from the cache. */
|
| 555 |
+
EOS_ProductUserId TargetUserId;
|
| 556 |
+
/** External auth service account ID to look for when copying external account info from the cache. */
|
| 557 |
+
const char* AccountId;
|
| 558 |
+
));
|
| 559 |
+
|
| 560 |
+
/** The most recent version of the EOS_Connect_CopyProductUserInfo API. */
|
| 561 |
+
#define EOS_CONNECT_COPYPRODUCTUSERINFO_API_LATEST 1
|
| 562 |
+
|
| 563 |
+
/**
|
| 564 |
+
* Input parameters for the EOS_Connect_CopyProductUserInfo function.
|
| 565 |
+
*/
|
| 566 |
+
EOS_STRUCT(EOS_Connect_CopyProductUserInfoOptions, (
|
| 567 |
+
/** API Version: Set this to EOS_CONNECT_COPYPRODUCTUSERINFO_API_LATEST. */
|
| 568 |
+
int32_t ApiVersion;
|
| 569 |
+
/** Product user ID to look for when copying external account info from the cache. */
|
| 570 |
+
EOS_ProductUserId TargetUserId;
|
| 571 |
+
));
|
| 572 |
+
|
| 573 |
+
/** Timestamp value representing an undefined time for last login time. */
|
| 574 |
+
#define EOS_CONNECT_TIME_UNDEFINED -1
|
| 575 |
+
|
| 576 |
+
/** The most recent version of the EOS_Connect_ExternalAccountInfo struct. */
|
| 577 |
+
#define EOS_CONNECT_EXTERNALACCOUNTINFO_API_LATEST 1
|
| 578 |
+
|
| 579 |
+
/**
|
| 580 |
+
* Contains information about an external account linked with a Product User ID.
|
| 581 |
+
*/
|
| 582 |
+
EOS_STRUCT(EOS_Connect_ExternalAccountInfo, (
|
| 583 |
+
/** API Version: Set this to EOS_CONNECT_EXTERNALACCOUNTINFO_API_LATEST. */
|
| 584 |
+
int32_t ApiVersion;
|
| 585 |
+
/** The Product User ID of the target user. */
|
| 586 |
+
EOS_ProductUserId ProductUserId;
|
| 587 |
+
/** Display name, can be null if not set. */
|
| 588 |
+
const char* DisplayName;
|
| 589 |
+
/**
|
| 590 |
+
* External account ID.
|
| 591 |
+
*
|
| 592 |
+
* May be set to an empty string if the AccountIdType of another user belongs
|
| 593 |
+
* to different account system than the local user's authenticated account.
|
| 594 |
+
* The availability of this field is dependent on account system specifics.
|
| 595 |
+
*/
|
| 596 |
+
const char* AccountId;
|
| 597 |
+
/** The identity provider that owns the external account. */
|
| 598 |
+
EOS_EExternalAccountType AccountIdType;
|
| 599 |
+
/** The POSIX timestamp for the time the user last logged in, or EOS_CONNECT_TIME_UNDEFINED. */
|
| 600 |
+
int64_t LastLoginTime;
|
| 601 |
+
));
|
| 602 |
+
|
| 603 |
+
/**
|
| 604 |
+
* Release the memory associated with an external account info. This must be called on data retrieved from
|
| 605 |
+
* EOS_Connect_CopyProductUserExternalAccountByIndex, EOS_Connect_CopyProductUserExternalAccountByAccountType,
|
| 606 |
+
* EOS_Connect_CopyProductUserExternalAccountByAccountId or EOS_Connect_CopyProductUserInfo.
|
| 607 |
+
*
|
| 608 |
+
* @param ExternalAccountInfo The external account info data to release.
|
| 609 |
+
*
|
| 610 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByIndex
|
| 611 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByAccountType
|
| 612 |
+
* @see EOS_Connect_CopyProductUserExternalAccountByAccountId
|
| 613 |
+
* @see EOS_Connect_CopyProductUserInfo
|
| 614 |
+
*/
|
| 615 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_ExternalAccountInfo_Release(EOS_Connect_ExternalAccountInfo* ExternalAccountInfo);
|
| 616 |
+
|
| 617 |
+
/** The most recent version of the EOS_Connect_AddNotifyAuthExpiration API. */
|
| 618 |
+
#define EOS_CONNECT_ADDNOTIFYAUTHEXPIRATION_API_LATEST 1
|
| 619 |
+
/**
|
| 620 |
+
* Structure containing information for the auth expiration notification callback.
|
| 621 |
+
*/
|
| 622 |
+
EOS_STRUCT(EOS_Connect_AddNotifyAuthExpirationOptions, (
|
| 623 |
+
/** API Version: Set this to EOS_CONNECT_ADDNOTIFYAUTHEXPIRATION_API_LATEST. */
|
| 624 |
+
int32_t ApiVersion;
|
| 625 |
+
));
|
| 626 |
+
|
| 627 |
+
/**
|
| 628 |
+
* Output parameters for the EOS_Connect_OnAuthExpirationCallback function.
|
| 629 |
+
*/
|
| 630 |
+
EOS_STRUCT(EOS_Connect_AuthExpirationCallbackInfo, (
|
| 631 |
+
/** Context that was passed into EOS_Connect_AddNotifyAuthExpiration. */
|
| 632 |
+
void* ClientData;
|
| 633 |
+
/** The Product User ID of the local player whose status has changed. */
|
| 634 |
+
EOS_ProductUserId LocalUserId;
|
| 635 |
+
));
|
| 636 |
+
|
| 637 |
+
/**
|
| 638 |
+
* Function prototype definition for notifications that come from EOS_Connect_AddNotifyAuthExpiration.
|
| 639 |
+
*
|
| 640 |
+
* @param Data A EOS_Connect_AuthExpirationCallbackInfo containing the output information and result.
|
| 641 |
+
*/
|
| 642 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnAuthExpirationCallback, const EOS_Connect_AuthExpirationCallbackInfo* Data);
|
| 643 |
+
|
| 644 |
+
|
| 645 |
+
/** The most recent version of the EOS_Connect_AddNotifyLoginStatusChanged API. */
|
| 646 |
+
#define EOS_CONNECT_ADDNOTIFYLOGINSTATUSCHANGED_API_LATEST 1
|
| 647 |
+
/**
|
| 648 |
+
* Structure containing information or the connect user login status change callback.
|
| 649 |
+
*/
|
| 650 |
+
EOS_STRUCT(EOS_Connect_AddNotifyLoginStatusChangedOptions, (
|
| 651 |
+
/** API Version: Set this to EOS_CONNECT_ADDNOTIFYLOGINSTATUSCHANGED_API_LATEST. */
|
| 652 |
+
int32_t ApiVersion;
|
| 653 |
+
));
|
| 654 |
+
|
| 655 |
+
/**
|
| 656 |
+
* Output parameters for the EOS_Connect_OnLoginStatusChangedCallback function.
|
| 657 |
+
*/
|
| 658 |
+
EOS_STRUCT(EOS_Connect_LoginStatusChangedCallbackInfo, (
|
| 659 |
+
/** Context that was passed into EOS_Connect_AddNotifyLoginStatusChanged. */
|
| 660 |
+
void* ClientData;
|
| 661 |
+
/** The Product User ID of the local player whose status has changed. */
|
| 662 |
+
EOS_ProductUserId LocalUserId;
|
| 663 |
+
/** The status prior to the change. */
|
| 664 |
+
EOS_ELoginStatus PreviousStatus;
|
| 665 |
+
/** The status at the time of the notification. */
|
| 666 |
+
EOS_ELoginStatus CurrentStatus;
|
| 667 |
+
));
|
| 668 |
+
|
| 669 |
+
/**
|
| 670 |
+
* Function prototype definition for notifications that come from EOS_Connect_AddNotifyLoginStatusChanged.
|
| 671 |
+
*
|
| 672 |
+
* @param Data A EOS_Connect_LoginStatusChangedCallbackInfo containing the output information and result.
|
| 673 |
+
*/
|
| 674 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnLoginStatusChangedCallback, const EOS_Connect_LoginStatusChangedCallbackInfo* Data);
|
| 675 |
+
|
| 676 |
+
/** The most recent version of the EOS_Connect_IdToken struct. */
|
| 677 |
+
#define EOS_CONNECT_IDTOKEN_API_LATEST 1
|
| 678 |
+
|
| 679 |
+
/**
|
| 680 |
+
* A structure that contains an ID token.
|
| 681 |
+
* These structures are created by EOS_Connect_CopyIdToken and must be passed to EOS_Connect_IdToken_Release.
|
| 682 |
+
*/
|
| 683 |
+
EOS_STRUCT(EOS_Connect_IdToken, (
|
| 684 |
+
/** API Version: Set this to EOS_CONNECT_IDTOKEN_API_LATEST. */
|
| 685 |
+
int32_t ApiVersion;
|
| 686 |
+
/**
|
| 687 |
+
* The Product User ID described by the ID token.
|
| 688 |
+
* Use EOS_ProductUserId_FromString to populate this field when validating a received ID token.
|
| 689 |
+
*/
|
| 690 |
+
EOS_ProductUserId ProductUserId;
|
| 691 |
+
/** The ID token as a Json Web Token (JWT) string. */
|
| 692 |
+
const char* JsonWebToken;
|
| 693 |
+
));
|
| 694 |
+
|
| 695 |
+
/**
|
| 696 |
+
* Release the memory associated with an EOS_Connect_IdToken structure. This must be called on data retrieved from EOS_Connect_CopyIdToken.
|
| 697 |
+
*
|
| 698 |
+
* @param IdToken The ID token structure to be released.
|
| 699 |
+
*
|
| 700 |
+
* @see EOS_Connect_IdToken
|
| 701 |
+
* @see EOS_Connect_CopyIdToken
|
| 702 |
+
*/
|
| 703 |
+
EOS_DECLARE_FUNC(void) EOS_Connect_IdToken_Release(EOS_Connect_IdToken* IdToken);
|
| 704 |
+
|
| 705 |
+
/** The most recent version of the EOS_Connect_CopyIdToken API. */
|
| 706 |
+
#define EOS_CONNECT_COPYIDTOKEN_API_LATEST 1
|
| 707 |
+
|
| 708 |
+
/**
|
| 709 |
+
* Input parameters for the EOS_Connect_CopyIdToken function.
|
| 710 |
+
*/
|
| 711 |
+
EOS_STRUCT(EOS_Connect_CopyIdTokenOptions, (
|
| 712 |
+
/** API Version: Set this to EOS_CONNECT_COPYIDTOKEN_API_LATEST. */
|
| 713 |
+
int32_t ApiVersion;
|
| 714 |
+
/** The local Product User ID whose ID token should be copied. */
|
| 715 |
+
EOS_ProductUserId LocalUserId;
|
| 716 |
+
));
|
| 717 |
+
|
| 718 |
+
/** The most recent version of the EOS_Connect_VerifyIdToken API. */
|
| 719 |
+
#define EOS_CONNECT_VERIFYIDTOKEN_API_LATEST 1
|
| 720 |
+
|
| 721 |
+
/**
|
| 722 |
+
* Input parameters for the EOS_Connect_VerifyIdToken function.
|
| 723 |
+
*/
|
| 724 |
+
EOS_STRUCT(EOS_Connect_VerifyIdTokenOptions, (
|
| 725 |
+
/** API Version: Set this to EOS_CONNECT_VERIFYIDTOKEN_API_LATEST. */
|
| 726 |
+
int32_t ApiVersion;
|
| 727 |
+
/**
|
| 728 |
+
* The ID token to verify.
|
| 729 |
+
* Use EOS_ProductUserId_FromString to populate the ProductUserId field of this struct.
|
| 730 |
+
*/
|
| 731 |
+
const EOS_Connect_IdToken* IdToken;
|
| 732 |
+
));
|
| 733 |
+
|
| 734 |
+
/**
|
| 735 |
+
* Output parameters for the EOS_Connect_VerifyIdToken Function.
|
| 736 |
+
*/
|
| 737 |
+
EOS_STRUCT(EOS_Connect_VerifyIdTokenCallbackInfo, (
|
| 738 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 739 |
+
EOS_EResult ResultCode;
|
| 740 |
+
/** Context that was passed into EOS_Connect_VerifyIdToken */
|
| 741 |
+
void* ClientData;
|
| 742 |
+
/** The Product User ID associated with the ID token. */
|
| 743 |
+
EOS_ProductUserId ProductUserId;
|
| 744 |
+
/**
|
| 745 |
+
* Flag set to indicate whether account information is available.
|
| 746 |
+
* Applications must always first check this value to be set before attempting
|
| 747 |
+
* to read the AccountType, AccountId, Platform and DeviceType fields.
|
| 748 |
+
*
|
| 749 |
+
* This flag is always false for users that authenticated using EOS Connect Device ID.
|
| 750 |
+
*/
|
| 751 |
+
EOS_Bool bIsAccountInfoPresent;
|
| 752 |
+
/**
|
| 753 |
+
* The identity provider that the user authenticated with to EOS Connect.
|
| 754 |
+
*
|
| 755 |
+
* If bIsAccountInfoPresent is set, this field describes the external account type.
|
| 756 |
+
*/
|
| 757 |
+
EOS_EExternalAccountType AccountIdType;
|
| 758 |
+
/**
|
| 759 |
+
* The external account ID of the authenticated user.
|
| 760 |
+
*
|
| 761 |
+
* This value may be set to an empty string.
|
| 762 |
+
*/
|
| 763 |
+
const char* AccountId;
|
| 764 |
+
/**
|
| 765 |
+
* Platform that the user is connected from.
|
| 766 |
+
*
|
| 767 |
+
* This value may be set to an empty string.
|
| 768 |
+
*/
|
| 769 |
+
const char* Platform;
|
| 770 |
+
/**
|
| 771 |
+
* Identifies the device type that the user is connected from.
|
| 772 |
+
* Can be used to securely verify that the user is connected through a real Console device.
|
| 773 |
+
*
|
| 774 |
+
* This value may be set to an empty string.
|
| 775 |
+
*/
|
| 776 |
+
const char* DeviceType;
|
| 777 |
+
/**
|
| 778 |
+
* Client ID of the authorized client.
|
| 779 |
+
*/
|
| 780 |
+
const char* ClientId;
|
| 781 |
+
/**
|
| 782 |
+
* Product ID.
|
| 783 |
+
*/
|
| 784 |
+
const char* ProductId;
|
| 785 |
+
/**
|
| 786 |
+
* Sandbox ID.
|
| 787 |
+
*/
|
| 788 |
+
const char* SandboxId;
|
| 789 |
+
/**
|
| 790 |
+
* Deployment ID.
|
| 791 |
+
*/
|
| 792 |
+
const char* DeploymentId;
|
| 793 |
+
));
|
| 794 |
+
|
| 795 |
+
/**
|
| 796 |
+
* Function prototype definition for callbacks passed into EOS_Connect_VerifyIdToken.
|
| 797 |
+
*
|
| 798 |
+
* @param Data A EOS_Connect_VerifyIdTokenCallbackInfo containing the output information and result.
|
| 799 |
+
*/
|
| 800 |
+
EOS_DECLARE_CALLBACK(EOS_Connect_OnVerifyIdTokenCallback, const EOS_Connect_VerifyIdTokenCallbackInfo* Data);
|
| 801 |
+
|
| 802 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_custominvites.h
ADDED
|
@@ -0,0 +1,314 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_custominvites_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Custom Invites Interface is designed to allow developers to have custom game Invite and Join operations driven by the Notification Service and supported by the Overlay (if desired).
|
| 8 |
+
* All Custom Invites Interface calls take a handle of type EOS_HCustomInvites as the first parameter.
|
| 9 |
+
* This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetCustomInvitesInterface function.
|
| 10 |
+
*
|
| 11 |
+
* @see EOS_Platform_GetCustomInvitesInterface
|
| 12 |
+
*/
|
| 13 |
+
|
| 14 |
+
/**
|
| 15 |
+
* Initializes a Custom Invite with a specified payload in preparation for it to be sent to another user or users.
|
| 16 |
+
*
|
| 17 |
+
* @param Options Structure containing information about the request.
|
| 18 |
+
*
|
| 19 |
+
* @return EOS_EResult containing the result of the operation.
|
| 20 |
+
* Possible result codes:
|
| 21 |
+
* - EOS_Success if the operation completes successfully
|
| 22 |
+
* - EOS_InvalidParameters if any of the options values are incorrect
|
| 23 |
+
*/
|
| 24 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_CustomInvites_SetCustomInvite(EOS_HCustomInvites Handle, const EOS_CustomInvites_SetCustomInviteOptions* Options);
|
| 25 |
+
|
| 26 |
+
/**
|
| 27 |
+
* Sends a Custom Invite that has previously been initialized via SetCustomInvite to a group of users.
|
| 28 |
+
*
|
| 29 |
+
* @param Options Structure containing information about the request.
|
| 30 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 31 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 32 |
+
*
|
| 33 |
+
* @see EOS_CustomInvites_SendCustomInviteOptions
|
| 34 |
+
* @see EOS_CustomInvites_OnSendCustomInviteCallback
|
| 35 |
+
*
|
| 36 |
+
* @return EOS_EResult containing the result of the operation.
|
| 37 |
+
* Possible result codes:
|
| 38 |
+
* - EOS_Success if the query completes successfully
|
| 39 |
+
* - EOS_InvalidParameters if any of the options values are incorrect
|
| 40 |
+
* - EOS_TooManyRequests if the number of allowed queries is exceeded
|
| 41 |
+
* - EOS_NotFound if SetCustomInvite has not been previously successfully called for this user
|
| 42 |
+
*/
|
| 43 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_SendCustomInvite(EOS_HCustomInvites Handle, const EOS_CustomInvites_SendCustomInviteOptions* Options, void* ClientData, const EOS_CustomInvites_OnSendCustomInviteCallback CompletionDelegate);
|
| 44 |
+
|
| 45 |
+
/**
|
| 46 |
+
* Register to receive notifications when a Custom Invite for any logged in local user is received
|
| 47 |
+
* @note If the returned NotificationId is valid, you must call EOS_CustomInvites_RemoveNotifyCustomInviteReceived when you no longer wish to have your NotificationHandler called.
|
| 48 |
+
*
|
| 49 |
+
* @param Options Structure containing information about the request.
|
| 50 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 51 |
+
* @param NotificationFn A callback that is fired when a Custom Invite is received.
|
| 52 |
+
*
|
| 53 |
+
* @see EOS_CustomInvites_AddNotifyCustomInviteReceivedOptions
|
| 54 |
+
* @see EOS_CustomInvites_OnCustomInviteReceivedCallback
|
| 55 |
+
*
|
| 56 |
+
* @return handle representing the registered callback
|
| 57 |
+
*/
|
| 58 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_CustomInvites_AddNotifyCustomInviteReceived(EOS_HCustomInvites Handle, const EOS_CustomInvites_AddNotifyCustomInviteReceivedOptions* Options, void* ClientData, const EOS_CustomInvites_OnCustomInviteReceivedCallback NotificationFn);
|
| 59 |
+
|
| 60 |
+
/**
|
| 61 |
+
* Unregister from receiving notifications when a Custom Invite for any logged in local user is received
|
| 62 |
+
*
|
| 63 |
+
* @param InId Handle representing the registered callback
|
| 64 |
+
*/
|
| 65 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RemoveNotifyCustomInviteReceived(EOS_HCustomInvites Handle, EOS_NotificationId InId);
|
| 66 |
+
|
| 67 |
+
/**
|
| 68 |
+
* Register to receive notifications when a Custom Invite for any logged in local user is accepted via the Social Overlay
|
| 69 |
+
* Invites accepted in this way still need to have FinalizeInvite called on them after you have finished processing the invite accept (e.g. after joining the game)
|
| 70 |
+
* @note If the returned NotificationId is valid, you must call EOS_CustomInvites_RemoveNotifyCustomInviteAccepted when you no longer wish to have your NotificationHandler called.
|
| 71 |
+
*
|
| 72 |
+
* @param Options Structure containing information about the request.
|
| 73 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 74 |
+
* @param NotificationFn A callback that is fired when a Custom Invite is accepted via the Social Overlay.
|
| 75 |
+
*
|
| 76 |
+
* @see EOS_CustomInvites_AddNotifyCustomInviteAcceptedOptions
|
| 77 |
+
* @see EOS_CustomInvites_OnCustomInviteAcceptedCallback
|
| 78 |
+
*
|
| 79 |
+
* @return handle representing the registered callback
|
| 80 |
+
*/
|
| 81 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_CustomInvites_AddNotifyCustomInviteAccepted(EOS_HCustomInvites Handle, const EOS_CustomInvites_AddNotifyCustomInviteAcceptedOptions* Options, void* ClientData, const EOS_CustomInvites_OnCustomInviteAcceptedCallback NotificationFn);
|
| 82 |
+
|
| 83 |
+
/**
|
| 84 |
+
* Unregister from receiving notifications when a Custom Invite for any logged in local user is accepted via the Social Overlay
|
| 85 |
+
*
|
| 86 |
+
* @param InId Handle representing the registered callback
|
| 87 |
+
*/
|
| 88 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RemoveNotifyCustomInviteAccepted(EOS_HCustomInvites Handle, EOS_NotificationId InId);
|
| 89 |
+
|
| 90 |
+
/**
|
| 91 |
+
* Register to receive notifications when a Custom Invite for any logged in local user is rejected via the Social Overlay
|
| 92 |
+
* Invites rejected in this way do not need to have FinalizeInvite called on them, it is called automatically internally by the SDK.
|
| 93 |
+
* @note If the returned NotificationId is valid, you must call EOS_CustomInvites_RemoveNotifyCustomInviteRejected when you no longer wish to have your NotificationHandler called.
|
| 94 |
+
*
|
| 95 |
+
* @param Options Structure containing information about the request.
|
| 96 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 97 |
+
* @param NotificationFn A callback that is fired when a Custom Invite is rejected via the Social Overlay.
|
| 98 |
+
*
|
| 99 |
+
* @see EOS_CustomInvites_AddNotifyCustomInviteRejectedOptions
|
| 100 |
+
* @see EOS_CustomInvites_OnCustomInviteRejectedCallback
|
| 101 |
+
*
|
| 102 |
+
* @return handle representing the registered callback
|
| 103 |
+
*/
|
| 104 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_CustomInvites_AddNotifyCustomInviteRejected(EOS_HCustomInvites Handle, const EOS_CustomInvites_AddNotifyCustomInviteRejectedOptions* Options, void* ClientData, const EOS_CustomInvites_OnCustomInviteRejectedCallback NotificationFn);
|
| 105 |
+
|
| 106 |
+
/**
|
| 107 |
+
* Unregister from receiving notifications when a Custom Invite for any logged in local user is rejected via the Social Overlay
|
| 108 |
+
*
|
| 109 |
+
* @param InId Handle representing the registered callback
|
| 110 |
+
*/
|
| 111 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RemoveNotifyCustomInviteRejected(EOS_HCustomInvites Handle, EOS_NotificationId InId);
|
| 112 |
+
|
| 113 |
+
/**
|
| 114 |
+
* Signal that the title has completed processing a received Custom Invite, and that it should be cleaned up internally and in the Overlay
|
| 115 |
+
*
|
| 116 |
+
* @param Options Structure containing information about the request.
|
| 117 |
+
*
|
| 118 |
+
* @see EOS_CustomInvites_FinalizeInviteOptions
|
| 119 |
+
*
|
| 120 |
+
* @return EOS_EResult containing the result of the operation.
|
| 121 |
+
* Possible result codes:
|
| 122 |
+
* - EOS_Success if the operation completes successfully
|
| 123 |
+
* - EOS_InvalidParameters if any of the option values are incorrect
|
| 124 |
+
*/
|
| 125 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_CustomInvites_FinalizeInvite(EOS_HCustomInvites Handle, const EOS_CustomInvites_FinalizeInviteOptions* Options);
|
| 126 |
+
|
| 127 |
+
/**
|
| 128 |
+
* Request that another user send an invitation.
|
| 129 |
+
*
|
| 130 |
+
* @param Options Structure containing information about the request.
|
| 131 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 132 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 133 |
+
*
|
| 134 |
+
* @see EOS_CustomInvites_SendRequestToJoinOptions
|
| 135 |
+
* @see EOS_CustomInvites_OnSendRequestToJoinCallback
|
| 136 |
+
*
|
| 137 |
+
* @return EOS_EResult containing the result of the operation.
|
| 138 |
+
* Possible result codes:
|
| 139 |
+
* - EOS_Success if the query completes successfully
|
| 140 |
+
* - EOS_InvalidParameters if any of the options values are incorrect
|
| 141 |
+
*/
|
| 142 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_SendRequestToJoin(EOS_HCustomInvites Handle, const EOS_CustomInvites_SendRequestToJoinOptions* Options, void* ClientData, const EOS_CustomInvites_OnSendRequestToJoinCallback CompletionDelegate);
|
| 143 |
+
|
| 144 |
+
/**
|
| 145 |
+
* Register to receive notifications when a request to join is responded to by a target user. Note that there is no guarantee a response will be received for every request to join.
|
| 146 |
+
* A player is free to ignore a Request to Join until it expires at which point it will be deleted without sending a response.
|
| 147 |
+
* @note If the returned NotificationId is valid, you must call EOS_CustomInvites_RemoveNotifyRequestToJoinResponseReceived when you no longer wish to have your NotificationHandler called.
|
| 148 |
+
*
|
| 149 |
+
* @param Options Structure containing information about the request.
|
| 150 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 151 |
+
* @param NotificationFn A callback that is fired when a response is received for an invite request.
|
| 152 |
+
*
|
| 153 |
+
* @see EOS_CustomInvites_AddNotifyRequestToJoinResponseReceivedOptions
|
| 154 |
+
* @see EOS_CustomInvites_OnRequestToJoinResponseReceivedCallback
|
| 155 |
+
*
|
| 156 |
+
* @return handle representing the registered callback
|
| 157 |
+
*/
|
| 158 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_CustomInvites_AddNotifyRequestToJoinResponseReceived(EOS_HCustomInvites Handle, const EOS_CustomInvites_AddNotifyRequestToJoinResponseReceivedOptions* Options, void* ClientData, const EOS_CustomInvites_OnRequestToJoinResponseReceivedCallback NotificationFn);
|
| 159 |
+
|
| 160 |
+
/**
|
| 161 |
+
* Unregister from receiving notifications when a request to join for any logged in local user is received
|
| 162 |
+
*
|
| 163 |
+
* @param InId Handle representing the registered callback
|
| 164 |
+
*/
|
| 165 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RemoveNotifyRequestToJoinResponseReceived(EOS_HCustomInvites Handle, EOS_NotificationId InId);
|
| 166 |
+
|
| 167 |
+
/**
|
| 168 |
+
* Register to receive notifications when a request to join is received for a local user
|
| 169 |
+
* @note If the returned NotificationId is valid, you must call EOS_CustomInvites_RemoveNotifyRequestToJoinReceived when you no longer wish to have your NotificationHandler called.
|
| 170 |
+
*
|
| 171 |
+
* @param Options Structure containing information about the request.
|
| 172 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 173 |
+
* @param NotificationFn A callback that is fired when a response is received for an invite request.
|
| 174 |
+
*
|
| 175 |
+
* @see EOS_CustomInvites_AddNotifyRequestToJoinReceivedOptions
|
| 176 |
+
* @see EOS_CustomInvites_OnRequestToJoinReceivedCallback
|
| 177 |
+
*
|
| 178 |
+
* @return handle representing the registered callback
|
| 179 |
+
*/
|
| 180 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_CustomInvites_AddNotifyRequestToJoinReceived(EOS_HCustomInvites Handle, const EOS_CustomInvites_AddNotifyRequestToJoinReceivedOptions* Options, void* ClientData, const EOS_CustomInvites_OnRequestToJoinReceivedCallback NotificationFn);
|
| 181 |
+
|
| 182 |
+
/**
|
| 183 |
+
* Unregister from receiving notifications when a request to join for any logged in local user is received
|
| 184 |
+
*
|
| 185 |
+
* @param InId Handle representing the registered callback
|
| 186 |
+
*/
|
| 187 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RemoveNotifyRequestToJoinReceived(EOS_HCustomInvites Handle, EOS_NotificationId InId);
|
| 188 |
+
|
| 189 |
+
/**
|
| 190 |
+
* Register to receive notifications about a custom invite "INVITE" performed by a local user via the overlay.
|
| 191 |
+
* This is only needed when a configured integrated platform has EOS_IPMF_DisableSDKManagedSessions set. The EOS SDK will
|
| 192 |
+
* then use the state of EOS_IPMF_PreferEOSIdentity and EOS_IPMF_PreferIntegratedIdentity to determine when the NotificationFn is
|
| 193 |
+
* called.
|
| 194 |
+
*
|
| 195 |
+
* @note If the returned NotificationId is valid, you must call EOS_CustomInvites_RemoveNotifySendCustomNativeInviteRequested when you no longer wish to have your NotificationHandler called.
|
| 196 |
+
*
|
| 197 |
+
* @param Options Structure containing information about the request.
|
| 198 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 199 |
+
* @param NotificationFn A callback that is fired when a notification is received.
|
| 200 |
+
*
|
| 201 |
+
* @return handle representing the registered callback
|
| 202 |
+
*
|
| 203 |
+
* @see EOS_CustomInvites_AddNotifySendCustomNativeInviteRequestedOptions
|
| 204 |
+
* @see EOS_CustomInvites_OnSendCustomNativeInviteRequestedCallback
|
| 205 |
+
* @see EOS_IPMF_DisableSDKManagedSessions
|
| 206 |
+
* @see EOS_IPMF_PreferEOSIdentity
|
| 207 |
+
* @see EOS_IPMF_PreferIntegratedIdentity
|
| 208 |
+
*/
|
| 209 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_CustomInvites_AddNotifySendCustomNativeInviteRequested(EOS_HCustomInvites Handle, const EOS_CustomInvites_AddNotifySendCustomNativeInviteRequestedOptions* Options, void* ClientData, const EOS_CustomInvites_OnSendCustomNativeInviteRequestedCallback NotificationFn);
|
| 210 |
+
|
| 211 |
+
/**
|
| 212 |
+
* Unregister from receiving notifications when a user requests a send invite via the overlay.
|
| 213 |
+
*
|
| 214 |
+
* @param InId Handle representing the registered callback
|
| 215 |
+
*/
|
| 216 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RemoveNotifySendCustomNativeInviteRequested(EOS_HCustomInvites Handle, EOS_NotificationId InId);
|
| 217 |
+
|
| 218 |
+
/**
|
| 219 |
+
* Register to receive notifications when a Request to Join for any logged in local user is accepted via the Social Overlay
|
| 220 |
+
* @note If the returned NotificationId is valid, you must call EOS_CustomInvites_RemoveNotifyRequestToJoinAccepted when you no longer wish to have your NotificationHandler called.
|
| 221 |
+
*
|
| 222 |
+
* @param Options Structure containing information about the request.
|
| 223 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 224 |
+
* @param NotificationFn A callback that is fired when a Request to Join is accepted via the Social Overlay.
|
| 225 |
+
*
|
| 226 |
+
* @return handle representing the registered callback
|
| 227 |
+
*
|
| 228 |
+
* @see EOS_CustomInvites_AddNotifyRequestToJoinAcceptedOptions
|
| 229 |
+
* @see EOS_CustomInvites_OnRequestToJoinAcceptedCallback
|
| 230 |
+
*/
|
| 231 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_CustomInvites_AddNotifyRequestToJoinAccepted(EOS_HCustomInvites Handle, const EOS_CustomInvites_AddNotifyRequestToJoinAcceptedOptions* Options, void* ClientData, const EOS_CustomInvites_OnRequestToJoinAcceptedCallback NotificationFn);
|
| 232 |
+
|
| 233 |
+
/**
|
| 234 |
+
* Unregister from receiving notifications when a Request to Join for any logged in local user is accepted via the Social Overlay
|
| 235 |
+
*
|
| 236 |
+
* @param InId Handle representing the registered callback
|
| 237 |
+
*/
|
| 238 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RemoveNotifyRequestToJoinAccepted(EOS_HCustomInvites Handle, EOS_NotificationId InId);
|
| 239 |
+
|
| 240 |
+
/**
|
| 241 |
+
* Register to receive notifications when a Request to Join for any logged in local user is rejected via the Social Overlay
|
| 242 |
+
* @note If the returned NotificationId is valid, you must call EOS_CustomInvites_RemoveNotifyRequestToJoinRejected when you no longer wish to have your NotificationHandler called.
|
| 243 |
+
*
|
| 244 |
+
* @param Options Structure containing information about the request.
|
| 245 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 246 |
+
* @param NotificationFn A callback that is fired when a Request to Join is accepted via the Social Overlay.
|
| 247 |
+
*
|
| 248 |
+
* @return handle representing the registered callback
|
| 249 |
+
*
|
| 250 |
+
* @see EOS_CustomInvites_AddNotifyRequestToJoinRejectedOptions
|
| 251 |
+
* @see EOS_CustomInvites_OnRequestToJoinRejectedCallback
|
| 252 |
+
*/
|
| 253 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_CustomInvites_AddNotifyRequestToJoinRejected(EOS_HCustomInvites Handle, const EOS_CustomInvites_AddNotifyRequestToJoinRejectedOptions* Options, void* ClientData, const EOS_CustomInvites_OnRequestToJoinRejectedCallback NotificationFn);
|
| 254 |
+
|
| 255 |
+
/**
|
| 256 |
+
* Unregister from receiving notifications when a Request to Join for any logged in local user is rejected via the Social Overlay
|
| 257 |
+
*
|
| 258 |
+
* @param InId Handle representing the registered callback
|
| 259 |
+
*/
|
| 260 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RemoveNotifyRequestToJoinRejected(EOS_HCustomInvites Handle, EOS_NotificationId InId);
|
| 261 |
+
|
| 262 |
+
/**
|
| 263 |
+
* Accept a request to join from another user
|
| 264 |
+
*
|
| 265 |
+
* @param Options Structure containing information about the request.
|
| 266 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 267 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 268 |
+
*
|
| 269 |
+
* @return EOS_EResult containing the result of the operation.
|
| 270 |
+
* Possible result codes:
|
| 271 |
+
* - EOS_Success if the query completes successfully
|
| 272 |
+
* - EOS_InvalidParameters if any of the options values are incorrect
|
| 273 |
+
*
|
| 274 |
+
* @see EOS_CustomInvites_AcceptRequestToJoinOptions
|
| 275 |
+
* @see EOS_CustomInvites_OnAcceptRequestToJoinCallback
|
| 276 |
+
*/
|
| 277 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_AcceptRequestToJoin(EOS_HCustomInvites Handle, const EOS_CustomInvites_AcceptRequestToJoinOptions* Options, void* ClientData, const EOS_CustomInvites_OnAcceptRequestToJoinCallback CompletionDelegate);
|
| 278 |
+
|
| 279 |
+
/**
|
| 280 |
+
* Reject a request to join from another user
|
| 281 |
+
*
|
| 282 |
+
* @param Options Structure containing information about the request.
|
| 283 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 284 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 285 |
+
*
|
| 286 |
+
* @return EOS_EResult containing the result of the operation.
|
| 287 |
+
* Possible result codes:
|
| 288 |
+
* - EOS_Success if the query completes successfully
|
| 289 |
+
* - EOS_InvalidParameters if any of the options values are incorrect
|
| 290 |
+
*
|
| 291 |
+
* @see EOS_CustomInvites_RejectRequestToJoinOptions
|
| 292 |
+
* @see EOS_CustomInvites_OnRejectRequestToJoinCallback
|
| 293 |
+
*/
|
| 294 |
+
EOS_DECLARE_FUNC(void) EOS_CustomInvites_RejectRequestToJoin(EOS_HCustomInvites Handle, const EOS_CustomInvites_RejectRequestToJoinOptions* Options, void* ClientData, const EOS_CustomInvites_OnRejectRequestToJoinCallback CompletionDelegate);
|
| 295 |
+
|
| 296 |
+
/**
|
| 297 |
+
* Disable the "Request to Join" button in the Social Overlay.
|
| 298 |
+
* This is a one-way operation; once disabled, the Request to Join feature cannot be re-enabled
|
| 299 |
+
* for the current SDK session.
|
| 300 |
+
*
|
| 301 |
+
* This API can be called at any time, including before user login.
|
| 302 |
+
* The change will take effect in the Social Overlay on the next user login.
|
| 303 |
+
*
|
| 304 |
+
* @param Options Structure containing information about the request.
|
| 305 |
+
*
|
| 306 |
+
* @return EOS_EResult containing the result of the operation.
|
| 307 |
+
* Possible result codes:
|
| 308 |
+
* - EOS_Success if the operation completes successfully
|
| 309 |
+
* - EOS_InvalidParameters if any of the options values are incorrect
|
| 310 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 311 |
+
*
|
| 312 |
+
* @see EOS_CustomInvites_DisableRequestToJoinOptions
|
| 313 |
+
*/
|
| 314 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_CustomInvites_DisableRequestToJoin(EOS_HCustomInvites Handle, const EOS_CustomInvites_DisableRequestToJoinOptions* Options);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_custominvites_types.h
ADDED
|
@@ -0,0 +1,484 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
#include "eos_ui_types.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
/** Handle to the custom invites interface */
|
| 10 |
+
EOS_EXTERN_C typedef struct EOS_CustomInvitesHandle* EOS_HCustomInvites;
|
| 11 |
+
|
| 12 |
+
/** Maximum size of the custom invite payload string */
|
| 13 |
+
#define EOS_CUSTOMINVITES_MAX_PAYLOAD_LENGTH 500
|
| 14 |
+
|
| 15 |
+
/** The most recent version of the EOS_CustomInvites_SetCustomInvite API. */
|
| 16 |
+
#define EOS_CUSTOMINVITES_SETCUSTOMINVITE_API_LATEST 1
|
| 17 |
+
|
| 18 |
+
/**
|
| 19 |
+
* Input parameters for the EOS_CustomInvites_SetCustomInvite function.
|
| 20 |
+
*/
|
| 21 |
+
EOS_STRUCT(EOS_CustomInvites_SetCustomInviteOptions, (
|
| 22 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_SETCUSTOMINVITE_API_LATEST. */
|
| 23 |
+
int32_t ApiVersion;
|
| 24 |
+
/** Local user creating / sending a Custom Invite */
|
| 25 |
+
EOS_ProductUserId LocalUserId;
|
| 26 |
+
/** String payload for the Custom Invite (must be less than EOS_CUSTOMINVITES_MAX_PAYLOAD_LENGTH) */
|
| 27 |
+
const char* Payload;
|
| 28 |
+
));
|
| 29 |
+
|
| 30 |
+
/** The most recent version of the EOS_CustomInvites_SendCustomInvite API. */
|
| 31 |
+
#define EOS_CUSTOMINVITES_SENDCUSTOMINVITE_API_LATEST 1
|
| 32 |
+
|
| 33 |
+
/**
|
| 34 |
+
* Input parameters for the EOS_CustomInvites_SendCustomInvite function.
|
| 35 |
+
*/
|
| 36 |
+
EOS_STRUCT(EOS_CustomInvites_SendCustomInviteOptions, (
|
| 37 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_SENDCUSTOMINVITE_API_LATEST. */
|
| 38 |
+
int32_t ApiVersion;
|
| 39 |
+
/** Local user sending a CustomInvite */
|
| 40 |
+
EOS_ProductUserId LocalUserId;
|
| 41 |
+
/** Users to whom the invites should be sent */
|
| 42 |
+
EOS_ProductUserId* TargetUserIds;
|
| 43 |
+
/** The number of users we are sending to */
|
| 44 |
+
uint32_t TargetUserIdsCount;
|
| 45 |
+
));
|
| 46 |
+
|
| 47 |
+
/**
|
| 48 |
+
* Output parameters for the EOS_CustomInvites_SendCustomInvite Function. These parameters are received through the callback provided to EOS_CustomInvites_SendCustomInvite
|
| 49 |
+
*/
|
| 50 |
+
EOS_STRUCT(EOS_CustomInvites_SendCustomInviteCallbackInfo, (
|
| 51 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 52 |
+
EOS_EResult ResultCode;
|
| 53 |
+
/** Context that was passed into EOS_CustomInvites_SendCustomInvite */
|
| 54 |
+
void* ClientData;
|
| 55 |
+
/** Local user sending a CustomInvite */
|
| 56 |
+
EOS_ProductUserId LocalUserId;
|
| 57 |
+
/** Users to whom the invites were successfully sent (can be different than original call if an invite for same Payload was previously sent) */
|
| 58 |
+
EOS_ProductUserId* TargetUserIds;
|
| 59 |
+
/** The number of users we are sending to */
|
| 60 |
+
uint32_t TargetUserIdsCount;
|
| 61 |
+
));
|
| 62 |
+
|
| 63 |
+
/**
|
| 64 |
+
* Function prototype definition for callbacks passed to EOS_CustomInvites_SendCustomInvite
|
| 65 |
+
* @param Data A EOS_CustomInvites_SendCustomInviteCallbackInfo containing the output information and result
|
| 66 |
+
*/
|
| 67 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnSendCustomInviteCallback, const EOS_CustomInvites_SendCustomInviteCallbackInfo* Data);
|
| 68 |
+
|
| 69 |
+
|
| 70 |
+
/** The most recent version of the EOS_CustomInvites_AddNotifyCustomInviteReceived API. */
|
| 71 |
+
#define EOS_CUSTOMINVITES_ADDNOTIFYCUSTOMINVITERECEIVED_API_LATEST 1
|
| 72 |
+
|
| 73 |
+
/**
|
| 74 |
+
* Input parameters for the EOS_CustomInvites_AddNotifyCustomInviteReceived function.
|
| 75 |
+
*/
|
| 76 |
+
EOS_STRUCT(EOS_CustomInvites_AddNotifyCustomInviteReceivedOptions, (
|
| 77 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ADDNOTIFYCUSTOMINVITERECEIVED_API_LATEST. */
|
| 78 |
+
int32_t ApiVersion;
|
| 79 |
+
));
|
| 80 |
+
|
| 81 |
+
/**
|
| 82 |
+
* Output parameters for the EOS_CustomInvites_OnCustomInviteReceivedCallback Function.
|
| 83 |
+
*/
|
| 84 |
+
EOS_STRUCT(EOS_CustomInvites_OnCustomInviteReceivedCallbackInfo, (
|
| 85 |
+
/** Context that was passed into EOS_CustomInvites_AddNotifyCustomInviteReceived */
|
| 86 |
+
void* ClientData;
|
| 87 |
+
/** User that sent this custom invite */
|
| 88 |
+
EOS_ProductUserId TargetUserId;
|
| 89 |
+
/** Recipient Local user id */
|
| 90 |
+
EOS_ProductUserId LocalUserId;
|
| 91 |
+
/** Id of the received Custom Invite*/
|
| 92 |
+
const char* CustomInviteId;
|
| 93 |
+
/** Payload of the received Custom Invite */
|
| 94 |
+
const char* Payload;
|
| 95 |
+
));
|
| 96 |
+
|
| 97 |
+
/**
|
| 98 |
+
* Function prototype definition for notifications that comes from EOS_CustomInvites_AddNotifyCustomInviteReceived
|
| 99 |
+
*
|
| 100 |
+
* @param Data A EOS_CustomInvites_OnCustomInviteReceivedCallbackInfo containing the output information and result
|
| 101 |
+
*/
|
| 102 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnCustomInviteReceivedCallback, const EOS_CustomInvites_OnCustomInviteReceivedCallbackInfo* Data);
|
| 103 |
+
|
| 104 |
+
|
| 105 |
+
/** The most recent version of the EOS_CustomInvites_AddNotifyCustomInviteAccepted API. */
|
| 106 |
+
#define EOS_CUSTOMINVITES_ADDNOTIFYCUSTOMINVITEACCEPTED_API_LATEST 1
|
| 107 |
+
|
| 108 |
+
/**
|
| 109 |
+
* Input parameters for the EOS_CustomInvites_AddNotifyCustomInviteAccepted function.
|
| 110 |
+
*/
|
| 111 |
+
EOS_STRUCT(EOS_CustomInvites_AddNotifyCustomInviteAcceptedOptions, (
|
| 112 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ADDNOTIFYCUSTOMINVITEACCEPTED_API_LATEST. */
|
| 113 |
+
int32_t ApiVersion;
|
| 114 |
+
));
|
| 115 |
+
|
| 116 |
+
/**
|
| 117 |
+
* Output parameters for the EOS_CustomInvites_OnCustomInviteAcceptedCallback Function.
|
| 118 |
+
*/
|
| 119 |
+
EOS_STRUCT(EOS_CustomInvites_OnCustomInviteAcceptedCallbackInfo, (
|
| 120 |
+
/** Context that was passed into EOS_CustomInvites_AddNotifyCustomInviteAccepted */
|
| 121 |
+
void* ClientData;
|
| 122 |
+
/** User that sent the custom invite */
|
| 123 |
+
EOS_ProductUserId TargetUserId;
|
| 124 |
+
/** Recipient Local user id */
|
| 125 |
+
EOS_ProductUserId LocalUserId;
|
| 126 |
+
/** Id of the accepted Custom Invite */
|
| 127 |
+
const char* CustomInviteId;
|
| 128 |
+
/** Payload of the accepted Custom Invite */
|
| 129 |
+
const char* Payload;
|
| 130 |
+
));
|
| 131 |
+
|
| 132 |
+
/**
|
| 133 |
+
* Function prototype definition for notifications that comes from EOS_CustomInvites_AddNotifyCustomInviteAccepted
|
| 134 |
+
*
|
| 135 |
+
* @param Data A EOS_CustomInvites_OnCustomInviteAcceptedCallbackInfo containing the output information and result
|
| 136 |
+
*/
|
| 137 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnCustomInviteAcceptedCallback, const EOS_CustomInvites_OnCustomInviteAcceptedCallbackInfo* Data);
|
| 138 |
+
|
| 139 |
+
/** The most recent version of the EOS_CustomInvites_AddNotifyCustomInviteRejected API. */
|
| 140 |
+
#define EOS_CUSTOMINVITES_ADDNOTIFYCUSTOMINVITEREJECTED_API_LATEST 1
|
| 141 |
+
|
| 142 |
+
/**
|
| 143 |
+
* Input parameters for the EOS_CustomInvites_AddNotifyCustomInviteRejected function.
|
| 144 |
+
*/
|
| 145 |
+
EOS_STRUCT(EOS_CustomInvites_AddNotifyCustomInviteRejectedOptions, (
|
| 146 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ADDNOTIFYCUSTOMINVITEREJECTED_API_LATEST. */
|
| 147 |
+
int32_t ApiVersion;
|
| 148 |
+
));
|
| 149 |
+
|
| 150 |
+
/**
|
| 151 |
+
* Output parameters for the EOS_CustomInvites_OnCustomInviteRejectedCallback Function.
|
| 152 |
+
*/
|
| 153 |
+
EOS_STRUCT(EOS_CustomInvites_CustomInviteRejectedCallbackInfo, (
|
| 154 |
+
/** Context that was passed into EOS_CustomInvites_AddNotifyCustomInviteRejected */
|
| 155 |
+
void* ClientData;
|
| 156 |
+
/** User that sent the custom invite */
|
| 157 |
+
EOS_ProductUserId TargetUserId;
|
| 158 |
+
/** Recipient Local user id */
|
| 159 |
+
EOS_ProductUserId LocalUserId;
|
| 160 |
+
/** Id of the rejected Custom Invite */
|
| 161 |
+
const char* CustomInviteId;
|
| 162 |
+
/** Payload of the rejected Custom Invite */
|
| 163 |
+
const char* Payload;
|
| 164 |
+
));
|
| 165 |
+
|
| 166 |
+
/**
|
| 167 |
+
* Function prototype definition for notifications that comes from EOS_CustomInvites_AddNotifyCustomInviteRejected
|
| 168 |
+
*
|
| 169 |
+
* @param Data A EOS_CustomInvites_CustomInviteRejectedCallbackInfo containing the output information and result
|
| 170 |
+
*/
|
| 171 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnCustomInviteRejectedCallback, const EOS_CustomInvites_CustomInviteRejectedCallbackInfo* Data);
|
| 172 |
+
|
| 173 |
+
/** The most recent version of the EOS_CustomInvites_FinalizeInvite API. */
|
| 174 |
+
#define EOS_CUSTOMINVITES_FINALIZEINVITE_API_LATEST 1
|
| 175 |
+
|
| 176 |
+
/**
|
| 177 |
+
* Input parameters for the EOS_CustomInvites_FinalizeInvite function.
|
| 178 |
+
*/
|
| 179 |
+
EOS_STRUCT(EOS_CustomInvites_FinalizeInviteOptions, (
|
| 180 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_FINALIZEINVITE_API_LATEST. */
|
| 181 |
+
int32_t ApiVersion;
|
| 182 |
+
/** User that sent the custom invite */
|
| 183 |
+
EOS_ProductUserId TargetUserId;
|
| 184 |
+
/** Recipient Local user id */
|
| 185 |
+
EOS_ProductUserId LocalUserId;
|
| 186 |
+
/** Id of the Custom Invite accepted */
|
| 187 |
+
const char* CustomInviteId;
|
| 188 |
+
/** Result of the Processing operation, transmitted to Social Overlay if applicable */
|
| 189 |
+
EOS_EResult ProcessingResult;
|
| 190 |
+
));
|
| 191 |
+
|
| 192 |
+
/** The most recent version of the EOS_CustomInvites_SendRequestToJoinOptions API. */
|
| 193 |
+
#define EOS_CUSTOMINVITES_SENDREQUESTTOJOIN_API_LATEST 1
|
| 194 |
+
|
| 195 |
+
/**
|
| 196 |
+
* Input parameters for the EOS_CustomInvites_SendRequestToJoin function.
|
| 197 |
+
*/
|
| 198 |
+
EOS_STRUCT(EOS_CustomInvites_SendRequestToJoinOptions, (
|
| 199 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_SENDREQUESTTOJOIN_API_LATEST. */
|
| 200 |
+
int32_t ApiVersion;
|
| 201 |
+
/** Local user Requesting an Invite */
|
| 202 |
+
EOS_ProductUserId LocalUserId;
|
| 203 |
+
/** Recipient of Request Invite*/
|
| 204 |
+
EOS_ProductUserId TargetUserId;
|
| 205 |
+
));
|
| 206 |
+
|
| 207 |
+
/**
|
| 208 |
+
* Output parameters for the EOS_CustomInvites_SendRequestToJoin Function. These parameters are received through the callback provided to EOS_CustomInvites_SendRequestToJoin
|
| 209 |
+
*/
|
| 210 |
+
EOS_STRUCT(EOS_CustomInvites_SendRequestToJoinCallbackInfo, (
|
| 211 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 212 |
+
EOS_EResult ResultCode;
|
| 213 |
+
/** Context that was passed into EOS_CustomInvites_SendRequestToJoin */
|
| 214 |
+
void* ClientData;
|
| 215 |
+
/** Local user requesting an invite */
|
| 216 |
+
EOS_ProductUserId LocalUserId;
|
| 217 |
+
/** Recipient of Request Invite*/
|
| 218 |
+
EOS_ProductUserId TargetUserId;
|
| 219 |
+
));
|
| 220 |
+
|
| 221 |
+
/**
|
| 222 |
+
* Function prototype definition for callbacks passed to EOS_CustomInvites_SendRequestToJoin
|
| 223 |
+
* @param Data A EOS_CustomInvites_SendCustomInviteCallbackInfo containing the output information and result
|
| 224 |
+
*/
|
| 225 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnSendRequestToJoinCallback, const EOS_CustomInvites_SendRequestToJoinCallbackInfo* Data);
|
| 226 |
+
|
| 227 |
+
/** The most recent version of the EOS_CustomInvites_AddNotifyRequestToJoinResponseReceived API. */
|
| 228 |
+
#define EOS_CUSTOMINVITES_ADDNOTIFYREQUESTTOJOINRESPONSERECEIVED_API_LATEST 1
|
| 229 |
+
|
| 230 |
+
/**
|
| 231 |
+
* Input parameters for the EOS_CustomInvites_AddNotifyRequestToJoinResponseReceived function.
|
| 232 |
+
*/
|
| 233 |
+
EOS_STRUCT(EOS_CustomInvites_AddNotifyRequestToJoinResponseReceivedOptions, (
|
| 234 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ADDNOTIFYREQUESTTOJOINRESPONSERECEIVED_API_LATEST. */
|
| 235 |
+
int32_t ApiVersion;
|
| 236 |
+
));
|
| 237 |
+
|
| 238 |
+
/** Response to an invite request. */
|
| 239 |
+
EOS_ENUM(EOS_ERequestToJoinResponse,
|
| 240 |
+
/** The target of the invite request has accepted. */
|
| 241 |
+
EOS_RTJR_ACCEPTED = 0,
|
| 242 |
+
/** The target of the invite request has rejected. */
|
| 243 |
+
EOS_RTJR_REJECTED = 1
|
| 244 |
+
);
|
| 245 |
+
|
| 246 |
+
/**
|
| 247 |
+
* Output parameters for the EOS_CustomInvites_OnRequestToJoinResponseReceivedCallback function.
|
| 248 |
+
*/
|
| 249 |
+
EOS_STRUCT(EOS_CustomInvites_RequestToJoinResponseReceivedCallbackInfo, (
|
| 250 |
+
/** Context that was passed into EOS_CustomInvites_AddNotifyRequestToJoinResponseReceived */
|
| 251 |
+
void* ClientData;
|
| 252 |
+
/** User that sent this response */
|
| 253 |
+
EOS_ProductUserId FromUserId;
|
| 254 |
+
/** Recipient Local user id */
|
| 255 |
+
EOS_ProductUserId ToUserId;
|
| 256 |
+
/** The Intent associated with this response */
|
| 257 |
+
EOS_ERequestToJoinResponse Response;
|
| 258 |
+
));
|
| 259 |
+
|
| 260 |
+
/**
|
| 261 |
+
* Function prototype definition for notifications that come from EOS_CustomInvites_AddNotifyRequestToJoinResponseReceived
|
| 262 |
+
*
|
| 263 |
+
* @param Data A EOS_CustomInvites_RequestToJoinResponseReceivedCallbackInfo containing the output information and result
|
| 264 |
+
*/
|
| 265 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnRequestToJoinResponseReceivedCallback, const EOS_CustomInvites_RequestToJoinResponseReceivedCallbackInfo* Data);
|
| 266 |
+
|
| 267 |
+
/** The most recent version of the AddNotifyRequestToJoinReceived API. */
|
| 268 |
+
#define EOS_CUSTOMINVITES_ADDNOTIFYREQUESTTOJOINRECEIVED_API_LATEST 1
|
| 269 |
+
|
| 270 |
+
/**
|
| 271 |
+
* Input parameters for the AddNotifyRequestToJoinReceived function.
|
| 272 |
+
*/
|
| 273 |
+
EOS_STRUCT(EOS_CustomInvites_AddNotifyRequestToJoinReceivedOptions, (
|
| 274 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ADDNOTIFYREQUESTTOJOINRECEIVED_API_LATEST. */
|
| 275 |
+
int32_t ApiVersion;
|
| 276 |
+
));
|
| 277 |
+
|
| 278 |
+
/**
|
| 279 |
+
* Output parameters for the EOS_CustomInvites_AddNotifyRequestToJoinReceived function.
|
| 280 |
+
*/
|
| 281 |
+
EOS_STRUCT(EOS_CustomInvites_RequestToJoinReceivedCallbackInfo, (
|
| 282 |
+
/** Context that was passed into EOS_CustomInvites_AddNotifyRequestToJoinReceived */
|
| 283 |
+
void* ClientData;
|
| 284 |
+
/** User that sent this response */
|
| 285 |
+
EOS_ProductUserId FromUserId;
|
| 286 |
+
/** Recipient Local user id */
|
| 287 |
+
EOS_ProductUserId ToUserId;
|
| 288 |
+
));
|
| 289 |
+
|
| 290 |
+
/**
|
| 291 |
+
* Function prototype definition for notifications that comes from EOS_CustomInvites_AddNotifyRequestToJoinReceived
|
| 292 |
+
*
|
| 293 |
+
* @param Data A EOS_CustomInvites_RequestToJoinReceivedCallbackInfo containing the output information and result
|
| 294 |
+
*/
|
| 295 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnRequestToJoinReceivedCallback, const EOS_CustomInvites_RequestToJoinReceivedCallbackInfo* Data);
|
| 296 |
+
|
| 297 |
+
/** The most recent version of the EOS_CustomInvites_AcceptRequestToJoin API. */
|
| 298 |
+
#define EOS_CUSTOMINVITES_ACCEPTREQUESTTOJOIN_API_LATEST 1
|
| 299 |
+
|
| 300 |
+
/**
|
| 301 |
+
* Input parameters for the EOS_CustomInvites_AcceptRequestToJoin function.
|
| 302 |
+
*/
|
| 303 |
+
EOS_STRUCT(EOS_CustomInvites_AcceptRequestToJoinOptions, (
|
| 304 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ACCEPTREQUESTTOJOIN_API_LATEST. */
|
| 305 |
+
int32_t ApiVersion;
|
| 306 |
+
/** Local user accepting a request to join */
|
| 307 |
+
EOS_ProductUserId LocalUserId;
|
| 308 |
+
/** Target user that sent original request to join */
|
| 309 |
+
EOS_ProductUserId TargetUserId;
|
| 310 |
+
));
|
| 311 |
+
|
| 312 |
+
/**
|
| 313 |
+
* Output parameters for the EOS_CustomInvites_AcceptRequestToJoin Function. These parameters are received through the callback provided to EOS_CustomInvites_AcceptRequestToJoin
|
| 314 |
+
*/
|
| 315 |
+
EOS_STRUCT(EOS_CustomInvites_AcceptRequestToJoinCallbackInfo, (
|
| 316 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 317 |
+
EOS_EResult ResultCode;
|
| 318 |
+
/** Context that was passed into EOS_CustomInvites_AcceptRequestToJoin */
|
| 319 |
+
void* ClientData;
|
| 320 |
+
/** Local user accepting an invite request */
|
| 321 |
+
EOS_ProductUserId LocalUserId;
|
| 322 |
+
/** Target user that sent original invite request */
|
| 323 |
+
EOS_ProductUserId TargetUserId;
|
| 324 |
+
));
|
| 325 |
+
|
| 326 |
+
/**
|
| 327 |
+
* Function prototype definition for callbacks passed to EOS_CustomInvites_AcceptRequestToJoin
|
| 328 |
+
* @param Data A EOS_CustomInvites_AcceptRequestToJoinCallbackInfo containing the output information and result
|
| 329 |
+
*/
|
| 330 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnAcceptRequestToJoinCallback, const EOS_CustomInvites_AcceptRequestToJoinCallbackInfo* Data);
|
| 331 |
+
|
| 332 |
+
/** The most recent version of the EOS_CustomInvites_RejectRequestToJoin API. */
|
| 333 |
+
#define EOS_CUSTOMINVITES_REJECTREQUESTTOJOIN_API_LATEST 1
|
| 334 |
+
|
| 335 |
+
/**
|
| 336 |
+
* Input parameters for the EOS_CustomInvites_RejectRequestToJoin function.
|
| 337 |
+
*/
|
| 338 |
+
EOS_STRUCT(EOS_CustomInvites_RejectRequestToJoinOptions, (
|
| 339 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_REJECTREQUESTTOJOIN_API_LATEST. */
|
| 340 |
+
int32_t ApiVersion;
|
| 341 |
+
/** Local user declining an invite request */
|
| 342 |
+
EOS_ProductUserId LocalUserId;
|
| 343 |
+
/** Target user that sent original invite request */
|
| 344 |
+
EOS_ProductUserId TargetUserId;
|
| 345 |
+
));
|
| 346 |
+
|
| 347 |
+
/**
|
| 348 |
+
* Output parameters for the EOS_CustomInvites_RejectRequestToJoin Function. These parameters are received through the callback provided to EOS_CustomInvites_RejectRequestToJoin
|
| 349 |
+
*/
|
| 350 |
+
EOS_STRUCT(EOS_CustomInvites_RejectRequestToJoinCallbackInfo, (
|
| 351 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 352 |
+
EOS_EResult ResultCode;
|
| 353 |
+
/** Context that was passed into EOS_CustomInvites_RejectRequestToJoin */
|
| 354 |
+
void* ClientData;
|
| 355 |
+
/** Local user declining a request to join */
|
| 356 |
+
EOS_ProductUserId LocalUserId;
|
| 357 |
+
/** Target user that sent original request to join */
|
| 358 |
+
EOS_ProductUserId TargetUserId;
|
| 359 |
+
));
|
| 360 |
+
|
| 361 |
+
/**
|
| 362 |
+
* Function prototype definition for callbacks passed to EOS_CustomInvites_RejectRequestToJoin
|
| 363 |
+
* @param Data A EOS_CustomInvites_OnRejectRequestToJoinCallback containing the output information and result
|
| 364 |
+
*/
|
| 365 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnRejectRequestToJoinCallback, const EOS_CustomInvites_RejectRequestToJoinCallbackInfo* Data);
|
| 366 |
+
|
| 367 |
+
/** The most recent version of the EOS_CustomInvites_DisableRequestToJoin API. */
|
| 368 |
+
#define EOS_CUSTOMINVITES_DISABLEREQUESTTOJOIN_API_LATEST 1
|
| 369 |
+
|
| 370 |
+
/**
|
| 371 |
+
* Input parameters for the EOS_CustomInvites_DisableRequestToJoin function.
|
| 372 |
+
*/
|
| 373 |
+
EOS_STRUCT(EOS_CustomInvites_DisableRequestToJoinOptions, (
|
| 374 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_DISABLEREQUESTTOJOIN_API_LATEST. */
|
| 375 |
+
int32_t ApiVersion;
|
| 376 |
+
));
|
| 377 |
+
|
| 378 |
+
/** The most recent version of the EOS_CustomInvites_AddNotifySendCustomNativeInviteRequested API. */
|
| 379 |
+
#define EOS_CUSTOMINVITES_ADDNOTIFYSENDCUSTOMNATIVEINVITEREQUESTED_API_LATEST 1
|
| 380 |
+
|
| 381 |
+
/**
|
| 382 |
+
* Input parameters for the EOS_CustomInvites_AddNotifySendCustomNativeInviteRequested function.
|
| 383 |
+
*/
|
| 384 |
+
EOS_STRUCT(EOS_CustomInvites_AddNotifySendCustomNativeInviteRequestedOptions, (
|
| 385 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ADDNOTIFYSENDCUSTOMNATIVEINVITEREQUESTED_API_LATEST. */
|
| 386 |
+
int32_t ApiVersion;
|
| 387 |
+
));
|
| 388 |
+
|
| 389 |
+
/**
|
| 390 |
+
* Output parameters for the EOS_CustomInvites_OnSendCustomNativeInviteRequestedCallback Function.
|
| 391 |
+
*/
|
| 392 |
+
EOS_STRUCT(EOS_CustomInvites_SendCustomNativeInviteRequestedCallbackInfo, (
|
| 393 |
+
/** Context that was passed into EOS_CustomInvites_AddNotifySendCustomNativeInviteRequested */
|
| 394 |
+
void* ClientData;
|
| 395 |
+
/**
|
| 396 |
+
* Identifies this event which will need to be acknowledged with EOS_UI_AcknowledgeEventId().
|
| 397 |
+
* @see EOS_UI_AcknowledgeEventId
|
| 398 |
+
*/
|
| 399 |
+
EOS_UI_EventId UiEventId;
|
| 400 |
+
/** The Product User ID of the local user who is inviting. */
|
| 401 |
+
EOS_ProductUserId LocalUserId;
|
| 402 |
+
/**
|
| 403 |
+
* The Native Platform Account Type. If only a single integrated platform is configured then
|
| 404 |
+
* this will always reference that platform.
|
| 405 |
+
*/
|
| 406 |
+
EOS_IntegratedPlatformType TargetNativeAccountType;
|
| 407 |
+
/** The Native Platform Account ID of the target user being invited. */
|
| 408 |
+
const char* TargetUserNativeAccountId;
|
| 409 |
+
/** Invite ID that the user is being invited to */
|
| 410 |
+
const char* InviteId;
|
| 411 |
+
));
|
| 412 |
+
|
| 413 |
+
/**
|
| 414 |
+
* Function prototype definition for notifications that comes from EOS_CustomInvites_AddNotifySendCustomNativeInviteRequested
|
| 415 |
+
*
|
| 416 |
+
* @param Data A EOS_CustomInvites_SendCustomNativeInviteRequestedCallbackInfo containing the output information and result
|
| 417 |
+
*
|
| 418 |
+
* @note After processing the callback EOS_UI_AcknowledgeEventId must be called.
|
| 419 |
+
*
|
| 420 |
+
* @see EOS_UI_AcknowledgeEventId
|
| 421 |
+
*/
|
| 422 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnSendCustomNativeInviteRequestedCallback, const EOS_CustomInvites_SendCustomNativeInviteRequestedCallbackInfo* Data);
|
| 423 |
+
|
| 424 |
+
/** The most recent version of the EOS_CustomInvites_AddNotifyRequestToJoinAccepted API. */
|
| 425 |
+
#define EOS_CUSTOMINVITES_ADDNOTIFYREQUESTTOJOINACCEPTED_API_LATEST 1
|
| 426 |
+
|
| 427 |
+
/**
|
| 428 |
+
* Input parameters for the EOS_CustomInvites_AddNotifyRequestToJoinAccepted function.
|
| 429 |
+
*/
|
| 430 |
+
EOS_STRUCT(EOS_CustomInvites_AddNotifyRequestToJoinAcceptedOptions, (
|
| 431 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ADDNOTIFYREQUESTTOJOINACCEPTED_API_LATEST. */
|
| 432 |
+
int32_t ApiVersion;
|
| 433 |
+
));
|
| 434 |
+
|
| 435 |
+
/**
|
| 436 |
+
* Output parameters for the EOS_CustomInvites_OnRequestToJoinAcceptedCallback Function.
|
| 437 |
+
*/
|
| 438 |
+
EOS_STRUCT(EOS_CustomInvites_OnRequestToJoinAcceptedCallbackInfo, (
|
| 439 |
+
/** Context that was passed into EOS_CustomInvites_AddNotifyRequestToJoinAccepted */
|
| 440 |
+
void* ClientData;
|
| 441 |
+
/** User that sent the request to join */
|
| 442 |
+
EOS_ProductUserId TargetUserId;
|
| 443 |
+
/** Local user ID of the Request to Join recipient */
|
| 444 |
+
EOS_ProductUserId LocalUserId;
|
| 445 |
+
));
|
| 446 |
+
|
| 447 |
+
/**
|
| 448 |
+
* Function prototype definition for notifications that comes from EOS_CustomInvites_AddNotifyRequestToJoinAccepted
|
| 449 |
+
*
|
| 450 |
+
* @param Data A EOS_CustomInvites_OnRequestToJoinAcceptedCallbackInfo containing the output information and result
|
| 451 |
+
*/
|
| 452 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnRequestToJoinAcceptedCallback, const EOS_CustomInvites_OnRequestToJoinAcceptedCallbackInfo* Data);
|
| 453 |
+
|
| 454 |
+
/** The most recent version of the EOS_CustomInvites_AddNotifyRequestToJoinRejected API. */
|
| 455 |
+
#define EOS_CUSTOMINVITES_ADDNOTIFYREQUESTTOJOINREJECTED_API_LATEST 1
|
| 456 |
+
|
| 457 |
+
/**
|
| 458 |
+
* Input parameters for the EOS_CustomInvites_AddNotifyRequestToJoinRejected function.
|
| 459 |
+
*/
|
| 460 |
+
EOS_STRUCT(EOS_CustomInvites_AddNotifyRequestToJoinRejectedOptions, (
|
| 461 |
+
/** API Version: Set this to EOS_CUSTOMINVITES_ADDNOTIFYREQUESTTOJOINREJECTED_API_LATEST. */
|
| 462 |
+
int32_t ApiVersion;
|
| 463 |
+
));
|
| 464 |
+
|
| 465 |
+
/**
|
| 466 |
+
* Output parameters for the EOS_CustomInvites_OnRequestToJoinRejectedCallback Function.
|
| 467 |
+
*/
|
| 468 |
+
EOS_STRUCT(EOS_CustomInvites_OnRequestToJoinRejectedCallbackInfo, (
|
| 469 |
+
/** Context that was passed into EOS_CustomInvites_AddNotifyCustomInviteRejected */
|
| 470 |
+
void* ClientData;
|
| 471 |
+
/** User that sent the custom invite */
|
| 472 |
+
EOS_ProductUserId TargetUserId;
|
| 473 |
+
/** Recipient Local user id */
|
| 474 |
+
EOS_ProductUserId LocalUserId;
|
| 475 |
+
));
|
| 476 |
+
|
| 477 |
+
/**
|
| 478 |
+
* Function prototype definition for notifications that comes from EOS_CustomInvites_AddNotifyRequestToJoinRejected
|
| 479 |
+
*
|
| 480 |
+
* @param Data A EOS_CustomInvites_OnRequestToJoinRejectedCallbackInfo containing the output information and result
|
| 481 |
+
*/
|
| 482 |
+
EOS_DECLARE_CALLBACK(EOS_CustomInvites_OnRequestToJoinRejectedCallback, const EOS_CustomInvites_OnRequestToJoinRejectedCallbackInfo* Data);
|
| 483 |
+
|
| 484 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_ecom.h
ADDED
|
@@ -0,0 +1,565 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_ecom_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Ecom Interface exposes all catalog, purchasing, and ownership entitlement features available with the Epic Games store
|
| 8 |
+
* All Ecom Interface calls take a handle of type EOS_HEcom as the first parameter.
|
| 9 |
+
* This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetEcomInterface function.
|
| 10 |
+
*
|
| 11 |
+
* @note At this time, this feature is only available for products that are part of the Epic Games store.
|
| 12 |
+
*
|
| 13 |
+
* @see EOS_Platform_GetEcomInterface
|
| 14 |
+
*/
|
| 15 |
+
|
| 16 |
+
/**
|
| 17 |
+
* Query the ownership status for a given list of catalog item IDs defined with Epic Online Services.
|
| 18 |
+
* This data will be cached for a limited time and retrieved again from the backend when necessary
|
| 19 |
+
* Depending on the number of catalog item ids passed, the SDK splits the query into smaller batch requests to the backend and aggregates the result.
|
| 20 |
+
* Note: If one of the request batches fails, no data is cached and the entire query is marked as failed.
|
| 21 |
+
*
|
| 22 |
+
* @param Options structure containing the account and catalog item IDs to retrieve
|
| 23 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 24 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 25 |
+
*
|
| 26 |
+
* @see EOS_Ecom_QueryOwnershipOptions
|
| 27 |
+
* @see EOS_Ecom_OnQueryOwnershipCallback
|
| 28 |
+
*/
|
| 29 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_QueryOwnership(EOS_HEcom Handle, const EOS_Ecom_QueryOwnershipOptions* Options, void* ClientData, const EOS_Ecom_OnQueryOwnershipCallback CompletionDelegate);
|
| 30 |
+
|
| 31 |
+
/**
|
| 32 |
+
* Query the ownership status of all catalog item IDs under the given list of Sandbox IDs defined with Epic Online Services.
|
| 33 |
+
* This data will be cached for a limited time and retrieved again from the backend when necessary.
|
| 34 |
+
*
|
| 35 |
+
* @param Options structure containing the account and Sandbox IDs to retrieve.
|
| 36 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate.
|
| 37 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error.
|
| 38 |
+
*
|
| 39 |
+
* @see EOS_Ecom_QueryOwnershipBySandboxIdsOptions
|
| 40 |
+
* @see EOS_Ecom_OnQueryOwnershipBySandboxIdsCallback
|
| 41 |
+
*/
|
| 42 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_QueryOwnershipBySandboxIds(EOS_HEcom Handle, const EOS_Ecom_QueryOwnershipBySandboxIdsOptions* Options, void* ClientData, const EOS_Ecom_OnQueryOwnershipBySandboxIdsCallback CompletionDelegate);
|
| 43 |
+
|
| 44 |
+
/**
|
| 45 |
+
* Query the ownership status for a given list of catalog item IDs defined with Epic Online Services.
|
| 46 |
+
* The data is return via the callback in the form of a signed JWT that should be verified by an external backend server using a public key for authenticity.
|
| 47 |
+
*
|
| 48 |
+
* @param Options structure containing the account and catalog item IDs to retrieve in token form
|
| 49 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 50 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 51 |
+
*
|
| 52 |
+
* @see EOS_Ecom_QueryOwnershipTokenOptions
|
| 53 |
+
* @see EOS_Ecom_OnQueryOwnershipTokenCallback
|
| 54 |
+
*/
|
| 55 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_QueryOwnershipToken(EOS_HEcom Handle, const EOS_Ecom_QueryOwnershipTokenOptions* Options, void* ClientData, const EOS_Ecom_OnQueryOwnershipTokenCallback CompletionDelegate);
|
| 56 |
+
|
| 57 |
+
/**
|
| 58 |
+
* Query the entitlement information defined with Epic Online Services.
|
| 59 |
+
* A set of entitlement names can be provided to filter the set of entitlements associated with the account.
|
| 60 |
+
* This data will be cached for a limited time and retrieved again from the backend when necessary.
|
| 61 |
+
* Depending on the number of entitlements passed, the SDK splits the query into smaller batch requests to the backend and aggregates the result.
|
| 62 |
+
* Note: If one of the request batches fails, no data is cached and the entire query is marked as failed.
|
| 63 |
+
* Use EOS_Ecom_CopyEntitlementByIndex, EOS_Ecom_CopyEntitlementByNameAndIndex, and EOS_Ecom_CopyEntitlementById to get the entitlement details.
|
| 64 |
+
* Use EOS_Ecom_GetEntitlementsByNameCount to retrieve the number of entitlements with a specific entitlement name.
|
| 65 |
+
* Note: If a durable item is queried used the QueryEntitlements API, the callback returns with a EOS_InvalidRequest result code. Durable item ownership should be queried using the EOS_Ecom_QueryOwnership API.
|
| 66 |
+
*
|
| 67 |
+
* @param Options structure containing the account and entitlement names to retrieve
|
| 68 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 69 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 70 |
+
*
|
| 71 |
+
* @see EOS_Ecom_QueryEntitlementsOptions
|
| 72 |
+
* @see EOS_Ecom_OnQueryEntitlementsCallback
|
| 73 |
+
*/
|
| 74 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_QueryEntitlements(EOS_HEcom Handle, const EOS_Ecom_QueryEntitlementsOptions* Options, void* ClientData, const EOS_Ecom_OnQueryEntitlementsCallback CompletionDelegate);
|
| 75 |
+
|
| 76 |
+
/**
|
| 77 |
+
* Query the entitlement verification status defined with Epic Online Services.
|
| 78 |
+
* An optional set of entitlement names can be provided to filter the set of entitlements associated with the account.
|
| 79 |
+
* The data is return via the callback in the form of a signed JWT that should be verified by an external backend server using a public key for authenticity.
|
| 80 |
+
*
|
| 81 |
+
* @param Options structure containing the account and catalog item IDs to retrieve in token form
|
| 82 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 83 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 84 |
+
*
|
| 85 |
+
* @see EOS_Ecom_QueryEntitlementTokenOptions
|
| 86 |
+
* @see EOS_Ecom_OnQueryEntitlementTokenCallback
|
| 87 |
+
*/
|
| 88 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_QueryEntitlementToken(EOS_HEcom Handle, const EOS_Ecom_QueryEntitlementTokenOptions* Options, void* ClientData, const EOS_Ecom_OnQueryEntitlementTokenCallback CompletionDelegate);
|
| 89 |
+
|
| 90 |
+
/**
|
| 91 |
+
* Query for a list of catalog offers defined with Epic Online Services.
|
| 92 |
+
* This data will be cached for a limited time and retrieved again from the backend when necessary.
|
| 93 |
+
* Cached offers can be accessed using EOS_Ecom_CopyOfferByIndex and EOS_Ecom_CopyOfferById.
|
| 94 |
+
*
|
| 95 |
+
* @param Options structure containing filter criteria
|
| 96 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 97 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 98 |
+
*
|
| 99 |
+
* @see EOS_Ecom_QueryOffersOptions
|
| 100 |
+
* @see EOS_Ecom_OnQueryOffersCallback
|
| 101 |
+
* @see EOS_Ecom_CopyOfferByIndex
|
| 102 |
+
* @see EOS_Ecom_CopyOfferById
|
| 103 |
+
*/
|
| 104 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_QueryOffers(EOS_HEcom Handle, const EOS_Ecom_QueryOffersOptions* Options, void* ClientData, const EOS_Ecom_OnQueryOffersCallback CompletionDelegate);
|
| 105 |
+
|
| 106 |
+
/**
|
| 107 |
+
* Initiates the purchase flow for a set of offers. The callback is triggered after the purchase flow.
|
| 108 |
+
* On success, the set of entitlements that were unlocked will be cached.
|
| 109 |
+
* On success, a Transaction ID will be returned. The Transaction ID can be used to obtain an
|
| 110 |
+
* EOS_Ecom_HTransaction handle. The handle can then be used to retrieve the entitlements rewarded by the purchase.
|
| 111 |
+
*
|
| 112 |
+
* @see EOS_Ecom_Transaction_Release
|
| 113 |
+
*
|
| 114 |
+
* @param Options structure containing filter criteria
|
| 115 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 116 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 117 |
+
*
|
| 118 |
+
* @see EOS_Ecom_CheckoutOptions
|
| 119 |
+
* @see EOS_Ecom_OnCheckoutCallback
|
| 120 |
+
*/
|
| 121 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_Checkout(EOS_HEcom Handle, const EOS_Ecom_CheckoutOptions* Options, void* ClientData, const EOS_Ecom_OnCheckoutCallback CompletionDelegate);
|
| 122 |
+
|
| 123 |
+
/**
|
| 124 |
+
* Requests that the provided entitlement be marked redeemed. This will cause that entitlement
|
| 125 |
+
* to no longer be returned from QueryEntitlements unless the include redeemed request flag is set true.
|
| 126 |
+
*
|
| 127 |
+
* @param Options structure containing entitlement to redeem
|
| 128 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 129 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 130 |
+
*
|
| 131 |
+
* @see EOS_Ecom_RedeemEntitlementsOptions
|
| 132 |
+
* @see EOS_Ecom_OnRedeemEntitlementsCallback
|
| 133 |
+
*/
|
| 134 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_RedeemEntitlements(EOS_HEcom Handle, const EOS_Ecom_RedeemEntitlementsOptions* Options, void* ClientData, const EOS_Ecom_OnRedeemEntitlementsCallback CompletionDelegate);
|
| 135 |
+
|
| 136 |
+
/**
|
| 137 |
+
* Fetch the number of entitlements that were redeemed during the last EOS_Ecom_RedeemEntitlements call.
|
| 138 |
+
*
|
| 139 |
+
* @param Options structure containing the Epic Account ID
|
| 140 |
+
*
|
| 141 |
+
* @see EOS_Ecom_GetLastRedeemedEntitlementsCountOptions
|
| 142 |
+
* @see EOS_Ecom_CopyLastRedeemedEntitlementByIndex
|
| 143 |
+
*
|
| 144 |
+
* @return the number of the redeemed entitlements.
|
| 145 |
+
*/
|
| 146 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetLastRedeemedEntitlementsCount(EOS_HEcom Handle, const EOS_Ecom_GetLastRedeemedEntitlementsCountOptions* Options);
|
| 147 |
+
|
| 148 |
+
/**
|
| 149 |
+
* Fetches a redeemed entitlement id from a given index.
|
| 150 |
+
* Only entitlements that were redeemed during the last EOS_Ecom_RedeemEntitlements call can be copied.
|
| 151 |
+
*
|
| 152 |
+
* @param Options structure containing the Epic Account ID and index being accessed
|
| 153 |
+
* @param OutRedeemedEntitlementId The ID of the redeemed entitlement. Must be long enough to hold a string of EOS_ECOM_ENTITLEMENTID_MAX_LENGTH.
|
| 154 |
+
* @param InOutRedeemedEntitlementIdLength The size of the OutRedeemedEntitlementId in characters.
|
| 155 |
+
* The input buffer should include enough space to be null-terminated.
|
| 156 |
+
* When the function returns, this parameter will be filled with the length of the string copied into OutRedeemedEntitlementId.
|
| 157 |
+
*
|
| 158 |
+
* @return EOS_EResult containing the result of the operation.
|
| 159 |
+
* Possible result codes:
|
| 160 |
+
* - EOS_Success if the information is available and passed out in OutRedeemedEntitlementId
|
| 161 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 162 |
+
* - EOS_NotFound if the entitlement id is not found
|
| 163 |
+
*
|
| 164 |
+
* @see EOS_Ecom_CopyLastRedeemedEntitlementByIndexOptions
|
| 165 |
+
* @see EOS_ECOM_ENTITLEMENTID_MAX_LENGTH
|
| 166 |
+
*/
|
| 167 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyLastRedeemedEntitlementByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyLastRedeemedEntitlementByIndexOptions* Options, char* OutRedeemedEntitlementId, int32_t* InOutRedeemedEntitlementIdLength);
|
| 168 |
+
|
| 169 |
+
/**
|
| 170 |
+
* Fetch the number of entitlements of the given type in the last Redeem Entitlements result.
|
| 171 |
+
*
|
| 172 |
+
* @param Options structure containing the Epic Account ID and the result type.
|
| 173 |
+
*
|
| 174 |
+
* @see EOS_Ecom_GetLastRedeemEntitlementsResultCountOptions
|
| 175 |
+
* @see EOS_Ecom_CopyLastRedeemEntitlementsResultByIndex
|
| 176 |
+
*
|
| 177 |
+
* @return the number of entitlements of the given result type in the last Redeem Entitlements result.
|
| 178 |
+
*/
|
| 179 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetLastRedeemEntitlementsResultCount(EOS_HEcom Handle, const EOS_Ecom_GetLastRedeemEntitlementsResultCountOptions* Options);
|
| 180 |
+
|
| 181 |
+
/**
|
| 182 |
+
* Fetches an entitlement id of the given result type and the given index in the last Redeem Entitlements result.
|
| 183 |
+
*
|
| 184 |
+
* @param Options structure containing the Epic Account ID and index being accessed
|
| 185 |
+
* @param OutEntitlementId The ID of the entitlement. Must be long enough to hold a string of EOS_ECOM_ENTITLEMENTID_MAX_LENGTH.
|
| 186 |
+
* @param InOutEntitlementIdLength The size of the OutEntitlementId in characters.
|
| 187 |
+
* The input buffer should include enough space to be null-terminated.
|
| 188 |
+
* When the function returns, this parameter will be filled with the length of the string copied into OutEntitlementId.
|
| 189 |
+
*
|
| 190 |
+
* @return EOS_EResult containing the result of the operation.
|
| 191 |
+
* Possible result codes:
|
| 192 |
+
* - EOS_Success if the information is available and passed out in EntitlementId
|
| 193 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 194 |
+
* - EOS_NotFound if the entitlement id is not found
|
| 195 |
+
*
|
| 196 |
+
* @see EOS_Ecom_CopyLastRedeemEntitlementsResultByIndexOptions
|
| 197 |
+
* @see EOS_ECOM_ENTITLEMENTID_MAX_LENGTH
|
| 198 |
+
*/
|
| 199 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyLastRedeemEntitlementsResultByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyLastRedeemEntitlementsResultByIndexOptions* Options, char* OutEntitlementId, int32_t* InOutEntitlementIdLength);
|
| 200 |
+
|
| 201 |
+
/**
|
| 202 |
+
* Fetch the number of entitlements that are cached for a given local user.
|
| 203 |
+
*
|
| 204 |
+
* @param Options structure containing the Epic Account ID being accessed
|
| 205 |
+
*
|
| 206 |
+
* @see EOS_Ecom_GetEntitlementsCountOptions
|
| 207 |
+
* @see EOS_Ecom_CopyEntitlementByIndex
|
| 208 |
+
*
|
| 209 |
+
* @return the number of entitlements found.
|
| 210 |
+
*/
|
| 211 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetEntitlementsCount(EOS_HEcom Handle, const EOS_Ecom_GetEntitlementsCountOptions* Options);
|
| 212 |
+
|
| 213 |
+
/**
|
| 214 |
+
* Fetch the number of entitlements with the given Entitlement Name that are cached for a given local user.
|
| 215 |
+
*
|
| 216 |
+
* @param Options structure containing the Epic Account ID and name being accessed
|
| 217 |
+
*
|
| 218 |
+
* @see EOS_Ecom_GetEntitlementsByNameCountOptions
|
| 219 |
+
* @see EOS_Ecom_CopyEntitlementByNameAndIndex
|
| 220 |
+
*
|
| 221 |
+
* @return the number of entitlements found.
|
| 222 |
+
*/
|
| 223 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetEntitlementsByNameCount(EOS_HEcom Handle, const EOS_Ecom_GetEntitlementsByNameCountOptions* Options);
|
| 224 |
+
|
| 225 |
+
/**
|
| 226 |
+
* Fetches an entitlement from a given index.
|
| 227 |
+
*
|
| 228 |
+
* @param Options structure containing the Epic Account ID and index being accessed
|
| 229 |
+
* @param OutEntitlement the entitlement for the given index, if it exists and is valid, use EOS_Ecom_Entitlement_Release when finished
|
| 230 |
+
*
|
| 231 |
+
* @see EOS_Ecom_CopyEntitlementByIndexOptions
|
| 232 |
+
* @see EOS_Ecom_Entitlement
|
| 233 |
+
* @see EOS_Ecom_Entitlement_Release
|
| 234 |
+
*
|
| 235 |
+
* @return EOS_EResult containing the result of the operation.
|
| 236 |
+
* Possible result codes:
|
| 237 |
+
* - EOS_Success if the information is available and passed out in OutEntitlement
|
| 238 |
+
* - EOS_Ecom_EntitlementStale if the entitlement information is stale and passed out in OutEntitlement
|
| 239 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 240 |
+
* - EOS_NotFound if the entitlement is not found
|
| 241 |
+
*/
|
| 242 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyEntitlementByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyEntitlementByIndexOptions* Options, EOS_Ecom_Entitlement ** OutEntitlement);
|
| 243 |
+
|
| 244 |
+
/**
|
| 245 |
+
* Fetches a single entitlement with a given Entitlement Name. The Index is used to access individual
|
| 246 |
+
* entitlements among those with the same Entitlement Name. The Index can be a value from 0 to
|
| 247 |
+
* one less than the result from EOS_Ecom_GetEntitlementsByNameCount.
|
| 248 |
+
*
|
| 249 |
+
* @param Options structure containing the Epic Account ID, entitlement name, and index being accessed
|
| 250 |
+
* @param OutEntitlement the entitlement for the given name index pair, if it exists and is valid, use EOS_Ecom_Entitlement_Release when finished
|
| 251 |
+
*
|
| 252 |
+
* @see EOS_Ecom_CopyEntitlementByNameAndIndexOptions
|
| 253 |
+
* @see EOS_Ecom_Entitlement
|
| 254 |
+
* @see EOS_Ecom_Entitlement_Release
|
| 255 |
+
*
|
| 256 |
+
* @return EOS_EResult containing the result of the operation.
|
| 257 |
+
* Possible result codes:
|
| 258 |
+
* - EOS_Success if the information is available and passed out in OutEntitlement
|
| 259 |
+
* - EOS_Ecom_EntitlementStale if the entitlement information is stale and passed out in OutEntitlement
|
| 260 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 261 |
+
* - EOS_NotFound if the entitlement is not found
|
| 262 |
+
*/
|
| 263 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyEntitlementByNameAndIndex(EOS_HEcom Handle, const EOS_Ecom_CopyEntitlementByNameAndIndexOptions* Options, EOS_Ecom_Entitlement ** OutEntitlement);
|
| 264 |
+
|
| 265 |
+
/**
|
| 266 |
+
* Fetches the entitlement with the given ID.
|
| 267 |
+
*
|
| 268 |
+
* @param Options structure containing the Epic Account ID and entitlement ID being accessed
|
| 269 |
+
* @param OutEntitlement the entitlement for the given ID, if it exists and is valid, use EOS_Ecom_Entitlement_Release when finished
|
| 270 |
+
*
|
| 271 |
+
* @see EOS_Ecom_CopyEntitlementByIdOptions
|
| 272 |
+
* @see EOS_Ecom_Entitlement
|
| 273 |
+
* @see EOS_Ecom_CopyEntitlementByNameAndIndex
|
| 274 |
+
* @see EOS_Ecom_Entitlement_Release
|
| 275 |
+
*
|
| 276 |
+
* @return EOS_EResult containing the result of the operation.
|
| 277 |
+
* Possible result codes:
|
| 278 |
+
* - EOS_Success if the information is available and passed out in OutEntitlement
|
| 279 |
+
* - EOS_Ecom_EntitlementStale if the entitlement information is stale and passed out in OutEntitlement
|
| 280 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 281 |
+
* - EOS_NotFound if the entitlement is not found
|
| 282 |
+
*/
|
| 283 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyEntitlementById(EOS_HEcom Handle, const EOS_Ecom_CopyEntitlementByIdOptions* Options, EOS_Ecom_Entitlement ** OutEntitlement);
|
| 284 |
+
|
| 285 |
+
/**
|
| 286 |
+
* Fetch the number of offers that are cached for a given local user.
|
| 287 |
+
*
|
| 288 |
+
* @param Options structure containing the Epic Account ID being accessed
|
| 289 |
+
*
|
| 290 |
+
* @see EOS_Ecom_GetOfferCountOptions
|
| 291 |
+
* @see EOS_Ecom_CopyOfferByIndex
|
| 292 |
+
*
|
| 293 |
+
* @return the number of offers found.
|
| 294 |
+
*/
|
| 295 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetOfferCount(EOS_HEcom Handle, const EOS_Ecom_GetOfferCountOptions* Options);
|
| 296 |
+
|
| 297 |
+
/**
|
| 298 |
+
* Fetches an offer from a given index. The pricing and text are localized to the provided account.
|
| 299 |
+
*
|
| 300 |
+
* @param Options structure containing the Epic Account ID and index being accessed
|
| 301 |
+
* @param OutOffer the offer for the given index, if it exists and is valid, use EOS_Ecom_CatalogOffer_Release when finished
|
| 302 |
+
*
|
| 303 |
+
* @see EOS_Ecom_CopyOfferByIndexOptions
|
| 304 |
+
* @see EOS_Ecom_CatalogOffer
|
| 305 |
+
* @see EOS_Ecom_CatalogOffer_Release
|
| 306 |
+
* @see EOS_Ecom_GetOfferItemCount
|
| 307 |
+
*
|
| 308 |
+
* @return EOS_EResult containing the result of the operation.
|
| 309 |
+
* Possible result codes:
|
| 310 |
+
* - EOS_Success if the information is available and passed out in OutOffer
|
| 311 |
+
* - EOS_Ecom_CatalogOfferStale if the offer information is stale and passed out in OutOffer
|
| 312 |
+
* - EOS_Ecom_CatalogOfferPriceInvalid if the offer information has an invalid price and passed out in OutOffer
|
| 313 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 314 |
+
* - EOS_NotFound if the offer is not found
|
| 315 |
+
*/
|
| 316 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyOfferByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyOfferByIndexOptions* Options, EOS_Ecom_CatalogOffer ** OutOffer);
|
| 317 |
+
|
| 318 |
+
/**
|
| 319 |
+
* Fetches an offer with a given ID. The pricing and text are localized to the provided account.
|
| 320 |
+
*
|
| 321 |
+
* @param Options structure containing the Epic Account ID and offer ID being accessed
|
| 322 |
+
* @param OutOffer the offer for the given index, if it exists and is valid, use EOS_Ecom_CatalogOffer_Release when finished
|
| 323 |
+
*
|
| 324 |
+
* @see EOS_Ecom_CopyOfferByIdOptions
|
| 325 |
+
* @see EOS_Ecom_CatalogOffer
|
| 326 |
+
* @see EOS_Ecom_CatalogOffer_Release
|
| 327 |
+
* @see EOS_Ecom_GetOfferItemCount
|
| 328 |
+
*
|
| 329 |
+
* @return EOS_EResult containing the result of the operation.
|
| 330 |
+
* Possible result codes:
|
| 331 |
+
* - EOS_Success if the information is available and passed out in OutOffer
|
| 332 |
+
* - EOS_Ecom_CatalogOfferStale if the offer information is stale and passed out in OutOffer
|
| 333 |
+
* - EOS_Ecom_CatalogOfferPriceInvalid if the offer information has an invalid price and passed out in OutOffer
|
| 334 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 335 |
+
* - EOS_NotFound if the offer is not found
|
| 336 |
+
*/
|
| 337 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyOfferById(EOS_HEcom Handle, const EOS_Ecom_CopyOfferByIdOptions* Options, EOS_Ecom_CatalogOffer ** OutOffer);
|
| 338 |
+
|
| 339 |
+
/**
|
| 340 |
+
* Fetch the number of items that are associated with a given cached offer for a local user.
|
| 341 |
+
*
|
| 342 |
+
* @see EOS_Ecom_GetOfferItemCountOptions
|
| 343 |
+
*
|
| 344 |
+
* @return the number of items found.
|
| 345 |
+
*/
|
| 346 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetOfferItemCount(EOS_HEcom Handle, const EOS_Ecom_GetOfferItemCountOptions* Options);
|
| 347 |
+
|
| 348 |
+
/**
|
| 349 |
+
* Fetches an item from a given index.
|
| 350 |
+
*
|
| 351 |
+
* @param Options structure containing the Epic Account ID and index being accessed
|
| 352 |
+
* @param OutItem the item for the given index, if it exists and is valid, use EOS_Ecom_CatalogItem_Release when finished
|
| 353 |
+
*
|
| 354 |
+
* @see EOS_Ecom_CopyOfferItemByIndexOptions
|
| 355 |
+
* @see EOS_Ecom_CatalogItem
|
| 356 |
+
* @see EOS_Ecom_CatalogItem_Release
|
| 357 |
+
* @see EOS_Ecom_GetItemImageInfoCount
|
| 358 |
+
* @see EOS_Ecom_GetItemReleaseCount
|
| 359 |
+
*
|
| 360 |
+
* @return EOS_EResult containing the result of the operation.
|
| 361 |
+
* Possible result codes:
|
| 362 |
+
* - EOS_Success if the information is available and passed out in OutItem
|
| 363 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 364 |
+
* - EOS_Ecom_CatalogItemStale if the item information is stale
|
| 365 |
+
* - EOS_NotFound if the item is not found
|
| 366 |
+
*/
|
| 367 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyOfferItemByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyOfferItemByIndexOptions* Options, EOS_Ecom_CatalogItem ** OutItem);
|
| 368 |
+
|
| 369 |
+
/**
|
| 370 |
+
* Fetches an item with a given ID.
|
| 371 |
+
*
|
| 372 |
+
* @param Options structure containing the item ID being accessed
|
| 373 |
+
* @param OutItem the item for the given index, if it exists and is valid, use EOS_Ecom_CatalogItem_Release when finished
|
| 374 |
+
*
|
| 375 |
+
* @see EOS_Ecom_CopyItemByIdOptions
|
| 376 |
+
* @see EOS_Ecom_CatalogItem
|
| 377 |
+
* @see EOS_Ecom_CatalogItem_Release
|
| 378 |
+
* @see EOS_Ecom_GetItemImageInfoCount
|
| 379 |
+
* @see EOS_Ecom_GetItemReleaseCount
|
| 380 |
+
*
|
| 381 |
+
* @return EOS_EResult containing the result of the operation.
|
| 382 |
+
* Possible result codes:
|
| 383 |
+
* - EOS_Success if the information is available and passed out in OutItem
|
| 384 |
+
* - EOS_Ecom_CatalogItemStale if the item information is stale and passed out in OutItem
|
| 385 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 386 |
+
* - EOS_NotFound if the offer is not found
|
| 387 |
+
*/
|
| 388 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyItemById(EOS_HEcom Handle, const EOS_Ecom_CopyItemByIdOptions* Options, EOS_Ecom_CatalogItem ** OutItem);
|
| 389 |
+
|
| 390 |
+
/**
|
| 391 |
+
* Fetch the number of images that are associated with a given cached offer for a local user.
|
| 392 |
+
*
|
| 393 |
+
* @see EOS_Ecom_GetOfferImageInfoCountOptions
|
| 394 |
+
*
|
| 395 |
+
* @return the number of images found.
|
| 396 |
+
*/
|
| 397 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetOfferImageInfoCount(EOS_HEcom Handle, const EOS_Ecom_GetOfferImageInfoCountOptions* Options);
|
| 398 |
+
|
| 399 |
+
/**
|
| 400 |
+
* Fetches an image from a given index.
|
| 401 |
+
*
|
| 402 |
+
* @param Options structure containing the offer ID and index being accessed
|
| 403 |
+
* @param OutImageInfo the image for the given index, if it exists and is valid, use EOS_Ecom_KeyImageInfo_Release when finished
|
| 404 |
+
*
|
| 405 |
+
* @see EOS_Ecom_CopyOfferImageInfoByIndexOptions
|
| 406 |
+
* @see EOS_Ecom_KeyImageInfo
|
| 407 |
+
* @see EOS_Ecom_KeyImageInfo_Release
|
| 408 |
+
*
|
| 409 |
+
* @return EOS_EResult containing the result of the operation.
|
| 410 |
+
* Possible result codes:
|
| 411 |
+
* - EOS_Success if the information is available and passed out in OutImageInfo
|
| 412 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 413 |
+
* - EOS_Ecom_CatalogOfferStale if the associated offer information is stale
|
| 414 |
+
* - EOS_NotFound if the image is not found
|
| 415 |
+
*/
|
| 416 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyOfferImageInfoByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyOfferImageInfoByIndexOptions* Options, EOS_Ecom_KeyImageInfo ** OutImageInfo);
|
| 417 |
+
|
| 418 |
+
/**
|
| 419 |
+
* Fetch the number of images that are associated with a given cached item for a local user.
|
| 420 |
+
*
|
| 421 |
+
* @see EOS_Ecom_GetItemImageInfoCountOptions
|
| 422 |
+
*
|
| 423 |
+
* @return the number of images found.
|
| 424 |
+
*/
|
| 425 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetItemImageInfoCount(EOS_HEcom Handle, const EOS_Ecom_GetItemImageInfoCountOptions* Options);
|
| 426 |
+
|
| 427 |
+
/**
|
| 428 |
+
* Fetches an image from a given index.
|
| 429 |
+
*
|
| 430 |
+
* @param Options structure containing the item ID and index being accessed
|
| 431 |
+
* @param OutImageInfo the image for the given index, if it exists and is valid, use EOS_Ecom_KeyImageInfo_Release when finished
|
| 432 |
+
*
|
| 433 |
+
* @see EOS_Ecom_CopyItemImageInfoByIndexOptions
|
| 434 |
+
* @see EOS_Ecom_KeyImageInfo
|
| 435 |
+
* @see EOS_Ecom_KeyImageInfo_Release
|
| 436 |
+
*
|
| 437 |
+
* @return EOS_EResult containing the result of the operation.
|
| 438 |
+
* Possible result codes:
|
| 439 |
+
* - EOS_Success if the information is available and passed out in OutImageInfo
|
| 440 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 441 |
+
* - EOS_Ecom_CatalogItemStale if the associated item information is stale
|
| 442 |
+
* - EOS_NotFound if the image is not found
|
| 443 |
+
*/
|
| 444 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyItemImageInfoByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyItemImageInfoByIndexOptions* Options, EOS_Ecom_KeyImageInfo ** OutImageInfo);
|
| 445 |
+
|
| 446 |
+
/**
|
| 447 |
+
* Fetch the number of releases that are associated with a given cached item for a local user.
|
| 448 |
+
*
|
| 449 |
+
* @see EOS_Ecom_GetItemReleaseCountOptions
|
| 450 |
+
*
|
| 451 |
+
* @return the number of releases found.
|
| 452 |
+
*/
|
| 453 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetItemReleaseCount(EOS_HEcom Handle, const EOS_Ecom_GetItemReleaseCountOptions* Options);
|
| 454 |
+
|
| 455 |
+
/**
|
| 456 |
+
* Fetches a release from a given index.
|
| 457 |
+
*
|
| 458 |
+
* @param Options structure containing the item ID and index being accessed
|
| 459 |
+
* @param OutRelease the release for the given index, if it exists and is valid, use EOS_Ecom_CatalogRelease_Release when finished
|
| 460 |
+
*
|
| 461 |
+
* @see EOS_Ecom_CopyItemReleaseByIndexOptions
|
| 462 |
+
* @see EOS_Ecom_CatalogRelease
|
| 463 |
+
* @see EOS_Ecom_CatalogRelease_Release
|
| 464 |
+
*
|
| 465 |
+
* @return EOS_EResult containing the result of the operation.
|
| 466 |
+
* Possible result codes:
|
| 467 |
+
* - EOS_Success if the information is available and passed out in OutRelease
|
| 468 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 469 |
+
* - EOS_Ecom_CatalogItemStale if the associated item information is stale
|
| 470 |
+
* - EOS_NotFound if the release is not found
|
| 471 |
+
*/
|
| 472 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyItemReleaseByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyItemReleaseByIndexOptions* Options, EOS_Ecom_CatalogRelease ** OutRelease);
|
| 473 |
+
|
| 474 |
+
/**
|
| 475 |
+
* Fetch the number of transactions that are cached for a given local user.
|
| 476 |
+
*
|
| 477 |
+
* @see EOS_Ecom_GetTransactionCountOptions
|
| 478 |
+
* @see EOS_Ecom_CheckoutCallbackInfo
|
| 479 |
+
* @see EOS_Ecom_CopyTransactionByIndex
|
| 480 |
+
*
|
| 481 |
+
* @return the number of transactions found.
|
| 482 |
+
*/
|
| 483 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_GetTransactionCount(EOS_HEcom Handle, const EOS_Ecom_GetTransactionCountOptions* Options);
|
| 484 |
+
|
| 485 |
+
/**
|
| 486 |
+
* Fetches the transaction handle at the given index.
|
| 487 |
+
*
|
| 488 |
+
* @param Options structure containing the Epic Account ID and index being accessed
|
| 489 |
+
*
|
| 490 |
+
* @see EOS_Ecom_CopyTransactionByIndexOptions
|
| 491 |
+
* @see EOS_Ecom_HTransaction
|
| 492 |
+
* @see EOS_Ecom_CheckoutCallbackInfo
|
| 493 |
+
* @see EOS_Ecom_Transaction_Release
|
| 494 |
+
*
|
| 495 |
+
* @return EOS_EResult containing the result of the operation.
|
| 496 |
+
* Possible result codes:
|
| 497 |
+
* - EOS_Success if the information is available and passed out in OutTransaction
|
| 498 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 499 |
+
* - EOS_NotFound if the transaction is not found
|
| 500 |
+
*/
|
| 501 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyTransactionByIndex(EOS_HEcom Handle, const EOS_Ecom_CopyTransactionByIndexOptions* Options, EOS_Ecom_HTransaction* OutTransaction);
|
| 502 |
+
|
| 503 |
+
/**
|
| 504 |
+
* Fetches the transaction handle at the given index.
|
| 505 |
+
*
|
| 506 |
+
* @param Options structure containing the Epic Account ID and transaction ID being accessed
|
| 507 |
+
*
|
| 508 |
+
* @see EOS_Ecom_CopyTransactionByIdOptions
|
| 509 |
+
* @see EOS_Ecom_HTransaction
|
| 510 |
+
* @see EOS_Ecom_CheckoutCallbackInfo
|
| 511 |
+
* @see EOS_Ecom_Transaction_Release
|
| 512 |
+
*
|
| 513 |
+
* @return EOS_EResult containing the result of the operation.
|
| 514 |
+
* Possible result codes:
|
| 515 |
+
* - EOS_Success if the information is available and passed out in OutTransaction
|
| 516 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 517 |
+
* - EOS_NotFound if the transaction is not found
|
| 518 |
+
*/
|
| 519 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_CopyTransactionById(EOS_HEcom Handle, const EOS_Ecom_CopyTransactionByIdOptions* Options, EOS_Ecom_HTransaction* OutTransaction);
|
| 520 |
+
|
| 521 |
+
/**
|
| 522 |
+
* The Ecom Transaction Interface exposes getters for accessing information about a completed transaction.
|
| 523 |
+
* All Ecom Transaction Interface calls take a handle of type EOS_Ecom_HTransaction as the first parameter.
|
| 524 |
+
* An EOS_Ecom_HTransaction handle is originally returned as part of the EOS_Ecom_CheckoutCallbackInfo struct.
|
| 525 |
+
* An EOS_Ecom_HTransaction handle can also be retrieved from an EOS_HEcom handle using EOS_Ecom_CopyTransactionByIndex.
|
| 526 |
+
* It is expected that after a transaction that EOS_Ecom_Transaction_Release is called.
|
| 527 |
+
* When EOS_Platform_Release is called any remaining transactions will also be released.
|
| 528 |
+
*
|
| 529 |
+
* @see EOS_Ecom_CheckoutCallbackInfo
|
| 530 |
+
* @see EOS_Ecom_GetTransactionCount
|
| 531 |
+
* @see EOS_Ecom_CopyTransactionByIndex
|
| 532 |
+
*/
|
| 533 |
+
|
| 534 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_Transaction_GetTransactionId(EOS_Ecom_HTransaction Handle, char* OutBuffer, int32_t* InOutBufferLength);
|
| 535 |
+
|
| 536 |
+
/**
|
| 537 |
+
* Fetch the number of entitlements that are part of this transaction.
|
| 538 |
+
*
|
| 539 |
+
* @param Options structure containing the Epic Account ID being accessed
|
| 540 |
+
*
|
| 541 |
+
* @see EOS_Ecom_Transaction_GetEntitlementsCountOptions
|
| 542 |
+
* @see EOS_Ecom_Transaction_CopyEntitlementByIndex
|
| 543 |
+
*
|
| 544 |
+
* @return the number of entitlements found.
|
| 545 |
+
*/
|
| 546 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Ecom_Transaction_GetEntitlementsCount(EOS_Ecom_HTransaction Handle, const EOS_Ecom_Transaction_GetEntitlementsCountOptions* Options);
|
| 547 |
+
|
| 548 |
+
/**
|
| 549 |
+
* Fetches an entitlement from a given index.
|
| 550 |
+
*
|
| 551 |
+
* @param Options structure containing the index being accessed
|
| 552 |
+
* @param OutEntitlement the entitlement for the given index, if it exists and is valid, use EOS_Ecom_Entitlement_Release when finished
|
| 553 |
+
*
|
| 554 |
+
* @see EOS_Ecom_Transaction_CopyEntitlementByIndexOptions
|
| 555 |
+
* @see EOS_Ecom_Entitlement
|
| 556 |
+
* @see EOS_Ecom_Entitlement_Release
|
| 557 |
+
*
|
| 558 |
+
* @return EOS_EResult containing the result of the operation.
|
| 559 |
+
* Possible result codes:
|
| 560 |
+
* - EOS_Success if the information is available and passed out in OutEntitlement
|
| 561 |
+
* - EOS_Ecom_EntitlementStale if the entitlement information is stale and passed out in OutEntitlement
|
| 562 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 563 |
+
* - EOS_NotFound if the entitlement is not found
|
| 564 |
+
*/
|
| 565 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Ecom_Transaction_CopyEntitlementByIndex(EOS_Ecom_HTransaction Handle, const EOS_Ecom_Transaction_CopyEntitlementByIndexOptions* Options, EOS_Ecom_Entitlement ** OutEntitlement);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_ecom_types.h
ADDED
|
@@ -0,0 +1,1178 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
EOS_EXTERN_C typedef struct EOS_EcomHandle* EOS_HEcom;
|
| 10 |
+
|
| 11 |
+
/**
|
| 12 |
+
* This handle is copied when EOS_Ecom_CopyTransactionById or EOS_Ecom_CopyTransactionByIndex is called.
|
| 13 |
+
* A EOS_Ecom_CheckoutCallbackInfo provides the ID for the copy.
|
| 14 |
+
* After being copied, EOS_Ecom_Transaction_Release must be called.
|
| 15 |
+
*
|
| 16 |
+
* @see EOS_Ecom_CheckoutCallbackInfo
|
| 17 |
+
* @see EOS_Ecom_CopyTransactionById
|
| 18 |
+
* @see EOS_Ecom_CopyTransactionByIndex
|
| 19 |
+
* @see EOS_Ecom_Transaction_Release
|
| 20 |
+
*/
|
| 21 |
+
EOS_EXTERN_C typedef struct EOS_Ecom_TransactionHandle* EOS_Ecom_HTransaction;
|
| 22 |
+
|
| 23 |
+
/**
|
| 24 |
+
* A unique identifier for a catalog item defined and stored with the backend catalog service.
|
| 25 |
+
* A catalog item represents a distinct object within the catalog. When acquired by an account, an
|
| 26 |
+
* entitlement is granted that references a specific catalog item.
|
| 27 |
+
*/
|
| 28 |
+
EOS_EXTERN_C typedef const char* EOS_Ecom_CatalogItemId;
|
| 29 |
+
|
| 30 |
+
/**
|
| 31 |
+
* A unique identifier for a catalog offer defined and stored with the backend catalog service.
|
| 32 |
+
* A catalog offer is a purchasable collection of 1 or more items, associated with a price (which
|
| 33 |
+
* could be 0). When an offer is purchased an entitlement is granted for each of the items
|
| 34 |
+
* referenced by the offer.
|
| 35 |
+
*/
|
| 36 |
+
EOS_EXTERN_C typedef const char* EOS_Ecom_CatalogOfferId;
|
| 37 |
+
|
| 38 |
+
/**
|
| 39 |
+
* An identifier which is defined on a catalog item and stored with the backend catalog service.
|
| 40 |
+
* The entitlement name may not be unique. A catalog may be configured with multiple items with the
|
| 41 |
+
* same entitlement name in order to define a logical grouping of entitlements. This is used to
|
| 42 |
+
* retrieve all entitlements granted to an account grouped in this way.
|
| 43 |
+
*
|
| 44 |
+
* @see EOS_Ecom_QueryEntitlements
|
| 45 |
+
*/
|
| 46 |
+
EOS_EXTERN_C typedef const char* EOS_Ecom_EntitlementName;
|
| 47 |
+
|
| 48 |
+
/**
|
| 49 |
+
* A unique identifier for an entitlement owned by an account. An entitlement is always associated
|
| 50 |
+
* with a single account. The entitlement ID is provided to allow redeeming the entitlement as
|
| 51 |
+
* well as identify individual entitlement grants.
|
| 52 |
+
*
|
| 53 |
+
* @see EOS_Ecom_QueryEntitlements
|
| 54 |
+
* @see EOS_Ecom_RedeemEntitlements
|
| 55 |
+
*/
|
| 56 |
+
EOS_EXTERN_C typedef const char* EOS_Ecom_EntitlementId;
|
| 57 |
+
|
| 58 |
+
/**
|
| 59 |
+
* A unique identifier for the Sandbox.
|
| 60 |
+
*
|
| 61 |
+
* @see EOS_Ecom_QueryOwnershipBySandboxIds
|
| 62 |
+
*/
|
| 63 |
+
EOS_EXTERN_C typedef const char* EOS_Ecom_SandboxId;
|
| 64 |
+
|
| 65 |
+
/**
|
| 66 |
+
* An enumeration of the different ownership statuses.
|
| 67 |
+
*/
|
| 68 |
+
EOS_ENUM(EOS_EOwnershipStatus,
|
| 69 |
+
/** The catalog item is not owned by the local user */
|
| 70 |
+
EOS_OS_NotOwned = 0,
|
| 71 |
+
/** The catalog item is owned by the local user */
|
| 72 |
+
EOS_OS_Owned = 1
|
| 73 |
+
);
|
| 74 |
+
|
| 75 |
+
/**
|
| 76 |
+
* An enumeration defining the type of catalog item. The primary use is to identify how the item is expended.
|
| 77 |
+
*/
|
| 78 |
+
EOS_ENUM(EOS_EEcomItemType,
|
| 79 |
+
/** This entitlement is intended to persist. */
|
| 80 |
+
EOS_EIT_Durable = 0,
|
| 81 |
+
/**
|
| 82 |
+
* This entitlement is intended to be transient and redeemed.
|
| 83 |
+
*
|
| 84 |
+
* @see EOS_Ecom_RedeemEntitlements
|
| 85 |
+
*/
|
| 86 |
+
EOS_EIT_Consumable = 1,
|
| 87 |
+
/** This entitlement has a type that is not currently intended for an in-game store. */
|
| 88 |
+
EOS_EIT_Other = 2
|
| 89 |
+
);
|
| 90 |
+
|
| 91 |
+
/**
|
| 92 |
+
* An enumeration defining the possible orientation for the checkout page. This will be used on mobile.
|
| 93 |
+
*/
|
| 94 |
+
EOS_ENUM(EOS_ECheckoutOrientation,
|
| 95 |
+
/** Current orientation will be used */
|
| 96 |
+
EOS_ECO_Default = 0,
|
| 97 |
+
/** Portrait orientation */
|
| 98 |
+
EOS_ECO_Portrait = 1,
|
| 99 |
+
/** Landscape orientation */
|
| 100 |
+
EOS_ECO_Landscape = 2
|
| 101 |
+
);
|
| 102 |
+
|
| 103 |
+
/** The most recent version of the EOS_Ecom_Entitlement struct. */
|
| 104 |
+
#define EOS_ECOM_ENTITLEMENT_API_LATEST 2
|
| 105 |
+
|
| 106 |
+
/** Timestamp value representing an undefined EndTimestamp for EOS_Ecom_Entitlement */
|
| 107 |
+
#define EOS_ECOM_ENTITLEMENT_ENDTIMESTAMP_UNDEFINED -1
|
| 108 |
+
|
| 109 |
+
/**
|
| 110 |
+
* Contains information about a single entitlement associated with an account. Instances of this structure are
|
| 111 |
+
* created by EOS_Ecom_CopyEntitlementByIndex, EOS_Ecom_CopyEntitlementByNameAndIndex, or EOS_Ecom_CopyEntitlementById.
|
| 112 |
+
* They must be passed to EOS_Ecom_Entitlement_Release.
|
| 113 |
+
*/
|
| 114 |
+
EOS_STRUCT(EOS_Ecom_Entitlement, (
|
| 115 |
+
/** API Version: Set this to EOS_ECOM_ENTITLEMENT_API_LATEST. */
|
| 116 |
+
int32_t ApiVersion;
|
| 117 |
+
/** Name of the entitlement */
|
| 118 |
+
EOS_Ecom_EntitlementName EntitlementName;
|
| 119 |
+
/** ID of the entitlement owned by an account */
|
| 120 |
+
EOS_Ecom_EntitlementId EntitlementId;
|
| 121 |
+
/** ID of the item associated with the offer which granted this entitlement */
|
| 122 |
+
EOS_Ecom_CatalogItemId CatalogItemId;
|
| 123 |
+
/**
|
| 124 |
+
* If queried using pagination then ServerIndex represents the index of the entitlement as it
|
| 125 |
+
* exists on the server. If not queried using pagination then ServerIndex will be -1.
|
| 126 |
+
*/
|
| 127 |
+
int32_t ServerIndex;
|
| 128 |
+
/** If true then the catalog has this entitlement marked as redeemed */
|
| 129 |
+
EOS_Bool bRedeemed;
|
| 130 |
+
/** If not -1 then this is a POSIX timestamp that this entitlement will end */
|
| 131 |
+
int64_t EndTimestamp;
|
| 132 |
+
));
|
| 133 |
+
|
| 134 |
+
/**
|
| 135 |
+
* Release the memory associated with an EOS_Ecom_Entitlement structure. This must be called on data
|
| 136 |
+
* retrieved from EOS_Ecom_CopyEntitlementByIndex and EOS_Ecom_CopyEntitlementById.
|
| 137 |
+
*
|
| 138 |
+
* @param Entitlement - The entitlement structure to be released
|
| 139 |
+
*
|
| 140 |
+
* @see EOS_Ecom_Entitlement
|
| 141 |
+
* @see EOS_Ecom_CopyEntitlementByIndex
|
| 142 |
+
* @see EOS_Ecom_CopyEntitlementById
|
| 143 |
+
*/
|
| 144 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_Entitlement_Release(EOS_Ecom_Entitlement* Entitlement);
|
| 145 |
+
|
| 146 |
+
/** The most recent version of the EOS_Ecom_ItemOwnership struct. */
|
| 147 |
+
#define EOS_ECOM_ITEMOWNERSHIP_API_LATEST 1
|
| 148 |
+
|
| 149 |
+
/**
|
| 150 |
+
* Contains information about a single item ownership associated with an account. This structure is
|
| 151 |
+
* returned as part of the EOS_Ecom_QueryOwnershipCallbackInfo structure.
|
| 152 |
+
*/
|
| 153 |
+
EOS_STRUCT(EOS_Ecom_ItemOwnership, (
|
| 154 |
+
/** API Version: Set this to EOS_ECOM_ITEMOWNERSHIP_API_LATEST. */
|
| 155 |
+
int32_t ApiVersion;
|
| 156 |
+
/** ID of the catalog item */
|
| 157 |
+
EOS_Ecom_CatalogItemId Id;
|
| 158 |
+
/** Is this catalog item owned by the local user */
|
| 159 |
+
EOS_EOwnershipStatus OwnershipStatus;
|
| 160 |
+
));
|
| 161 |
+
|
| 162 |
+
/** The most recent version of the EOS_Ecom_CatalogItem struct. */
|
| 163 |
+
#define EOS_ECOM_CATALOGITEM_API_LATEST 1
|
| 164 |
+
|
| 165 |
+
/** Timestamp value representing an undefined EntitlementEndTimestamp for EOS_Ecom_CatalogItem */
|
| 166 |
+
#define EOS_ECOM_CATALOGITEM_ENTITLEMENTENDTIMESTAMP_UNDEFINED -1
|
| 167 |
+
|
| 168 |
+
/** The maximum length of a CatalogItemId. */
|
| 169 |
+
#define EOS_ECOM_CATALOGITEMID_MAX_LENGTH 32
|
| 170 |
+
|
| 171 |
+
/**
|
| 172 |
+
* Contains information about a single item within the catalog. Instances of this structure are created
|
| 173 |
+
* by EOS_Ecom_CopyOfferItemByIndex. They must be passed to EOS_Ecom_CatalogItem_Release.
|
| 174 |
+
*/
|
| 175 |
+
EOS_STRUCT(EOS_Ecom_CatalogItem, (
|
| 176 |
+
/** API Version: Set this to EOS_ECOM_CATALOGITEM_API_LATEST. */
|
| 177 |
+
int32_t ApiVersion;
|
| 178 |
+
/** Product namespace in which this item exists */
|
| 179 |
+
const char* CatalogNamespace;
|
| 180 |
+
/** The ID of this item */
|
| 181 |
+
EOS_Ecom_CatalogItemId Id;
|
| 182 |
+
/** The entitlement name associated with this item */
|
| 183 |
+
EOS_Ecom_EntitlementName EntitlementName;
|
| 184 |
+
/** Localized UTF-8 title of this item */
|
| 185 |
+
const char* TitleText;
|
| 186 |
+
/** Localized UTF-8 description of this item */
|
| 187 |
+
const char* DescriptionText;
|
| 188 |
+
/** Localized UTF-8 long description of this item */
|
| 189 |
+
const char* LongDescriptionText;
|
| 190 |
+
/** Localized UTF-8 technical details of this item */
|
| 191 |
+
const char* TechnicalDetailsText;
|
| 192 |
+
/** Localized UTF-8 developer of this item */
|
| 193 |
+
const char* DeveloperText;
|
| 194 |
+
/** The type of item as defined in the catalog */
|
| 195 |
+
EOS_EEcomItemType ItemType;
|
| 196 |
+
/** If not -1 then this is the POSIX timestamp that the entitlement will end */
|
| 197 |
+
int64_t EntitlementEndTimestamp;
|
| 198 |
+
));
|
| 199 |
+
|
| 200 |
+
/**
|
| 201 |
+
* Release the memory associated with an EOS_Ecom_CatalogItem structure. This must be called on data
|
| 202 |
+
* retrieved from EOS_Ecom_CopyOfferItemByIndex.
|
| 203 |
+
*
|
| 204 |
+
* @param CatalogItem - The catalog item structure to be released
|
| 205 |
+
*
|
| 206 |
+
* @see EOS_Ecom_CatalogItem
|
| 207 |
+
* @see EOS_Ecom_CopyOfferItemByIndex
|
| 208 |
+
*/
|
| 209 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_CatalogItem_Release(EOS_Ecom_CatalogItem* CatalogItem);
|
| 210 |
+
|
| 211 |
+
/** The most recent version of the EOS_Ecom_CatalogOffer struct. */
|
| 212 |
+
#define EOS_ECOM_CATALOGOFFER_API_LATEST 5
|
| 213 |
+
|
| 214 |
+
/** Timestamp value representing an undefined ExpirationTimestamp for EOS_Ecom_CatalogOffer */
|
| 215 |
+
#define EOS_ECOM_CATALOGOFFER_EXPIRATIONTIMESTAMP_UNDEFINED -1
|
| 216 |
+
/** Timestamp value representing an undefined ReleaseDateTimestamp for EOS_Ecom_CatalogOffer */
|
| 217 |
+
#define EOS_ECOM_CATALOGOFFER_RELEASEDATETIMESTAMP_UNDEFINED -1
|
| 218 |
+
/** Timestamp value representing an undefined EffectiveDateTimestamp for EOS_Ecom_CatalogOffer */
|
| 219 |
+
#define EOS_ECOM_CATALOGOFFER_EFFECTIVEDATETIMESTAMP_UNDEFINED -1
|
| 220 |
+
|
| 221 |
+
/** The maximum length of a CatalogOfferId. */
|
| 222 |
+
#define EOS_ECOM_CATALOGOFFERID_MAX_LENGTH 32
|
| 223 |
+
|
| 224 |
+
/**
|
| 225 |
+
* Contains information about a single offer within the catalog. Instances of this structure are
|
| 226 |
+
* created by EOS_Ecom_CopyOfferByIndex. They must be passed to EOS_Ecom_CatalogOffer_Release.
|
| 227 |
+
* Prices are stored in the lowest denomination for the associated currency. If CurrencyCode is
|
| 228 |
+
* "USD" then a price of 299 represents "$2.99".
|
| 229 |
+
*/
|
| 230 |
+
EOS_STRUCT(EOS_Ecom_CatalogOffer, (
|
| 231 |
+
/** API Version: Set this to EOS_ECOM_CATALOGOFFER_API_LATEST. */
|
| 232 |
+
int32_t ApiVersion;
|
| 233 |
+
/**
|
| 234 |
+
* The index of this offer as it exists on the server.
|
| 235 |
+
* This is useful for understanding pagination data.
|
| 236 |
+
*/
|
| 237 |
+
int32_t ServerIndex;
|
| 238 |
+
/** Product namespace in which this offer exists */
|
| 239 |
+
const char* CatalogNamespace;
|
| 240 |
+
/** The ID of this offer */
|
| 241 |
+
EOS_Ecom_CatalogOfferId Id;
|
| 242 |
+
/** Localized UTF-8 title of this offer */
|
| 243 |
+
const char* TitleText;
|
| 244 |
+
/** Localized UTF-8 description of this offer */
|
| 245 |
+
const char* DescriptionText;
|
| 246 |
+
/** Localized UTF-8 long description of this offer */
|
| 247 |
+
const char* LongDescriptionText;
|
| 248 |
+
/**
|
| 249 |
+
* Deprecated.
|
| 250 |
+
* EOS_Ecom_CatalogItem::TechnicalDetailsText is still valid.
|
| 251 |
+
*/
|
| 252 |
+
const char* TechnicalDetailsText_DEPRECATED;
|
| 253 |
+
/** The Currency Code for this offer */
|
| 254 |
+
const char* CurrencyCode;
|
| 255 |
+
/**
|
| 256 |
+
* If this value is EOS_Success then OriginalPrice, CurrentPrice, and DiscountPercentage contain valid data.
|
| 257 |
+
* Otherwise this value represents the error that occurred on the price query.
|
| 258 |
+
*/
|
| 259 |
+
EOS_EResult PriceResult;
|
| 260 |
+
/** The original price of this offer as a 32-bit number is deprecated. */
|
| 261 |
+
uint32_t OriginalPrice_DEPRECATED;
|
| 262 |
+
/** The current price including discounts of this offer as a 32-bit number is deprecated.. */
|
| 263 |
+
uint32_t CurrentPrice_DEPRECATED;
|
| 264 |
+
/** A value from 0 to 100 define the percentage of the OrignalPrice that the CurrentPrice represents */
|
| 265 |
+
uint8_t DiscountPercentage;
|
| 266 |
+
/** Contains the POSIX timestamp that the offer expires or -1 if it does not expire */
|
| 267 |
+
int64_t ExpirationTimestamp;
|
| 268 |
+
/**
|
| 269 |
+
* The number of times that the requesting account has purchased this offer.
|
| 270 |
+
* This value is deprecated and the backend no longer returns this value.
|
| 271 |
+
*/
|
| 272 |
+
uint32_t PurchasedCount_DEPRECATED;
|
| 273 |
+
/**
|
| 274 |
+
* The maximum number of times that the offer can be purchased.
|
| 275 |
+
* A negative value implies there is no limit.
|
| 276 |
+
*/
|
| 277 |
+
int32_t PurchaseLimit;
|
| 278 |
+
/** True if the user can purchase this offer. */
|
| 279 |
+
EOS_Bool bAvailableForPurchase;
|
| 280 |
+
/** The original price of this offer as a 64-bit number. */
|
| 281 |
+
uint64_t OriginalPrice64;
|
| 282 |
+
/** The current price including discounts of this offer as a 64-bit number. */
|
| 283 |
+
uint64_t CurrentPrice64;
|
| 284 |
+
/** The decimal point for the provided price. For example, DecimalPoint '2' and CurrentPrice64 '12345' would be '123.45'. */
|
| 285 |
+
uint32_t DecimalPoint;
|
| 286 |
+
/** Timestamp indicating when the time when the offer was released. Can be ignored if set to -1. */
|
| 287 |
+
int64_t ReleaseDateTimestamp;
|
| 288 |
+
/** Timestamp indicating the effective date of the offer. Can be ignored if set to -1. */
|
| 289 |
+
int64_t EffectiveDateTimestamp;
|
| 290 |
+
));
|
| 291 |
+
|
| 292 |
+
/**
|
| 293 |
+
* Release the memory associated with an EOS_Ecom_CatalogOffer structure. This must be called on data
|
| 294 |
+
* retrieved from EOS_Ecom_CopyOfferByIndex.
|
| 295 |
+
*
|
| 296 |
+
* @param CatalogOffer - The catalog offer structure to be released
|
| 297 |
+
*
|
| 298 |
+
* @see EOS_Ecom_CatalogOffer
|
| 299 |
+
* @see EOS_Ecom_CopyOfferByIndex
|
| 300 |
+
*/
|
| 301 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_CatalogOffer_Release(EOS_Ecom_CatalogOffer* CatalogOffer);
|
| 302 |
+
|
| 303 |
+
/** The most recent version of the EOS_Ecom_KeyImageInfo struct. */
|
| 304 |
+
#define EOS_ECOM_KEYIMAGEINFO_API_LATEST 1
|
| 305 |
+
|
| 306 |
+
/**
|
| 307 |
+
* Contains information about a key image used by the catalog. Instances of this structure are
|
| 308 |
+
* created by EOS_Ecom_CopyItemImageInfoByIndex. They must be passed to EOS_Ecom_KeyImageInfo_Release.
|
| 309 |
+
* A Key Image is defined within Dev Portal and is associated with a Catalog Item. A Key Image is
|
| 310 |
+
* intended to be used to provide imagery for an in-game store.
|
| 311 |
+
*
|
| 312 |
+
* @see EOS_Ecom_CopyItemImageInfoByIndex
|
| 313 |
+
* @see EOS_Ecom_KeyImageInfo_Release
|
| 314 |
+
*/
|
| 315 |
+
EOS_STRUCT(EOS_Ecom_KeyImageInfo, (
|
| 316 |
+
/** API Version: Set this to EOS_ECOM_KEYIMAGEINFO_API_LATEST. */
|
| 317 |
+
int32_t ApiVersion;
|
| 318 |
+
/** Describes the usage of the image (ex: home_thumbnail) */
|
| 319 |
+
const char* Type;
|
| 320 |
+
/** The URL of the image */
|
| 321 |
+
const char* Url;
|
| 322 |
+
/** The expected width in pixels of the image */
|
| 323 |
+
uint32_t Width;
|
| 324 |
+
/** The expected height in pixels of the image */
|
| 325 |
+
uint32_t Height;
|
| 326 |
+
));
|
| 327 |
+
|
| 328 |
+
/**
|
| 329 |
+
* Release the memory associated with an EOS_Ecom_KeyImageInfo structure. This must be called on data
|
| 330 |
+
* retrieved from EOS_Ecom_CopyItemImageInfoByIndex.
|
| 331 |
+
*
|
| 332 |
+
* @param KeyImageInfo - The key image info structure to be released
|
| 333 |
+
*
|
| 334 |
+
* @see EOS_Ecom_KeyImageInfo
|
| 335 |
+
* @see EOS_Ecom_CopyItemImageInfoByIndex
|
| 336 |
+
*/
|
| 337 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_KeyImageInfo_Release(EOS_Ecom_KeyImageInfo* KeyImageInfo);
|
| 338 |
+
|
| 339 |
+
/** The most recent version of the EOS_Ecom_CatalogRelease struct. */
|
| 340 |
+
#define EOS_ECOM_CATALOGRELEASE_API_LATEST 1
|
| 341 |
+
|
| 342 |
+
/**
|
| 343 |
+
* Contains information about a single release within the catalog. Instances of this structure are
|
| 344 |
+
* created by EOS_Ecom_CopyItemReleaseByIndex. They must be passed to EOS_Ecom_CatalogRelease_Release.
|
| 345 |
+
*/
|
| 346 |
+
EOS_STRUCT(EOS_Ecom_CatalogRelease, (
|
| 347 |
+
/** API Version: Set this to EOS_ECOM_CATALOGRELEASE_API_LATEST. */
|
| 348 |
+
int32_t ApiVersion;
|
| 349 |
+
/** The number of APP IDs */
|
| 350 |
+
uint32_t CompatibleAppIdCount;
|
| 351 |
+
/** A list of compatible APP IDs */
|
| 352 |
+
const char** CompatibleAppIds;
|
| 353 |
+
/** The number of platforms */
|
| 354 |
+
uint32_t CompatiblePlatformCount;
|
| 355 |
+
/** A list of compatible Platforms */
|
| 356 |
+
const char** CompatiblePlatforms;
|
| 357 |
+
/** Release note for compatible versions */
|
| 358 |
+
const char* ReleaseNote;
|
| 359 |
+
));
|
| 360 |
+
|
| 361 |
+
/**
|
| 362 |
+
* Release the memory associated with an EOS_Ecom_CatalogRelease structure. This must be called on
|
| 363 |
+
* data retrieved from EOS_Ecom_CopyItemReleaseByIndex.
|
| 364 |
+
*
|
| 365 |
+
* @param CatalogRelease - The catalog release structure to be released
|
| 366 |
+
*
|
| 367 |
+
* @see EOS_Ecom_CatalogRelease
|
| 368 |
+
* @see EOS_Ecom_CopyItemReleaseByIndex
|
| 369 |
+
*/
|
| 370 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_CatalogRelease_Release(EOS_Ecom_CatalogRelease* CatalogRelease);
|
| 371 |
+
|
| 372 |
+
/** The most recent version of the EOS_Ecom_CheckoutEntry struct. */
|
| 373 |
+
#define EOS_ECOM_CHECKOUTENTRY_API_LATEST 1
|
| 374 |
+
|
| 375 |
+
/**
|
| 376 |
+
* Contains information about a request to purchase a single offer. This structure is set as part
|
| 377 |
+
* of the EOS_Ecom_CheckoutOptions structure.
|
| 378 |
+
*/
|
| 379 |
+
EOS_STRUCT(EOS_Ecom_CheckoutEntry, (
|
| 380 |
+
/** API Version: Set this to EOS_ECOM_CHECKOUTENTRY_API_LATEST. */
|
| 381 |
+
int32_t ApiVersion;
|
| 382 |
+
/** The ID of the offer to purchase */
|
| 383 |
+
EOS_Ecom_CatalogOfferId OfferId;
|
| 384 |
+
));
|
| 385 |
+
|
| 386 |
+
/** The most recent version of the EOS_Ecom_QueryOwnership API. */
|
| 387 |
+
#define EOS_ECOM_QUERYOWNERSHIP_API_LATEST 2
|
| 388 |
+
|
| 389 |
+
/**
|
| 390 |
+
* The maximum number of catalog items that may be queried in a single pass
|
| 391 |
+
*/
|
| 392 |
+
#define EOS_ECOM_QUERYOWNERSHIP_MAX_CATALOG_IDS 400
|
| 393 |
+
|
| 394 |
+
/**
|
| 395 |
+
* Input parameters for the EOS_Ecom_QueryOwnership function.
|
| 396 |
+
*/
|
| 397 |
+
EOS_STRUCT(EOS_Ecom_QueryOwnershipOptions, (
|
| 398 |
+
/** API Version: Set this to EOS_ECOM_QUERYOWNERSHIP_API_LATEST. */
|
| 399 |
+
int32_t ApiVersion;
|
| 400 |
+
/** The Epic Account ID of the local user whose ownership to query */
|
| 401 |
+
EOS_EpicAccountId LocalUserId;
|
| 402 |
+
/** The array of Catalog Item IDs to check for ownership */
|
| 403 |
+
EOS_Ecom_CatalogItemId* CatalogItemIds;
|
| 404 |
+
/** The number of Catalog Item IDs to in the array */
|
| 405 |
+
uint32_t CatalogItemIdCount;
|
| 406 |
+
/** Optional product namespace, if not the one specified during initialization */
|
| 407 |
+
const char* CatalogNamespace;
|
| 408 |
+
));
|
| 409 |
+
|
| 410 |
+
/**
|
| 411 |
+
* Output parameters for the EOS_Ecom_QueryOwnership Function.
|
| 412 |
+
*/
|
| 413 |
+
EOS_STRUCT(EOS_Ecom_QueryOwnershipCallbackInfo, (
|
| 414 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 415 |
+
EOS_EResult ResultCode;
|
| 416 |
+
/** Context that was passed into EOS_Ecom_QueryOwnership */
|
| 417 |
+
void* ClientData;
|
| 418 |
+
/** The Epic Account ID of the local user whose ownership was queried */
|
| 419 |
+
EOS_EpicAccountId LocalUserId;
|
| 420 |
+
/** List of catalog items and their ownership status */
|
| 421 |
+
const EOS_Ecom_ItemOwnership* ItemOwnership;
|
| 422 |
+
/** Number of ownership results are included in this callback */
|
| 423 |
+
uint32_t ItemOwnershipCount;
|
| 424 |
+
));
|
| 425 |
+
|
| 426 |
+
/**
|
| 427 |
+
* Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnership
|
| 428 |
+
* @param Data A EOS_Ecom_QueryOwnershipCallbackInfo containing the output information and result
|
| 429 |
+
*/
|
| 430 |
+
EOS_DECLARE_CALLBACK(EOS_Ecom_OnQueryOwnershipCallback, const EOS_Ecom_QueryOwnershipCallbackInfo* Data);
|
| 431 |
+
|
| 432 |
+
/** The most recent version of the EOS_Ecom_QueryOwnershipBySandboxIds API. */
|
| 433 |
+
#define EOS_ECOM_QUERYOWNERSHIPBYSANDBOXIDSOPTIONS_API_LATEST 1
|
| 434 |
+
|
| 435 |
+
/**
|
| 436 |
+
* The maximum number of Sandbox Ids that may be queried in a single pass.
|
| 437 |
+
*/
|
| 438 |
+
#define EOS_ECOM_QUERYOWNERSHIP_MAX_SANDBOX_IDS 10
|
| 439 |
+
|
| 440 |
+
/**
|
| 441 |
+
* Input parameters for the EOS_Ecom_QueryOwnershipBySandboxIds function.
|
| 442 |
+
*/
|
| 443 |
+
EOS_STRUCT(EOS_Ecom_QueryOwnershipBySandboxIdsOptions, (
|
| 444 |
+
/** API Version: Set this to EOS_ECOM_QUERYOWNERSHIPBYSANDBOXIDSOPTIONS_API_LATEST. */
|
| 445 |
+
int32_t ApiVersion;
|
| 446 |
+
/** The Epic Account ID of the local user whose ownership to query. */
|
| 447 |
+
EOS_EpicAccountId LocalUserId;
|
| 448 |
+
/** The array of Sandbox IDs to check for ownership. */
|
| 449 |
+
EOS_Ecom_SandboxId* SandboxIds;
|
| 450 |
+
/** The number of Sandbox IDs in the query. */
|
| 451 |
+
uint32_t SandboxIdsCount;
|
| 452 |
+
));
|
| 453 |
+
|
| 454 |
+
/**
|
| 455 |
+
* Contains all owned catalog items for a sandbox ID. This structure is
|
| 456 |
+
* returned as part of the EOS_Ecom_QueryOwnershipBySandboxIdsCallbackInfo structure.
|
| 457 |
+
* Note: The SandboxID and CatalogItemId strings will not remain valid after EOS_Ecom_OnQueryOwnershipBySandboxIdsCallback, so a copy should be as needed.
|
| 458 |
+
*/
|
| 459 |
+
EOS_STRUCT(EOS_Ecom_SandboxIdItemOwnership, (
|
| 460 |
+
/** SandboxId */
|
| 461 |
+
EOS_Ecom_SandboxId SandboxId;
|
| 462 |
+
/** List of all owned catalog items for this SandboxId */
|
| 463 |
+
const EOS_Ecom_CatalogItemId* OwnedCatalogItemIds;
|
| 464 |
+
/** Number of owned catalog items for this SandboxId */
|
| 465 |
+
uint32_t OwnedCatalogItemIdsCount;
|
| 466 |
+
));
|
| 467 |
+
|
| 468 |
+
/**
|
| 469 |
+
* Output parameters for the EOS_Ecom_QueryOwnershipBySandboxIds Function.
|
| 470 |
+
*/
|
| 471 |
+
EOS_STRUCT(EOS_Ecom_QueryOwnershipBySandboxIdsCallbackInfo, (
|
| 472 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 473 |
+
EOS_EResult ResultCode;
|
| 474 |
+
/** Context that was passed into EOS_Ecom_QueryOwnership */
|
| 475 |
+
void* ClientData;
|
| 476 |
+
/** The Epic Account ID of the local user whose ownership was queried */
|
| 477 |
+
EOS_EpicAccountId LocalUserId;
|
| 478 |
+
/** List of SandboxIds and their corresponding owned catalog item Ids. If there are no ownership items, the OwnedCatalogItemIdsCount is 0 and OwnedCatalogItemIds is null. */
|
| 479 |
+
const EOS_Ecom_SandboxIdItemOwnership* SandboxIdItemOwnerships;
|
| 480 |
+
/** Number of ownership results are included in this callback */
|
| 481 |
+
uint32_t SandboxIdItemOwnershipsCount;
|
| 482 |
+
));
|
| 483 |
+
|
| 484 |
+
/**
|
| 485 |
+
* Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnershipBySandboxIds
|
| 486 |
+
* @param Data A EOS_Ecom_QueryOwnershipBySandboxIdsCallbackInfo containing the output information and result
|
| 487 |
+
*/
|
| 488 |
+
EOS_DECLARE_CALLBACK(EOS_Ecom_OnQueryOwnershipBySandboxIdsCallback, const EOS_Ecom_QueryOwnershipBySandboxIdsCallbackInfo* Data);
|
| 489 |
+
|
| 490 |
+
/** The most recent version of the EOS_Ecom_QueryOwnershipToken API. */
|
| 491 |
+
#define EOS_ECOM_QUERYOWNERSHIPTOKEN_API_LATEST 2
|
| 492 |
+
|
| 493 |
+
/**
|
| 494 |
+
* The maximum number of catalog items that may be queried in a single pass
|
| 495 |
+
*/
|
| 496 |
+
#define EOS_ECOM_QUERYOWNERSHIPTOKEN_MAX_CATALOGITEM_IDS 32
|
| 497 |
+
|
| 498 |
+
/**
|
| 499 |
+
* Input parameters for the EOS_Ecom_QueryOwnershipToken function.
|
| 500 |
+
*/
|
| 501 |
+
EOS_STRUCT(EOS_Ecom_QueryOwnershipTokenOptions, (
|
| 502 |
+
/** API Version: Set this to EOS_ECOM_QUERYOWNERSHIPTOKEN_API_LATEST. */
|
| 503 |
+
int32_t ApiVersion;
|
| 504 |
+
/** The Epic Account ID of the local user whose ownership token you want to query */
|
| 505 |
+
EOS_EpicAccountId LocalUserId;
|
| 506 |
+
/** The array of Catalog Item IDs to check for ownership, matching in number to the CatalogItemIdCount */
|
| 507 |
+
EOS_Ecom_CatalogItemId* CatalogItemIds;
|
| 508 |
+
/** The number of catalog item IDs to query */
|
| 509 |
+
uint32_t CatalogItemIdCount;
|
| 510 |
+
/** Optional product namespace, if not the one specified during initialization */
|
| 511 |
+
const char* CatalogNamespace;
|
| 512 |
+
));
|
| 513 |
+
|
| 514 |
+
/**
|
| 515 |
+
* Output parameters for the EOS_Ecom_QueryOwnershipToken Function.
|
| 516 |
+
*/
|
| 517 |
+
EOS_STRUCT(EOS_Ecom_QueryOwnershipTokenCallbackInfo, (
|
| 518 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 519 |
+
EOS_EResult ResultCode;
|
| 520 |
+
/** Context that was passed into EOS_Ecom_QueryOwnershipToken */
|
| 521 |
+
void* ClientData;
|
| 522 |
+
/** The Epic Account ID of the local user whose ownership token was queried */
|
| 523 |
+
EOS_EpicAccountId LocalUserId;
|
| 524 |
+
/** Ownership token containing details about the catalog items queried */
|
| 525 |
+
const char* OwnershipToken;
|
| 526 |
+
));
|
| 527 |
+
|
| 528 |
+
/**
|
| 529 |
+
* Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnershipToken
|
| 530 |
+
* @param Data A EOS_Ecom_QueryOwnershipTokenCallbackInfo containing the output information and result
|
| 531 |
+
*/
|
| 532 |
+
EOS_DECLARE_CALLBACK(EOS_Ecom_OnQueryOwnershipTokenCallback, const EOS_Ecom_QueryOwnershipTokenCallbackInfo* Data);
|
| 533 |
+
|
| 534 |
+
/** The most recent version of the EOS_Ecom_QueryEntitlements API. */
|
| 535 |
+
#define EOS_ECOM_QUERYENTITLEMENTS_API_LATEST 3
|
| 536 |
+
|
| 537 |
+
/**
|
| 538 |
+
* The maximum number of entitlements that may be queried in a single QueryEntitlements API call.
|
| 539 |
+
*/
|
| 540 |
+
#define EOS_ECOM_QUERYENTITLEMENTS_MAX_ENTITLEMENT_IDS 256
|
| 541 |
+
|
| 542 |
+
/**
|
| 543 |
+
* Input parameters for the EOS_Ecom_QueryEntitlements function.
|
| 544 |
+
*/
|
| 545 |
+
EOS_STRUCT(EOS_Ecom_QueryEntitlementsOptions, (
|
| 546 |
+
/** API Version: Set this to EOS_ECOM_QUERYENTITLEMENTS_API_LATEST. */
|
| 547 |
+
int32_t ApiVersion;
|
| 548 |
+
/** The Epic Account ID of the local user whose Entitlements you want to retrieve */
|
| 549 |
+
EOS_EpicAccountId LocalUserId;
|
| 550 |
+
/** An array of Entitlement Names that you want to check */
|
| 551 |
+
EOS_Ecom_EntitlementName* EntitlementNames;
|
| 552 |
+
/** The number of Entitlement Names included in the array, up to EOS_ECOM_QUERYENTITLEMENTS_MAX_ENTITLEMENT_IDS; use zero to request all Entitlements associated with the user's Epic Online Services account. */
|
| 553 |
+
uint32_t EntitlementNameCount;
|
| 554 |
+
/** If true, Entitlements that have been redeemed will be included in the results. */
|
| 555 |
+
EOS_Bool bIncludeRedeemed;
|
| 556 |
+
/** If not provided then the SandboxId is used as the catalog namespace */
|
| 557 |
+
const char* OverrideCatalogNamespace;
|
| 558 |
+
));
|
| 559 |
+
|
| 560 |
+
/**
|
| 561 |
+
* Output parameters for the EOS_Ecom_QueryEntitlements Function.
|
| 562 |
+
*/
|
| 563 |
+
EOS_STRUCT(EOS_Ecom_QueryEntitlementsCallbackInfo, (
|
| 564 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 565 |
+
EOS_EResult ResultCode;
|
| 566 |
+
/** Context that was passed into EOS_Ecom_QueryEntitlements */
|
| 567 |
+
void* ClientData;
|
| 568 |
+
/** The Epic Account ID of the local user whose entitlement was queried */
|
| 569 |
+
EOS_EpicAccountId LocalUserId;
|
| 570 |
+
));
|
| 571 |
+
|
| 572 |
+
/**
|
| 573 |
+
* Function prototype definition for callbacks passed to EOS_Ecom_QueryOwnershipToken
|
| 574 |
+
* @param Data A EOS_Ecom_QueryEntitlementsCallbackInfo containing the output information and result
|
| 575 |
+
*/
|
| 576 |
+
EOS_DECLARE_CALLBACK(EOS_Ecom_OnQueryEntitlementsCallback, const EOS_Ecom_QueryEntitlementsCallbackInfo* Data);
|
| 577 |
+
|
| 578 |
+
/** The most recent version of the EOS_Ecom_QueryEntitlementToken API. */
|
| 579 |
+
#define EOS_ECOM_QUERYENTITLEMENTTOKEN_API_LATEST 1
|
| 580 |
+
|
| 581 |
+
/** The maximum number of entitlements that may be queried in a single pass. */
|
| 582 |
+
#define EOS_ECOM_QUERYENTITLEMENTTOKEN_MAX_ENTITLEMENT_IDS 32
|
| 583 |
+
|
| 584 |
+
/**
|
| 585 |
+
* Input parameters for the EOS_Ecom_QueryEntitlementToken function.
|
| 586 |
+
*/
|
| 587 |
+
EOS_STRUCT(EOS_Ecom_QueryEntitlementTokenOptions, (
|
| 588 |
+
/** API Version: Set this to EOS_ECOM_QUERYENTITLEMENTTOKEN_API_LATEST. */
|
| 589 |
+
int32_t ApiVersion;
|
| 590 |
+
/** The Epic Account ID of the local user whose Entitlements you want to retrieve */
|
| 591 |
+
EOS_EpicAccountId LocalUserId;
|
| 592 |
+
/** An array of Entitlement Names that you want to check */
|
| 593 |
+
EOS_Ecom_EntitlementName* EntitlementNames;
|
| 594 |
+
/** The number of Entitlement Names included in the array, up to EOS_ECOM_QUERYENTITLEMENTTOKEN_MAX_ENTITLEMENT_IDS; use zero to request all Entitlements associated with the user's Epic Online Services account. */
|
| 595 |
+
uint32_t EntitlementNameCount;
|
| 596 |
+
));
|
| 597 |
+
|
| 598 |
+
/**
|
| 599 |
+
* Output parameters for the EOS_Ecom_QueryEntitlementToken Function.
|
| 600 |
+
*/
|
| 601 |
+
EOS_STRUCT(EOS_Ecom_QueryEntitlementTokenCallbackInfo, (
|
| 602 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 603 |
+
EOS_EResult ResultCode;
|
| 604 |
+
/** Context that was passed into EOS_Ecom_QueryEntitlementToken */
|
| 605 |
+
void* ClientData;
|
| 606 |
+
/** The Epic Account ID of the local user whose entitlement was queried */
|
| 607 |
+
EOS_EpicAccountId LocalUserId;
|
| 608 |
+
/** Entitlements token containing details about the catalog items queried */
|
| 609 |
+
const char* EntitlementToken;
|
| 610 |
+
));
|
| 611 |
+
|
| 612 |
+
/**
|
| 613 |
+
* Function prototype definition for callbacks passed to EOS_Ecom_QueryEntitlementToken.
|
| 614 |
+
* @param Data A EOS_Ecom_QueryEntitlementTokenCallbackInfo containing the output information and result.
|
| 615 |
+
*/
|
| 616 |
+
EOS_DECLARE_CALLBACK(EOS_Ecom_OnQueryEntitlementTokenCallback, const EOS_Ecom_QueryEntitlementTokenCallbackInfo* Data);
|
| 617 |
+
|
| 618 |
+
/** The most recent version of the EOS_Ecom_QueryOffers API. */
|
| 619 |
+
#define EOS_ECOM_QUERYOFFERS_API_LATEST 1
|
| 620 |
+
|
| 621 |
+
/**
|
| 622 |
+
* Input parameters for the EOS_Ecom_QueryOffers function.
|
| 623 |
+
*/
|
| 624 |
+
EOS_STRUCT(EOS_Ecom_QueryOffersOptions, (
|
| 625 |
+
/** API Version: Set this to EOS_ECOM_QUERYOFFERS_API_LATEST. */
|
| 626 |
+
int32_t ApiVersion;
|
| 627 |
+
/** The Epic Account ID of the local user whose offer to query */
|
| 628 |
+
EOS_EpicAccountId LocalUserId;
|
| 629 |
+
/** If not provided then the SandboxId is used as the catalog namespace */
|
| 630 |
+
const char* OverrideCatalogNamespace;
|
| 631 |
+
));
|
| 632 |
+
|
| 633 |
+
/**
|
| 634 |
+
* Output parameters for the EOS_Ecom_QueryOffers Function.
|
| 635 |
+
*/
|
| 636 |
+
EOS_STRUCT(EOS_Ecom_QueryOffersCallbackInfo, (
|
| 637 |
+
/**
|
| 638 |
+
* Possible result codes for the operation:
|
| 639 |
+
* - EOS_Success: The request was successful.
|
| 640 |
+
* - EOS_IncompatibleVersion: The API version passed in is incorrect.
|
| 641 |
+
* - EOS_InvalidParameters: An options parameter is incorrect.
|
| 642 |
+
* - EOS_InvalidUser: An invalid Product User Id is specified.
|
| 643 |
+
* - EOS_InvalidAuth: A valid Product User Id is specified but the local user is not logged in.
|
| 644 |
+
* - EOS_TooManyRequests: There are too many requests in progress at this time.
|
| 645 |
+
* - EOS_PartialResult: Only part of the backend response was received and processed by the client.
|
| 646 |
+
*/
|
| 647 |
+
EOS_EResult ResultCode;
|
| 648 |
+
/** Context that was passed into EOS_Ecom_QueryOffers */
|
| 649 |
+
void* ClientData;
|
| 650 |
+
/** The Epic Account ID of the local user whose offer was queried; needed for localization of Catalog Item (Item) description text and pricing information */
|
| 651 |
+
EOS_EpicAccountId LocalUserId;
|
| 652 |
+
));
|
| 653 |
+
|
| 654 |
+
/**
|
| 655 |
+
* Function prototype definition for callbacks passed to EOS_Ecom_QueryOffers. When one or more cached offers have an invalid price, the callback returns the result code EOS_EResult::EOS_Ecom_CatalogOfferPriceInvalid.
|
| 656 |
+
* @param Data A EOS_Ecom_QueryOffersCallbackInfo containing the output information and result
|
| 657 |
+
*/
|
| 658 |
+
EOS_DECLARE_CALLBACK(EOS_Ecom_OnQueryOffersCallback, const EOS_Ecom_QueryOffersCallbackInfo* Data);
|
| 659 |
+
|
| 660 |
+
|
| 661 |
+
/** The most recent version of the EOS_Ecom_Checkout API. */
|
| 662 |
+
#define EOS_ECOM_CHECKOUT_API_LATEST 2
|
| 663 |
+
|
| 664 |
+
/** The maximum number of entries in a single checkout. */
|
| 665 |
+
#define EOS_ECOM_CHECKOUT_MAX_ENTRIES 10
|
| 666 |
+
|
| 667 |
+
/** The maximum length of a transaction ID. DEPRECATED, replaced with EOS_ECOM_TRANSACTIONID_MAX_LENGTH. */
|
| 668 |
+
#define EOS_ECOM_TRANSACTIONID_MAXIMUM_LENGTH 64
|
| 669 |
+
|
| 670 |
+
/** The maximum length of a transaction ID. */
|
| 671 |
+
#define EOS_ECOM_TRANSACTIONID_MAX_LENGTH 64
|
| 672 |
+
/**
|
| 673 |
+
* Input parameters for the EOS_Ecom_Checkout function.
|
| 674 |
+
*/
|
| 675 |
+
EOS_STRUCT(EOS_Ecom_CheckoutOptions, (
|
| 676 |
+
/** API Version: Set this to EOS_ECOM_CHECKOUT_API_LATEST. */
|
| 677 |
+
int32_t ApiVersion;
|
| 678 |
+
/** The Epic Account ID of the local user who is making the purchase */
|
| 679 |
+
EOS_EpicAccountId LocalUserId;
|
| 680 |
+
/** The catalog namespace will be the current Sandbox ID (in EOS_Platform_Options) unless overridden by this field */
|
| 681 |
+
const char* OverrideCatalogNamespace;
|
| 682 |
+
/** The number of EOS_Ecom_CheckoutEntry elements contained in Entries */
|
| 683 |
+
uint32_t EntryCount;
|
| 684 |
+
/** An array of EOS_Ecom_CheckoutEntry elements, each containing the details of a single offer */
|
| 685 |
+
const EOS_Ecom_CheckoutEntry* Entries;
|
| 686 |
+
/**
|
| 687 |
+
* Preferred device orientation, specifies Default, Portrait or Landscape.
|
| 688 |
+
* This is used only on mobile platforms currently.
|
| 689 |
+
* SDK can use it to optimize how the Checkout page should be displayed.
|
| 690 |
+
* Please check the mobile SDK documentation for additional required setup.
|
| 691 |
+
*/
|
| 692 |
+
EOS_ECheckoutOrientation PreferredOrientation;
|
| 693 |
+
));
|
| 694 |
+
|
| 695 |
+
/**
|
| 696 |
+
* Output parameters for the EOS_Ecom_Checkout Function.
|
| 697 |
+
*/
|
| 698 |
+
EOS_STRUCT(EOS_Ecom_CheckoutCallbackInfo, (
|
| 699 |
+
/** Result code for the operation. EOS_Success is returned for a successful request, otherwise one of the error codes is returned. See eos_common.h */
|
| 700 |
+
EOS_EResult ResultCode;
|
| 701 |
+
/** Context that was passed into EOS_Ecom_Checkout */
|
| 702 |
+
void* ClientData;
|
| 703 |
+
/** The Epic Account ID of the user who initiated the purchase */
|
| 704 |
+
EOS_EpicAccountId LocalUserId;
|
| 705 |
+
/** The transaction ID which can be used to obtain an EOS_Ecom_HTransaction using EOS_Ecom_CopyTransactionById. */
|
| 706 |
+
const char* TransactionId;
|
| 707 |
+
));
|
| 708 |
+
|
| 709 |
+
/**
|
| 710 |
+
* Function prototype definition for callbacks passed to EOS_Ecom_Checkout
|
| 711 |
+
* @param Data A EOS_Ecom_CheckoutCallbackInfo containing the output information and result
|
| 712 |
+
*/
|
| 713 |
+
EOS_DECLARE_CALLBACK(EOS_Ecom_OnCheckoutCallback, const EOS_Ecom_CheckoutCallbackInfo* Data);
|
| 714 |
+
|
| 715 |
+
|
| 716 |
+
/** The most recent version of the EOS_Ecom_RedeemEntitlements API. */
|
| 717 |
+
#define EOS_ECOM_REDEEMENTITLEMENTS_API_LATEST 2
|
| 718 |
+
|
| 719 |
+
/**
|
| 720 |
+
* The maximum number of entitlement IDs that may be redeemed in a single pass
|
| 721 |
+
*/
|
| 722 |
+
#define EOS_ECOM_REDEEMENTITLEMENTS_MAX_IDS 32
|
| 723 |
+
|
| 724 |
+
/**
|
| 725 |
+
* The maximum length of an entitlement ID
|
| 726 |
+
*/
|
| 727 |
+
#define EOS_ECOM_ENTITLEMENTID_MAX_LENGTH 32
|
| 728 |
+
|
| 729 |
+
/**
|
| 730 |
+
* Input parameters for the EOS_Ecom_RedeemEntitlements function.
|
| 731 |
+
*/
|
| 732 |
+
EOS_STRUCT(EOS_Ecom_RedeemEntitlementsOptions, (
|
| 733 |
+
/** API Version: Set this to EOS_ECOM_REDEEMENTITLEMENTS_API_LATEST. */
|
| 734 |
+
int32_t ApiVersion;
|
| 735 |
+
/** The Epic Account ID of the user who is redeeming Entitlements */
|
| 736 |
+
EOS_EpicAccountId LocalUserId;
|
| 737 |
+
/** The number of Entitlements to redeem */
|
| 738 |
+
uint32_t EntitlementIdCount;
|
| 739 |
+
/** The array of Entitlements to redeem */
|
| 740 |
+
EOS_Ecom_EntitlementId* EntitlementIds;
|
| 741 |
+
));
|
| 742 |
+
|
| 743 |
+
/**
|
| 744 |
+
* Output parameters for the EOS_Ecom_RedeemEntitlements Function.
|
| 745 |
+
*/
|
| 746 |
+
EOS_STRUCT(EOS_Ecom_RedeemEntitlementsCallbackInfo, (
|
| 747 |
+
/** Result code for the operation. EOS_Success is returned for a successful request, otherwise one of the error codes is returned. See eos_common.h */
|
| 748 |
+
EOS_EResult ResultCode;
|
| 749 |
+
/** Context that was passed into EOS_Ecom_RedeemEntitlements */
|
| 750 |
+
void* ClientData;
|
| 751 |
+
/** The Epic Account ID of the user who has redeemed entitlements */
|
| 752 |
+
EOS_EpicAccountId LocalUserId;
|
| 753 |
+
/* The number of redeemed Entitlements specified in the request. */
|
| 754 |
+
uint32_t RedeemedEntitlementIdsCount;
|
| 755 |
+
/* The number of previously redeemed Entitlements specified in the request. */
|
| 756 |
+
uint32_t PreviouslyRedeemedEntitlementIdsCount;
|
| 757 |
+
/* The number of invalid Entitlements specified in the request. */
|
| 758 |
+
uint32_t InvalidEntitlementIdsCount;
|
| 759 |
+
));
|
| 760 |
+
|
| 761 |
+
/**
|
| 762 |
+
* Function prototype definition for callbacks passed to EOS_Ecom_RedeemEntitlements
|
| 763 |
+
* @param Data A EOS_Ecom_RedeemEntitlementsCallbackInfo containing the output information and result
|
| 764 |
+
*/
|
| 765 |
+
EOS_DECLARE_CALLBACK(EOS_Ecom_OnRedeemEntitlementsCallback, const EOS_Ecom_RedeemEntitlementsCallbackInfo* Data);
|
| 766 |
+
|
| 767 |
+
/** The most recent version of the EOS_Ecom_GetLastRedeemedEntitlementsCount API. */
|
| 768 |
+
#define EOS_ECOM_GETLASTREDEEMEDENTITLEMENTSCOUNT_API_LATEST 1
|
| 769 |
+
|
| 770 |
+
/**
|
| 771 |
+
* Input parameters for the EOS_Ecom_GetLastRedeemedEntitlementsCount function.
|
| 772 |
+
*/
|
| 773 |
+
EOS_STRUCT(EOS_Ecom_GetLastRedeemedEntitlementsCountOptions, (
|
| 774 |
+
/** API Version: Set this to EOS_ECOM_GETLASTREDEEMEDENTITLEMENTSCOUNT_API_LATEST. */
|
| 775 |
+
int32_t ApiVersion;
|
| 776 |
+
/** The Epic Account ID of the local user for who to retrieve the last redeemed entitlements count */
|
| 777 |
+
EOS_EpicAccountId LocalUserId;
|
| 778 |
+
));
|
| 779 |
+
|
| 780 |
+
/** The most recent version of the EOS_Ecom_CopyLastRedeemedEntitlementByIndex API. */
|
| 781 |
+
#define EOS_ECOM_COPYLASTREDEEMEDENTITLEMENTBYINDEX_API_LATEST 1
|
| 782 |
+
|
| 783 |
+
/**
|
| 784 |
+
* Input parameters for the EOS_Ecom_CopyLastRedeemedEntitlementByIndex function.
|
| 785 |
+
*/
|
| 786 |
+
EOS_STRUCT(EOS_Ecom_CopyLastRedeemedEntitlementByIndexOptions, (
|
| 787 |
+
/** API Version: Set this to EOS_ECOM_COPYLASTREDEEMEDENTITLEMENTBYINDEX_API_LATEST. */
|
| 788 |
+
int32_t ApiVersion;
|
| 789 |
+
/** The Epic Account ID of the local user whose last redeemed entitlement id is being copied */
|
| 790 |
+
EOS_EpicAccountId LocalUserId;
|
| 791 |
+
/** Index of the last redeemed entitlement id to retrieve from the cache */
|
| 792 |
+
uint32_t RedeemedEntitlementIndex;
|
| 793 |
+
));
|
| 794 |
+
|
| 795 |
+
/**
|
| 796 |
+
* An enumeration defining the different entitlement list types in the Redeem Entitlements result.
|
| 797 |
+
*/
|
| 798 |
+
EOS_ENUM(EOS_ERedeemEntitlementsResultListType,
|
| 799 |
+
/** List of entitlements in the Redeem Entitlements result that were redeemed. */
|
| 800 |
+
EOS_ERERLT_Redeemed = 0,
|
| 801 |
+
/** List of entitlements in the Redeem Entitlements result that were previously redeemed. */
|
| 802 |
+
EOS_ERERLT_PreviouslyRedeemed = 1,
|
| 803 |
+
/** List of entitlements in the Redeem Entitlements result that are invalid. */
|
| 804 |
+
EOS_ERERLT_Invalid = 2
|
| 805 |
+
);
|
| 806 |
+
|
| 807 |
+
/** The most recent version of the EOS_Ecom_GetLastRedeemEntitlementsResultCount API. */
|
| 808 |
+
#define EOS_ECOM_GETLASTREDEEMENTITLEMENTSRESULTCOUNT_API_LATEST 1
|
| 809 |
+
|
| 810 |
+
/**
|
| 811 |
+
* Input parameters for the EOS_Ecom_GetLastRedeemEntitlementsResultCount function.
|
| 812 |
+
*/
|
| 813 |
+
EOS_STRUCT(EOS_Ecom_GetLastRedeemEntitlementsResultCountOptions, (
|
| 814 |
+
/** API Version: Set this to EOS_ECOM_GETLASTREDEEMENTITLEMENTSRESULTCOUNT_API_LATEST. */
|
| 815 |
+
int32_t ApiVersion;
|
| 816 |
+
/** The Epic Account ID of the local user for who to retrieve the last redeemed entitlements count */
|
| 817 |
+
EOS_EpicAccountId LocalUserId;
|
| 818 |
+
/** The Redeem Entitlements Result Type. */
|
| 819 |
+
EOS_ERedeemEntitlementsResultListType ResultType;
|
| 820 |
+
));
|
| 821 |
+
|
| 822 |
+
/** The most recent version of the EOS_Ecom_CopyLastRedeemEntitlementsResultByIndex API. */
|
| 823 |
+
#define EOS_ECOM_COPYLASTREDEEMENTITLEMENTSRESULTBYINDEX_API_LATEST 1
|
| 824 |
+
|
| 825 |
+
/**
|
| 826 |
+
* Input parameters for the EOS_Ecom_CopyLastRedeemEntitlementsResultByIndex function.
|
| 827 |
+
*/
|
| 828 |
+
EOS_STRUCT(EOS_Ecom_CopyLastRedeemEntitlementsResultByIndexOptions, (
|
| 829 |
+
/** API Version: Set this to EOS_ECOM_COPYLASTREDEEMENTITLEMENTSRESULTBYINDEX_API_LATEST. */
|
| 830 |
+
int32_t ApiVersion;
|
| 831 |
+
/** The Epic Account ID of the local user whose last redeemed entitlement id is being copied */
|
| 832 |
+
EOS_EpicAccountId LocalUserId;
|
| 833 |
+
/** Index of the entitlement of the given result type. */
|
| 834 |
+
uint32_t EntitlementIndex;
|
| 835 |
+
/** The Redeem Entitlements Result Type. */
|
| 836 |
+
EOS_ERedeemEntitlementsResultListType ResultType;
|
| 837 |
+
));
|
| 838 |
+
|
| 839 |
+
/** The most recent version of the EOS_Ecom_GetEntitlementsCount API. */
|
| 840 |
+
#define EOS_ECOM_GETENTITLEMENTSCOUNT_API_LATEST 1
|
| 841 |
+
|
| 842 |
+
/**
|
| 843 |
+
* Input parameters for the EOS_Ecom_GetEntitlementsCount function.
|
| 844 |
+
*/
|
| 845 |
+
EOS_STRUCT(EOS_Ecom_GetEntitlementsCountOptions, (
|
| 846 |
+
/** API Version: Set this to EOS_ECOM_GETENTITLEMENTSCOUNT_API_LATEST. */
|
| 847 |
+
int32_t ApiVersion;
|
| 848 |
+
/** The Epic Account ID of the local user for which to retrieve the entitlement count */
|
| 849 |
+
EOS_EpicAccountId LocalUserId;
|
| 850 |
+
));
|
| 851 |
+
|
| 852 |
+
/** The most recent version of the EOS_Ecom_GetEntitlementsByNameCount API. */
|
| 853 |
+
#define EOS_ECOM_GETENTITLEMENTSBYNAMECOUNT_API_LATEST 1
|
| 854 |
+
|
| 855 |
+
/**
|
| 856 |
+
* Input parameters for the EOS_Ecom_GetEntitlementsByNameCount function.
|
| 857 |
+
*/
|
| 858 |
+
EOS_STRUCT(EOS_Ecom_GetEntitlementsByNameCountOptions, (
|
| 859 |
+
/** API Version: Set this to EOS_ECOM_GETENTITLEMENTSBYNAMECOUNT_API_LATEST. */
|
| 860 |
+
int32_t ApiVersion;
|
| 861 |
+
/** The Epic Account ID of the local user for which to retrieve the entitlement count */
|
| 862 |
+
EOS_EpicAccountId LocalUserId;
|
| 863 |
+
/** Name of the entitlement to count in the cache */
|
| 864 |
+
EOS_Ecom_EntitlementName EntitlementName;
|
| 865 |
+
));
|
| 866 |
+
|
| 867 |
+
/** The most recent version of the EOS_Ecom_CopyEntitlementByIndex API. */
|
| 868 |
+
#define EOS_ECOM_COPYENTITLEMENTBYINDEX_API_LATEST 1
|
| 869 |
+
|
| 870 |
+
/**
|
| 871 |
+
* Input parameters for the EOS_Ecom_CopyEntitlementByIndex function.
|
| 872 |
+
*/
|
| 873 |
+
EOS_STRUCT(EOS_Ecom_CopyEntitlementByIndexOptions, (
|
| 874 |
+
/** API Version: Set this to EOS_ECOM_COPYENTITLEMENTBYINDEX_API_LATEST. */
|
| 875 |
+
int32_t ApiVersion;
|
| 876 |
+
/** The Epic Account ID of the local user whose entitlement is being copied */
|
| 877 |
+
EOS_EpicAccountId LocalUserId;
|
| 878 |
+
/** Index of the entitlement to retrieve from the cache */
|
| 879 |
+
uint32_t EntitlementIndex;
|
| 880 |
+
));
|
| 881 |
+
|
| 882 |
+
/** The most recent version of the EOS_Ecom_CopyEntitlementByNameAndIndex API. */
|
| 883 |
+
#define EOS_ECOM_COPYENTITLEMENTBYNAMEANDINDEX_API_LATEST 1
|
| 884 |
+
|
| 885 |
+
/**
|
| 886 |
+
* Input parameters for the EOS_Ecom_CopyEntitlementByNameAndIndex function.
|
| 887 |
+
*/
|
| 888 |
+
EOS_STRUCT(EOS_Ecom_CopyEntitlementByNameAndIndexOptions, (
|
| 889 |
+
/** API Version: Set this to EOS_ECOM_COPYENTITLEMENTBYNAMEANDINDEX_API_LATEST. */
|
| 890 |
+
int32_t ApiVersion;
|
| 891 |
+
/** The Epic Account ID of the local user whose entitlement is being copied */
|
| 892 |
+
EOS_EpicAccountId LocalUserId;
|
| 893 |
+
/** Name of the entitlement to retrieve from the cache */
|
| 894 |
+
EOS_Ecom_EntitlementName EntitlementName;
|
| 895 |
+
/** Index of the entitlement within the named set to retrieve from the cache. */
|
| 896 |
+
uint32_t Index;
|
| 897 |
+
));
|
| 898 |
+
|
| 899 |
+
/** The most recent version of the EOS_Ecom_CopyEntitlementById API. */
|
| 900 |
+
#define EOS_ECOM_COPYENTITLEMENTBYID_API_LATEST 2
|
| 901 |
+
|
| 902 |
+
/**
|
| 903 |
+
* Input parameters for the EOS_Ecom_CopyEntitlementById function.
|
| 904 |
+
*/
|
| 905 |
+
EOS_STRUCT(EOS_Ecom_CopyEntitlementByIdOptions, (
|
| 906 |
+
/** API Version: Set this to EOS_ECOM_COPYENTITLEMENTBYID_API_LATEST. */
|
| 907 |
+
int32_t ApiVersion;
|
| 908 |
+
/** The Epic Account ID of the local user whose entitlement is being copied */
|
| 909 |
+
EOS_EpicAccountId LocalUserId;
|
| 910 |
+
/** ID of the entitlement to retrieve from the cache */
|
| 911 |
+
EOS_Ecom_EntitlementId EntitlementId;
|
| 912 |
+
));
|
| 913 |
+
|
| 914 |
+
/** The most recent version of the EOS_Ecom_GetOfferCount API. */
|
| 915 |
+
#define EOS_ECOM_GETOFFERCOUNT_API_LATEST 1
|
| 916 |
+
|
| 917 |
+
/**
|
| 918 |
+
* Input parameters for the EOS_Ecom_GetOfferCount function.
|
| 919 |
+
*/
|
| 920 |
+
EOS_STRUCT(EOS_Ecom_GetOfferCountOptions, (
|
| 921 |
+
/** API Version: Set this to EOS_ECOM_GETOFFERCOUNT_API_LATEST. */
|
| 922 |
+
int32_t ApiVersion;
|
| 923 |
+
/** The Epic Account ID of the local user whose offers are being accessed */
|
| 924 |
+
EOS_EpicAccountId LocalUserId;
|
| 925 |
+
));
|
| 926 |
+
|
| 927 |
+
/** The most recent version of the EOS_Ecom_CopyOfferByIndex API. */
|
| 928 |
+
#define EOS_ECOM_COPYOFFERBYINDEX_API_LATEST 3
|
| 929 |
+
|
| 930 |
+
/**
|
| 931 |
+
* Input parameters for the EOS_Ecom_CopyOfferByIndex function.
|
| 932 |
+
*/
|
| 933 |
+
EOS_STRUCT(EOS_Ecom_CopyOfferByIndexOptions, (
|
| 934 |
+
/** API Version: Set this to EOS_ECOM_COPYOFFERBYINDEX_API_LATEST. */
|
| 935 |
+
int32_t ApiVersion;
|
| 936 |
+
/** The Epic Account ID of the local user whose offer is being copied */
|
| 937 |
+
EOS_EpicAccountId LocalUserId;
|
| 938 |
+
/** The index of the offer to get. */
|
| 939 |
+
uint32_t OfferIndex;
|
| 940 |
+
));
|
| 941 |
+
|
| 942 |
+
/** The most recent version of the EOS_Ecom_CopyOfferById API. */
|
| 943 |
+
#define EOS_ECOM_COPYOFFERBYID_API_LATEST 3
|
| 944 |
+
|
| 945 |
+
/**
|
| 946 |
+
* Input parameters for the EOS_Ecom_CopyOfferById function.
|
| 947 |
+
*/
|
| 948 |
+
EOS_STRUCT(EOS_Ecom_CopyOfferByIdOptions, (
|
| 949 |
+
/** API Version: Set this to EOS_ECOM_COPYOFFERBYID_API_LATEST. */
|
| 950 |
+
int32_t ApiVersion;
|
| 951 |
+
/** The Epic Account ID of the local user whose offer is being copied */
|
| 952 |
+
EOS_EpicAccountId LocalUserId;
|
| 953 |
+
/** The ID of the offer to get. */
|
| 954 |
+
EOS_Ecom_CatalogOfferId OfferId;
|
| 955 |
+
));
|
| 956 |
+
|
| 957 |
+
/** The most recent version of the EOS_Ecom_GetOfferItemCount API. */
|
| 958 |
+
#define EOS_ECOM_GETOFFERITEMCOUNT_API_LATEST 1
|
| 959 |
+
|
| 960 |
+
/**
|
| 961 |
+
* Input parameters for the EOS_Ecom_GetOfferItemCount function.
|
| 962 |
+
*/
|
| 963 |
+
EOS_STRUCT(EOS_Ecom_GetOfferItemCountOptions, (
|
| 964 |
+
/** API Version: Set this to EOS_ECOM_GETOFFERITEMCOUNT_API_LATEST. */
|
| 965 |
+
int32_t ApiVersion;
|
| 966 |
+
/** The Epic Account ID of the local user who made the initial request for the Catalog Offer through EOS_Ecom_QueryOffers */
|
| 967 |
+
EOS_EpicAccountId LocalUserId;
|
| 968 |
+
/** An ID that corresponds to a cached Catalog Offer (retrieved by EOS_Ecom_CopyOfferByIndex) */
|
| 969 |
+
EOS_Ecom_CatalogOfferId OfferId;
|
| 970 |
+
));
|
| 971 |
+
|
| 972 |
+
/** The most recent version of the EOS_Ecom_CopyOfferItemByIndex API. */
|
| 973 |
+
#define EOS_ECOM_COPYOFFERITEMBYINDEX_API_LATEST 1
|
| 974 |
+
|
| 975 |
+
/**
|
| 976 |
+
* Input parameters for the EOS_Ecom_CopyOfferItemByIndex function.
|
| 977 |
+
*/
|
| 978 |
+
EOS_STRUCT(EOS_Ecom_CopyOfferItemByIndexOptions, (
|
| 979 |
+
/** API Version: Set this to EOS_ECOM_COPYOFFERITEMBYINDEX_API_LATEST. */
|
| 980 |
+
int32_t ApiVersion;
|
| 981 |
+
/** The Epic Account ID of the local user whose item is being copied */
|
| 982 |
+
EOS_EpicAccountId LocalUserId;
|
| 983 |
+
/** The ID of the offer to get the items for. */
|
| 984 |
+
EOS_Ecom_CatalogOfferId OfferId;
|
| 985 |
+
/** The index of the item to get. */
|
| 986 |
+
uint32_t ItemIndex;
|
| 987 |
+
));
|
| 988 |
+
|
| 989 |
+
/** The most recent version of the EOS_Ecom_CopyItemById API. */
|
| 990 |
+
#define EOS_ECOM_COPYITEMBYID_API_LATEST 1
|
| 991 |
+
|
| 992 |
+
/**
|
| 993 |
+
* Input parameters for the EOS_Ecom_CopyItemById function.
|
| 994 |
+
*/
|
| 995 |
+
EOS_STRUCT(EOS_Ecom_CopyItemByIdOptions, (
|
| 996 |
+
/** API Version: Set this to EOS_ECOM_COPYITEMBYID_API_LATEST. */
|
| 997 |
+
int32_t ApiVersion;
|
| 998 |
+
/** The Epic Account ID of the local user whose item is being copied */
|
| 999 |
+
EOS_EpicAccountId LocalUserId;
|
| 1000 |
+
/** The ID of the item to get. */
|
| 1001 |
+
EOS_Ecom_CatalogItemId ItemId;
|
| 1002 |
+
));
|
| 1003 |
+
|
| 1004 |
+
/** The most recent version of the EOS_Ecom_GetOfferImageInfoCount API. */
|
| 1005 |
+
#define EOS_ECOM_GETOFFERIMAGEINFOCOUNT_API_LATEST 1
|
| 1006 |
+
|
| 1007 |
+
/**
|
| 1008 |
+
* Input parameters for the EOS_Ecom_GetOfferImageInfoCount function.
|
| 1009 |
+
*/
|
| 1010 |
+
EOS_STRUCT(EOS_Ecom_GetOfferImageInfoCountOptions, (
|
| 1011 |
+
/** API Version: Set this to EOS_ECOM_GETOFFERIMAGEINFOCOUNT_API_LATEST. */
|
| 1012 |
+
int32_t ApiVersion;
|
| 1013 |
+
/** The Epic Account ID of the local user whose offer image is being accessed. */
|
| 1014 |
+
EOS_EpicAccountId LocalUserId;
|
| 1015 |
+
/** The ID of the offer to get the images for. */
|
| 1016 |
+
EOS_Ecom_CatalogOfferId OfferId;
|
| 1017 |
+
));
|
| 1018 |
+
|
| 1019 |
+
/** The most recent version of the EOS_Ecom_CopyOfferImageInfoByIndex API. */
|
| 1020 |
+
#define EOS_ECOM_COPYOFFERIMAGEINFOBYINDEX_API_LATEST 1
|
| 1021 |
+
|
| 1022 |
+
/**
|
| 1023 |
+
* Input parameters for the EOS_Ecom_CopyOfferImageInfoByIndex function.
|
| 1024 |
+
*/
|
| 1025 |
+
EOS_STRUCT(EOS_Ecom_CopyOfferImageInfoByIndexOptions, (
|
| 1026 |
+
/** API Version: Set this to EOS_ECOM_COPYOFFERIMAGEINFOBYINDEX_API_LATEST. */
|
| 1027 |
+
int32_t ApiVersion;
|
| 1028 |
+
/** The Epic Account ID of the local user whose offer image is being copied. */
|
| 1029 |
+
EOS_EpicAccountId LocalUserId;
|
| 1030 |
+
/** The ID of the offer to get the images for. */
|
| 1031 |
+
EOS_Ecom_CatalogOfferId OfferId;
|
| 1032 |
+
/** The index of the image to get. */
|
| 1033 |
+
uint32_t ImageInfoIndex;
|
| 1034 |
+
));
|
| 1035 |
+
|
| 1036 |
+
/** The most recent version of the EOS_Ecom_GetItemImageInfoCount API. */
|
| 1037 |
+
#define EOS_ECOM_GETITEMIMAGEINFOCOUNT_API_LATEST 1
|
| 1038 |
+
|
| 1039 |
+
/**
|
| 1040 |
+
* Input parameters for the EOS_Ecom_GetItemImageInfoCount function.
|
| 1041 |
+
*/
|
| 1042 |
+
EOS_STRUCT(EOS_Ecom_GetItemImageInfoCountOptions, (
|
| 1043 |
+
/** API Version: Set this to EOS_ECOM_GETITEMIMAGEINFOCOUNT_API_LATEST. */
|
| 1044 |
+
int32_t ApiVersion;
|
| 1045 |
+
/** The Epic Account ID of the local user whose item image is being accessed */
|
| 1046 |
+
EOS_EpicAccountId LocalUserId;
|
| 1047 |
+
/** The ID of the item to get the images for. */
|
| 1048 |
+
EOS_Ecom_CatalogItemId ItemId;
|
| 1049 |
+
));
|
| 1050 |
+
|
| 1051 |
+
/** The most recent version of the EOS_Ecom_CopyItemImageInfoByIndex API. */
|
| 1052 |
+
#define EOS_ECOM_COPYITEMIMAGEINFOBYINDEX_API_LATEST 1
|
| 1053 |
+
|
| 1054 |
+
/**
|
| 1055 |
+
* Input parameters for the EOS_Ecom_CopyItemImageInfoByIndex function.
|
| 1056 |
+
*/
|
| 1057 |
+
EOS_STRUCT(EOS_Ecom_CopyItemImageInfoByIndexOptions, (
|
| 1058 |
+
/** API Version: Set this to EOS_ECOM_COPYITEMIMAGEINFOBYINDEX_API_LATEST. */
|
| 1059 |
+
int32_t ApiVersion;
|
| 1060 |
+
/** The Epic Account ID of the local user whose item image is being copied */
|
| 1061 |
+
EOS_EpicAccountId LocalUserId;
|
| 1062 |
+
/** The ID of the item to get the images for. */
|
| 1063 |
+
EOS_Ecom_CatalogItemId ItemId;
|
| 1064 |
+
/** The index of the image to get. */
|
| 1065 |
+
uint32_t ImageInfoIndex;
|
| 1066 |
+
));
|
| 1067 |
+
|
| 1068 |
+
/** The most recent version of the EOS_Ecom_GetItemReleaseCount API. */
|
| 1069 |
+
#define EOS_ECOM_GETITEMRELEASECOUNT_API_LATEST 1
|
| 1070 |
+
|
| 1071 |
+
/**
|
| 1072 |
+
* Input parameters for the EOS_Ecom_GetItemReleaseCount function.
|
| 1073 |
+
*/
|
| 1074 |
+
EOS_STRUCT(EOS_Ecom_GetItemReleaseCountOptions, (
|
| 1075 |
+
/** API Version: Set this to EOS_ECOM_GETITEMRELEASECOUNT_API_LATEST. */
|
| 1076 |
+
int32_t ApiVersion;
|
| 1077 |
+
/** The Epic Account ID of the local user whose item release is being accessed */
|
| 1078 |
+
EOS_EpicAccountId LocalUserId;
|
| 1079 |
+
/** The ID of the item to get the releases for. */
|
| 1080 |
+
EOS_Ecom_CatalogItemId ItemId;
|
| 1081 |
+
));
|
| 1082 |
+
|
| 1083 |
+
/** The most recent version of the EOS_Ecom_CopyItemReleaseByIndex API. */
|
| 1084 |
+
#define EOS_ECOM_COPYITEMRELEASEBYINDEX_API_LATEST 1
|
| 1085 |
+
|
| 1086 |
+
/**
|
| 1087 |
+
* Input parameters for the EOS_Ecom_CopyItemReleaseByIndex function.
|
| 1088 |
+
*/
|
| 1089 |
+
EOS_STRUCT(EOS_Ecom_CopyItemReleaseByIndexOptions, (
|
| 1090 |
+
/** API Version: Set this to EOS_ECOM_COPYITEMRELEASEBYINDEX_API_LATEST. */
|
| 1091 |
+
int32_t ApiVersion;
|
| 1092 |
+
/** The Epic Account ID of the local user whose item release is being copied */
|
| 1093 |
+
EOS_EpicAccountId LocalUserId;
|
| 1094 |
+
/** The ID of the item to get the releases for. */
|
| 1095 |
+
EOS_Ecom_CatalogItemId ItemId;
|
| 1096 |
+
/** The index of the release to get. */
|
| 1097 |
+
uint32_t ReleaseIndex;
|
| 1098 |
+
));
|
| 1099 |
+
|
| 1100 |
+
/** The most recent version of the EOS_Ecom_GetTransactionCount Function. */
|
| 1101 |
+
#define EOS_ECOM_GETTRANSACTIONCOUNT_API_LATEST 1
|
| 1102 |
+
|
| 1103 |
+
/**
|
| 1104 |
+
* Input parameters for the EOS_Ecom_GetTransactionCount function.
|
| 1105 |
+
*/
|
| 1106 |
+
EOS_STRUCT(EOS_Ecom_GetTransactionCountOptions, (
|
| 1107 |
+
/** API Version: Set this to EOS_ECOM_GETTRANSACTIONCOUNT_API_LATEST. */
|
| 1108 |
+
int32_t ApiVersion;
|
| 1109 |
+
/** The Epic Account ID of the local user whose transaction count to get */
|
| 1110 |
+
EOS_EpicAccountId LocalUserId;
|
| 1111 |
+
));
|
| 1112 |
+
|
| 1113 |
+
/** The most recent version of the EOS_Ecom_CopyTransactionByIndex Function. */
|
| 1114 |
+
#define EOS_ECOM_COPYTRANSACTIONBYINDEX_API_LATEST 1
|
| 1115 |
+
|
| 1116 |
+
/**
|
| 1117 |
+
* Input parameters for the EOS_Ecom_CopyTransactionByIndex function.
|
| 1118 |
+
*/
|
| 1119 |
+
EOS_STRUCT(EOS_Ecom_CopyTransactionByIndexOptions, (
|
| 1120 |
+
/** API Version: Set this to EOS_ECOM_COPYTRANSACTIONBYINDEX_API_LATEST. */
|
| 1121 |
+
int32_t ApiVersion;
|
| 1122 |
+
/** The Epic Account ID of the local user who is associated with the transaction */
|
| 1123 |
+
EOS_EpicAccountId LocalUserId;
|
| 1124 |
+
/** The index of the transaction to get */
|
| 1125 |
+
uint32_t TransactionIndex;
|
| 1126 |
+
));
|
| 1127 |
+
|
| 1128 |
+
/** The most recent version of the EOS_Ecom_CopyTransactionById Function. */
|
| 1129 |
+
#define EOS_ECOM_COPYTRANSACTIONBYID_API_LATEST 1
|
| 1130 |
+
/**
|
| 1131 |
+
* Input parameters for the EOS_Ecom_CopyTransactionById function.
|
| 1132 |
+
*/
|
| 1133 |
+
EOS_STRUCT(EOS_Ecom_CopyTransactionByIdOptions, (
|
| 1134 |
+
/** API Version: Set this to EOS_ECOM_COPYTRANSACTIONBYID_API_LATEST. */
|
| 1135 |
+
int32_t ApiVersion;
|
| 1136 |
+
/** The Epic Account ID of the local user who is associated with the transaction */
|
| 1137 |
+
EOS_EpicAccountId LocalUserId;
|
| 1138 |
+
/** The ID of the transaction to get */
|
| 1139 |
+
const char* TransactionId;
|
| 1140 |
+
));
|
| 1141 |
+
|
| 1142 |
+
/** The most recent version of the EOS_Ecom_Transaction_GetEntitlementsCount Function. */
|
| 1143 |
+
#define EOS_ECOM_TRANSACTION_GETENTITLEMENTSCOUNT_API_LATEST 1
|
| 1144 |
+
|
| 1145 |
+
/**
|
| 1146 |
+
* Input parameters for the EOS_Ecom_Transaction_GetEntitlementsCount function.
|
| 1147 |
+
*/
|
| 1148 |
+
EOS_STRUCT(EOS_Ecom_Transaction_GetEntitlementsCountOptions, (
|
| 1149 |
+
/** API Version: Set this to EOS_ECOM_TRANSACTION_GETENTITLEMENTSCOUNT_API_LATEST. */
|
| 1150 |
+
int32_t ApiVersion;
|
| 1151 |
+
));
|
| 1152 |
+
|
| 1153 |
+
/** The most recent version of the EOS_Ecom_Transaction_CopyEntitlementByIndex Function. */
|
| 1154 |
+
#define EOS_ECOM_TRANSACTION_COPYENTITLEMENTBYINDEX_API_LATEST 1
|
| 1155 |
+
|
| 1156 |
+
/**
|
| 1157 |
+
* Input parameters for the EOS_Ecom_Transaction_CopyEntitlementByIndex function.
|
| 1158 |
+
*/
|
| 1159 |
+
EOS_STRUCT(EOS_Ecom_Transaction_CopyEntitlementByIndexOptions, (
|
| 1160 |
+
/** API Version: Set this to EOS_ECOM_TRANSACTION_COPYENTITLEMENTBYINDEX_API_LATEST. */
|
| 1161 |
+
int32_t ApiVersion;
|
| 1162 |
+
/** The index of the entitlement to get */
|
| 1163 |
+
uint32_t EntitlementIndex;
|
| 1164 |
+
));
|
| 1165 |
+
|
| 1166 |
+
/**
|
| 1167 |
+
* Release the memory associated with an EOS_Ecom_HTransaction. Is expected to be called after
|
| 1168 |
+
* being received from a EOS_Ecom_CheckoutCallbackInfo.
|
| 1169 |
+
*
|
| 1170 |
+
* @param Transaction A handle to a transaction.
|
| 1171 |
+
*
|
| 1172 |
+
* @see EOS_Ecom_CheckoutCallbackInfo
|
| 1173 |
+
* @see EOS_Ecom_GetTransactionCount
|
| 1174 |
+
* @see EOS_Ecom_CopyTransactionByIndex
|
| 1175 |
+
*/
|
| 1176 |
+
EOS_DECLARE_FUNC(void) EOS_Ecom_Transaction_Release(EOS_Ecom_HTransaction Transaction);
|
| 1177 |
+
|
| 1178 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_friends.h
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_friends_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Friends Interface is used to manage a user's friends list, by interacting with the backend services, and to retrieve the cached list of friends, blocked users and pending invitations.
|
| 8 |
+
* All Friends Interface calls take a handle of type EOS_HFriends as the first parameter.
|
| 9 |
+
* This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetFriendsInterface function.
|
| 10 |
+
*
|
| 11 |
+
* @see EOS_Platform_GetFriendsInterface
|
| 12 |
+
*/
|
| 13 |
+
|
| 14 |
+
/**
|
| 15 |
+
* Starts an asynchronous task that reads the user's friends list and blocklist from the backend service, caching it for future use.
|
| 16 |
+
*
|
| 17 |
+
* @note When the Social Overlay is enabled then this will be called automatically. The Social Overlay is enabled by default (see EOS_PF_DISABLE_SOCIAL_OVERLAY).
|
| 18 |
+
*
|
| 19 |
+
* @param Options structure containing the account for which to retrieve the friends list
|
| 20 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 21 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 22 |
+
*
|
| 23 |
+
* @see EOS_Friends_QueryFriendsOptions
|
| 24 |
+
* @see EOS_Friends_OnQueryFriendsCallback
|
| 25 |
+
*/
|
| 26 |
+
EOS_DECLARE_FUNC(void) EOS_Friends_QueryFriends(EOS_HFriends Handle, const EOS_Friends_QueryFriendsOptions* Options, void* ClientData, const EOS_Friends_OnQueryFriendsCallback CompletionDelegate);
|
| 27 |
+
|
| 28 |
+
/**
|
| 29 |
+
* Starts an asynchronous task that sends a friend invitation to another user. The completion delegate is executed after the backend response has been received.
|
| 30 |
+
* It does not indicate that the target user has responded to the friend invitation.
|
| 31 |
+
*
|
| 32 |
+
* @param Options structure containing the account to send the invite from and the account to send the invite to
|
| 33 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 34 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 35 |
+
*
|
| 36 |
+
* @see EOS_Friends_SendInviteOptions
|
| 37 |
+
* @see EOS_Friends_OnSendInviteCallback
|
| 38 |
+
*/
|
| 39 |
+
EOS_DECLARE_FUNC(void) EOS_Friends_SendInvite(EOS_HFriends Handle, const EOS_Friends_SendInviteOptions* Options, void* ClientData, const EOS_Friends_OnSendInviteCallback CompletionDelegate);
|
| 40 |
+
|
| 41 |
+
/**
|
| 42 |
+
* Starts an asynchronous task that accepts a friend invitation from another user. The completion delegate is executed after the backend response has been received.
|
| 43 |
+
*
|
| 44 |
+
* @param Options structure containing the logged in account and the inviting account
|
| 45 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 46 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 47 |
+
*
|
| 48 |
+
* @see EOS_Friends_AcceptInviteOptions
|
| 49 |
+
* @see EOS_Friends_OnAcceptInviteCallback
|
| 50 |
+
*/
|
| 51 |
+
EOS_DECLARE_FUNC(void) EOS_Friends_AcceptInvite(EOS_HFriends Handle, const EOS_Friends_AcceptInviteOptions* Options, void* ClientData, const EOS_Friends_OnAcceptInviteCallback CompletionDelegate);
|
| 52 |
+
|
| 53 |
+
/**
|
| 54 |
+
* Starts an asynchronous task that rejects a friend invitation from another user. The completion delegate is executed after the backend response has been received.
|
| 55 |
+
*
|
| 56 |
+
* @param Options structure containing the logged in account and the inviting account
|
| 57 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 58 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 59 |
+
*
|
| 60 |
+
* @see EOS_Friends_RejectInviteOptions
|
| 61 |
+
* @see EOS_Friends_OnRejectInviteCallback
|
| 62 |
+
*/
|
| 63 |
+
EOS_DECLARE_FUNC(void) EOS_Friends_RejectInvite(EOS_HFriends Handle, const EOS_Friends_RejectInviteOptions* Options, void* ClientData, const EOS_Friends_OnRejectInviteCallback CompletionDelegate);
|
| 64 |
+
|
| 65 |
+
/**
|
| 66 |
+
* Retrieves the number of friends on the friends list that has already been retrieved by the EOS_Friends_QueryFriends API.
|
| 67 |
+
*
|
| 68 |
+
* @param Options structure containing the Epic Account ID of user who owns the friends list
|
| 69 |
+
* @return the number of friends on the list
|
| 70 |
+
*
|
| 71 |
+
* @see EOS_Friends_GetFriendsCountOptions
|
| 72 |
+
* @see EOS_Friends_GetFriendAtIndex
|
| 73 |
+
*/
|
| 74 |
+
EOS_DECLARE_FUNC(int32_t) EOS_Friends_GetFriendsCount(EOS_HFriends Handle, const EOS_Friends_GetFriendsCountOptions* Options);
|
| 75 |
+
|
| 76 |
+
/**
|
| 77 |
+
* Retrieves the Epic Account ID of an entry from the friends list that has already been retrieved by the EOS_Friends_QueryFriends API.
|
| 78 |
+
* The Epic Account ID returned by this function may belong to an account that has been invited to be a friend or that has invited the local user to be a friend.
|
| 79 |
+
* To determine if the Epic Account ID returned by this function is a friend or a pending friend invitation, use the EOS_Friends_GetStatus function.
|
| 80 |
+
*
|
| 81 |
+
* @param Options structure containing the Epic Account ID of the owner of the friends list and the index into the list
|
| 82 |
+
* @return the Epic Account ID of the friend. Note that if the index provided is out of bounds, the returned Epic Account ID will be a "null" account ID.
|
| 83 |
+
*
|
| 84 |
+
* @see EOS_Friends_GetFriendAtIndexOptions
|
| 85 |
+
* @see EOS_Friends_GetFriendsCount
|
| 86 |
+
* @see EOS_Friends_GetStatus
|
| 87 |
+
*/
|
| 88 |
+
EOS_DECLARE_FUNC(EOS_EpicAccountId) EOS_Friends_GetFriendAtIndex(EOS_HFriends Handle, const EOS_Friends_GetFriendAtIndexOptions* Options);
|
| 89 |
+
|
| 90 |
+
/**
|
| 91 |
+
* Retrieve the friendship status between the local user and another user.
|
| 92 |
+
*
|
| 93 |
+
* @param Options structure containing the Epic Account ID of the friend list to check and the account of the user to test friendship status
|
| 94 |
+
* @return A value indicating whether the two accounts have a friendship, pending invites in either direction, or no relationship
|
| 95 |
+
* - EOS_FS_Friends is returned for two users that have confirmed friendship
|
| 96 |
+
* - EOS_FS_InviteSent is returned when the local user has sent a friend invitation but the other user has not accepted or rejected it
|
| 97 |
+
* - EOS_FS_InviteReceived is returned when the other user has sent a friend invitation to the local user
|
| 98 |
+
* - EOS_FS_NotFriends is returned when there is no known relationship
|
| 99 |
+
*
|
| 100 |
+
* @see EOS_Friends_GetStatusOptions
|
| 101 |
+
* @see EOS_EFriendsStatus
|
| 102 |
+
*/
|
| 103 |
+
EOS_DECLARE_FUNC(EOS_EFriendsStatus) EOS_Friends_GetStatus(EOS_HFriends Handle, const EOS_Friends_GetStatusOptions* Options);
|
| 104 |
+
|
| 105 |
+
/**
|
| 106 |
+
* Listen for changes to friends for a particular account.
|
| 107 |
+
*
|
| 108 |
+
* @param Options Information about who would like notifications.
|
| 109 |
+
* @param ClientData This value is returned to the caller when FriendsUpdateHandler is invoked.
|
| 110 |
+
* @param FriendsUpdateHandler The callback to be invoked when a change to any friend status changes.
|
| 111 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 112 |
+
*
|
| 113 |
+
* @see EOS_Friends_AddNotifyFriendsUpdateOptions
|
| 114 |
+
* @see EOS_Friends_OnFriendsUpdateCallback
|
| 115 |
+
*/
|
| 116 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Friends_AddNotifyFriendsUpdate(EOS_HFriends Handle, const EOS_Friends_AddNotifyFriendsUpdateOptions* Options, void* ClientData, const EOS_Friends_OnFriendsUpdateCallback FriendsUpdateHandler);
|
| 117 |
+
|
| 118 |
+
/**
|
| 119 |
+
* Stop listening for friends changes on a previously bound handler.
|
| 120 |
+
*
|
| 121 |
+
* @param NotificationId The previously bound notification ID.
|
| 122 |
+
*/
|
| 123 |
+
EOS_DECLARE_FUNC(void) EOS_Friends_RemoveNotifyFriendsUpdate(EOS_HFriends Handle, EOS_NotificationId NotificationId);
|
| 124 |
+
|
| 125 |
+
/**
|
| 126 |
+
* Retrieves the number of blocked users on the blocklist that has already been retrieved by the EOS_Friends_QueryFriends API.
|
| 127 |
+
*
|
| 128 |
+
* @param Options structure containing the Epic Account ID of user who owns the blocklist.
|
| 129 |
+
* @return the number of users on the blocklist.
|
| 130 |
+
*
|
| 131 |
+
* @see EOS_Friends_GetBlockedUsersCountOptions
|
| 132 |
+
* @see EOS_Friends_QueryFriends
|
| 133 |
+
*/
|
| 134 |
+
EOS_DECLARE_FUNC(int32_t) EOS_Friends_GetBlockedUsersCount(EOS_HFriends Handle, const EOS_Friends_GetBlockedUsersCountOptions* Options);
|
| 135 |
+
|
| 136 |
+
/**
|
| 137 |
+
* Retrieves the Epic Account ID of an entry from the blocklist that has already been retrieved by the EOS_Friends_QueryFriends API.
|
| 138 |
+
*
|
| 139 |
+
* @param Options structure containing the Epic Account ID of the owner of the blocklist and the index into the list.
|
| 140 |
+
* @return the Epic Account ID of the blocked user. Note that if the index provided is out of bounds, the returned Epic Account ID will be a "null" account ID.
|
| 141 |
+
*
|
| 142 |
+
* @see EOS_Friends_GetBlockedUserAtIndexOptions
|
| 143 |
+
* @see EOS_Friends_QueryFriends
|
| 144 |
+
* @see EOS_Friends_GetBlockedUsersCount
|
| 145 |
+
*/
|
| 146 |
+
EOS_DECLARE_FUNC(EOS_EpicAccountId) EOS_Friends_GetBlockedUserAtIndex(EOS_HFriends Handle, const EOS_Friends_GetBlockedUserAtIndexOptions* Options);
|
| 147 |
+
|
| 148 |
+
/**
|
| 149 |
+
* Listen for changes to blocklist for a particular account.
|
| 150 |
+
*
|
| 151 |
+
* @param Options Information about the API version which is being used.
|
| 152 |
+
* @param ClientData This value is returned to the caller when BlockedUsersUpdateHandler is invoked.
|
| 153 |
+
* @param BlockedUsersUpdateHandler The callback to be invoked when a blocklist changes.
|
| 154 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise.
|
| 155 |
+
*
|
| 156 |
+
* @see EOS_Friends_AddNotifyBlockedUsersUpdateOptions
|
| 157 |
+
* @see EOS_Friends_OnBlockedUsersUpdateCallback
|
| 158 |
+
*/
|
| 159 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Friends_AddNotifyBlockedUsersUpdate(EOS_HFriends Handle, const EOS_Friends_AddNotifyBlockedUsersUpdateOptions* Options, void* ClientData, const EOS_Friends_OnBlockedUsersUpdateCallback BlockedUsersUpdateHandler);
|
| 160 |
+
|
| 161 |
+
/**
|
| 162 |
+
* Stop listening for blocklist changes on a previously bound handler.
|
| 163 |
+
*
|
| 164 |
+
* @param NotificationId The previously bound notification ID.
|
| 165 |
+
*/
|
| 166 |
+
EOS_DECLARE_FUNC(void) EOS_Friends_RemoveNotifyBlockedUsersUpdate(EOS_HFriends Handle, EOS_NotificationId NotificationId);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_friends_types.h
ADDED
|
@@ -0,0 +1,369 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
|
| 6 |
+
#pragma pack(push, 8)
|
| 7 |
+
|
| 8 |
+
EOS_EXTERN_C typedef struct EOS_FriendsHandle* EOS_HFriends;
|
| 9 |
+
|
| 10 |
+
/**
|
| 11 |
+
* EOS_Friends_QueryFriends is used to start an asynchronous query to retrieve friends, blocked users and pending outbound/inbound friends list invitations for a user account.
|
| 12 |
+
* The following types are used to work with the API.
|
| 13 |
+
*/
|
| 14 |
+
|
| 15 |
+
|
| 16 |
+
/** The most recent version of the EOS_Friends_QueryFriends API. */
|
| 17 |
+
#define EOS_FRIENDS_QUERYFRIENDS_API_LATEST 1
|
| 18 |
+
|
| 19 |
+
/**
|
| 20 |
+
* Input parameters for the EOS_Friends_QueryFriends function.
|
| 21 |
+
*/
|
| 22 |
+
EOS_STRUCT(EOS_Friends_QueryFriendsOptions, (
|
| 23 |
+
/** API Version: Set this to EOS_FRIENDS_QUERYFRIENDS_API_LATEST. */
|
| 24 |
+
int32_t ApiVersion;
|
| 25 |
+
/** The Epic Account ID of the local, logged-in user whose friends list you want to retrieve */
|
| 26 |
+
EOS_EpicAccountId LocalUserId;
|
| 27 |
+
));
|
| 28 |
+
|
| 29 |
+
/**
|
| 30 |
+
* Output parameters for the EOS_Friends_QueryFriends Function. These parameters are received through the callback provided to EOS_Friends_QueryFriends
|
| 31 |
+
*/
|
| 32 |
+
EOS_STRUCT(EOS_Friends_QueryFriendsCallbackInfo, (
|
| 33 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 34 |
+
EOS_EResult ResultCode;
|
| 35 |
+
/** Context that was passed into EOS_Friends_QueryFriends */
|
| 36 |
+
void* ClientData;
|
| 37 |
+
/** The Epic Account ID of the user whose friends were queried */
|
| 38 |
+
EOS_EpicAccountId LocalUserId;
|
| 39 |
+
));
|
| 40 |
+
|
| 41 |
+
/**
|
| 42 |
+
* Function prototype definition for callbacks passed to EOS_Friends_QueryFriends
|
| 43 |
+
* @param Data A EOS_Friends_QueryFriendsCallbackInfo containing the output information and result
|
| 44 |
+
*/
|
| 45 |
+
EOS_DECLARE_CALLBACK(EOS_Friends_OnQueryFriendsCallback, const EOS_Friends_QueryFriendsCallbackInfo* Data);
|
| 46 |
+
|
| 47 |
+
|
| 48 |
+
|
| 49 |
+
/**
|
| 50 |
+
* EOS_Friends_SendInvite is used to start an asynchronous operation to send a friends list invitation from a local user to a target user.
|
| 51 |
+
* The following types are used to work with the API.
|
| 52 |
+
*/
|
| 53 |
+
|
| 54 |
+
/** The most recent version of the EOS_Friends_SendInvite API. */
|
| 55 |
+
#define EOS_FRIENDS_SENDINVITE_API_LATEST 1
|
| 56 |
+
|
| 57 |
+
/**
|
| 58 |
+
* Input parameters for the EOS_Friends_SendInvite function.
|
| 59 |
+
*/
|
| 60 |
+
EOS_STRUCT(EOS_Friends_SendInviteOptions, (
|
| 61 |
+
/** API Version: Set this to EOS_FRIENDS_SENDINVITE_API_LATEST. */
|
| 62 |
+
int32_t ApiVersion;
|
| 63 |
+
/** The Epic Account ID of the local, logged-in user who is sending the friends list invitation */
|
| 64 |
+
EOS_EpicAccountId LocalUserId;
|
| 65 |
+
/** The Epic Account ID of the user who is receiving the friends list invitation */
|
| 66 |
+
EOS_EpicAccountId TargetUserId;
|
| 67 |
+
));
|
| 68 |
+
|
| 69 |
+
/**
|
| 70 |
+
* Output parameters for the EOS_Friends_SendInvite API.
|
| 71 |
+
*/
|
| 72 |
+
EOS_STRUCT(EOS_Friends_SendInviteCallbackInfo, (
|
| 73 |
+
/** Result code for the operation. EOS_Success is returned if the invitation was sent, otherwise one of the error codes is returned. See eos_common.h */
|
| 74 |
+
EOS_EResult ResultCode;
|
| 75 |
+
/** Context that was passed into EOS_Friends_SendInvite */
|
| 76 |
+
void* ClientData;
|
| 77 |
+
/** The Epic Account ID of the user who sent the friends list invitation */
|
| 78 |
+
EOS_EpicAccountId LocalUserId;
|
| 79 |
+
/** The Epic Account ID of the user to whom the friends list invitation was sent */
|
| 80 |
+
EOS_EpicAccountId TargetUserId;
|
| 81 |
+
));
|
| 82 |
+
|
| 83 |
+
/**
|
| 84 |
+
* Function prototype definition for callbacks passed to EOS_Friends_SendInvite
|
| 85 |
+
* @param Data A EOS_Friends_SendInviteCallbackInfo containing the output information and result.
|
| 86 |
+
*/
|
| 87 |
+
EOS_DECLARE_CALLBACK(EOS_Friends_OnSendInviteCallback, const EOS_Friends_SendInviteCallbackInfo* Data);
|
| 88 |
+
|
| 89 |
+
|
| 90 |
+
|
| 91 |
+
/**
|
| 92 |
+
* EOS_Friends_AcceptInvite is used to start an asynchronous operation to accept a friends list invitation from another user.
|
| 93 |
+
* The following types are used to work with the API.
|
| 94 |
+
*/
|
| 95 |
+
|
| 96 |
+
/** The most recent version of the EOS_Friends_AcceptInvite API. */
|
| 97 |
+
#define EOS_FRIENDS_ACCEPTINVITE_API_LATEST 1
|
| 98 |
+
|
| 99 |
+
/**
|
| 100 |
+
* Input parameters for the EOS_Friends_AcceptInvite function.
|
| 101 |
+
*/
|
| 102 |
+
EOS_STRUCT(EOS_Friends_AcceptInviteOptions, (
|
| 103 |
+
/** API Version: Set this to EOS_FRIENDS_ACCEPTINVITE_API_LATEST. */
|
| 104 |
+
int32_t ApiVersion;
|
| 105 |
+
/** The Epic Account ID of the local, logged-in user who is accepting the friends list invitation */
|
| 106 |
+
EOS_EpicAccountId LocalUserId;
|
| 107 |
+
/** The Epic Account ID of the user who sent the friends list invitation */
|
| 108 |
+
EOS_EpicAccountId TargetUserId;
|
| 109 |
+
));
|
| 110 |
+
|
| 111 |
+
/**
|
| 112 |
+
* Output parameters for the EOS_Friends_AcceptInvite Function.
|
| 113 |
+
*/
|
| 114 |
+
EOS_STRUCT(EOS_Friends_AcceptInviteCallbackInfo, (
|
| 115 |
+
/** Result code for the operation. EOS_Success is returned if an invite was accepted, otherwise one of the error codes is returned. See eos_common.h */
|
| 116 |
+
EOS_EResult ResultCode;
|
| 117 |
+
/** Context that is passed into EOS_Friends_AcceptInvite */
|
| 118 |
+
void* ClientData;
|
| 119 |
+
/** The Epic Account ID of the user who is accepting the friends list invitation */
|
| 120 |
+
EOS_EpicAccountId LocalUserId;
|
| 121 |
+
/** The Epic Account ID of the user who sent the local user a friends list invitation */
|
| 122 |
+
EOS_EpicAccountId TargetUserId;
|
| 123 |
+
));
|
| 124 |
+
|
| 125 |
+
/**
|
| 126 |
+
* Function prototype definition for callbacks passed to EOS_Friends_AcceptInvite
|
| 127 |
+
* @param Data A EOS_Friends_AcceptInviteCallbackInfo containing the output information and result.
|
| 128 |
+
*/
|
| 129 |
+
EOS_DECLARE_CALLBACK(EOS_Friends_OnAcceptInviteCallback, const EOS_Friends_AcceptInviteCallbackInfo* Data);
|
| 130 |
+
|
| 131 |
+
|
| 132 |
+
|
| 133 |
+
/**
|
| 134 |
+
* EOS_Friends_RejectInvite is used to start an asynchronous operation to reject a friends list invitation from another user.
|
| 135 |
+
* The following types are used to work with the API.
|
| 136 |
+
*/
|
| 137 |
+
|
| 138 |
+
/** The most recent version of the EOS_Friends_RejectInvite API. */
|
| 139 |
+
#define EOS_FRIENDS_REJECTINVITE_API_LATEST 1
|
| 140 |
+
|
| 141 |
+
/**
|
| 142 |
+
* Input parameters for the EOS_Friends_RejectInvite function.
|
| 143 |
+
*/
|
| 144 |
+
EOS_STRUCT(EOS_Friends_RejectInviteOptions, (
|
| 145 |
+
/** API Version: Set this to EOS_FRIENDS_REJECTINVITE_API_LATEST. */
|
| 146 |
+
int32_t ApiVersion;
|
| 147 |
+
/** The Epic Account ID of the local, logged-in user who is rejecting a friends list invitation */
|
| 148 |
+
EOS_EpicAccountId LocalUserId;
|
| 149 |
+
/** The Epic Account ID of the user who sent the friends list invitation */
|
| 150 |
+
EOS_EpicAccountId TargetUserId;
|
| 151 |
+
));
|
| 152 |
+
|
| 153 |
+
/**
|
| 154 |
+
* Output parameters for the EOS_Friends_RejectInvite Function.
|
| 155 |
+
*/
|
| 156 |
+
EOS_STRUCT(EOS_Friends_RejectInviteCallbackInfo, (
|
| 157 |
+
/** Result code for the operation. EOS_Success is returned if an invite was accepted, otherwise one of the error codes is returned. See eos_common.h */
|
| 158 |
+
EOS_EResult ResultCode;
|
| 159 |
+
/** Context that is passed into EOS_Friends_RejectInvite */
|
| 160 |
+
void* ClientData;
|
| 161 |
+
/** The Epic Account ID of the user who is rejecting the friends list invitation */
|
| 162 |
+
EOS_EpicAccountId LocalUserId;
|
| 163 |
+
/** The Epic Account ID of the user who sent the friends list invitation */
|
| 164 |
+
EOS_EpicAccountId TargetUserId;
|
| 165 |
+
));
|
| 166 |
+
|
| 167 |
+
/**
|
| 168 |
+
* Function prototype definition for callbacks passed to EOS_Friends_RejectInvite
|
| 169 |
+
* @param Data A EOS_Friends_RejectInviteCallbackInfo containing output information and the result.
|
| 170 |
+
*/
|
| 171 |
+
EOS_DECLARE_CALLBACK(EOS_Friends_OnRejectInviteCallback, const EOS_Friends_RejectInviteCallbackInfo* Data);
|
| 172 |
+
|
| 173 |
+
|
| 174 |
+
|
| 175 |
+
/**
|
| 176 |
+
* EOS_Friends_GetFriendsCount is used to immediately retrieve the number of cached friendships.
|
| 177 |
+
* The following types are used to work with the API.
|
| 178 |
+
*/
|
| 179 |
+
|
| 180 |
+
/** The most recent version of the EOS_Friends_GetFriendsCount API. */
|
| 181 |
+
#define EOS_FRIENDS_GETFRIENDSCOUNT_API_LATEST 1
|
| 182 |
+
|
| 183 |
+
|
| 184 |
+
/**
|
| 185 |
+
* Input parameters for the EOS_Friends_GetFriendsCount function.
|
| 186 |
+
*/
|
| 187 |
+
EOS_STRUCT(EOS_Friends_GetFriendsCountOptions, (
|
| 188 |
+
/** API Version: Set this to EOS_FRIENDS_GETFRIENDSCOUNT_API_LATEST. */
|
| 189 |
+
int32_t ApiVersion;
|
| 190 |
+
/** The Epic Account ID of the user whose friends should be counted */
|
| 191 |
+
EOS_EpicAccountId LocalUserId;
|
| 192 |
+
));
|
| 193 |
+
|
| 194 |
+
|
| 195 |
+
/**
|
| 196 |
+
* EOS_Friends_GetFriendAtIndex is used to immediately retrieve the account ID of another user who has a friendship (or pending friendship).
|
| 197 |
+
* The following types are used to work with the API.
|
| 198 |
+
*/
|
| 199 |
+
|
| 200 |
+
/** The most recent version of the EOS_Friends_GetFriendAtIndex API. */
|
| 201 |
+
#define EOS_FRIENDS_GETFRIENDATINDEX_API_LATEST 1
|
| 202 |
+
|
| 203 |
+
/**
|
| 204 |
+
* Input parameters for the EOS_Friends_GetFriendAtIndex function.
|
| 205 |
+
*/
|
| 206 |
+
EOS_STRUCT(EOS_Friends_GetFriendAtIndexOptions, (
|
| 207 |
+
/** API Version: Set this to EOS_FRIENDS_GETFRIENDATINDEX_API_LATEST. */
|
| 208 |
+
int32_t ApiVersion;
|
| 209 |
+
/** The Epic Account ID of the user whose friend list is being queried */
|
| 210 |
+
EOS_EpicAccountId LocalUserId;
|
| 211 |
+
/** Index into the friend list. This value must be between 0 and EOS_Friends_GetFriendsCount-1 inclusively. */
|
| 212 |
+
int32_t Index;
|
| 213 |
+
));
|
| 214 |
+
|
| 215 |
+
|
| 216 |
+
|
| 217 |
+
/**
|
| 218 |
+
* EOS_Friends_GetStatus is used to immediately retrieve the friendship status between two users.
|
| 219 |
+
* The following types are used to work with the API.
|
| 220 |
+
*/
|
| 221 |
+
|
| 222 |
+
/** The most recent version of the EOS_Friends_GetStatus API. */
|
| 223 |
+
#define EOS_FRIENDS_GETSTATUS_API_LATEST 1
|
| 224 |
+
|
| 225 |
+
/**
|
| 226 |
+
* An enumeration of the different friendship statuses.
|
| 227 |
+
*/
|
| 228 |
+
EOS_ENUM(EOS_EFriendsStatus,
|
| 229 |
+
/** The two accounts have no friendship status. */
|
| 230 |
+
EOS_FS_NotFriends = 0,
|
| 231 |
+
|
| 232 |
+
/**
|
| 233 |
+
* The local account has sent a friend invite to the other account.
|
| 234 |
+
*
|
| 235 |
+
* NOTE: EOS_FS_InviteSent is not returned by EOS_Friends_GetStatus or in EOS_Friends_AddNotifyFriendsUpdate callbacks unless
|
| 236 |
+
* the local account was logged in with the EOS_AS_FriendsManagement authentication scope. Friend invites are managed
|
| 237 |
+
* automatically by the Social Overlay.
|
| 238 |
+
*/
|
| 239 |
+
EOS_FS_InviteSent = 1,
|
| 240 |
+
|
| 241 |
+
/**
|
| 242 |
+
* The other account has sent a friend invite to the local account.
|
| 243 |
+
*
|
| 244 |
+
* NOTE: EOS_FS_InviteReceived is not returned by EOS_Friends_GetStatus or in EOS_Friends_AddNotifyFriendsUpdate callbacks unless
|
| 245 |
+
* the local account was logged in with the EOS_AS_FriendsManagement authentication scope. Friend invites are managed
|
| 246 |
+
* automatically by the Social Overlay.
|
| 247 |
+
*/
|
| 248 |
+
EOS_FS_InviteReceived = 2,
|
| 249 |
+
|
| 250 |
+
/** The accounts have accepted friendship. */
|
| 251 |
+
EOS_FS_Friends = 3
|
| 252 |
+
);
|
| 253 |
+
|
| 254 |
+
/**
|
| 255 |
+
* Input parameters for the EOS_Friends_GetStatus function.
|
| 256 |
+
*/
|
| 257 |
+
EOS_STRUCT(EOS_Friends_GetStatusOptions, (
|
| 258 |
+
/** API Version: Set this to EOS_FRIENDS_GETSTATUS_API_LATEST. */
|
| 259 |
+
int32_t ApiVersion;
|
| 260 |
+
/** The Epic Account ID of the local, logged in user */
|
| 261 |
+
EOS_EpicAccountId LocalUserId;
|
| 262 |
+
/** The Epic Account ID of the user whose friendship status with the local user is being queried */
|
| 263 |
+
EOS_EpicAccountId TargetUserId;
|
| 264 |
+
));
|
| 265 |
+
|
| 266 |
+
|
| 267 |
+
|
| 268 |
+
/**
|
| 269 |
+
* EOS_Friends_AddNotifyFriendsUpdate is used to setup notification to receive any friend status updates.
|
| 270 |
+
* The following types are used to work with the API.
|
| 271 |
+
*/
|
| 272 |
+
|
| 273 |
+
/** The most recent version of the EOS_Friends_AddNotifyFriendsUpdate API. */
|
| 274 |
+
#define EOS_FRIENDS_ADDNOTIFYFRIENDSUPDATE_API_LATEST 1
|
| 275 |
+
|
| 276 |
+
/** Input parameters for the EOS_Friends_AddNotifyFriendsUpdate function. */
|
| 277 |
+
EOS_STRUCT(EOS_Friends_AddNotifyFriendsUpdateOptions, (
|
| 278 |
+
/** API Version: Set this to EOS_FRIENDS_ADDNOTIFYFRIENDSUPDATE_API_LATEST. */
|
| 279 |
+
int32_t ApiVersion;
|
| 280 |
+
));
|
| 281 |
+
|
| 282 |
+
/**
|
| 283 |
+
* Structure containing information about a friend status update.
|
| 284 |
+
*/
|
| 285 |
+
EOS_STRUCT(EOS_Friends_OnFriendsUpdateInfo, (
|
| 286 |
+
/** Client-specified data passed into EOS_Friends_AddNotifyFriendsUpdate */
|
| 287 |
+
void* ClientData;
|
| 288 |
+
/** The Epic Account ID of the local user who is receiving the update */
|
| 289 |
+
EOS_EpicAccountId LocalUserId;
|
| 290 |
+
/** The Epic Account ID of the user whose status is being updated. */
|
| 291 |
+
EOS_EpicAccountId TargetUserId;
|
| 292 |
+
/** The previous status of the user. */
|
| 293 |
+
EOS_EFriendsStatus PreviousStatus;
|
| 294 |
+
/** The current status of the user. */
|
| 295 |
+
EOS_EFriendsStatus CurrentStatus;
|
| 296 |
+
));
|
| 297 |
+
|
| 298 |
+
/**
|
| 299 |
+
* Callback for information related to a friend status update.
|
| 300 |
+
*/
|
| 301 |
+
EOS_DECLARE_CALLBACK(EOS_Friends_OnFriendsUpdateCallback, const EOS_Friends_OnFriendsUpdateInfo* Data);
|
| 302 |
+
|
| 303 |
+
/**
|
| 304 |
+
* EOS_Friends_GetBlockedUsersCount is used to immediately retrieve the number of cached blocked users.
|
| 305 |
+
* The following types are used to work with the API.
|
| 306 |
+
*/
|
| 307 |
+
|
| 308 |
+
/** The most recent version of the EOS_Friends_GetBlockedUsersCount API. */
|
| 309 |
+
#define EOS_FRIENDS_GETBLOCKEDUSERSCOUNT_API_LATEST 1
|
| 310 |
+
|
| 311 |
+
/**
|
| 312 |
+
* Input parameters for the EOS_Friends_GetBlockedUsersCount function.
|
| 313 |
+
*/
|
| 314 |
+
EOS_STRUCT(EOS_Friends_GetBlockedUsersCountOptions, (
|
| 315 |
+
/** API Version: Set this to EOS_FRIENDS_GETBLOCKEDUSERSCOUNT_API_LATEST. */
|
| 316 |
+
int32_t ApiVersion;
|
| 317 |
+
/** The Epic Account ID of the user whose blocked users should be counted. */
|
| 318 |
+
EOS_EpicAccountId LocalUserId;
|
| 319 |
+
));
|
| 320 |
+
|
| 321 |
+
/**
|
| 322 |
+
* EOS_Friends_GetBlockedUserAtIndex is used to immediately retrieve the account ID of user who is blocked.
|
| 323 |
+
* The following types are used to work with the API.
|
| 324 |
+
*/
|
| 325 |
+
|
| 326 |
+
/** The most recent version of the EOS_Friends_GetBlockedUserAtIndex API. */
|
| 327 |
+
#define EOS_FRIENDS_GETBLOCKEDUSERATINDEX_API_LATEST 1
|
| 328 |
+
|
| 329 |
+
/**
|
| 330 |
+
* Input parameters for the EOS_Friends_GetBlockedUserAtIndex function.
|
| 331 |
+
*/
|
| 332 |
+
EOS_STRUCT(EOS_Friends_GetBlockedUserAtIndexOptions, (
|
| 333 |
+
/** API Version: Set this to EOS_FRIENDS_GETBLOCKEDUSERATINDEX_API_LATEST. */
|
| 334 |
+
int32_t ApiVersion;
|
| 335 |
+
/** The Epic Account ID of the user whose blocked users list is being queried. */
|
| 336 |
+
EOS_EpicAccountId LocalUserId;
|
| 337 |
+
/** Index into the blocked users list. This value must be between 0 and EOS_Friends_GetBlockedUsersCount-1 inclusively. */
|
| 338 |
+
int32_t Index;
|
| 339 |
+
));
|
| 340 |
+
|
| 341 |
+
/** The most recent version of the EOS_Friends_AddNotifyBlockedUsersUpdate API. */
|
| 342 |
+
#define EOS_FRIENDS_ADDNOTIFYBLOCKEDUSERSUPDATE_API_LATEST 1
|
| 343 |
+
|
| 344 |
+
/** Input parameters for the EOS_Friends_AddNotifyBlockedUsersUpdate function. */
|
| 345 |
+
EOS_STRUCT(EOS_Friends_AddNotifyBlockedUsersUpdateOptions, (
|
| 346 |
+
/** API Version: Set this to EOS_FRIENDS_ADDNOTIFYBLOCKEDUSERSUPDATE_API_LATEST. */
|
| 347 |
+
int32_t ApiVersion;
|
| 348 |
+
));
|
| 349 |
+
|
| 350 |
+
/**
|
| 351 |
+
* Structure containing information about a blocklist update.
|
| 352 |
+
*/
|
| 353 |
+
EOS_STRUCT(EOS_Friends_OnBlockedUsersUpdateInfo, (
|
| 354 |
+
/** Client-specified data passed into EOS_Friends_AddNotifyBlockedUsersUpdate */
|
| 355 |
+
void* ClientData;
|
| 356 |
+
/** The Epic Account ID of the local user who is receiving the update */
|
| 357 |
+
EOS_EpicAccountId LocalUserId;
|
| 358 |
+
/** The Epic Account ID of the user whose blocked status is being updated. */
|
| 359 |
+
EOS_EpicAccountId TargetUserId;
|
| 360 |
+
/** TargetUserId block status (blocked or not). */
|
| 361 |
+
EOS_Bool bBlocked;
|
| 362 |
+
));
|
| 363 |
+
|
| 364 |
+
/**
|
| 365 |
+
* Callback for information related to a blocklist update.
|
| 366 |
+
*/
|
| 367 |
+
EOS_DECLARE_CALLBACK(EOS_Friends_OnBlockedUsersUpdateCallback, const EOS_Friends_OnBlockedUsersUpdateInfo* Data);
|
| 368 |
+
|
| 369 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_init.h
ADDED
|
@@ -0,0 +1,161 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_types.h"
|
| 5 |
+
|
| 6 |
+
#pragma pack(push, 8)
|
| 7 |
+
|
| 8 |
+
/**
|
| 9 |
+
* Function prototype type definition for functions that allocate memory.
|
| 10 |
+
*
|
| 11 |
+
* Functions passed to EOS_Initialize to serve as memory allocators should return a pointer to the allocated memory.
|
| 12 |
+
*
|
| 13 |
+
* The returned pointer should have at least SizeInBytes available capacity and the memory address should be a multiple of Alignment.
|
| 14 |
+
* The SDK will always call the provided function with an Alignment that is a power of 2.
|
| 15 |
+
* Allocation failures should return a null pointer.
|
| 16 |
+
*/
|
| 17 |
+
EOS_EXTERN_C typedef void* (EOS_MEMORY_CALL * EOS_AllocateMemoryFunc)(size_t SizeInBytes, size_t Alignment);
|
| 18 |
+
|
| 19 |
+
/**
|
| 20 |
+
* Function prototype type definition for functions that reallocate memory.
|
| 21 |
+
*
|
| 22 |
+
* Functions passed to EOS_Initialize to serve as memory reallocators should return a pointer to the reallocated memory.
|
| 23 |
+
* The returned pointer should have at least SizeInBytes available capacity and the memory address should be a multiple of alignment.
|
| 24 |
+
* The SDK will always call the provided function with an Alignment that is a power of 2.
|
| 25 |
+
* Reallocation failures should return a null pointer.
|
| 26 |
+
*/
|
| 27 |
+
EOS_EXTERN_C typedef void* (EOS_MEMORY_CALL * EOS_ReallocateMemoryFunc)(void* Pointer, size_t SizeInBytes, size_t Alignment);
|
| 28 |
+
|
| 29 |
+
/**
|
| 30 |
+
* Function prototype type definition for functions that release memory.
|
| 31 |
+
*
|
| 32 |
+
* When the SDK is done with memory that has been allocated by a custom allocator passed to EOS_Initialize, it will call the corresponding memory release function.
|
| 33 |
+
*/
|
| 34 |
+
EOS_EXTERN_C typedef void (EOS_MEMORY_CALL * EOS_ReleaseMemoryFunc)(void* Pointer);
|
| 35 |
+
|
| 36 |
+
/** The most recent version of the EOS_Initialize_ThreadAffinity API. */
|
| 37 |
+
#define EOS_INITIALIZE_THREADAFFINITY_API_LATEST 4
|
| 38 |
+
|
| 39 |
+
/**
|
| 40 |
+
* Options for initializing defining thread affinity for use by Epic Online Services SDK.
|
| 41 |
+
* Set the affinity to 0 to allow EOS SDK to use a platform specific default value.
|
| 42 |
+
*/
|
| 43 |
+
EOS_STRUCT(EOS_Initialize_ThreadAffinity, (
|
| 44 |
+
/** API Version: Set this to EOS_INITIALIZE_THREADAFFINITY_API_LATEST. */
|
| 45 |
+
int32_t ApiVersion;
|
| 46 |
+
/** Any thread related to network management that is not IO. */
|
| 47 |
+
uint64_t NetworkWork;
|
| 48 |
+
/** Any thread that will interact with a storage device. */
|
| 49 |
+
uint64_t StorageIo;
|
| 50 |
+
/** Any thread that will generate web socket IO. */
|
| 51 |
+
uint64_t WebSocketIo;
|
| 52 |
+
/** Any thread that will generate IO related to P2P traffic and management. */
|
| 53 |
+
uint64_t P2PIo;
|
| 54 |
+
/** Any thread that will generate http request IO. */
|
| 55 |
+
uint64_t HttpRequestIo;
|
| 56 |
+
/** Any thread that will generate IO related to RTC traffic and management. */
|
| 57 |
+
uint64_t RTCIo;
|
| 58 |
+
/** Main thread of the external overlay */
|
| 59 |
+
uint64_t EmbeddedOverlayMainThread;
|
| 60 |
+
/** Worker threads of the external overlay */
|
| 61 |
+
uint64_t EmbeddedOverlayWorkerThreads;
|
| 62 |
+
/** Any thread that process cryptography work */
|
| 63 |
+
uint64_t CryptographyWork;
|
| 64 |
+
));
|
| 65 |
+
|
| 66 |
+
/** The most recent version of the EOS_Initialize API. */
|
| 67 |
+
#define EOS_INITIALIZE_API_LATEST 5
|
| 68 |
+
|
| 69 |
+
/** Max length of a product name, not including the terminating null. */
|
| 70 |
+
#define EOS_INITIALIZEOPTIONS_PRODUCTNAME_MAX_LENGTH 64
|
| 71 |
+
|
| 72 |
+
/** Max length of a product version, not including the terminating null. */
|
| 73 |
+
#define EOS_INITIALIZEOPTIONS_PRODUCTVERSION_MAX_LENGTH 64
|
| 74 |
+
|
| 75 |
+
/**
|
| 76 |
+
* Options for initializing the Epic Online Services SDK.
|
| 77 |
+
*/
|
| 78 |
+
EOS_STRUCT(EOS_InitializeOptions, (
|
| 79 |
+
/** API Version: Set this to EOS_INITIALIZE_API_LATEST. */
|
| 80 |
+
int32_t ApiVersion;
|
| 81 |
+
/** A custom memory allocator, if desired. */
|
| 82 |
+
EOS_AllocateMemoryFunc AllocateMemoryFunction;
|
| 83 |
+
/** A corresponding memory reallocator. If the AllocateMemoryFunction is nulled, then this field must also be nulled. */
|
| 84 |
+
EOS_ReallocateMemoryFunc ReallocateMemoryFunction;
|
| 85 |
+
/** A corresponding memory releaser. If the AllocateMemoryFunction is nulled, then this field must also be nulled. */
|
| 86 |
+
EOS_ReleaseMemoryFunc ReleaseMemoryFunction;
|
| 87 |
+
/**
|
| 88 |
+
* The name of the product using the Epic Online Services SDK.
|
| 89 |
+
*
|
| 90 |
+
* The name string is required to be non-empty and at maximum of EOS_INITIALIZEOPTIONS_PRODUCTNAME_MAX_LENGTH bytes long.
|
| 91 |
+
* The string buffer can consist of any readable ANSI characters in the range 32-127.
|
| 92 |
+
*/
|
| 93 |
+
const char* ProductName;
|
| 94 |
+
/**
|
| 95 |
+
* Product version of the running application.
|
| 96 |
+
*
|
| 97 |
+
* The version string is required to be non-empty and at maximum of EOS_INITIALIZEOPTIONS_PRODUCTVERSION_MAX_LENGTH bytes long.
|
| 98 |
+
* The string buffer can consist of any readable ANSI characters in the range 32-127.
|
| 99 |
+
*/
|
| 100 |
+
const char* ProductVersion;
|
| 101 |
+
/** A reserved field that should always be nulled. */
|
| 102 |
+
void* Reserved;
|
| 103 |
+
/**
|
| 104 |
+
* This field is for system specific initialization if any.
|
| 105 |
+
*
|
| 106 |
+
* If provided then the structure will be located in {System}/eos_{system}.h.
|
| 107 |
+
* The structure will be named EOS_{System}_InitializeOptions.
|
| 108 |
+
*/
|
| 109 |
+
void* SystemInitializeOptions;
|
| 110 |
+
/** The thread affinity override values for each category of thread. */
|
| 111 |
+
EOS_Initialize_ThreadAffinity* OverrideThreadAffinity;
|
| 112 |
+
));
|
| 113 |
+
|
| 114 |
+
/**
|
| 115 |
+
* Initialize the Epic Online Services SDK.
|
| 116 |
+
*
|
| 117 |
+
* Before calling any other function in the SDK, clients must call this function.
|
| 118 |
+
*
|
| 119 |
+
* This function must only be called one time and must have a corresponding EOS_Shutdown call.
|
| 120 |
+
*
|
| 121 |
+
* @param Options - The initialization options to use for the SDK.
|
| 122 |
+
* @return An EOS_EResult is returned to indicate success or an error.
|
| 123 |
+
*
|
| 124 |
+
* EOS_Success is returned if the SDK successfully initializes.
|
| 125 |
+
* EOS_AlreadyConfigured is returned if the function has already been called.
|
| 126 |
+
* EOS_InvalidParameters is returned if the provided options are invalid.
|
| 127 |
+
*/
|
| 128 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Initialize(const EOS_InitializeOptions* Options);
|
| 129 |
+
|
| 130 |
+
/**
|
| 131 |
+
* Tear down the Epic Online Services SDK.
|
| 132 |
+
*
|
| 133 |
+
* Once this function has been called, no more SDK calls are permitted; calling anything after EOS_Shutdown will result in undefined behavior.
|
| 134 |
+
* @return An EOS_EResult is returned to indicate success or an error.
|
| 135 |
+
* EOS_Success is returned if the SDK is successfully torn down.
|
| 136 |
+
* EOS_NotConfigured is returned if a successful call to EOS_Initialize has not been made.
|
| 137 |
+
* EOS_UnexpectedError is returned if EOS_Shutdown has already been called.
|
| 138 |
+
*/
|
| 139 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Shutdown();
|
| 140 |
+
|
| 141 |
+
/**
|
| 142 |
+
* Create a single Epic Online Services Platform Instance.
|
| 143 |
+
*
|
| 144 |
+
* The platform instance is used to gain access to the various Epic Online Services.
|
| 145 |
+
*
|
| 146 |
+
* This function returns an opaque handle to the platform instance, and that handle must be passed to EOS_Platform_Release to release the instance.
|
| 147 |
+
*
|
| 148 |
+
* @return An opaque handle to the platform instance.
|
| 149 |
+
*/
|
| 150 |
+
EOS_DECLARE_FUNC(EOS_HPlatform) EOS_Platform_Create(const EOS_Platform_Options* Options);
|
| 151 |
+
|
| 152 |
+
/**
|
| 153 |
+
* Release an Epic Online Services platform instance previously returned from EOS_Platform_Create.
|
| 154 |
+
*
|
| 155 |
+
* This function should only be called once per instance returned by EOS_Platform_Create. Undefined behavior will result in calling it with a single instance more than once.
|
| 156 |
+
* Typically only a single platform instance needs to be created during the lifetime of a game.
|
| 157 |
+
* You should release each platform instance before calling the EOS_Shutdown function.
|
| 158 |
+
*/
|
| 159 |
+
EOS_DECLARE_FUNC(void) EOS_Platform_Release(EOS_HPlatform Handle);
|
| 160 |
+
|
| 161 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_integratedplatform.h
ADDED
|
@@ -0,0 +1,134 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_integratedplatform_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* To add integrated platforms, you must call EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainer to create an integrated platform options container. To modify that handle, call
|
| 8 |
+
* EOS_IntegratedPlatformOptionsContainer_* methods. Once you are finished, call EOS_Platform_Create with your handle. You must then release your integrated platform options container
|
| 9 |
+
* handle by calling EOS_IntegratedPlatformOptionsContainer_Release.
|
| 10 |
+
*/
|
| 11 |
+
|
| 12 |
+
/**
|
| 13 |
+
* Adds an integrated platform options to the container.
|
| 14 |
+
*
|
| 15 |
+
* @param InOptions Object containing properties related to setting a user's Status
|
| 16 |
+
* @return Success if modification was added successfully, otherwise an error code related to the problem
|
| 17 |
+
*/
|
| 18 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_IntegratedPlatformOptionsContainer_Add(EOS_HIntegratedPlatformOptionsContainer Handle, const EOS_IntegratedPlatformOptionsContainer_AddOptions* InOptions);
|
| 19 |
+
|
| 20 |
+
/**
|
| 21 |
+
* Sets the current login status of a specific local platform user to a new value.
|
| 22 |
+
*
|
| 23 |
+
* This function may only be used with an Integrated Platform initialized with the EOS_IPMF_ApplicationManagedIdentityLogin flag, otherwise
|
| 24 |
+
* calls will return EOS_InvalidState and a platform user's login status will be controlled by OS events.
|
| 25 |
+
*
|
| 26 |
+
* If the login status of a user changes, a Integrated Platform User Login Status Changed notification will fire, and depending on the state
|
| 27 |
+
* of the user's login and the platform, the EOS SDK might start fetching data for the user, it may clear cached data, or it may do nothing.
|
| 28 |
+
*
|
| 29 |
+
* If the login status of a user is not different from a previous call to this function, the function will do nothing and return EOS_Success.
|
| 30 |
+
* This will not trigger a call to the Integrated Platform User Login Status Changed.
|
| 31 |
+
*
|
| 32 |
+
* @param Options
|
| 33 |
+
* @return EOS_EResult containing the result of the operation.
|
| 34 |
+
* Possible result codes:
|
| 35 |
+
* - EOS_Success if the call was successful
|
| 36 |
+
* - EOS_NotConfigured if the Integrated Platform was not initialized on platform creation
|
| 37 |
+
* - EOS_InvalidState if the Integrated Platform was not initialized with the EOS_IPMF_ApplicationManagedIdentityLogin flag
|
| 38 |
+
* - EOS_InvalidUser if the LocalPlatformUserId is not a valid user id for the provided Integrated Platform
|
| 39 |
+
* - EOS_InvalidParameters if any other input was invalid
|
| 40 |
+
*
|
| 41 |
+
* @see EOS_IntegratedPlatform_SetUserLoginStatusOptions
|
| 42 |
+
*/
|
| 43 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_IntegratedPlatform_SetUserLoginStatus(EOS_HIntegratedPlatform Handle, const EOS_IntegratedPlatform_SetUserLoginStatusOptions* Options);
|
| 44 |
+
|
| 45 |
+
/**
|
| 46 |
+
* Register to receive notifications when the login state of Integrated Platform users change.
|
| 47 |
+
*
|
| 48 |
+
* This notification will trigger any time the EOS SDK's internal login state changes for a user, including for manual login state
|
| 49 |
+
* changes (when the EOS_IPMF_ApplicationManagedIdentityLogin flag is set), or automatically detected ones (when not disabled by the
|
| 50 |
+
* EOS_IPMF_ApplicationManagedIdentityLogin flag).
|
| 51 |
+
*
|
| 52 |
+
* @param Options Data associated with what version of the notification to receive.
|
| 53 |
+
* @param ClientData A context pointer that is returned in the callback function.
|
| 54 |
+
* @param CallbackFunction The function that is called when Integrated Platform user logins happen
|
| 55 |
+
* @return A valid notification that can be used to unregister for notifications, or EOS_INVALID_NOTIFICATIONID if input was invalid.
|
| 56 |
+
*
|
| 57 |
+
* @see EOS_IntegratedPlatform_AddNotifyUserLoginStatusChangedOptions
|
| 58 |
+
* @see EOS_IntegratedPlatform_OnUserLoginStatusChangedCallback
|
| 59 |
+
* @see EOS_IntegratedPlatform_RemoveNotifyUserLoginStatusChanged
|
| 60 |
+
*/
|
| 61 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_IntegratedPlatform_AddNotifyUserLoginStatusChanged(EOS_HIntegratedPlatform Handle, const EOS_IntegratedPlatform_AddNotifyUserLoginStatusChangedOptions* Options, void* ClientData, const EOS_IntegratedPlatform_OnUserLoginStatusChangedCallback CallbackFunction);
|
| 62 |
+
|
| 63 |
+
/**
|
| 64 |
+
* Unregister from Integrated Platform user login and logout notifications.
|
| 65 |
+
*
|
| 66 |
+
* @param NotificationId The NotificationId that was returned from registering for Integrated Platform user login and logout notifications.
|
| 67 |
+
*
|
| 68 |
+
* @see EOS_IntegratedPlatform_AddNotifyUserLoginStatusChanged
|
| 69 |
+
*/
|
| 70 |
+
EOS_DECLARE_FUNC(void) EOS_IntegratedPlatform_RemoveNotifyUserLoginStatusChanged(EOS_HIntegratedPlatform Handle, EOS_NotificationId NotificationId);
|
| 71 |
+
|
| 72 |
+
/**
|
| 73 |
+
* Sets the integrated platform user logout handler for all integrated platforms.
|
| 74 |
+
*
|
| 75 |
+
* There can only be one handler set at once, attempting to set a handler when one is already set will result in a EOS_AlreadyConfigured error.
|
| 76 |
+
*
|
| 77 |
+
* This callback handler allows applications to decide if a user is logged-out immediately when the SDK receives a system user logout event,
|
| 78 |
+
* or if the application would like to give the user a chance to correct themselves and log back in if they are in a state that might be
|
| 79 |
+
* disruptive if an accidental logout happens (unsaved user data, in a multiplayer match, etc). This is not supported on all integrated
|
| 80 |
+
* platforms, such as those where applications automatically close when a user logs out, or those where a user is always logged-in.
|
| 81 |
+
*
|
| 82 |
+
* If a logout is deferred, applications are expected to eventually call EOS_IntegratedPlatform_FinalizeDeferredUserLogout when they
|
| 83 |
+
* have decided a user meant to logout, or if they have logged in again.
|
| 84 |
+
*
|
| 85 |
+
* @param Options Data that specifies the API version.
|
| 86 |
+
* @param ClientData An optional context pointer that is returned in the callback data.
|
| 87 |
+
* @param CallbackFunction The function that will handle the callback.
|
| 88 |
+
* @return EOS_EResult containing the result of the operation.
|
| 89 |
+
* Possible result codes:
|
| 90 |
+
* - EOS_Success if the platform user logout handler was bound successfully.
|
| 91 |
+
* - EOS_AlreadyConfigured if there is already a platform user logout handler bound.
|
| 92 |
+
*
|
| 93 |
+
* @see EOS_IntegratedPlatform_SetUserPreLogoutCallbackOptions
|
| 94 |
+
* @see EOS_IntegratedPlatform_OnUserPreLogoutCallback
|
| 95 |
+
* @see EOS_IntegratedPlatform_FinalizeDeferredUserLogout
|
| 96 |
+
*/
|
| 97 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_IntegratedPlatform_SetUserPreLogoutCallback(EOS_HIntegratedPlatform Handle, const EOS_IntegratedPlatform_SetUserPreLogoutCallbackOptions* Options, void* ClientData, EOS_IntegratedPlatform_OnUserPreLogoutCallback CallbackFunction);
|
| 98 |
+
|
| 99 |
+
/**
|
| 100 |
+
* Clears a previously set integrated platform user logout handler for the specified integrated platform. If none is set for the specified platform, this does nothing.
|
| 101 |
+
*
|
| 102 |
+
* If there are any pending deferred user-logouts when a handler is cleared, those users will internally be logged-out and cached data about those users cleared before this function returns.
|
| 103 |
+
* Any applicable callbacks about those users being logged-out will occur in a future call to EOS_Platform_Tick().
|
| 104 |
+
*
|
| 105 |
+
* @param Options Data for which integrated platform to no longer call a previously-registered callback for.
|
| 106 |
+
*
|
| 107 |
+
* @see EOS_IntegratedPlatform_ClearUserPreLogoutCallbackOptions
|
| 108 |
+
*/
|
| 109 |
+
EOS_DECLARE_FUNC(void) EOS_IntegratedPlatform_ClearUserPreLogoutCallback(EOS_HIntegratedPlatform Handle, const EOS_IntegratedPlatform_ClearUserPreLogoutCallbackOptions* Options);
|
| 110 |
+
|
| 111 |
+
/**
|
| 112 |
+
* Complete a Logout/Login for a previously deferred Integrated Platform User Logout.
|
| 113 |
+
*
|
| 114 |
+
* This function allows applications to control whether an integrated-platform user actually logs out when an integrated platform's system tells the SDK a user has been logged-out.
|
| 115 |
+
* This allows applications to prevent accidental logouts from destroying application user state. If a user did not mean to logout, the application should prompt and confirm whether
|
| 116 |
+
* the user meant to logout, and either wait for them to confirm they meant to, or wait for them to login again, before calling this function.
|
| 117 |
+
*
|
| 118 |
+
* If the sign-out is intended and your application believes the user is still logged-out, the UserExpectedLoginState in Options should be EOS_LS_NotLoggedIn.
|
| 119 |
+
* If the sign-out was NOT intended and your application believes the user has logged-in again, the UserExpectedLoginState in Options should be EOS_LS_LoggedIn.
|
| 120 |
+
*
|
| 121 |
+
* @param Options Data for which integrated platform and user is now in the expected logged-in/logged-out state.
|
| 122 |
+
* @return EOS_EResult containing the result of the operation.
|
| 123 |
+
* Possible result codes:
|
| 124 |
+
* - EOS_Success if the platform user state matches the UserExpectedLoginState internally.
|
| 125 |
+
* - EOS_NotConfigured if the Integrated Platform was not initialized on platform creation
|
| 126 |
+
* - EOS_InvalidUser if the LocalPlatformUserId is not a valid user id for the provided Integrated Platform, or if there is no deferred logout waiting to be completed for this specified user
|
| 127 |
+
* - EOS_InvalidParameters if any other input was invalid
|
| 128 |
+
*
|
| 129 |
+
* @see EOS_IntegratedPlatform_FinalizeDeferredUserLogoutOptions
|
| 130 |
+
* @see EOS_IntegratedPlatform_SetUserPreLogoutCallback
|
| 131 |
+
* @see EOS_IntegratedPlatform_ClearUserPreLogoutCallback
|
| 132 |
+
* @see EOS_IntegratedPlatform_AddNotifyUserLoginStatusChanged
|
| 133 |
+
*/
|
| 134 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_IntegratedPlatform_FinalizeDeferredUserLogout(EOS_HIntegratedPlatform Handle, const EOS_IntegratedPlatform_FinalizeDeferredUserLogoutOptions* Options);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_integratedplatform_types.h
ADDED
|
@@ -0,0 +1,384 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
|
| 6 |
+
#pragma pack(push, 8)
|
| 7 |
+
|
| 8 |
+
typedef struct EOS_IntegratedPlatformOptionsContainerHandle* EOS_HIntegratedPlatformOptionsContainer;
|
| 9 |
+
typedef struct EOS_IntegratedPlatformHandle* EOS_HIntegratedPlatform;
|
| 10 |
+
|
| 11 |
+
/** These flags are used to determine how a specific Integrated Platform will be managed. */
|
| 12 |
+
EOS_ENUM(EOS_EIntegratedPlatformManagementFlags,
|
| 13 |
+
/** The integrated platform library should be disabled. This is equivalent to providing no flags. */
|
| 14 |
+
EOS_IPMF_Disabled = 0x0001,
|
| 15 |
+
/** The integrated platform library is managed by the calling application. EOS SDK should only hook into an existing instance of the integrated platform library. */
|
| 16 |
+
EOS_IPMF_LibraryManagedByApplication = 0x0002,
|
| 17 |
+
/** EOS SDK should fully manage the integrated platform library. It will do this by performing the load, initialize, tick and unload operations as necessary. */
|
| 18 |
+
EOS_IPMF_LibraryManagedBySDK = 0x0004,
|
| 19 |
+
/**
|
| 20 |
+
* The EOS SDK should not mirror the EOS rich presence with the Integrated Platform.
|
| 21 |
+
* The default behavior is for EOS SDK to share local presence with the Integrated Platform.
|
| 22 |
+
*/
|
| 23 |
+
EOS_IPMF_DisablePresenceMirroring = 0x0008,
|
| 24 |
+
/**
|
| 25 |
+
* EOS SDK should not perform any sessions management through the Integrated Platform.
|
| 26 |
+
* The default behavior is for EOS SDK to perform sessions management through the Integrated Platform.
|
| 27 |
+
* Sessions management includes:
|
| 28 |
+
* - sharing the lobby and session presence enabled games with the Integrated Platform.
|
| 29 |
+
* - handling Social Overlay join button events which cannot be handled by normal processing of Epic Services.
|
| 30 |
+
* - handling Social Overlay invite button events which cannot be handled by normal processing of Epic Services.
|
| 31 |
+
* - handling startup requests from the Integrated Platform to immediately join a game due to in invite while offline.
|
| 32 |
+
*
|
| 33 |
+
* @see EOS_Lobby_AddNotifySendLobbyNativeInviteRequested
|
| 34 |
+
*/
|
| 35 |
+
EOS_IPMF_DisableSDKManagedSessions = 0x0010,
|
| 36 |
+
/**
|
| 37 |
+
* Some features within the EOS SDK may wish to know a preference of Integrated Platform versus EOS.
|
| 38 |
+
* When determining an absolute platform preference those with this flag will be skipped.
|
| 39 |
+
* The IntegratedPlatforms list is provided via the EOS_Platform_Options during EOS_Platform_Create.
|
| 40 |
+
*
|
| 41 |
+
* The primary usage of the EOS_IPMF_PreferEOSIdentity and EOS_IPMF_PreferIntegratedIdentity flags is with game invites
|
| 42 |
+
* from the Social Overlay.
|
| 43 |
+
*
|
| 44 |
+
* For game invites from the Social Overlay the EOS SDK will follow these rules:
|
| 45 |
+
* - If the only account ID we can determine for the target player is an EAS ID then the EOS system will be used.
|
| 46 |
+
* - If the only account ID we can determine for the target player is an integrated platform ID then the integrated platform system will be used.
|
| 47 |
+
* - If both are available then the EOS SDK will operate in 1 of 3 modes:
|
| 48 |
+
* - no preference identified: use both the EOS and integrated platform systems.
|
| 49 |
+
* - PreferEOS: Use EOS if the target is an EAS friend and is either online in EAS or not online for the integrated platform.
|
| 50 |
+
* - PreferIntegrated: Use integrated platform if the target is an integrated platform friend and is either online in the integrated platform or not online for EAS.
|
| 51 |
+
* - If the integrated platform fails to send then try EAS if was not already used.
|
| 52 |
+
*/
|
| 53 |
+
EOS_IPMF_PreferEOSIdentity = 0x0020,
|
| 54 |
+
/**
|
| 55 |
+
* Some features within the EOS SDK may wish to know a preference of Integrated Platform versus EOS.
|
| 56 |
+
* For further explanation see EOS_IPMF_PreferEOSIdentity.
|
| 57 |
+
*
|
| 58 |
+
* @see EOS_IPMF_PreferEOSIdentity
|
| 59 |
+
*/
|
| 60 |
+
EOS_IPMF_PreferIntegratedIdentity = 0x0040,
|
| 61 |
+
/**
|
| 62 |
+
* By default the EOS SDK will attempt to detect the login/logout events of local users and update local states accordingly. Setting this flag will disable this functionality,
|
| 63 |
+
* relying on the application to process login/logout events and notify EOS SDK. It is not possible for the EOS SDK to do this on all platforms, making this flag not always
|
| 64 |
+
* optional.
|
| 65 |
+
*
|
| 66 |
+
* This flag must be set to use the manual platform user login/logout functions, even on platforms where it is not possible for the EOS SDK to detect login/logout events,
|
| 67 |
+
* making this a required flag for correct Integrated Platform behavior on those platforms.
|
| 68 |
+
*/
|
| 69 |
+
EOS_IPMF_ApplicationManagedIdentityLogin = 0x0080
|
| 70 |
+
);
|
| 71 |
+
EOS_ENUM_BOOLEAN_OPERATORS(EOS_EIntegratedPlatformManagementFlags);
|
| 72 |
+
|
| 73 |
+
/** A macro to identify the Steam integrated platform. */
|
| 74 |
+
#define EOS_IPT_Steam "STEAM"
|
| 75 |
+
|
| 76 |
+
/** The most recent version of the EOS_IntegratedPlatform_Options API. */
|
| 77 |
+
#define EOS_INTEGRATEDPLATFORM_OPTIONS_API_LATEST 1
|
| 78 |
+
|
| 79 |
+
/**
|
| 80 |
+
* Initialization options to use with EOS_Platform_Options for integrated platforms.
|
| 81 |
+
*
|
| 82 |
+
* @see EOS_Platform_Options
|
| 83 |
+
*/
|
| 84 |
+
EOS_STRUCT(EOS_IntegratedPlatform_Options, (
|
| 85 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORM_OPTIONS_API_LATEST. */
|
| 86 |
+
int32_t ApiVersion;
|
| 87 |
+
/** The type to be initialized. */
|
| 88 |
+
EOS_IntegratedPlatformType Type;
|
| 89 |
+
/** Identifies how to initialize the IntegratedPlatform. */
|
| 90 |
+
EOS_EIntegratedPlatformManagementFlags Flags;
|
| 91 |
+
/**
|
| 92 |
+
* Options specific to this integrated platform type.
|
| 93 |
+
* This parameter is either required or set to NULL based on the platform type.
|
| 94 |
+
*
|
| 95 |
+
* @see EOS_IntegratedPlatform_Steam_Options
|
| 96 |
+
*/
|
| 97 |
+
const void* InitOptions;
|
| 98 |
+
));
|
| 99 |
+
|
| 100 |
+
/** The most recent version of the EOS_IntegratedPlatform_Steam_Options API. */
|
| 101 |
+
#define EOS_INTEGRATEDPLATFORM_STEAM_OPTIONS_API_LATEST 3
|
| 102 |
+
|
| 103 |
+
/** The maximum size of the SteamApiInterfaceVersionsArray in the EOS_IntegratedPlatform_Steam_Options struct. */
|
| 104 |
+
#define EOS_INTEGRATEDPLATFORM_STEAM_MAX_STEAMAPIINTERFACEVERSIONSARRAY_SIZE 4096
|
| 105 |
+
|
| 106 |
+
/**
|
| 107 |
+
* Required initialization options to use with EOS_IntegratedPlatform_Options for Steam.
|
| 108 |
+
* Steamworks API needs to be at least v1.13
|
| 109 |
+
* Steam Sanitization requires at least v1.45
|
| 110 |
+
* Starting Steamworks v1.58a onwards, SteamApiInterfaceVersionsArray is required when EOS_IPMF_LibraryManagedBySDK is set.
|
| 111 |
+
*
|
| 112 |
+
* @see EOS_IntegratedPlatform_Options
|
| 113 |
+
*/
|
| 114 |
+
EOS_STRUCT(EOS_IntegratedPlatform_Steam_Options, (
|
| 115 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORM_STEAM_OPTIONS_API_LATEST. */
|
| 116 |
+
int32_t ApiVersion;
|
| 117 |
+
/**
|
| 118 |
+
* Usage of this parameter is dependent on the specified EOS_EIntegratedPlatformManagementFlags.
|
| 119 |
+
*
|
| 120 |
+
* Optional with EOS_IPMF_LibraryManagedByApplication.
|
| 121 |
+
* Set to override the loaded library basename, or use NULL to assume the default basename by platform:
|
| 122 |
+
*
|
| 123 |
+
* - Linux: libsteam_api.so,
|
| 124 |
+
* - macOS: libsteam_api.dylib,
|
| 125 |
+
* - Windows 32-bit: steam_api.dll,
|
| 126 |
+
* - Windows 64-bit: steam_api64.dll.
|
| 127 |
+
*
|
| 128 |
+
* Required with EOS_IPMF_LibraryManagedBySDK.
|
| 129 |
+
* Set to a fully qualified file path to the Steamworks SDK runtime library on disk.
|
| 130 |
+
*/
|
| 131 |
+
const char* OverrideLibraryPath;
|
| 132 |
+
/**
|
| 133 |
+
* Used to specify the major version of the Steam SDK your game is compiled against, e.g.:
|
| 134 |
+
*
|
| 135 |
+
* Options.SteamMajorVersion = 1;
|
| 136 |
+
*/
|
| 137 |
+
uint32_t SteamMajorVersion;
|
| 138 |
+
/**
|
| 139 |
+
* Used to specify the minor version of the Steam SDK your game is compiled against, e.g.:
|
| 140 |
+
*
|
| 141 |
+
* Options.SteamMinorVersion = 58;
|
| 142 |
+
*/
|
| 143 |
+
uint32_t SteamMinorVersion;
|
| 144 |
+
|
| 145 |
+
/**
|
| 146 |
+
* A pointer to a series of null terminated steam interface version names supported by the current steam dll.
|
| 147 |
+
*
|
| 148 |
+
* This field is only required when the Integrated Platform Management flags has EOS_IPMF_LibraryManagedBySDK set. Else must be set to NULL.
|
| 149 |
+
*
|
| 150 |
+
* Starting v1.58 the Steam initialization API requires this new field during initialization for version check validations.
|
| 151 |
+
*
|
| 152 |
+
* Note: The pointer must be valid until after the execution of the EOS_IntegratedPlatformOptionsContainer_Add method.
|
| 153 |
+
*
|
| 154 |
+
* This value must be constructed from the corresponding steam_api.h header of the steam dll version that is shipped with the game.
|
| 155 |
+
* In the steam_api.h header, look for SteamAPI_InitEx() and copy the value of pszInternalCheckInterfaceVersions as it is.
|
| 156 |
+
*
|
| 157 |
+
* For example in v1.58a its this:
|
| 158 |
+
* const char SteamInterfaceVersionsArray[] =
|
| 159 |
+
* STEAMUTILS_INTERFACE_VERSION "\0"
|
| 160 |
+
* STEAMNETWORKINGUTILS_INTERFACE_VERSION "\0"
|
| 161 |
+
* ...
|
| 162 |
+
* STEAMUSER_INTERFACE_VERSION "\0"
|
| 163 |
+
* STEAMVIDEO_INTERFACE_VERSION "\0"
|
| 164 |
+
* "\0";
|
| 165 |
+
*/
|
| 166 |
+
const char* SteamApiInterfaceVersionsArray;
|
| 167 |
+
|
| 168 |
+
/**
|
| 169 |
+
* Size of the SteamApiInterfaceVersionsArray in bytes. Cannot exceed EOS_INTEGRATEDPLATFORM_STEAM_MAX_STEAMAPIINTERFACEVERSIONSARRAY_SIZE.
|
| 170 |
+
*
|
| 171 |
+
* This field is only required when the Integrated Platform Management flags has EOS_IPMF_LibraryManagedBySDK set. Else must be set to 0.
|
| 172 |
+
*
|
| 173 |
+
* Note: Since SteamInterfaceVersionsArray contains a series of null terminated strings, please ensure that strlen() is NOT used to calculate this field.
|
| 174 |
+
* For instance, you can use the following to get the array length:
|
| 175 |
+
* const char SteamInterfaceVersionsArray[] =
|
| 176 |
+
* STEAMUTILS_INTERFACE_VERSION "\0"
|
| 177 |
+
* STEAMNETWORKINGUTILS_INTERFACE_VERSION "\0"
|
| 178 |
+
* ...
|
| 179 |
+
* STEAMVIDEO_INTERFACE_VERSION "\0"
|
| 180 |
+
* "\0";
|
| 181 |
+
*
|
| 182 |
+
* uint32_t SteamApiInterfaceVersionsArrayBytes = sizeof(SteamApiInterfaceVersionsArray) // Note: sizeof() takes into account the last "\0" of the string literal;
|
| 183 |
+
*/
|
| 184 |
+
uint32_t SteamApiInterfaceVersionsArrayBytes;
|
| 185 |
+
));
|
| 186 |
+
|
| 187 |
+
/** The most recent version of the EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainer API. */
|
| 188 |
+
#define EOS_INTEGRATEDPLATFORM_CREATEINTEGRATEDPLATFORMOPTIONSCONTAINER_API_LATEST 1
|
| 189 |
+
|
| 190 |
+
/**
|
| 191 |
+
* Data for the EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainer function.
|
| 192 |
+
*/
|
| 193 |
+
EOS_STRUCT(EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainerOptions, (
|
| 194 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORM_CREATEINTEGRATEDPLATFORMOPTIONSCONTAINER_API_LATEST. */
|
| 195 |
+
int32_t ApiVersion;
|
| 196 |
+
));
|
| 197 |
+
|
| 198 |
+
/**
|
| 199 |
+
* Creates an integrated platform options container handle. This handle can used to add multiple options to your container which will then be applied with EOS_Platform_Create.
|
| 200 |
+
* The resulting handle must be released by calling EOS_IntegratedPlatformOptionsContainer_Release once it has been passed to EOS_Platform_Create.
|
| 201 |
+
*
|
| 202 |
+
* @param Options structure containing operation input parameters.
|
| 203 |
+
* @param OutIntegratedPlatformOptionsContainerHandle Pointer to an integrated platform options container handle to be set if successful.
|
| 204 |
+
* @return Success if we successfully created the integrated platform options container handle pointed at in OutIntegratedPlatformOptionsContainerHandle, or an error result if the input data was invalid.
|
| 205 |
+
*
|
| 206 |
+
* @see EOS_IntegratedPlatformOptionsContainer_Release
|
| 207 |
+
* @see EOS_Platform_Create
|
| 208 |
+
* @see EOS_IntegratedPlatformOptionsContainer_Add
|
| 209 |
+
*/
|
| 210 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainer(const EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainerOptions* Options, EOS_HIntegratedPlatformOptionsContainer* OutIntegratedPlatformOptionsContainerHandle);
|
| 211 |
+
|
| 212 |
+
/**
|
| 213 |
+
* Release the memory associated with an EOS_HIntegratedPlatformOptionsContainer handle. This must be called on Handles retrieved from EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainer.
|
| 214 |
+
* This can be safely called on a NULL integrated platform options container handle.
|
| 215 |
+
*
|
| 216 |
+
* @param IntegratedPlatformOptionsContainerHandle The integrated platform options container handle to release.
|
| 217 |
+
*
|
| 218 |
+
* @see EOS_IntegratedPlatform_CreateIntegratedPlatformOptionsContainer
|
| 219 |
+
*/
|
| 220 |
+
EOS_DECLARE_FUNC(void) EOS_IntegratedPlatformOptionsContainer_Release(EOS_HIntegratedPlatformOptionsContainer IntegratedPlatformOptionsContainerHandle);
|
| 221 |
+
|
| 222 |
+
|
| 223 |
+
/** The most recent version of the EOS_IntegratedPlatformOptionsContainer_Add API. */
|
| 224 |
+
#define EOS_INTEGRATEDPLATFORMOPTIONSCONTAINER_ADD_API_LATEST 1
|
| 225 |
+
|
| 226 |
+
/**
|
| 227 |
+
* Data for the EOS_IntegratedPlatformOptionsContainer_Add function.
|
| 228 |
+
*/
|
| 229 |
+
EOS_STRUCT(EOS_IntegratedPlatformOptionsContainer_AddOptions, (
|
| 230 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORMOPTIONSCONTAINER_ADD_API_LATEST. */
|
| 231 |
+
int32_t ApiVersion;
|
| 232 |
+
/** The integrated platform options to add. */
|
| 233 |
+
const EOS_IntegratedPlatform_Options* Options;
|
| 234 |
+
));
|
| 235 |
+
|
| 236 |
+
/** The most recent version of the EOS_IntegratedPlatform_SetUserLoginStatus API. */
|
| 237 |
+
#define EOS_INTEGRATEDPLATFORM_SETUSERLOGINSTATUS_API_LATEST 1
|
| 238 |
+
|
| 239 |
+
/**
|
| 240 |
+
* Input parameters for the EOS_IntegratedPlatform_SetUserLoginStatus function.
|
| 241 |
+
*/
|
| 242 |
+
EOS_STRUCT(EOS_IntegratedPlatform_SetUserLoginStatusOptions, (
|
| 243 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORM_SETUSERLOGINSTATUS_API_LATEST. */
|
| 244 |
+
int32_t ApiVersion;
|
| 245 |
+
|
| 246 |
+
/** The integrated platform this user belongs to. */
|
| 247 |
+
EOS_IntegratedPlatformType PlatformType;
|
| 248 |
+
|
| 249 |
+
/** String version of the integrated platform-dependent user id. */
|
| 250 |
+
const char* LocalPlatformUserId;
|
| 251 |
+
|
| 252 |
+
/** The login status of the provided user */
|
| 253 |
+
EOS_ELoginStatus CurrentLoginStatus;
|
| 254 |
+
));
|
| 255 |
+
|
| 256 |
+
|
| 257 |
+
/** The most recent version of the EOS_IntegratedPlatform_AddNotifyUserLoginStatusChanged API. */
|
| 258 |
+
#define EOS_INTEGRATEDPLATFORM_ADDNOTIFYUSERLOGINSTATUSCHANGED_API_LATEST 1
|
| 259 |
+
|
| 260 |
+
/**
|
| 261 |
+
* Input parameters for the EOS_IntegratedPlatform_AddNotifyUserLoginStatusChanged function.
|
| 262 |
+
*/
|
| 263 |
+
EOS_STRUCT(EOS_IntegratedPlatform_AddNotifyUserLoginStatusChangedOptions, (
|
| 264 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORM_ADDNOTIFYUSERLOGINSTATUSCHANGED_API_LATEST. */
|
| 265 |
+
int32_t ApiVersion;
|
| 266 |
+
));
|
| 267 |
+
|
| 268 |
+
/**
|
| 269 |
+
* Data about which integrated platform and which user that had a login status change and what the login status changed to.
|
| 270 |
+
*/
|
| 271 |
+
EOS_STRUCT(EOS_IntegratedPlatform_UserLoginStatusChangedCallbackInfo, (
|
| 272 |
+
/** Context that was passed into EOS_IntegratedPlatform_AddNotifyUserLoginStatusChanged */
|
| 273 |
+
void* ClientData;
|
| 274 |
+
/** The integrated platform of the local platform user. */
|
| 275 |
+
EOS_IntegratedPlatformType PlatformType;
|
| 276 |
+
/** String version of platform's user id. */
|
| 277 |
+
const char* LocalPlatformUserId;
|
| 278 |
+
/** The Epic Games Account ID associated with this Integrated Platform's User (if there is one) */
|
| 279 |
+
EOS_EpicAccountId AccountId;
|
| 280 |
+
/** The EOS Product User ID associated with this Integrated Platform's User (if there is one) */
|
| 281 |
+
EOS_ProductUserId ProductUserId;
|
| 282 |
+
/** The login status prior to this change. */
|
| 283 |
+
EOS_ELoginStatus PreviousLoginStatus;
|
| 284 |
+
/** The login status at the time of this notification. */
|
| 285 |
+
EOS_ELoginStatus CurrentLoginStatus;
|
| 286 |
+
));
|
| 287 |
+
/**
|
| 288 |
+
* The callback function for when a local integrated platform user's login status has changed.
|
| 289 |
+
*/
|
| 290 |
+
EOS_DECLARE_CALLBACK(EOS_IntegratedPlatform_OnUserLoginStatusChangedCallback, const EOS_IntegratedPlatform_UserLoginStatusChangedCallbackInfo* Data);
|
| 291 |
+
|
| 292 |
+
/** The most recent version of the EOS_IntegratedPlatform_SetUserPreLogoutCallback API. */
|
| 293 |
+
#define EOS_INTEGRATEDPLATFORM_SETUSERPRELOGOUTCALLBACK_API_LATEST 1
|
| 294 |
+
|
| 295 |
+
/**
|
| 296 |
+
* Input parameters for the EOS_IntegratedPlatform_SetUserPreLogoutCallback function.
|
| 297 |
+
*/
|
| 298 |
+
EOS_STRUCT(EOS_IntegratedPlatform_SetUserPreLogoutCallbackOptions, (
|
| 299 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORM_SETUSERPRELOGOUTCALLBACK_API_LATEST. */
|
| 300 |
+
int32_t ApiVersion;
|
| 301 |
+
));
|
| 302 |
+
|
| 303 |
+
/**
|
| 304 |
+
* The return value for the EOS_IntegratedPlatform_OnUserPreLogoutCallback callback function. This signifies what the application wants to do for
|
| 305 |
+
* the provided user of the integrated platform.
|
| 306 |
+
*/
|
| 307 |
+
EOS_ENUM(EOS_EIntegratedPlatformPreLogoutAction,
|
| 308 |
+
/**
|
| 309 |
+
* The application accepts the user being logged-out. all cached data for the user will be cleared immediately and any pending
|
| 310 |
+
* actions canceled.
|
| 311 |
+
*/
|
| 312 |
+
EOS_IPLA_ProcessLogoutImmediately = 0,
|
| 313 |
+
/**
|
| 314 |
+
* Instead of the user being logged-out, the SDK will wait for a call to EOS_IntegratedPlatform_FinalizeDeferredUserLogout with the
|
| 315 |
+
* expected login state of the user. If the expected state matches the current state, the user will continue to be logged-in or they
|
| 316 |
+
* will be logged-out, depending on the value of the expected state. This lets the application choose to ask the user if they meant
|
| 317 |
+
* to logout if it wishes, possibly preventing losing any unsaved changes, such as game progress, leaving a multiplayer match, or
|
| 318 |
+
* similar.
|
| 319 |
+
*
|
| 320 |
+
* @see EOS_IntegratedPlatform_FinalizeDeferredUserLogout
|
| 321 |
+
*/
|
| 322 |
+
EOS_IPLA_DeferLogout = 1
|
| 323 |
+
);
|
| 324 |
+
|
| 325 |
+
/**
|
| 326 |
+
* Data passed to the application in the EOS_IntegratedPlatform_OnUserPreLogoutCallback function. This contains which user and associated
|
| 327 |
+
* Integrated Platform that was detected as logged-out.
|
| 328 |
+
*/
|
| 329 |
+
EOS_STRUCT(EOS_IntegratedPlatform_UserPreLogoutCallbackInfo, (
|
| 330 |
+
/** Context that was passed into EOS_IntegratedPlatform_SetUserPreLogoutCallback */
|
| 331 |
+
void* ClientData;
|
| 332 |
+
/** The integrated platform the local user logged-out of. */
|
| 333 |
+
EOS_IntegratedPlatformType PlatformType;
|
| 334 |
+
/** String version of platform-dependent user id. */
|
| 335 |
+
const char* LocalPlatformUserId;
|
| 336 |
+
/** The Epic Games Account ID associated with this Integrated Platform's User (if there is one) */
|
| 337 |
+
EOS_EpicAccountId AccountId;
|
| 338 |
+
/** The EOS Product User ID associated with this Integrated Platform's User (if there is one) */
|
| 339 |
+
EOS_ProductUserId ProductUserId;
|
| 340 |
+
));
|
| 341 |
+
/**
|
| 342 |
+
* The callback function for when an integrated platform user is detected to have logged-out.
|
| 343 |
+
*/
|
| 344 |
+
EOS_DECLARE_CALLBACK_RETVALUE(EOS_EIntegratedPlatformPreLogoutAction, EOS_IntegratedPlatform_OnUserPreLogoutCallback, const EOS_IntegratedPlatform_UserPreLogoutCallbackInfo* Data);
|
| 345 |
+
|
| 346 |
+
/** The most recent version of the EOS_IntegratedPlatform_ClearUserPreLogoutCallback API. */
|
| 347 |
+
#define EOS_INTEGRATEDPLATFORM_CLEARUSERPRELOGOUTCALLBACK_API_LATEST 1
|
| 348 |
+
|
| 349 |
+
/**
|
| 350 |
+
* Input parameters for the EOS_IntegratedPlatform_ClearUserPreLogoutCallback function.
|
| 351 |
+
*/
|
| 352 |
+
EOS_STRUCT(EOS_IntegratedPlatform_ClearUserPreLogoutCallbackOptions, (
|
| 353 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORM_CLEARUSERPRELOGOUTCALLBACK_API_LATEST. */
|
| 354 |
+
int32_t ApiVersion;
|
| 355 |
+
));
|
| 356 |
+
|
| 357 |
+
|
| 358 |
+
/** The most recent version of the EOS_IntegratedPlatform_FinalizeDeferredUserLogout API. */
|
| 359 |
+
#define EOS_INTEGRATEDPLATFORM_FINALIZEDEFERREDUSERLOGOUT_API_LATEST 1
|
| 360 |
+
|
| 361 |
+
/**
|
| 362 |
+
* Input parameters for the EOS_IntegratedPlatform_FinalizeDeferredUserLogout function.
|
| 363 |
+
*/
|
| 364 |
+
EOS_STRUCT(EOS_IntegratedPlatform_FinalizeDeferredUserLogoutOptions, (
|
| 365 |
+
/** API Version: Set this to EOS_INTEGRATEDPLATFORM_FINALIZEDEFERREDUSERLOGOUT_API_LATEST. */
|
| 366 |
+
int32_t ApiVersion;
|
| 367 |
+
|
| 368 |
+
/** The integrated platform this user belongs to. */
|
| 369 |
+
EOS_IntegratedPlatformType PlatformType;
|
| 370 |
+
|
| 371 |
+
/** String version of the integrated platform-dependent user id. */
|
| 372 |
+
const char* LocalPlatformUserId;
|
| 373 |
+
|
| 374 |
+
/**
|
| 375 |
+
* The logged-in state the user is expected to be (EOS_LS_LoggedIn or EOS_LS_NotLoggedIn). If the provided
|
| 376 |
+
* state does not match internal EOS state, this function will return in failure. If the state is incorrect,
|
| 377 |
+
* the application should wait and attempt to call the function again next tick, after both updating its own
|
| 378 |
+
* state from the system and calling EOS_Platform_Tick, allowing the SDK to update its state from the system
|
| 379 |
+
* as well.
|
| 380 |
+
*/
|
| 381 |
+
EOS_ELoginStatus ExpectedLoginStatus;
|
| 382 |
+
));
|
| 383 |
+
|
| 384 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_kws.h
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_kws_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* This interface is not available for general access at this time.
|
| 8 |
+
*
|
| 9 |
+
* The KWS Interface exists as an integration for age gating functionality provided by Kids Web Services from SuperAwesome, using the EOS Connect interface.
|
| 10 |
+
*
|
| 11 |
+
* All KWS Interface calls take a handle of type EOS_HKWS as the first parameter.
|
| 12 |
+
* This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetKWSInterface function.
|
| 13 |
+
*
|
| 14 |
+
* @see EOS_Platform_GetKWSInterface
|
| 15 |
+
*/
|
| 16 |
+
|
| 17 |
+
/**
|
| 18 |
+
* This interface is not available for general access at this time.
|
| 19 |
+
*
|
| 20 |
+
* Query the client's country and age permissions for client side reasoning about the possible need enforce age based restrictions
|
| 21 |
+
*
|
| 22 |
+
* @param Options options required for interacting with the age gate system
|
| 23 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 24 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 25 |
+
*
|
| 26 |
+
* @see EOS_KWS_QueryAgeGateOptions
|
| 27 |
+
* @see EOS_KWS_OnQueryAgeGateCallback
|
| 28 |
+
*/
|
| 29 |
+
EOS_DECLARE_FUNC(void) EOS_KWS_QueryAgeGate(EOS_HKWS Handle, const EOS_KWS_QueryAgeGateOptions* Options, void* ClientData, const EOS_KWS_OnQueryAgeGateCallback CompletionDelegate);
|
| 30 |
+
|
| 31 |
+
/**
|
| 32 |
+
* This interface is not available for general access at this time.
|
| 33 |
+
*
|
| 34 |
+
* Create an account with Kids Web Services and associate it with the local Product User ID
|
| 35 |
+
*
|
| 36 |
+
* @param Options options required for creating an account such as the local users Product User ID, their data of birth, and parental contact information
|
| 37 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 38 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 39 |
+
*
|
| 40 |
+
* @see EOS_KWS_CreateUserOptions
|
| 41 |
+
* @see EOS_KWS_OnCreateUserCallback
|
| 42 |
+
*/
|
| 43 |
+
EOS_DECLARE_FUNC(void) EOS_KWS_CreateUser(EOS_HKWS Handle, const EOS_KWS_CreateUserOptions* Options, void* ClientData, const EOS_KWS_OnCreateUserCallback CompletionDelegate);
|
| 44 |
+
|
| 45 |
+
/**
|
| 46 |
+
* This interface is not available for general access at this time.
|
| 47 |
+
*
|
| 48 |
+
* Query the current state of permissions for a given local Product User ID
|
| 49 |
+
*
|
| 50 |
+
* @param Options options required for querying permissions such as the local users Product User ID
|
| 51 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 52 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 53 |
+
*
|
| 54 |
+
* @see EOS_KWS_QueryPermissionsOptions
|
| 55 |
+
* @see EOS_KWS_OnQueryPermissionsCallback
|
| 56 |
+
*/
|
| 57 |
+
EOS_DECLARE_FUNC(void) EOS_KWS_QueryPermissions(EOS_HKWS Handle, const EOS_KWS_QueryPermissionsOptions* Options, void* ClientData, const EOS_KWS_OnQueryPermissionsCallback CompletionDelegate);
|
| 58 |
+
|
| 59 |
+
/**
|
| 60 |
+
* This interface is not available for general access at this time.
|
| 61 |
+
*
|
| 62 |
+
* Update the parent contact information for a given local Product User ID
|
| 63 |
+
*
|
| 64 |
+
* @param Options options required for updating the contact information such as the new email address
|
| 65 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 66 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 67 |
+
*
|
| 68 |
+
* @see EOS_KWS_UpdateParentEmailOptions
|
| 69 |
+
* @see EOS_KWS_OnUpdateParentEmailCallback
|
| 70 |
+
*/
|
| 71 |
+
EOS_DECLARE_FUNC(void) EOS_KWS_UpdateParentEmail(EOS_HKWS Handle, const EOS_KWS_UpdateParentEmailOptions* Options, void* ClientData, const EOS_KWS_OnUpdateParentEmailCallback CompletionDelegate);
|
| 72 |
+
|
| 73 |
+
/**
|
| 74 |
+
* This interface is not available for general access at this time.
|
| 75 |
+
*
|
| 76 |
+
* Request new permissions for a given local Product User ID
|
| 77 |
+
*
|
| 78 |
+
* @param Options options required for updating permissions such as the new list of permissions
|
| 79 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 80 |
+
* @param CompletionDelegate A callback that is fired when the operation completes, either successfully or in error
|
| 81 |
+
*
|
| 82 |
+
* @see EOS_KWS_RequestPermissionsOptions
|
| 83 |
+
* @see EOS_KWS_OnRequestPermissionsCallback
|
| 84 |
+
*/
|
| 85 |
+
EOS_DECLARE_FUNC(void) EOS_KWS_RequestPermissions(EOS_HKWS Handle, const EOS_KWS_RequestPermissionsOptions* Options, void* ClientData, const EOS_KWS_OnRequestPermissionsCallback CompletionDelegate);
|
| 86 |
+
|
| 87 |
+
/**
|
| 88 |
+
* This interface is not available for general access at this time.
|
| 89 |
+
*
|
| 90 |
+
* Fetch the number of permissions found for a given local user
|
| 91 |
+
*
|
| 92 |
+
* @param Options Structure containing the input parameters
|
| 93 |
+
*
|
| 94 |
+
* @return the number of permissions associated with the given user
|
| 95 |
+
*
|
| 96 |
+
* @see EOS_KWS_GetPermissionsCountOptions
|
| 97 |
+
*/
|
| 98 |
+
EOS_DECLARE_FUNC(int32_t) EOS_KWS_GetPermissionsCount(EOS_HKWS Handle, const EOS_KWS_GetPermissionsCountOptions* Options);
|
| 99 |
+
|
| 100 |
+
/**
|
| 101 |
+
* This interface is not available for general access at this time.
|
| 102 |
+
*
|
| 103 |
+
* Fetch a permission for a given by index for a given local user
|
| 104 |
+
*
|
| 105 |
+
* @param Options Structure containing the input parameters
|
| 106 |
+
* @param OutPermission the permission for the given index, if it exists and is valid, use EOS_KWS_PermissionStatus_Release when finished
|
| 107 |
+
*
|
| 108 |
+
* @see EOS_KWS_CopyPermissionByIndexOptions
|
| 109 |
+
* @see EOS_KWS_PermissionStatus
|
| 110 |
+
* @see EOS_KWS_CreateUser
|
| 111 |
+
* @see EOS_KWS_QueryPermissions
|
| 112 |
+
* @see EOS_KWS_RequestPermissions
|
| 113 |
+
* @see EOS_KWS_PermissionStatus_Release
|
| 114 |
+
*
|
| 115 |
+
* @return EOS_EResult containing the result of the operation.
|
| 116 |
+
* Possible result codes:
|
| 117 |
+
* - EOS_Success if the permission state is known for the given user and index
|
| 118 |
+
* - EOS_NotFound if the user is not found or the index is invalid
|
| 119 |
+
*/
|
| 120 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_KWS_CopyPermissionByIndex(EOS_HKWS Handle, const EOS_KWS_CopyPermissionByIndexOptions* Options, EOS_KWS_PermissionStatus ** OutPermission);
|
| 121 |
+
|
| 122 |
+
/**
|
| 123 |
+
* This interface is not available for general access at this time.
|
| 124 |
+
*
|
| 125 |
+
* Fetch the state of a given permission that are cached for a given local user.
|
| 126 |
+
*
|
| 127 |
+
* @param Options Structure containing the input parameters
|
| 128 |
+
* @param OutPermission the permission for the given key, if it exists and is valid
|
| 129 |
+
*
|
| 130 |
+
* @see EOS_KWS_GetPermissionByKeyOptions
|
| 131 |
+
* @see EOS_EKWSPermissionStatus
|
| 132 |
+
* @see EOS_KWS_CreateUser
|
| 133 |
+
* @see EOS_KWS_QueryPermissions
|
| 134 |
+
* @see EOS_KWS_RequestPermissions
|
| 135 |
+
*
|
| 136 |
+
* @return EOS_EResult containing the result of the operation.
|
| 137 |
+
* Possible result codes:
|
| 138 |
+
* - EOS_Success if the permission state is known for the given user and key
|
| 139 |
+
* - EOS_NotFound if the user or the permission is not found
|
| 140 |
+
*/
|
| 141 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_KWS_GetPermissionByKey(EOS_HKWS Handle, const EOS_KWS_GetPermissionByKeyOptions* Options, EOS_EKWSPermissionStatus* OutPermission);
|
| 142 |
+
|
| 143 |
+
/**
|
| 144 |
+
* This interface is not available for general access at this time.
|
| 145 |
+
*
|
| 146 |
+
* Register to receive notifications about KWS permissions changes for any logged in local users
|
| 147 |
+
* @note If the returned NotificationId is valid, you must call EOS_KWS_RemoveNotifyPermissionsUpdateReceived when you no longer wish to have your NotificationHandler called.
|
| 148 |
+
*
|
| 149 |
+
* @param Options Structure containing information about the request.
|
| 150 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 151 |
+
* @param NotificationFn A callback that is fired when a notification is received.
|
| 152 |
+
*
|
| 153 |
+
* @see EOS_KWS_AddNotifyPermissionsUpdateReceivedOptions
|
| 154 |
+
* @see EOS_KWS_OnPermissionsUpdateReceivedCallback
|
| 155 |
+
*
|
| 156 |
+
* @return handle representing the registered callback
|
| 157 |
+
*/
|
| 158 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_KWS_AddNotifyPermissionsUpdateReceived(EOS_HKWS Handle, const EOS_KWS_AddNotifyPermissionsUpdateReceivedOptions* Options, void* ClientData, const EOS_KWS_OnPermissionsUpdateReceivedCallback NotificationFn);
|
| 159 |
+
|
| 160 |
+
/**
|
| 161 |
+
* This interface is not available for general access at this time.
|
| 162 |
+
*
|
| 163 |
+
* Unregister from receiving notifications about KWS permissions related to logged in users
|
| 164 |
+
*
|
| 165 |
+
* @param InId Handle representing the registered callback
|
| 166 |
+
*/
|
| 167 |
+
EOS_DECLARE_FUNC(void) EOS_KWS_RemoveNotifyPermissionsUpdateReceived(EOS_HKWS Handle, EOS_NotificationId InId);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_kws_types.h
ADDED
|
@@ -0,0 +1,310 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
|
| 6 |
+
#pragma pack(push, 8)
|
| 7 |
+
|
| 8 |
+
EOS_EXTERN_C typedef struct EOS_KWSHandle* EOS_HKWS;
|
| 9 |
+
|
| 10 |
+
/** Maximum number of permissions that may be requested */
|
| 11 |
+
#define EOS_KWS_MAX_PERMISSIONS 16
|
| 12 |
+
|
| 13 |
+
/** Maximum size of the name for the permission */
|
| 14 |
+
#define EOS_KWS_MAX_PERMISSION_LENGTH 32
|
| 15 |
+
|
| 16 |
+
/**
|
| 17 |
+
* An enumeration of the different permission statuses.
|
| 18 |
+
*/
|
| 19 |
+
EOS_ENUM(EOS_EKWSPermissionStatus,
|
| 20 |
+
/** Permission has been granted */
|
| 21 |
+
EOS_KPS_GRANTED = 0,
|
| 22 |
+
/** Permission has been rejected */
|
| 23 |
+
EOS_KPS_REJECTED = 1,
|
| 24 |
+
/** Permission is still pending approval */
|
| 25 |
+
EOS_KPS_PENDING = 2
|
| 26 |
+
);
|
| 27 |
+
|
| 28 |
+
/** The most recent version of the EOS_KWS_PermissionStatus API. */
|
| 29 |
+
#define EOS_KWS_PERMISSIONSTATUS_API_LATEST 1
|
| 30 |
+
|
| 31 |
+
/**
|
| 32 |
+
* Contains information about a KWS permission status.
|
| 33 |
+
*/
|
| 34 |
+
EOS_STRUCT(EOS_KWS_PermissionStatus, (
|
| 35 |
+
/** API Version: Set this to EOS_KWS_PERMISSIONSTATUS_API_LATEST. */
|
| 36 |
+
int32_t ApiVersion;
|
| 37 |
+
/** Name of the permission */
|
| 38 |
+
const char* Name;
|
| 39 |
+
/** Status of the permission */
|
| 40 |
+
EOS_EKWSPermissionStatus Status;
|
| 41 |
+
));
|
| 42 |
+
|
| 43 |
+
/**
|
| 44 |
+
* Release the memory associated with a KWS permission status. This must be called on data retrieved from EOS_KWS_CopyPermissionByIndex.
|
| 45 |
+
*
|
| 46 |
+
* @param PermissionStatus - A pointer to the KWS permission status to release
|
| 47 |
+
*
|
| 48 |
+
* @see EOS_KWS_CopyPermissionByIndex
|
| 49 |
+
*/
|
| 50 |
+
EOS_DECLARE_FUNC(void) EOS_KWS_PermissionStatus_Release(EOS_KWS_PermissionStatus* PermissionStatus);
|
| 51 |
+
|
| 52 |
+
/** The most recent version of the EOS_KWS_QueryAgeGate API. */
|
| 53 |
+
#define EOS_KWS_QUERYAGEGATE_API_LATEST 1
|
| 54 |
+
|
| 55 |
+
/**
|
| 56 |
+
* Input parameters for the EOS_KWS_QueryAgeGate function.
|
| 57 |
+
*/
|
| 58 |
+
EOS_STRUCT(EOS_KWS_QueryAgeGateOptions, (
|
| 59 |
+
/** API Version: Set this to EOS_KWS_QUERYAGEGATE_API_LATEST. */
|
| 60 |
+
int32_t ApiVersion;
|
| 61 |
+
));
|
| 62 |
+
|
| 63 |
+
/**
|
| 64 |
+
* Output parameters for the EOS_KWS_QueryAgeGate Function. These parameters are received through the callback provided to EOS_KWS_QueryAgeGate
|
| 65 |
+
*/
|
| 66 |
+
EOS_STRUCT(EOS_KWS_QueryAgeGateCallbackInfo, (
|
| 67 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 68 |
+
EOS_EResult ResultCode;
|
| 69 |
+
/** Context that was passed into EOS_KWS_QueryAgeGate */
|
| 70 |
+
void* ClientData;
|
| 71 |
+
/** Country code determined for this request based on the local client's ip address that the backend resolves */
|
| 72 |
+
const char* CountryCode;
|
| 73 |
+
/** Age of consent in the given country */
|
| 74 |
+
uint32_t AgeOfConsent;
|
| 75 |
+
));
|
| 76 |
+
|
| 77 |
+
/**
|
| 78 |
+
* Function prototype definition for callbacks passed to EOS_KWS_QueryAgeGate
|
| 79 |
+
* @param Data A EOS_KWS_QueryAgeGateCallbackInfo containing the output information and result
|
| 80 |
+
*/
|
| 81 |
+
EOS_DECLARE_CALLBACK(EOS_KWS_OnQueryAgeGateCallback, const EOS_KWS_QueryAgeGateCallbackInfo* Data);
|
| 82 |
+
|
| 83 |
+
/** The most recent version of the EOS_KWS_CreateUser API. */
|
| 84 |
+
#define EOS_KWS_CREATEUSER_API_LATEST 1
|
| 85 |
+
|
| 86 |
+
/**
|
| 87 |
+
* Input parameters for the EOS_KWS_CreateUser function.
|
| 88 |
+
*/
|
| 89 |
+
EOS_STRUCT(EOS_KWS_CreateUserOptions, (
|
| 90 |
+
/** API Version: Set this to EOS_KWS_CREATEUSER_API_LATEST. */
|
| 91 |
+
int32_t ApiVersion;
|
| 92 |
+
/** Local user creating a KWS entry */
|
| 93 |
+
EOS_ProductUserId LocalUserId;
|
| 94 |
+
/** Date of birth in ISO8601 form (YYYY-MM-DD) */
|
| 95 |
+
const char* DateOfBirth;
|
| 96 |
+
/** Parent email */
|
| 97 |
+
const char* ParentEmail;
|
| 98 |
+
));
|
| 99 |
+
|
| 100 |
+
/**
|
| 101 |
+
* Output parameters for the EOS_KWS_CreateUserOptions Function. These parameters are received through the callback provided to EOS_KWS_CreateUser
|
| 102 |
+
*/
|
| 103 |
+
EOS_STRUCT(EOS_KWS_CreateUserCallbackInfo, (
|
| 104 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 105 |
+
EOS_EResult ResultCode;
|
| 106 |
+
/** Context that was passed into EOS_KWS_CreateUser */
|
| 107 |
+
void* ClientData;
|
| 108 |
+
/** Local user that created a KWS entry */
|
| 109 |
+
EOS_ProductUserId LocalUserId;
|
| 110 |
+
/** KWS UserId created */
|
| 111 |
+
const char* KWSUserId;
|
| 112 |
+
/** Is this user a minor */
|
| 113 |
+
EOS_Bool bIsMinor;
|
| 114 |
+
));
|
| 115 |
+
|
| 116 |
+
|
| 117 |
+
/**
|
| 118 |
+
* Function prototype definition for callbacks passed to EOS_KWS_CreateUser
|
| 119 |
+
* @param Data A EOS_KWS_CreateUserCallbackInfo containing the output information and result
|
| 120 |
+
*/
|
| 121 |
+
EOS_DECLARE_CALLBACK(EOS_KWS_OnCreateUserCallback, const EOS_KWS_CreateUserCallbackInfo* Data);
|
| 122 |
+
|
| 123 |
+
/** The most recent version of the EOS_KWS_QueryPermissions API. */
|
| 124 |
+
#define EOS_KWS_QUERYPERMISSIONS_API_LATEST 1
|
| 125 |
+
|
| 126 |
+
/**
|
| 127 |
+
* Input parameters for the EOS_KWS_QueryPermissions function.
|
| 128 |
+
*/
|
| 129 |
+
EOS_STRUCT(EOS_KWS_QueryPermissionsOptions, (
|
| 130 |
+
/** API Version: Set this to EOS_KWS_QUERYPERMISSIONS_API_LATEST. */
|
| 131 |
+
int32_t ApiVersion;
|
| 132 |
+
/** Local user querying their permissions */
|
| 133 |
+
EOS_ProductUserId LocalUserId;
|
| 134 |
+
));
|
| 135 |
+
|
| 136 |
+
/**
|
| 137 |
+
* Output parameters for the EOS_KWS_QueryPermissionsOptions Function. These parameters are received through the callback provided to EOS_KWS_QueryPermissions
|
| 138 |
+
*/
|
| 139 |
+
EOS_STRUCT(EOS_KWS_QueryPermissionsCallbackInfo, (
|
| 140 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 141 |
+
EOS_EResult ResultCode;
|
| 142 |
+
/** Context that was passed into EOS_KWS_QueryPermissions */
|
| 143 |
+
void* ClientData;
|
| 144 |
+
/** Local user querying their permissions */
|
| 145 |
+
EOS_ProductUserId LocalUserId;
|
| 146 |
+
/** KWS UserId created */
|
| 147 |
+
const char* KWSUserId;
|
| 148 |
+
/** Date of birth in ISO8601 form (YYYY-MM-DD) */
|
| 149 |
+
const char* DateOfBirth;
|
| 150 |
+
/** Is this user a minor */
|
| 151 |
+
EOS_Bool bIsMinor;
|
| 152 |
+
/** Parent email. This value may be set to an empty string if the originally registered email recipient declined to be the right person to give consent. */
|
| 153 |
+
const char* ParentEmail;
|
| 154 |
+
));
|
| 155 |
+
|
| 156 |
+
/**
|
| 157 |
+
* Function prototype definition for callbacks passed to EOS_KWS_QueryPermissions
|
| 158 |
+
* @param Data A EOS_KWS_QueryPermissionsCallbackInfo containing the output information and result
|
| 159 |
+
*/
|
| 160 |
+
EOS_DECLARE_CALLBACK(EOS_KWS_OnQueryPermissionsCallback, const EOS_KWS_QueryPermissionsCallbackInfo* Data);
|
| 161 |
+
|
| 162 |
+
/** The most recent version of the EOS_KWS_UpdateParentEmail API. */
|
| 163 |
+
#define EOS_KWS_UPDATEPARENTEMAIL_API_LATEST 1
|
| 164 |
+
|
| 165 |
+
/**
|
| 166 |
+
* Input parameters for the EOS_KWS_UpdateParentEmail function.
|
| 167 |
+
*/
|
| 168 |
+
EOS_STRUCT(EOS_KWS_UpdateParentEmailOptions, (
|
| 169 |
+
/** API Version: Set this to EOS_KWS_UPDATEPARENTEMAIL_API_LATEST. */
|
| 170 |
+
int32_t ApiVersion;
|
| 171 |
+
/** Local user updating parental information */
|
| 172 |
+
EOS_ProductUserId LocalUserId;
|
| 173 |
+
/** New parent email */
|
| 174 |
+
const char* ParentEmail;
|
| 175 |
+
));
|
| 176 |
+
|
| 177 |
+
/**
|
| 178 |
+
* Output parameters for the EOS_KWS_UpdateParentEmailOptions Function. These parameters are received through the callback provided to EOS_KWS_UpdateParentEmail
|
| 179 |
+
*/
|
| 180 |
+
EOS_STRUCT(EOS_KWS_UpdateParentEmailCallbackInfo, (
|
| 181 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 182 |
+
EOS_EResult ResultCode;
|
| 183 |
+
/** Context that was passed into EOS_KWS_UpdateParentEmail */
|
| 184 |
+
void* ClientData;
|
| 185 |
+
/** Local user updating their parental email */
|
| 186 |
+
EOS_ProductUserId LocalUserId;
|
| 187 |
+
));
|
| 188 |
+
|
| 189 |
+
/**
|
| 190 |
+
* Function prototype definition for callbacks passed to EOS_KWS_UpdateParentEmail
|
| 191 |
+
* @param Data A EOS_KWS_UpdateParentEmailCallbackInfo containing the output information and result
|
| 192 |
+
*/
|
| 193 |
+
EOS_DECLARE_CALLBACK(EOS_KWS_OnUpdateParentEmailCallback, const EOS_KWS_UpdateParentEmailCallbackInfo* Data);
|
| 194 |
+
|
| 195 |
+
/** The most recent version of the EOS_KWS_RequestPermissions API. */
|
| 196 |
+
#define EOS_KWS_REQUESTPERMISSIONS_API_LATEST 1
|
| 197 |
+
|
| 198 |
+
/**
|
| 199 |
+
* Input parameters for the EOS_KWS_RequestPermissions function.
|
| 200 |
+
*/
|
| 201 |
+
EOS_STRUCT(EOS_KWS_RequestPermissionsOptions, (
|
| 202 |
+
/** API Version: Set this to EOS_KWS_REQUESTPERMISSIONS_API_LATEST. */
|
| 203 |
+
int32_t ApiVersion;
|
| 204 |
+
/** Local user requesting new permissions */
|
| 205 |
+
EOS_ProductUserId LocalUserId;
|
| 206 |
+
/** The number of permissions to request, may not exceed EOS_KWS_MAX_PERMISSIONS. Only new permissions need be included. */
|
| 207 |
+
uint32_t PermissionKeyCount;
|
| 208 |
+
/** Names of the permissions to request (Setup with KWS) */
|
| 209 |
+
const char** PermissionKeys;
|
| 210 |
+
));
|
| 211 |
+
|
| 212 |
+
/**
|
| 213 |
+
* Output parameters for the EOS_KWS_RequestPermissionsOptions Function. These parameters are received through the callback provided to EOS_KWS_RequestPermissions
|
| 214 |
+
*/
|
| 215 |
+
EOS_STRUCT(EOS_KWS_RequestPermissionsCallbackInfo, (
|
| 216 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 217 |
+
EOS_EResult ResultCode;
|
| 218 |
+
/** Context that was passed into EOS_KWS_RequestPermissions */
|
| 219 |
+
void* ClientData;
|
| 220 |
+
/** Local user requesting new permissions */
|
| 221 |
+
EOS_ProductUserId LocalUserId;
|
| 222 |
+
));
|
| 223 |
+
|
| 224 |
+
/**
|
| 225 |
+
* Function prototype definition for callbacks passed to EOS_KWS_RequestPermissions
|
| 226 |
+
* @param Data A EOS_KWS_RequestPermissionsCallbackInfo containing the output information and result
|
| 227 |
+
*/
|
| 228 |
+
EOS_DECLARE_CALLBACK(EOS_KWS_OnRequestPermissionsCallback, const EOS_KWS_RequestPermissionsCallbackInfo* Data);
|
| 229 |
+
|
| 230 |
+
|
| 231 |
+
/** The most recent version of the EOS_KWS_GetPermissionsCount API. */
|
| 232 |
+
#define EOS_KWS_GETPERMISSIONSCOUNT_API_LATEST 1
|
| 233 |
+
|
| 234 |
+
/**
|
| 235 |
+
* Input parameters for the EOS_KWS_GetPermissionsCount function.
|
| 236 |
+
*/
|
| 237 |
+
EOS_STRUCT(EOS_KWS_GetPermissionsCountOptions, (
|
| 238 |
+
/** API Version: Set this to EOS_KWS_GETPERMISSIONSCOUNT_API_LATEST. */
|
| 239 |
+
int32_t ApiVersion;
|
| 240 |
+
/** The Product User ID of the local user whose permissions are being accessed */
|
| 241 |
+
EOS_ProductUserId LocalUserId;
|
| 242 |
+
));
|
| 243 |
+
|
| 244 |
+
/** The most recent version of the EOS_KWS_CopyPermissionByIndex API. */
|
| 245 |
+
#define EOS_KWS_COPYPERMISSIONBYINDEX_API_LATEST 1
|
| 246 |
+
|
| 247 |
+
/**
|
| 248 |
+
* Input parameters for the EOS_KWS_CopyPermissionByIndex function.
|
| 249 |
+
*/
|
| 250 |
+
EOS_STRUCT(EOS_KWS_CopyPermissionByIndexOptions, (
|
| 251 |
+
/** API Version: Set this to EOS_KWS_COPYPERMISSIONBYINDEX_API_LATEST. */
|
| 252 |
+
int32_t ApiVersion;
|
| 253 |
+
/** The Product User ID of the local user whose permissions are being accessed */
|
| 254 |
+
EOS_ProductUserId LocalUserId;
|
| 255 |
+
/** The index of the permission to get. */
|
| 256 |
+
uint32_t Index;
|
| 257 |
+
));
|
| 258 |
+
|
| 259 |
+
/** The most recent version of the EOS_KWS_CreateUser API. */
|
| 260 |
+
#define EOS_KWS_GETPERMISSIONBYKEY_API_LATEST 1
|
| 261 |
+
|
| 262 |
+
/**
|
| 263 |
+
* Input parameters for the EOS_KWS_GetPermissionByKey function.
|
| 264 |
+
*/
|
| 265 |
+
EOS_STRUCT(EOS_KWS_GetPermissionByKeyOptions, (
|
| 266 |
+
/** API Version: Set this to EOS_KWS_GETPERMISSIONBYKEY_API_LATEST. */
|
| 267 |
+
int32_t ApiVersion;
|
| 268 |
+
/** The Product User ID of the local user getting permissions */
|
| 269 |
+
EOS_ProductUserId LocalUserId;
|
| 270 |
+
/** Permission name to query */
|
| 271 |
+
const char* Key;
|
| 272 |
+
));
|
| 273 |
+
|
| 274 |
+
/** The most recent version of the EOS_KWS_AddNotifyPermissionsUpdateReceived API. */
|
| 275 |
+
#define EOS_KWS_ADDNOTIFYPERMISSIONSUPDATERECEIVED_API_LATEST 1
|
| 276 |
+
|
| 277 |
+
/**
|
| 278 |
+
* Input parameters for the EOS_KWS_AddNotifyPermissionsUpdateReceived function.
|
| 279 |
+
*/
|
| 280 |
+
EOS_STRUCT(EOS_KWS_AddNotifyPermissionsUpdateReceivedOptions, (
|
| 281 |
+
/** API Version: Set this to EOS_KWS_ADDNOTIFYPERMISSIONSUPDATERECEIVED_API_LATEST. */
|
| 282 |
+
int32_t ApiVersion;
|
| 283 |
+
));
|
| 284 |
+
|
| 285 |
+
/**
|
| 286 |
+
* Output parameters for the EOS_KWS_OnPermissionsUpdateReceivedCallback Function.
|
| 287 |
+
*/
|
| 288 |
+
EOS_STRUCT(EOS_KWS_PermissionsUpdateReceivedCallbackInfo, (
|
| 289 |
+
/** Context that was passed into EOS_KWS_AddNotifyPermissionsUpdateReceived */
|
| 290 |
+
void* ClientData;
|
| 291 |
+
/** Recipient Local user id */
|
| 292 |
+
EOS_ProductUserId LocalUserId;
|
| 293 |
+
/** Recipient's associated KWS UserId */
|
| 294 |
+
const char* KWSUserId;
|
| 295 |
+
/** Date of birth in ISO8601 form (YYYY-MM-DD) */
|
| 296 |
+
const char* DateOfBirth;
|
| 297 |
+
/** Is this user a minor */
|
| 298 |
+
EOS_Bool bIsMinor;
|
| 299 |
+
/** Parent email. This value may be set to an empty string if the originally registered email recipient declined to be the right person to give consent. */
|
| 300 |
+
const char* ParentEmail;
|
| 301 |
+
));
|
| 302 |
+
|
| 303 |
+
/**
|
| 304 |
+
* Function prototype definition for notifications that comes from EOS_KWS_AddNotifyPermissionsUpdateReceived
|
| 305 |
+
*
|
| 306 |
+
* @param Data A EOS_KWS_PermissionsUpdateReceivedCallbackInfo containing the output information and result
|
| 307 |
+
*/
|
| 308 |
+
EOS_DECLARE_CALLBACK(EOS_KWS_OnPermissionsUpdateReceivedCallback, const EOS_KWS_PermissionsUpdateReceivedCallbackInfo* Data);
|
| 309 |
+
|
| 310 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_leaderboards.h
ADDED
|
@@ -0,0 +1,187 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_leaderboards_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* Query for a list of existing leaderboards definitions including their attributes.
|
| 8 |
+
*
|
| 9 |
+
* @param Options Structure containing information about the application whose leaderboard definitions we're retrieving.
|
| 10 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 11 |
+
* @param CompletionDelegate This function is called when the query operation completes.
|
| 12 |
+
*
|
| 13 |
+
* @see EOS_Leaderboards_QueryLeaderboardDefinitionsOptions
|
| 14 |
+
* @see EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallback
|
| 15 |
+
*/
|
| 16 |
+
EOS_DECLARE_FUNC(void) EOS_Leaderboards_QueryLeaderboardDefinitions(EOS_HLeaderboards Handle, const EOS_Leaderboards_QueryLeaderboardDefinitionsOptions* Options, void* ClientData, const EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallback CompletionDelegate);
|
| 17 |
+
|
| 18 |
+
/**
|
| 19 |
+
* Fetch the number of leaderboards definitions that are cached locally.
|
| 20 |
+
*
|
| 21 |
+
* @param Options The Options associated with retrieving the leaderboard count.
|
| 22 |
+
*
|
| 23 |
+
* @see EOS_Leaderboards_GetLeaderboardDefinitionCountOptions
|
| 24 |
+
* @see EOS_Leaderboards_CopyLeaderboardDefinitionByIndex
|
| 25 |
+
* @see EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId
|
| 26 |
+
*
|
| 27 |
+
* @return Number of leaderboards or 0 if there is an error
|
| 28 |
+
*/
|
| 29 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Leaderboards_GetLeaderboardDefinitionCount(EOS_HLeaderboards Handle, const EOS_Leaderboards_GetLeaderboardDefinitionCountOptions* Options);
|
| 30 |
+
|
| 31 |
+
/**
|
| 32 |
+
* Fetches a leaderboard definition from the cache using an index.
|
| 33 |
+
*
|
| 34 |
+
* @param Options Structure containing the index being accessed.
|
| 35 |
+
* @param OutLeaderboardDefinition The leaderboard data for the given index, if it exists and is valid, use EOS_Leaderboards_Definition_Release when finished.
|
| 36 |
+
*
|
| 37 |
+
* @see EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions
|
| 38 |
+
* @see EOS_Leaderboards_Definition
|
| 39 |
+
* @see EOS_Leaderboards_Definition_Release
|
| 40 |
+
*
|
| 41 |
+
* @return EOS_EResult containing the result of the operation.
|
| 42 |
+
* Possible result codes:
|
| 43 |
+
* - EOS_Success if the information is available and passed out in OutLeaderboardDefinition
|
| 44 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 45 |
+
* - EOS_NotFound if the leaderboard is not found
|
| 46 |
+
*/
|
| 47 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Leaderboards_CopyLeaderboardDefinitionByIndex(EOS_HLeaderboards Handle, const EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions* Options, EOS_Leaderboards_Definition ** OutLeaderboardDefinition);
|
| 48 |
+
|
| 49 |
+
/**
|
| 50 |
+
* Fetches a leaderboard definition from the cache using a leaderboard ID.
|
| 51 |
+
*
|
| 52 |
+
* @param Options Structure containing the leaderboard ID being accessed.
|
| 53 |
+
* @param OutLeaderboardDefinition The leaderboard definition for the given leaderboard ID, if it exists and is valid, use EOS_Leaderboards_Definition_Release when finished.
|
| 54 |
+
*
|
| 55 |
+
* @see EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions
|
| 56 |
+
* @see EOS_Leaderboards_Definition
|
| 57 |
+
* @see EOS_Leaderboards_Definition_Release
|
| 58 |
+
*
|
| 59 |
+
* @return EOS_EResult containing the result of the operation.
|
| 60 |
+
* Possible result codes:
|
| 61 |
+
* - EOS_Success if the information is available and passed out in OutLeaderboardDefinition
|
| 62 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 63 |
+
* - EOS_NotFound if the leaderboard data is not found
|
| 64 |
+
*/
|
| 65 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId(EOS_HLeaderboards Handle, const EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions* Options, EOS_Leaderboards_Definition ** OutLeaderboardDefinition);
|
| 66 |
+
|
| 67 |
+
/**
|
| 68 |
+
* Retrieves top leaderboard records by rank in the leaderboard matching the given leaderboard ID.
|
| 69 |
+
*
|
| 70 |
+
* @param Options Structure containing information about the leaderboard records we're retrieving.
|
| 71 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 72 |
+
* @param CompletionDelegate This function is called when the query operation completes.
|
| 73 |
+
*
|
| 74 |
+
* @see EOS_Leaderboards_QueryLeaderboardRanksOptions
|
| 75 |
+
* @see EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallback
|
| 76 |
+
*/
|
| 77 |
+
EOS_DECLARE_FUNC(void) EOS_Leaderboards_QueryLeaderboardRanks(EOS_HLeaderboards Handle, const EOS_Leaderboards_QueryLeaderboardRanksOptions* Options, void* ClientData, const EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallback CompletionDelegate);
|
| 78 |
+
|
| 79 |
+
/**
|
| 80 |
+
* Fetch the number of leaderboard records that are cached locally.
|
| 81 |
+
*
|
| 82 |
+
* @param Options The Options associated with retrieving the leaderboard record count.
|
| 83 |
+
*
|
| 84 |
+
* @see EOS_Leaderboards_GetLeaderboardRecordCountOptions
|
| 85 |
+
* @see EOS_Leaderboards_CopyLeaderboardRecordByIndex
|
| 86 |
+
* @see EOS_Leaderboards_CopyLeaderboardRecordByUserId
|
| 87 |
+
*
|
| 88 |
+
* @return Number of leaderboard records or 0 if there is an error
|
| 89 |
+
*/
|
| 90 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Leaderboards_GetLeaderboardRecordCount(EOS_HLeaderboards Handle, const EOS_Leaderboards_GetLeaderboardRecordCountOptions* Options);
|
| 91 |
+
|
| 92 |
+
/**
|
| 93 |
+
* Fetches a leaderboard record from a given index.
|
| 94 |
+
*
|
| 95 |
+
* @param Options Structure containing the index being accessed.
|
| 96 |
+
* @param OutLeaderboardRecord The leaderboard record for the given index, if it exists and is valid, use EOS_Leaderboards_LeaderboardRecord_Release when finished.
|
| 97 |
+
*
|
| 98 |
+
* @see EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions
|
| 99 |
+
* @see EOS_Leaderboards_LeaderboardRecord
|
| 100 |
+
* @see EOS_Leaderboards_LeaderboardRecord_Release
|
| 101 |
+
*
|
| 102 |
+
* @return EOS_EResult containing the result of the operation.
|
| 103 |
+
* Possible result codes:
|
| 104 |
+
* - EOS_Success if the leaderboard record is available and passed out in OutLeaderboardRecord
|
| 105 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 106 |
+
* - EOS_NotFound if the leaderboard is not found
|
| 107 |
+
*/
|
| 108 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Leaderboards_CopyLeaderboardRecordByIndex(EOS_HLeaderboards Handle, const EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions* Options, EOS_Leaderboards_LeaderboardRecord ** OutLeaderboardRecord);
|
| 109 |
+
|
| 110 |
+
/**
|
| 111 |
+
* Fetches a leaderboard record from a given user ID.
|
| 112 |
+
*
|
| 113 |
+
* @param Options Structure containing the user ID being accessed.
|
| 114 |
+
* @param OutLeaderboardRecord The leaderboard record for the given user ID, if it exists and is valid, use EOS_Leaderboards_LeaderboardRecord_Release when finished.
|
| 115 |
+
*
|
| 116 |
+
* @see EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions
|
| 117 |
+
* @see EOS_Leaderboards_LeaderboardRecord
|
| 118 |
+
* @see EOS_Leaderboards_LeaderboardRecord_Release
|
| 119 |
+
*
|
| 120 |
+
* @return EOS_EResult containing the result of the operation.
|
| 121 |
+
* Possible result codes:
|
| 122 |
+
* - EOS_Success if the leaderboard record is available and passed out in OutLeaderboardRecord
|
| 123 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 124 |
+
* - EOS_NotFound if the leaderboard data is not found
|
| 125 |
+
*/
|
| 126 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Leaderboards_CopyLeaderboardRecordByUserId(EOS_HLeaderboards Handle, const EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions* Options, EOS_Leaderboards_LeaderboardRecord ** OutLeaderboardRecord);
|
| 127 |
+
|
| 128 |
+
/**
|
| 129 |
+
* Query for a list of scores for a given list of users.
|
| 130 |
+
*
|
| 131 |
+
* @param Options Structure containing information about the users whose scores we're retrieving.
|
| 132 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 133 |
+
* @param CompletionDelegate This function is called when the query operation completes.
|
| 134 |
+
*
|
| 135 |
+
* @see EOS_Leaderboards_QueryLeaderboardUserScoresOptions
|
| 136 |
+
* @see EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback
|
| 137 |
+
*/
|
| 138 |
+
EOS_DECLARE_FUNC(void) EOS_Leaderboards_QueryLeaderboardUserScores(EOS_HLeaderboards Handle, const EOS_Leaderboards_QueryLeaderboardUserScoresOptions* Options, void* ClientData, const EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback CompletionDelegate);
|
| 139 |
+
|
| 140 |
+
/**
|
| 141 |
+
* Fetch the number of leaderboard user scores that are cached locally.
|
| 142 |
+
*
|
| 143 |
+
* @param Options The Options associated with retrieving the leaderboard user scores count.
|
| 144 |
+
*
|
| 145 |
+
* @see EOS_Leaderboards_GetLeaderboardUserScoreCountOptions
|
| 146 |
+
* @see EOS_Leaderboards_CopyLeaderboardUserScoreByIndex
|
| 147 |
+
* @see EOS_Leaderboards_CopyLeaderboardUserScoreByUserId
|
| 148 |
+
*
|
| 149 |
+
* @return Number of leaderboard records or 0 if there is an error
|
| 150 |
+
*/
|
| 151 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Leaderboards_GetLeaderboardUserScoreCount(EOS_HLeaderboards Handle, const EOS_Leaderboards_GetLeaderboardUserScoreCountOptions* Options);
|
| 152 |
+
|
| 153 |
+
/**
|
| 154 |
+
* Fetches leaderboard user score from a given index.
|
| 155 |
+
*
|
| 156 |
+
* @param Options Structure containing the index being accessed.
|
| 157 |
+
* @param OutLeaderboardUserScore The leaderboard user score for the given index, if it exists and is valid, use EOS_Leaderboards_LeaderboardUserScore_Release when finished.
|
| 158 |
+
*
|
| 159 |
+
* @see EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions
|
| 160 |
+
* @see EOS_Leaderboards_LeaderboardUserScore
|
| 161 |
+
* @see EOS_Leaderboards_LeaderboardUserScore_Release
|
| 162 |
+
*
|
| 163 |
+
* @return EOS_EResult containing the result of the operation.
|
| 164 |
+
* Possible result codes:
|
| 165 |
+
* - EOS_Success if the leaderboard scores are available and passed out in OutLeaderboardUserScore
|
| 166 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 167 |
+
* - EOS_NotFound if the leaderboard user scores are not found
|
| 168 |
+
*/
|
| 169 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Leaderboards_CopyLeaderboardUserScoreByIndex(EOS_HLeaderboards Handle, const EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions* Options, EOS_Leaderboards_LeaderboardUserScore ** OutLeaderboardUserScore);
|
| 170 |
+
|
| 171 |
+
/**
|
| 172 |
+
* Fetches leaderboard user score from a given user ID.
|
| 173 |
+
*
|
| 174 |
+
* @param Options Structure containing the user ID being accessed.
|
| 175 |
+
* @param OutLeaderboardUserScore The leaderboard user score for the given user ID, if it exists and is valid, use EOS_Leaderboards_LeaderboardUserScore_Release when finished.
|
| 176 |
+
*
|
| 177 |
+
* @see EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions
|
| 178 |
+
* @see EOS_Leaderboards_LeaderboardUserScore
|
| 179 |
+
* @see EOS_Leaderboards_LeaderboardUserScore_Release
|
| 180 |
+
*
|
| 181 |
+
* @return EOS_EResult containing the result of the operation.
|
| 182 |
+
* Possible result codes:
|
| 183 |
+
* - EOS_Success if the leaderboard scores are available and passed out in OutLeaderboardUserScore
|
| 184 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 185 |
+
* - EOS_NotFound if the leaderboard user scores are not found
|
| 186 |
+
*/
|
| 187 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Leaderboards_CopyLeaderboardUserScoreByUserId(EOS_HLeaderboards Handle, const EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions* Options, EOS_Leaderboards_LeaderboardUserScore ** OutLeaderboardUserScore);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_leaderboards_types.h
ADDED
|
@@ -0,0 +1,378 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
EOS_EXTERN_C typedef struct EOS_LeaderboardsHandle* EOS_HLeaderboards;
|
| 10 |
+
|
| 11 |
+
/** Timestamp value representing an undefined time for EOS_HLeaderboards. */
|
| 12 |
+
#define EOS_LEADERBOARDS_TIME_UNDEFINED -1
|
| 13 |
+
|
| 14 |
+
/** The most recent version of the EOS_Leaderboards_QueryLeaderboardDefinitions struct. */
|
| 15 |
+
#define EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST 2
|
| 16 |
+
|
| 17 |
+
/**
|
| 18 |
+
* Input parameters for the EOS_Leaderboards_QueryLeaderboardDefinitions function.
|
| 19 |
+
* StartTime and EndTime are optional parameters, they can be used to limit the list of definitions
|
| 20 |
+
* to overlap the time window specified.
|
| 21 |
+
*/
|
| 22 |
+
EOS_STRUCT(EOS_Leaderboards_QueryLeaderboardDefinitionsOptions, (
|
| 23 |
+
/** API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDDEFINITIONS_API_LATEST. */
|
| 24 |
+
int32_t ApiVersion;
|
| 25 |
+
/** An optional POSIX timestamp for the leaderboard's start time, or EOS_LEADERBOARDS_TIME_UNDEFINED */
|
| 26 |
+
int64_t StartTime;
|
| 27 |
+
/** An optional POSIX timestamp for the leaderboard's end time, or EOS_LEADERBOARDS_TIME_UNDEFINED */
|
| 28 |
+
int64_t EndTime;
|
| 29 |
+
/**
|
| 30 |
+
* Product User ID for user who is querying definitions.
|
| 31 |
+
* Must be set when using a client policy that requires a valid logged in user.
|
| 32 |
+
* Not used for Dedicated Server where no user is available.
|
| 33 |
+
*/
|
| 34 |
+
EOS_ProductUserId LocalUserId;
|
| 35 |
+
));
|
| 36 |
+
|
| 37 |
+
/**
|
| 38 |
+
* An enumeration of the different leaderboard aggregation types.
|
| 39 |
+
*/
|
| 40 |
+
EOS_ENUM(EOS_ELeaderboardAggregation,
|
| 41 |
+
/** Minimum */
|
| 42 |
+
EOS_LA_Min = 0,
|
| 43 |
+
/** Maximum */
|
| 44 |
+
EOS_LA_Max = 1,
|
| 45 |
+
/** Sum */
|
| 46 |
+
EOS_LA_Sum = 2,
|
| 47 |
+
/** Latest */
|
| 48 |
+
EOS_LA_Latest = 3
|
| 49 |
+
);
|
| 50 |
+
|
| 51 |
+
/** The most recent version of the EOS_Leaderboards_Definition struct. */
|
| 52 |
+
#define EOS_LEADERBOARDS_DEFINITION_API_LATEST 1
|
| 53 |
+
|
| 54 |
+
/**
|
| 55 |
+
* Contains information about a single leaderboard definition
|
| 56 |
+
*/
|
| 57 |
+
EOS_STRUCT(EOS_Leaderboards_Definition, (
|
| 58 |
+
/** API Version: Set this to EOS_LEADERBOARDS_DEFINITION_API_LATEST. */
|
| 59 |
+
int32_t ApiVersion;
|
| 60 |
+
/** Unique ID to identify leaderboard. */
|
| 61 |
+
const char* LeaderboardId;
|
| 62 |
+
/** Name of stat used to rank leaderboard. */
|
| 63 |
+
const char* StatName;
|
| 64 |
+
/** Aggregation used to sort leaderboard. */
|
| 65 |
+
EOS_ELeaderboardAggregation Aggregation;
|
| 66 |
+
/** The POSIX timestamp for the start time, or EOS_LEADERBOARDS_TIME_UNDEFINED. */
|
| 67 |
+
int64_t StartTime;
|
| 68 |
+
/** The POSIX timestamp for the end time, or EOS_LEADERBOARDS_TIME_UNDEFINED. */
|
| 69 |
+
int64_t EndTime;
|
| 70 |
+
));
|
| 71 |
+
|
| 72 |
+
/** The most recent version of the EOS_Leaderboards_GetLeaderboardDefinitionCount API. */
|
| 73 |
+
#define EOS_LEADERBOARDS_GETLEADERBOARDDEFINITIONCOUNT_API_LATEST 1
|
| 74 |
+
|
| 75 |
+
/**
|
| 76 |
+
* Input parameters for the EOS_Leaderboards_GetLeaderboardDefinitionCount function.
|
| 77 |
+
*/
|
| 78 |
+
EOS_STRUCT(EOS_Leaderboards_GetLeaderboardDefinitionCountOptions, (
|
| 79 |
+
/** API Version: Set this to EOS_LEADERBOARDS_GETLEADERBOARDDEFINITIONCOUNT_API_LATEST. */
|
| 80 |
+
int32_t ApiVersion;
|
| 81 |
+
));
|
| 82 |
+
|
| 83 |
+
/** The most recent version of the EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions struct. */
|
| 84 |
+
#define EOS_LEADERBOARDS_COPYLEADERBOARDDEFINITIONBYINDEX_API_LATEST 1
|
| 85 |
+
|
| 86 |
+
/**
|
| 87 |
+
* Input parameters for the EOS_Leaderboards_CopyLeaderboardDefinitionByIndex function.
|
| 88 |
+
*/
|
| 89 |
+
EOS_STRUCT(EOS_Leaderboards_CopyLeaderboardDefinitionByIndexOptions, (
|
| 90 |
+
/** API Version: Set this to EOS_LEADERBOARDS_COPYLEADERBOARDDEFINITIONBYINDEX_API_LATEST. */
|
| 91 |
+
int32_t ApiVersion;
|
| 92 |
+
/** Index of the leaderboard definition to retrieve from the cache */
|
| 93 |
+
uint32_t LeaderboardIndex;
|
| 94 |
+
));
|
| 95 |
+
|
| 96 |
+
/** The most recent version of the EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions struct. */
|
| 97 |
+
#define EOS_LEADERBOARDS_COPYLEADERBOARDDEFINITIONBYLEADERBOARDID_API_LATEST 1
|
| 98 |
+
|
| 99 |
+
/**
|
| 100 |
+
* Input parameters for the EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId function.
|
| 101 |
+
*/
|
| 102 |
+
EOS_STRUCT(EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardIdOptions, (
|
| 103 |
+
/** API Version: Set this to EOS_LEADERBOARDS_COPYLEADERBOARDDEFINITIONBYLEADERBOARDID_API_LATEST. */
|
| 104 |
+
int32_t ApiVersion;
|
| 105 |
+
/** The ID of the leaderboard whose definition you want to copy from the cache */
|
| 106 |
+
const char* LeaderboardId;
|
| 107 |
+
));
|
| 108 |
+
|
| 109 |
+
/**
|
| 110 |
+
* Release the memory associated with a leaderboard definition. This must be called on data retrieved from
|
| 111 |
+
* EOS_Leaderboards_CopyLeaderboardDefinitionByIndex or EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId.
|
| 112 |
+
*
|
| 113 |
+
* @param LeaderboardDefinition - The Leaderboard definition to release.
|
| 114 |
+
*
|
| 115 |
+
* @see EOS_Leaderboards_Definition
|
| 116 |
+
* @see EOS_Leaderboards_CopyLeaderboardDefinitionByIndex
|
| 117 |
+
* @see EOS_Leaderboards_CopyLeaderboardDefinitionByLeaderboardId
|
| 118 |
+
*/
|
| 119 |
+
EOS_DECLARE_FUNC(void) EOS_Leaderboards_Definition_Release(EOS_Leaderboards_Definition* LeaderboardDefinition);
|
| 120 |
+
|
| 121 |
+
/**
|
| 122 |
+
* Data containing the result information for a query leaderboard definitions request.
|
| 123 |
+
*/
|
| 124 |
+
EOS_STRUCT(EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo, (
|
| 125 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 126 |
+
EOS_EResult ResultCode;
|
| 127 |
+
/** Context that was passed into EOS_Leaderboards_QueryLeaderboardDefinitions. */
|
| 128 |
+
void* ClientData;
|
| 129 |
+
));
|
| 130 |
+
|
| 131 |
+
/**
|
| 132 |
+
* Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardDefinitions
|
| 133 |
+
* @param Data A EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo containing the output information and result
|
| 134 |
+
*/
|
| 135 |
+
EOS_DECLARE_CALLBACK(EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallback, const EOS_Leaderboards_OnQueryLeaderboardDefinitionsCompleteCallbackInfo* Data);
|
| 136 |
+
|
| 137 |
+
|
| 138 |
+
/** The most recent version of the EOS_Leaderboards_UserScoresQueryStatInfo struct. */
|
| 139 |
+
#define EOS_LEADERBOARDS_USERSCORESQUERYSTATINFO_API_LATEST 1
|
| 140 |
+
|
| 141 |
+
/**
|
| 142 |
+
* Contains information about a single stat to query with user scores.
|
| 143 |
+
*/
|
| 144 |
+
EOS_STRUCT(EOS_Leaderboards_UserScoresQueryStatInfo, (
|
| 145 |
+
/** API Version: Set this to EOS_LEADERBOARDS_USERSCORESQUERYSTATINFO_API_LATEST. */
|
| 146 |
+
int32_t ApiVersion;
|
| 147 |
+
/** The name of the stat to query. */
|
| 148 |
+
const char* StatName;
|
| 149 |
+
/** Aggregation used to sort the cached user scores. */
|
| 150 |
+
EOS_ELeaderboardAggregation Aggregation;
|
| 151 |
+
));
|
| 152 |
+
|
| 153 |
+
/** The most recent version of the EOS_Leaderboards_QueryLeaderboardUserScores struct. */
|
| 154 |
+
#define EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST 2
|
| 155 |
+
|
| 156 |
+
/**
|
| 157 |
+
* Input parameters for the EOS_Leaderboards_QueryLeaderboardUserScores function.
|
| 158 |
+
*/
|
| 159 |
+
EOS_STRUCT(EOS_Leaderboards_QueryLeaderboardUserScoresOptions, (
|
| 160 |
+
/** API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST. */
|
| 161 |
+
int32_t ApiVersion;
|
| 162 |
+
/** An array of Product User IDs indicating the users whose scores you want to retrieve */
|
| 163 |
+
const EOS_ProductUserId* UserIds;
|
| 164 |
+
/** The number of users included in query */
|
| 165 |
+
uint32_t UserIdsCount;
|
| 166 |
+
/** The stats to be collected, along with the sorting method to use when determining rank order for each stat */
|
| 167 |
+
const EOS_Leaderboards_UserScoresQueryStatInfo* StatInfo;
|
| 168 |
+
/** The number of stats to query */
|
| 169 |
+
uint32_t StatInfoCount;
|
| 170 |
+
/** An optional POSIX timestamp, or EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made after this time */
|
| 171 |
+
int64_t StartTime;
|
| 172 |
+
/** An optional POSIX timestamp, or EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made before this time */
|
| 173 |
+
int64_t EndTime;
|
| 174 |
+
/**
|
| 175 |
+
* Product User ID for user who is querying user scores.
|
| 176 |
+
* Must be set when using a client policy that requires a valid logged in user.
|
| 177 |
+
* Not used for Dedicated Server where no user is available.
|
| 178 |
+
*/
|
| 179 |
+
EOS_ProductUserId LocalUserId;
|
| 180 |
+
));
|
| 181 |
+
|
| 182 |
+
/** The most recent version of the EOS_Leaderboards_LeaderboardUserScore struct. */
|
| 183 |
+
#define EOS_LEADERBOARDS_LEADERBOARDUSERSCORE_API_LATEST 1
|
| 184 |
+
|
| 185 |
+
/**
|
| 186 |
+
* Contains information about a single leaderboard user score
|
| 187 |
+
*/
|
| 188 |
+
EOS_STRUCT(EOS_Leaderboards_LeaderboardUserScore, (
|
| 189 |
+
/** API Version: Set this to EOS_LEADERBOARDS_LEADERBOARDUSERSCORE_API_LATEST. */
|
| 190 |
+
int32_t ApiVersion;
|
| 191 |
+
/** The Product User ID of the user who got this score */
|
| 192 |
+
EOS_ProductUserId UserId;
|
| 193 |
+
/** Leaderboard score */
|
| 194 |
+
int32_t Score;
|
| 195 |
+
));
|
| 196 |
+
|
| 197 |
+
/** The most recent version of the EOS_Leaderboards_GetLeaderboardUserScoreCount API. */
|
| 198 |
+
#define EOS_LEADERBOARDS_GETLEADERBOARDUSERSCORECOUNT_API_LATEST 1
|
| 199 |
+
|
| 200 |
+
/**
|
| 201 |
+
* Input parameters for the EOS_Leaderboards_GetLeaderboardUserScoreCount function.
|
| 202 |
+
*/
|
| 203 |
+
EOS_STRUCT(EOS_Leaderboards_GetLeaderboardUserScoreCountOptions, (
|
| 204 |
+
/** API Version: Set this to EOS_LEADERBOARDS_GETLEADERBOARDUSERSCORECOUNT_API_LATEST. */
|
| 205 |
+
int32_t ApiVersion;
|
| 206 |
+
/** Name of stat used to rank leaderboard. */
|
| 207 |
+
const char* StatName;
|
| 208 |
+
));
|
| 209 |
+
|
| 210 |
+
/** The most recent version of the EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions struct. */
|
| 211 |
+
#define EOS_LEADERBOARDS_COPYLEADERBOARDUSERSCOREBYINDEX_API_LATEST 1
|
| 212 |
+
|
| 213 |
+
/**
|
| 214 |
+
* Input parameters for the EOS_Leaderboards_CopyLeaderboardUserScoreByIndex function.
|
| 215 |
+
*/
|
| 216 |
+
EOS_STRUCT(EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions, (
|
| 217 |
+
/** API Version: Set this to EOS_LEADERBOARDS_COPYLEADERBOARDUSERSCOREBYINDEX_API_LATEST. */
|
| 218 |
+
int32_t ApiVersion;
|
| 219 |
+
/** Index of the sorted leaderboard user score to retrieve from the cache. */
|
| 220 |
+
uint32_t LeaderboardUserScoreIndex;
|
| 221 |
+
/** Name of the stat used to rank the leaderboard. */
|
| 222 |
+
const char* StatName;
|
| 223 |
+
));
|
| 224 |
+
|
| 225 |
+
/** The most recent version of the EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions struct. */
|
| 226 |
+
#define EOS_LEADERBOARDS_COPYLEADERBOARDUSERSCOREBYUSERID_API_LATEST 1
|
| 227 |
+
|
| 228 |
+
/**
|
| 229 |
+
* Input parameters for the EOS_Leaderboards_CopyLeaderboardUserScoreByUserId function.
|
| 230 |
+
*/
|
| 231 |
+
EOS_STRUCT(EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions, (
|
| 232 |
+
/** API Version: Set this to EOS_LEADERBOARDS_COPYLEADERBOARDUSERSCOREBYUSERID_API_LATEST. */
|
| 233 |
+
int32_t ApiVersion;
|
| 234 |
+
/** The Product User ID to look for when copying leaderboard score data from the cache */
|
| 235 |
+
EOS_ProductUserId UserId;
|
| 236 |
+
/** The name of the stat that is used to rank this leaderboard */
|
| 237 |
+
const char* StatName;
|
| 238 |
+
));
|
| 239 |
+
|
| 240 |
+
/**
|
| 241 |
+
* Release the memory associated with leaderboard user score. This must be called on data retrieved from
|
| 242 |
+
* EOS_Leaderboards_CopyLeaderboardUserScoreByIndex or EOS_Leaderboards_CopyLeaderboardUserScoreByUserId.
|
| 243 |
+
*
|
| 244 |
+
* @param LeaderboardUserScore - The Leaderboard user score to release.
|
| 245 |
+
*
|
| 246 |
+
* @see EOS_Leaderboards_LeaderboardUserScore
|
| 247 |
+
* @see EOS_Leaderboards_CopyLeaderboardUserScoreByIndex
|
| 248 |
+
* @see EOS_Leaderboards_CopyLeaderboardUserScoreByUserId
|
| 249 |
+
*/
|
| 250 |
+
EOS_DECLARE_FUNC(void) EOS_Leaderboards_LeaderboardUserScore_Release(EOS_Leaderboards_LeaderboardUserScore* LeaderboardUserScore);
|
| 251 |
+
|
| 252 |
+
/**
|
| 253 |
+
* Data containing the result information for a query leaderboard user scores request.
|
| 254 |
+
*/
|
| 255 |
+
EOS_STRUCT(EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo, (
|
| 256 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 257 |
+
EOS_EResult ResultCode;
|
| 258 |
+
/** Context that was passed into EOS_Leaderboards_QueryLeaderboardUserScores. */
|
| 259 |
+
void* ClientData;
|
| 260 |
+
));
|
| 261 |
+
|
| 262 |
+
/**
|
| 263 |
+
* Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardUserScores
|
| 264 |
+
* @param Data A EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo containing the output information and result
|
| 265 |
+
*/
|
| 266 |
+
EOS_DECLARE_CALLBACK(EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallback, const EOS_Leaderboards_OnQueryLeaderboardUserScoresCompleteCallbackInfo* Data);
|
| 267 |
+
|
| 268 |
+
|
| 269 |
+
/** The most recent version of the EOS_Leaderboards_QueryLeaderboardRanks struct. */
|
| 270 |
+
#define EOS_LEADERBOARDS_QUERYLEADERBOARDRANKS_API_LATEST 2
|
| 271 |
+
|
| 272 |
+
/**
|
| 273 |
+
* Input parameters for the EOS_Leaderboards_QueryLeaderboardRanks function.
|
| 274 |
+
*
|
| 275 |
+
* @see EOS_Leaderboards_Definition
|
| 276 |
+
*/
|
| 277 |
+
EOS_STRUCT(EOS_Leaderboards_QueryLeaderboardRanksOptions, (
|
| 278 |
+
/** API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDRANKS_API_LATEST. */
|
| 279 |
+
int32_t ApiVersion;
|
| 280 |
+
/** The ID of the leaderboard whose information you want to retrieve. */
|
| 281 |
+
const char* LeaderboardId;
|
| 282 |
+
/**
|
| 283 |
+
* Product User ID for user who is querying ranks.
|
| 284 |
+
* Must be set when using a client policy that requires a valid logged in user.
|
| 285 |
+
* Not used for Dedicated Server where no user is available.
|
| 286 |
+
*/
|
| 287 |
+
EOS_ProductUserId LocalUserId;
|
| 288 |
+
));
|
| 289 |
+
|
| 290 |
+
/** The most recent version of the EOS_Leaderboards_LeaderboardRecord struct. */
|
| 291 |
+
#define EOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATEST 2
|
| 292 |
+
|
| 293 |
+
/**
|
| 294 |
+
* Contains information about a single leaderboard record
|
| 295 |
+
*/
|
| 296 |
+
EOS_STRUCT(EOS_Leaderboards_LeaderboardRecord, (
|
| 297 |
+
/** API Version: Set this to EOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATEST. */
|
| 298 |
+
int32_t ApiVersion;
|
| 299 |
+
/** The Product User ID associated with this record */
|
| 300 |
+
EOS_ProductUserId UserId;
|
| 301 |
+
/** Sorted position on leaderboard */
|
| 302 |
+
uint32_t Rank;
|
| 303 |
+
/** Leaderboard score */
|
| 304 |
+
int32_t Score;
|
| 305 |
+
/** The latest display name seen for the user since they last time logged in. This is empty if the user does not have a display name set. */
|
| 306 |
+
const char* UserDisplayName;
|
| 307 |
+
));
|
| 308 |
+
|
| 309 |
+
/** The most recent version of the EOS_Leaderboards_GetLeaderboardRecordCount API. */
|
| 310 |
+
#define EOS_LEADERBOARDS_GETLEADERBOARDRECORDCOUNT_API_LATEST 1
|
| 311 |
+
|
| 312 |
+
/**
|
| 313 |
+
* Input parameters for the EOS_Leaderboards_GetLeaderboardRecordCount function.
|
| 314 |
+
*/
|
| 315 |
+
EOS_STRUCT(EOS_Leaderboards_GetLeaderboardRecordCountOptions, (
|
| 316 |
+
/** API Version: Set this to EOS_LEADERBOARDS_GETLEADERBOARDRECORDCOUNT_API_LATEST. */
|
| 317 |
+
int32_t ApiVersion;
|
| 318 |
+
));
|
| 319 |
+
|
| 320 |
+
/** The most recent version of the EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions struct. */
|
| 321 |
+
#define EOS_LEADERBOARDS_COPYLEADERBOARDRECORDBYINDEX_API_LATEST 2
|
| 322 |
+
|
| 323 |
+
/**
|
| 324 |
+
* Input parameters for the EOS_Leaderboards_CopyLeaderboardRecordByIndex function.
|
| 325 |
+
*/
|
| 326 |
+
EOS_STRUCT(EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions, (
|
| 327 |
+
/** API Version: Set this to EOS_LEADERBOARDS_COPYLEADERBOARDRECORDBYINDEX_API_LATEST. */
|
| 328 |
+
int32_t ApiVersion;
|
| 329 |
+
/** Index of the leaderboard record to retrieve from the cache */
|
| 330 |
+
uint32_t LeaderboardRecordIndex;
|
| 331 |
+
));
|
| 332 |
+
|
| 333 |
+
/** The most recent version of the EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions struct. */
|
| 334 |
+
#define EOS_LEADERBOARDS_COPYLEADERBOARDRECORDBYUSERID_API_LATEST 2
|
| 335 |
+
|
| 336 |
+
/**
|
| 337 |
+
* Input parameters for the EOS_Leaderboards_CopyLeaderboardRecordByUserId function.
|
| 338 |
+
*/
|
| 339 |
+
EOS_STRUCT(EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions, (
|
| 340 |
+
/** API Version: Set this to EOS_LEADERBOARDS_COPYLEADERBOARDRECORDBYUSERID_API_LATEST. */
|
| 341 |
+
int32_t ApiVersion;
|
| 342 |
+
/** Leaderboard data will be copied from the cache if it relates to the user matching this Product User ID */
|
| 343 |
+
EOS_ProductUserId UserId;
|
| 344 |
+
));
|
| 345 |
+
|
| 346 |
+
/**
|
| 347 |
+
* Release the memory associated with leaderboard record. This must be called on data retrieved from
|
| 348 |
+
* EOS_Leaderboards_CopyLeaderboardRecordByIndex or EOS_Leaderboards_CopyLeaderboardRecordByUserId.
|
| 349 |
+
*
|
| 350 |
+
* @param LeaderboardRecord - The Leaderboard record to release.
|
| 351 |
+
*
|
| 352 |
+
* @see EOS_Leaderboards_LeaderboardRecord
|
| 353 |
+
* @see EOS_Leaderboards_CopyLeaderboardRecordByIndex
|
| 354 |
+
* @see EOS_Leaderboards_CopyLeaderboardRecordByUserId
|
| 355 |
+
*/
|
| 356 |
+
EOS_DECLARE_FUNC(void) EOS_Leaderboards_LeaderboardRecord_Release(EOS_Leaderboards_LeaderboardRecord* LeaderboardRecord);
|
| 357 |
+
|
| 358 |
+
/**
|
| 359 |
+
* Data containing the result information for a query leaderboard ranks request.
|
| 360 |
+
*/
|
| 361 |
+
EOS_STRUCT(EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallbackInfo, (
|
| 362 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 363 |
+
EOS_EResult ResultCode;
|
| 364 |
+
/** Context that was passed into EOS_Leaderboards_QueryLeaderboardRanks. */
|
| 365 |
+
void* ClientData;
|
| 366 |
+
/** The Leaderboard ID for the leaderboard that was queried. */
|
| 367 |
+
const char* LeaderboardId;
|
| 368 |
+
));
|
| 369 |
+
|
| 370 |
+
/**
|
| 371 |
+
* Function prototype definition for callbacks passed to EOS_Leaderboards_QueryLeaderboardRanks
|
| 372 |
+
* @param Data A EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallbackInfo containing the output information and result
|
| 373 |
+
*/
|
| 374 |
+
EOS_DECLARE_CALLBACK(EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallback, const EOS_Leaderboards_OnQueryLeaderboardRanksCompleteCallbackInfo* Data);
|
| 375 |
+
|
| 376 |
+
#pragma pack(pop)
|
| 377 |
+
|
| 378 |
+
#include "eos_leaderboards_types_deprecated.inl"
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_leaderboards_types_deprecated.inl
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
/**
|
| 8 |
+
* This file contains the deprecated types for EOS Leaderboards. In a future version, these types will be removed.
|
| 9 |
+
*/
|
| 10 |
+
|
| 11 |
+
#pragma pack(push, 8)
|
| 12 |
+
|
| 13 |
+
/** Do not use. Alias to the previous API name for backwards compatibility in compilation. */
|
| 14 |
+
EOS_DECLARE_FUNC(void) EOS_Leaderboards_LeaderboardDefinition_Release(EOS_Leaderboards_Definition* LeaderboardDefinition);
|
| 15 |
+
|
| 16 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_lobby.h
ADDED
|
@@ -0,0 +1,1120 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_lobby_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Lobby Interface is used to manage lobbies that provide a persistent connection between users and
|
| 8 |
+
* notifications of data sharing/updates. Lobbies may also be found by advertising and searching with the backend service.
|
| 9 |
+
* All Lobby Interface calls take a handle of type EOS_HLobby as the first parameter.
|
| 10 |
+
* This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetLobbyInterface function.
|
| 11 |
+
*
|
| 12 |
+
* @see EOS_Platform_GetLobbyInterface
|
| 13 |
+
*/
|
| 14 |
+
|
| 15 |
+
/**
|
| 16 |
+
* 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
|
| 17 |
+
*
|
| 18 |
+
* 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
|
| 19 |
+
* 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
|
| 20 |
+
* many of the functions in the RTC interface. This can be useful to: register for notifications for talking status; to mute or unmute the local user's audio output;
|
| 21 |
+
* to block or unblock room participants; to set local audio device settings; and more.
|
| 22 |
+
*
|
| 23 |
+
* @param Options Required fields for the creation of a lobby such as a user count and its starting advertised state
|
| 24 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 25 |
+
* @param CompletionDelegate A callback that is fired when the create operation completes, either successfully or in error
|
| 26 |
+
*
|
| 27 |
+
* @see EOS_Lobby_CreateLobbyOptions
|
| 28 |
+
* @see EOS_Lobby_OnCreateLobbyCallback
|
| 29 |
+
*/
|
| 30 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_CreateLobby(EOS_HLobby Handle, const EOS_Lobby_CreateLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnCreateLobbyCallback CompletionDelegate);
|
| 31 |
+
|
| 32 |
+
/**
|
| 33 |
+
* Destroy a lobby given a lobby ID
|
| 34 |
+
*
|
| 35 |
+
* @param Options Structure containing information about the lobby to be destroyed
|
| 36 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 37 |
+
* @param CompletionDelegate A callback that is fired when the destroy operation completes, either successfully or in error
|
| 38 |
+
*
|
| 39 |
+
* @see EOS_Lobby_DestroyLobbyOptions
|
| 40 |
+
* @see EOS_Lobby_OnDestroyLobbyCallback
|
| 41 |
+
*/
|
| 42 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_DestroyLobby(EOS_HLobby Handle, const EOS_Lobby_DestroyLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnDestroyLobbyCallback CompletionDelegate);
|
| 43 |
+
|
| 44 |
+
/**
|
| 45 |
+
* 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.
|
| 46 |
+
*
|
| 47 |
+
* 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
|
| 48 |
+
* 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
|
| 49 |
+
* many of the functions in the RTC interface. This can be useful to: register for notifications for talking status; to mute or unmute the local user's audio output;
|
| 50 |
+
* to block or unblock room participants; to set local audio device settings; and more.
|
| 51 |
+
*
|
| 52 |
+
* @param Options Structure containing information about the lobby to be joined
|
| 53 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 54 |
+
* @param CompletionDelegate A callback that is fired when the join operation completes, either successfully or in error
|
| 55 |
+
*
|
| 56 |
+
* @see EOS_Lobby_JoinLobbyOptions
|
| 57 |
+
* @see EOS_Lobby_OnJoinLobbyCallback
|
| 58 |
+
*/
|
| 59 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_JoinLobby(EOS_HLobby Handle, const EOS_Lobby_JoinLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnJoinLobbyCallback CompletionDelegate);
|
| 60 |
+
|
| 61 |
+
/**
|
| 62 |
+
* This is a special case of EOS_Lobby_JoinLobby. It should only be used if the lobby has had Join-by-ID enabled.
|
| 63 |
+
* Additionally, Join-by-ID should only be enabled to support native invites on an integrated platform.
|
| 64 |
+
*
|
| 65 |
+
* @param Options Structure containing information about the lobby to be joined
|
| 66 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 67 |
+
* @param CompletionDelegate A callback that is fired when the join operation completes, either successfully or in error
|
| 68 |
+
*
|
| 69 |
+
* @see EOS_Lobby_JoinLobbyByIdOptions
|
| 70 |
+
* @see EOS_Lobby_OnJoinLobbyByIdCallback
|
| 71 |
+
* @see EOS_Lobby_JoinLobby
|
| 72 |
+
*/
|
| 73 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_JoinLobbyById(EOS_HLobby Handle, const EOS_Lobby_JoinLobbyByIdOptions* Options, void* ClientData, const EOS_Lobby_OnJoinLobbyByIdCallback CompletionDelegate);
|
| 74 |
+
|
| 75 |
+
/**
|
| 76 |
+
* Leave a lobby given a lobby ID
|
| 77 |
+
*
|
| 78 |
+
* If the lobby you are leaving had an RTC Room enabled, leaving the lobby will also automatically leave the RTC room.
|
| 79 |
+
*
|
| 80 |
+
* @param Options Structure containing information about the lobby to be left
|
| 81 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 82 |
+
* @param CompletionDelegate A callback that is fired when the leave operation completes, either successfully or in error
|
| 83 |
+
*
|
| 84 |
+
* @see EOS_Lobby_LeaveLobbyOptions
|
| 85 |
+
* @see EOS_Lobby_OnLeaveLobbyCallback
|
| 86 |
+
*/
|
| 87 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_LeaveLobby(EOS_HLobby Handle, const EOS_Lobby_LeaveLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnLeaveLobbyCallback CompletionDelegate);
|
| 88 |
+
|
| 89 |
+
/**
|
| 90 |
+
* 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.
|
| 91 |
+
* The EOS_HLobbyModification must be released by calling EOS_LobbyModification_Release once it is no longer needed.
|
| 92 |
+
*
|
| 93 |
+
* @param Options Required fields such as lobby ID
|
| 94 |
+
* @param OutLobbyModificationHandle Pointer to a Lobby Modification Handle only set if successful
|
| 95 |
+
* @return EOS_EResult containing the result of the operation.
|
| 96 |
+
* Possible result codes:
|
| 97 |
+
* - EOS_Success if we successfully created the Lobby Modification Handle pointed at in OutLobbyModificationHandle, or an error result if the input data was invalid
|
| 98 |
+
* - EOS_InvalidParameters if any of the options are incorrect
|
| 99 |
+
*
|
| 100 |
+
* @see EOS_LobbyModification_Release
|
| 101 |
+
* @see EOS_Lobby_UpdateLobby
|
| 102 |
+
* @see EOS_Lobby_UpdateLobbyModificationOptions
|
| 103 |
+
* @see EOS_HLobbyModification
|
| 104 |
+
*/
|
| 105 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_UpdateLobbyModification(EOS_HLobby Handle, const EOS_Lobby_UpdateLobbyModificationOptions* Options, EOS_HLobbyModification* OutLobbyModificationHandle);
|
| 106 |
+
|
| 107 |
+
/**
|
| 108 |
+
* Update a lobby given a lobby modification handle created by EOS_Lobby_UpdateLobbyModification
|
| 109 |
+
*
|
| 110 |
+
* @param Options Structure containing information about the lobby to be updated
|
| 111 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 112 |
+
* @param CompletionDelegate A callback that is fired when the update operation completes, either successfully or in error
|
| 113 |
+
*
|
| 114 |
+
* @see EOS_Lobby_UpdateLobbyOptions
|
| 115 |
+
* @see EOS_Lobby_OnUpdateLobbyCallback
|
| 116 |
+
*/
|
| 117 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_UpdateLobby(EOS_HLobby Handle, const EOS_Lobby_UpdateLobbyOptions* Options, void* ClientData, const EOS_Lobby_OnUpdateLobbyCallback CompletionDelegate);
|
| 118 |
+
|
| 119 |
+
/**
|
| 120 |
+
* Promote an existing member of the lobby to owner, allowing them to make lobby data modifications
|
| 121 |
+
*
|
| 122 |
+
* @param Options Structure containing information about the lobby and member to be promoted
|
| 123 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 124 |
+
* @param CompletionDelegate A callback that is fired when the promotion operation completes, either successfully or in error
|
| 125 |
+
*
|
| 126 |
+
* @see EOS_Lobby_PromoteMemberOptions
|
| 127 |
+
* @see EOS_Lobby_OnPromoteMemberCallback
|
| 128 |
+
*/
|
| 129 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_PromoteMember(EOS_HLobby Handle, const EOS_Lobby_PromoteMemberOptions* Options, void* ClientData, const EOS_Lobby_OnPromoteMemberCallback CompletionDelegate);
|
| 130 |
+
|
| 131 |
+
/**
|
| 132 |
+
* Kick an existing member from the lobby
|
| 133 |
+
*
|
| 134 |
+
* @param Options Structure containing information about the lobby and member to be kicked
|
| 135 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 136 |
+
* @param CompletionDelegate A callback that is fired when the kick operation completes, either successfully or in error
|
| 137 |
+
*
|
| 138 |
+
* @see EOS_Lobby_KickMemberOptions
|
| 139 |
+
* @see EOS_Lobby_OnKickMemberCallback
|
| 140 |
+
*/
|
| 141 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_KickMember(EOS_HLobby Handle, const EOS_Lobby_KickMemberOptions* Options, void* ClientData, const EOS_Lobby_OnKickMemberCallback CompletionDelegate);
|
| 142 |
+
|
| 143 |
+
/**
|
| 144 |
+
* Hard mute an existing member in the lobby, can't speak but can hear other members of the lobby
|
| 145 |
+
*
|
| 146 |
+
* @param Options Structure containing information about the lobby and member to be hard muted
|
| 147 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 148 |
+
* @param CompletionDelegate A callback that is fired when the hard mute operation completes, either successfully or in error
|
| 149 |
+
*
|
| 150 |
+
* @see EOS_Lobby_HardMuteMemberOptions
|
| 151 |
+
* @see EOS_Lobby_OnHardMuteMemberCallback
|
| 152 |
+
*/
|
| 153 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_HardMuteMember(EOS_HLobby Handle, const EOS_Lobby_HardMuteMemberOptions* Options, void* ClientData, const EOS_Lobby_OnHardMuteMemberCallback CompletionDelegate);
|
| 154 |
+
|
| 155 |
+
/**
|
| 156 |
+
* Register to receive notifications when a lobby owner updates the attributes associated with the lobby.
|
| 157 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyUpdateReceived when you no longer wish to have your NotificationHandler called.
|
| 158 |
+
*
|
| 159 |
+
* @param Options Structure containing information about the request.
|
| 160 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 161 |
+
* @param NotificationFn A callback that is fired when a a notification is received.
|
| 162 |
+
*
|
| 163 |
+
* @return handle representing the registered callback
|
| 164 |
+
*
|
| 165 |
+
* @see EOS_Lobby_AddNotifyLobbyUpdateReceivedOptions
|
| 166 |
+
* @see EOS_Lobby_OnLobbyUpdateReceivedCallback
|
| 167 |
+
*/
|
| 168 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyUpdateReceived(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyUpdateReceivedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyUpdateReceivedCallback NotificationFn);
|
| 169 |
+
|
| 170 |
+
/**
|
| 171 |
+
* Unregister from receiving notifications when a lobby changes its data.
|
| 172 |
+
*
|
| 173 |
+
* @param InId Handle representing the registered callback
|
| 174 |
+
*/
|
| 175 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyUpdateReceived(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 176 |
+
|
| 177 |
+
/**
|
| 178 |
+
* Register to receive notifications when a lobby member updates the attributes associated with themselves inside the lobby.
|
| 179 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyMemberUpdateReceived when you no longer wish to have your NotificationHandler called.
|
| 180 |
+
*
|
| 181 |
+
* @param Options Structure containing information about the request.
|
| 182 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 183 |
+
* @param NotificationFn A callback that is fired when a a notification is received.
|
| 184 |
+
*
|
| 185 |
+
* @return handle representing the registered callback
|
| 186 |
+
*
|
| 187 |
+
* @see EOS_Lobby_AddNotifyLobbyMemberUpdateReceivedOptions
|
| 188 |
+
* @see EOS_Lobby_OnLobbyMemberUpdateReceivedCallback
|
| 189 |
+
*/
|
| 190 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyMemberUpdateReceived(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyMemberUpdateReceivedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyMemberUpdateReceivedCallback NotificationFn);
|
| 191 |
+
|
| 192 |
+
/**
|
| 193 |
+
* Unregister from receiving notifications when lobby members change their data.
|
| 194 |
+
*
|
| 195 |
+
* @param InId Handle representing the registered callback
|
| 196 |
+
*/
|
| 197 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyMemberUpdateReceived(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 198 |
+
|
| 199 |
+
/**
|
| 200 |
+
* Register to receive notifications about the changing status of lobby members.
|
| 201 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyMemberStatusReceived when you no longer wish to have your NotificationHandler called.
|
| 202 |
+
*
|
| 203 |
+
* @param Options Structure containing information about the request.
|
| 204 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 205 |
+
* @param NotificationFn A callback that is fired when a a notification is received.
|
| 206 |
+
*
|
| 207 |
+
* @return handle representing the registered callback
|
| 208 |
+
*
|
| 209 |
+
* @see EOS_Lobby_AddNotifyLobbyMemberStatusReceivedOptions
|
| 210 |
+
* @see EOS_Lobby_OnLobbyMemberStatusReceivedCallback
|
| 211 |
+
*/
|
| 212 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyMemberStatusReceived(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyMemberStatusReceivedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyMemberStatusReceivedCallback NotificationFn);
|
| 213 |
+
|
| 214 |
+
/**
|
| 215 |
+
* Unregister from receiving notifications when lobby members status change.
|
| 216 |
+
*
|
| 217 |
+
* @param InId Handle representing the registered callback
|
| 218 |
+
*/
|
| 219 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyMemberStatusReceived(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 220 |
+
|
| 221 |
+
/**
|
| 222 |
+
* Send an invite to another user. User must be a member of the lobby or else the call will fail
|
| 223 |
+
*
|
| 224 |
+
* @param Options Structure containing information about the lobby and user to invite
|
| 225 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 226 |
+
* @param CompletionDelegate A callback that is fired when the send invite operation completes, either successfully or in error
|
| 227 |
+
*
|
| 228 |
+
* @see EOS_Lobby_SendInviteOptions
|
| 229 |
+
* @see EOS_Lobby_OnSendInviteCallback
|
| 230 |
+
*/
|
| 231 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_SendInvite(EOS_HLobby Handle, const EOS_Lobby_SendInviteOptions* Options, void* ClientData, const EOS_Lobby_OnSendInviteCallback CompletionDelegate);
|
| 232 |
+
|
| 233 |
+
/**
|
| 234 |
+
* Reject an invite from another user.
|
| 235 |
+
*
|
| 236 |
+
* @param Options Structure containing information about the invite to reject
|
| 237 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 238 |
+
* @param CompletionDelegate A callback that is fired when the reject invite operation completes, either successfully or in error
|
| 239 |
+
*
|
| 240 |
+
* @see EOS_Lobby_RejectInviteOptions
|
| 241 |
+
* @see EOS_Lobby_OnRejectInviteCallback
|
| 242 |
+
*/
|
| 243 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RejectInvite(EOS_HLobby Handle, const EOS_Lobby_RejectInviteOptions* Options, void* ClientData, const EOS_Lobby_OnRejectInviteCallback CompletionDelegate);
|
| 244 |
+
|
| 245 |
+
/**
|
| 246 |
+
* Retrieve all existing invites for a single user
|
| 247 |
+
*
|
| 248 |
+
* @param Options Structure containing information about the invites to query
|
| 249 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 250 |
+
* @param CompletionDelegate A callback that is fired when the query invites operation completes, either successfully or in error
|
| 251 |
+
*
|
| 252 |
+
* @see EOS_Lobby_QueryInvitesOptions
|
| 253 |
+
* @see EOS_Lobby_OnQueryInvitesCallback
|
| 254 |
+
*/
|
| 255 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_QueryInvites(EOS_HLobby Handle, const EOS_Lobby_QueryInvitesOptions* Options, void* ClientData, const EOS_Lobby_OnQueryInvitesCallback CompletionDelegate);
|
| 256 |
+
|
| 257 |
+
/**
|
| 258 |
+
* Get the number of known invites for a given user
|
| 259 |
+
*
|
| 260 |
+
* @param Options the Options associated with retrieving the current invite count
|
| 261 |
+
*
|
| 262 |
+
* @return number of known invites for a given user or 0 if there is an error
|
| 263 |
+
*
|
| 264 |
+
* @see EOS_Lobby_GetInviteCountOptions
|
| 265 |
+
*/
|
| 266 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_Lobby_GetInviteCount(EOS_HLobby Handle, const EOS_Lobby_GetInviteCountOptions* Options);
|
| 267 |
+
|
| 268 |
+
/**
|
| 269 |
+
* Retrieve an invite ID from a list of active invites for a given user
|
| 270 |
+
*
|
| 271 |
+
* @param Options Structure containing the input parameters
|
| 272 |
+
*
|
| 273 |
+
* @return EOS_EResult containing the result of the operation.
|
| 274 |
+
* Possible result codes:
|
| 275 |
+
* - EOS_Success if the input is valid and an invite ID was returned
|
| 276 |
+
* - EOS_InvalidParameters if any of the options are incorrect
|
| 277 |
+
* - EOS_NotFound if the invite doesn't exist
|
| 278 |
+
*
|
| 279 |
+
* @see EOS_Lobby_GetInviteCount
|
| 280 |
+
* @see EOS_Lobby_CopyLobbyDetailsHandleByInviteId
|
| 281 |
+
*
|
| 282 |
+
* @see EOS_Lobby_GetInviteIdByIndexOptions
|
| 283 |
+
*/
|
| 284 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_GetInviteIdByIndex(EOS_HLobby Handle, const EOS_Lobby_GetInviteIdByIndexOptions* Options, char* OutBuffer, int32_t* InOutBufferLength);
|
| 285 |
+
|
| 286 |
+
/**
|
| 287 |
+
* Create a lobby search handle. This handle may be modified to include various search parameters.
|
| 288 |
+
* Searching is possible in three methods, all mutually exclusive
|
| 289 |
+
* - set the lobby ID to find a specific lobby
|
| 290 |
+
* - set the target user ID to find a specific user
|
| 291 |
+
* - set lobby parameters to find an array of lobbies that match the search criteria
|
| 292 |
+
*
|
| 293 |
+
* @param Options Structure containing required parameters such as the maximum number of search results
|
| 294 |
+
* @param OutLobbySearchHandle The new search handle or null if there was an error creating the search handle
|
| 295 |
+
*
|
| 296 |
+
* @return EOS_EResult containing the result of the operation.
|
| 297 |
+
* Possible result codes:
|
| 298 |
+
* - EOS_Success if the search creation completes successfully
|
| 299 |
+
* - EOS_InvalidParameters if any of the options are incorrect
|
| 300 |
+
*
|
| 301 |
+
* @see EOS_Lobby_CreateLobbySearchOptions
|
| 302 |
+
* @see EOS_HLobbySearch
|
| 303 |
+
*/
|
| 304 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_CreateLobbySearch(EOS_HLobby Handle, const EOS_Lobby_CreateLobbySearchOptions* Options, EOS_HLobbySearch* OutLobbySearchHandle);
|
| 305 |
+
|
| 306 |
+
/**
|
| 307 |
+
* Register to receive notifications about lobby invites sent to local users.
|
| 308 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyInviteReceived when you no longer wish to have your NotificationHandler called.
|
| 309 |
+
*
|
| 310 |
+
* @param Options Structure containing information about the request.
|
| 311 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 312 |
+
* @param NotificationFn A callback that is fired when a a notification is received.
|
| 313 |
+
*
|
| 314 |
+
* @return handle representing the registered callback
|
| 315 |
+
*
|
| 316 |
+
* @see EOS_Lobby_AddNotifyLobbyInviteReceivedOptions
|
| 317 |
+
* @see EOS_Lobby_OnLobbyInviteReceivedCallback
|
| 318 |
+
*/
|
| 319 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyInviteReceived(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyInviteReceivedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyInviteReceivedCallback NotificationFn);
|
| 320 |
+
|
| 321 |
+
/**
|
| 322 |
+
* Unregister from receiving notifications when a user receives a lobby invitation.
|
| 323 |
+
*
|
| 324 |
+
* @param InId Handle representing the registered callback
|
| 325 |
+
*/
|
| 326 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyInviteReceived(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 327 |
+
|
| 328 |
+
/**
|
| 329 |
+
* Register to receive notifications about lobby invites accepted by local user via the overlay.
|
| 330 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyInviteAccepted when you no longer wish to have your NotificationHandler called.
|
| 331 |
+
*
|
| 332 |
+
* @param Options Structure containing information about the request.
|
| 333 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 334 |
+
* @param NotificationFn A callback that is fired when a a notification is received.
|
| 335 |
+
*
|
| 336 |
+
* @return handle representing the registered callback
|
| 337 |
+
*
|
| 338 |
+
* @see EOS_Lobby_AddNotifyLobbyInviteAcceptedOptions
|
| 339 |
+
* @see EOS_Lobby_OnLobbyInviteAcceptedCallback
|
| 340 |
+
*/
|
| 341 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyInviteAccepted(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyInviteAcceptedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyInviteAcceptedCallback NotificationFn);
|
| 342 |
+
|
| 343 |
+
/**
|
| 344 |
+
* Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.
|
| 345 |
+
*
|
| 346 |
+
* @param InId Handle representing the registered callback
|
| 347 |
+
*/
|
| 348 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyInviteAccepted(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 349 |
+
|
| 350 |
+
/**
|
| 351 |
+
* Register to receive notifications about lobby invites rejected by local user.
|
| 352 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLobbyInviteRejected when you no longer wish to have your NotificationHandler called.
|
| 353 |
+
*
|
| 354 |
+
* @param Options Structure containing information about the request.
|
| 355 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 356 |
+
* @param NotificationFn A callback that is fired when a a notification is received.
|
| 357 |
+
*
|
| 358 |
+
* @return handle representing the registered callback
|
| 359 |
+
*
|
| 360 |
+
* @see EOS_Lobby_AddNotifyLobbyInviteRejectedOptions
|
| 361 |
+
* @see EOS_Lobby_OnLobbyInviteRejectedCallback
|
| 362 |
+
*/
|
| 363 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLobbyInviteRejected(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLobbyInviteRejectedOptions* Options, void* ClientData, const EOS_Lobby_OnLobbyInviteRejectedCallback NotificationFn);
|
| 364 |
+
|
| 365 |
+
/**
|
| 366 |
+
* Unregister from receiving notifications when a user rejects a lobby invitation via the overlay.
|
| 367 |
+
*
|
| 368 |
+
* @param InId Handle representing the registered callback
|
| 369 |
+
*/
|
| 370 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLobbyInviteRejected(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 371 |
+
|
| 372 |
+
/**
|
| 373 |
+
* Register to receive notifications about lobby "JOIN" performed by local user (when no invite) via the overlay.
|
| 374 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyJoinLobbyAccepted when you no longer wish to have your NotificationHandler called.
|
| 375 |
+
*
|
| 376 |
+
* @param Options Structure containing information about the request.
|
| 377 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 378 |
+
* @param NotificationFn A callback that is fired when a notification is received.
|
| 379 |
+
*
|
| 380 |
+
* @return handle representing the registered callback
|
| 381 |
+
*
|
| 382 |
+
* @see EOS_Lobby_AddNotifyJoinLobbyAcceptedOptions
|
| 383 |
+
* @see EOS_Lobby_OnJoinLobbyAcceptedCallback
|
| 384 |
+
*/
|
| 385 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyJoinLobbyAccepted(EOS_HLobby Handle, const EOS_Lobby_AddNotifyJoinLobbyAcceptedOptions* Options, void* ClientData, const EOS_Lobby_OnJoinLobbyAcceptedCallback NotificationFn);
|
| 386 |
+
|
| 387 |
+
/**
|
| 388 |
+
* Unregister from receiving notifications when a user accepts a lobby invitation via the overlay.
|
| 389 |
+
*
|
| 390 |
+
* @param InId Handle representing the registered callback
|
| 391 |
+
*/
|
| 392 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyJoinLobbyAccepted(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 393 |
+
|
| 394 |
+
/**
|
| 395 |
+
* Register to receive notifications about a lobby "INVITE" performed by a local user via the overlay.
|
| 396 |
+
* This is only needed when a configured integrated platform has EOS_IPMF_DisableSDKManagedSessions set. The EOS SDK will
|
| 397 |
+
* then use the state of EOS_IPMF_PreferEOSIdentity and EOS_IPMF_PreferIntegratedIdentity to determine when the NotificationFn is
|
| 398 |
+
* called.
|
| 399 |
+
*
|
| 400 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifySendLobbyNativeInviteRequested when you no longer wish to have your NotificationHandler called.
|
| 401 |
+
*
|
| 402 |
+
* @param Options Structure containing information about the request.
|
| 403 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 404 |
+
* @param NotificationFn A callback that is fired when a notification is received.
|
| 405 |
+
*
|
| 406 |
+
* @return handle representing the registered callback
|
| 407 |
+
*
|
| 408 |
+
* @see EOS_IPMF_DisableSDKManagedSessions
|
| 409 |
+
* @see EOS_IPMF_PreferEOSIdentity
|
| 410 |
+
* @see EOS_IPMF_PreferIntegratedIdentity
|
| 411 |
+
*
|
| 412 |
+
* @see EOS_Lobby_AddNotifySendLobbyNativeInviteRequestedOptions
|
| 413 |
+
* @see EOS_Lobby_OnSendLobbyNativeInviteRequestedCallback
|
| 414 |
+
*/
|
| 415 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifySendLobbyNativeInviteRequested(EOS_HLobby Handle, const EOS_Lobby_AddNotifySendLobbyNativeInviteRequestedOptions* Options, void* ClientData, const EOS_Lobby_OnSendLobbyNativeInviteRequestedCallback NotificationFn);
|
| 416 |
+
|
| 417 |
+
/**
|
| 418 |
+
* Unregister from receiving notifications when a user requests a send invite via the overlay.
|
| 419 |
+
*
|
| 420 |
+
* @param InId Handle representing the registered callback
|
| 421 |
+
*/
|
| 422 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifySendLobbyNativeInviteRequested(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 423 |
+
|
| 424 |
+
/**
|
| 425 |
+
* EOS_Lobby_CopyLobbyDetailsHandleByInviteId is used to immediately retrieve a handle to the lobby information from after notification of an invite
|
| 426 |
+
* 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.
|
| 427 |
+
*
|
| 428 |
+
* @param Options Structure containing the input parameters
|
| 429 |
+
* @param OutLobbyDetailsHandle out parameter used to receive the lobby handle
|
| 430 |
+
*
|
| 431 |
+
* @return EOS_EResult containing the result of the operation.
|
| 432 |
+
* Possible result codes:
|
| 433 |
+
* - EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
|
| 434 |
+
* - EOS_InvalidParameters if you pass an invalid invite ID or a null pointer for the out parameter
|
| 435 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 436 |
+
* - EOS_NotFound If the invite ID cannot be found
|
| 437 |
+
*
|
| 438 |
+
* @see EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions
|
| 439 |
+
* @see EOS_HLobbyDetails
|
| 440 |
+
* @see EOS_LobbyDetails_Release
|
| 441 |
+
*/
|
| 442 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_CopyLobbyDetailsHandleByInviteId(EOS_HLobby Handle, const EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions* Options, EOS_HLobbyDetails* OutLobbyDetailsHandle);
|
| 443 |
+
|
| 444 |
+
/**
|
| 445 |
+
* EOS_Lobby_CopyLobbyDetailsHandleByUiEventId is used to immediately retrieve a handle to the lobby information from after notification of a join game
|
| 446 |
+
* 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.
|
| 447 |
+
*
|
| 448 |
+
* @param Options Structure containing the input parameters
|
| 449 |
+
* @param OutLobbyDetailsHandle out parameter used to receive the lobby handle
|
| 450 |
+
*
|
| 451 |
+
* @return EOS_EResult containing the result of the operation.
|
| 452 |
+
* Possible result codes:
|
| 453 |
+
* - EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
|
| 454 |
+
* - EOS_InvalidParameters if you pass an invalid ui event ID
|
| 455 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 456 |
+
* - EOS_NotFound If the invite ID cannot be found
|
| 457 |
+
*
|
| 458 |
+
* @see EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions
|
| 459 |
+
* @see EOS_HLobbyDetails
|
| 460 |
+
* @see EOS_LobbyDetails_Release
|
| 461 |
+
*/
|
| 462 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_CopyLobbyDetailsHandleByUiEventId(EOS_HLobby Handle, const EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions* Options, EOS_HLobbyDetails* OutLobbyDetailsHandle);
|
| 463 |
+
|
| 464 |
+
/**
|
| 465 |
+
* Create a handle to an existing lobby.
|
| 466 |
+
* 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.
|
| 467 |
+
*
|
| 468 |
+
* @param Options Structure containing information about the lobby to retrieve
|
| 469 |
+
* @param OutLobbyDetailsHandle The new active lobby handle or null if there was an error
|
| 470 |
+
*
|
| 471 |
+
* @return EOS_EResult containing the result of the operation.
|
| 472 |
+
* Possible result codes:
|
| 473 |
+
* - EOS_Success if the lobby handle was created successfully
|
| 474 |
+
* - EOS_InvalidParameters if any of the options are incorrect
|
| 475 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 476 |
+
* - EOS_NotFound if the lobby doesn't exist
|
| 477 |
+
*
|
| 478 |
+
* @see EOS_Lobby_CopyLobbyDetailsHandleOptions
|
| 479 |
+
* @see EOS_HLobbyDetails
|
| 480 |
+
*/
|
| 481 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_CopyLobbyDetailsHandle(EOS_HLobby Handle, const EOS_Lobby_CopyLobbyDetailsHandleOptions* Options, EOS_HLobbyDetails* OutLobbyDetailsHandle);
|
| 482 |
+
|
| 483 |
+
/**
|
| 484 |
+
* Get the name of the RTC room associated with a specific lobby a local user belongs to.
|
| 485 |
+
*
|
| 486 |
+
* 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
|
| 487 |
+
* EOS_RTC_JoinRoom, EOS_RTC_LeaveRoom, or EOS_RTC_AddNotifyDisconnected. Doing so will return EOS_AccessDenied or
|
| 488 |
+
* EOS_INVALID_NOTIFICATIONID if used with those functions.
|
| 489 |
+
*
|
| 490 |
+
* This function will only succeed when called on a lobby the local user is currently a member of.
|
| 491 |
+
*
|
| 492 |
+
* @param Options Structure containing information about the RTC room name to retrieve
|
| 493 |
+
* @param OutBuffer The buffer to store the null-terminated room name string within
|
| 494 |
+
* @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)
|
| 495 |
+
*
|
| 496 |
+
* @return EOS_EResult containing the result of the operation.
|
| 497 |
+
* Possible result codes:
|
| 498 |
+
* - EOS_Success if a room exists for the specified lobby, there was enough space in OutBuffer, and the name was written successfully
|
| 499 |
+
* - EOS_NotFound if the lobby does not exist
|
| 500 |
+
* - EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created
|
| 501 |
+
* - EOS_InvalidParameters if you pass a null pointer on invalid length for any of the parameters
|
| 502 |
+
* - EOS_LimitExceeded The OutBuffer is not large enough to receive the room name. InOutBufferLength contains the required minimum length to perform the operation successfully.
|
| 503 |
+
*
|
| 504 |
+
* @see EOS_Lobby_GetRTCRoomNameOptions
|
| 505 |
+
*/
|
| 506 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_GetRTCRoomName(EOS_HLobby Handle, const EOS_Lobby_GetRTCRoomNameOptions* Options, char* OutBuffer, uint32_t* InOutBufferLength);
|
| 507 |
+
|
| 508 |
+
/**
|
| 509 |
+
* Joins the RTC room associated with a specific lobby a local user belongs to.
|
| 510 |
+
*
|
| 511 |
+
* This function will only succeed when called on a lobby that has the RTC Room feature enabled.
|
| 512 |
+
* Clients may check if the RTC Room feature is enabled by inspecting the value of EOS_LobbyDetails_Info::bRTCRoomEnabled.
|
| 513 |
+
*
|
| 514 |
+
* @param Options Structure containing information about which lobby a local user should join the RTC Room for
|
| 515 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 516 |
+
* @param CompletionDelegate A callback that is fired when the join RTC Room operation completes, either successfully or in error
|
| 517 |
+
*
|
| 518 |
+
* @see EOS_Lobby_JoinRTCRoomOptions
|
| 519 |
+
* @see EOS_Lobby_OnJoinRTCRoomCallback
|
| 520 |
+
*/
|
| 521 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_JoinRTCRoom(EOS_HLobby Handle, const EOS_Lobby_JoinRTCRoomOptions* Options, void* ClientData, const EOS_Lobby_OnJoinRTCRoomCallback CompletionDelegate);
|
| 522 |
+
|
| 523 |
+
/**
|
| 524 |
+
* Leaves the RTC room associated with a specific lobby a local user belongs to.
|
| 525 |
+
*
|
| 526 |
+
* This function will only succeed when called on a lobby that has the RTC Room feature enabled.
|
| 527 |
+
* Clients may check if the RTC Room feature is enabled by inspecting the value of EOS_LobbyDetails_Info::bRTCRoomEnabled.
|
| 528 |
+
*
|
| 529 |
+
* @param Options Structure containing information about which lobby a local user should leave the RTC Room for
|
| 530 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 531 |
+
* @param CompletionDelegate A callback that is fired when the leave RTC Room operation completes, either successfully or in error
|
| 532 |
+
*
|
| 533 |
+
* @see EOS_Lobby_LeaveRTCRoomOptions
|
| 534 |
+
* @see EOS_Lobby_OnLeaveRTCRoomCallback
|
| 535 |
+
*/
|
| 536 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_LeaveRTCRoom(EOS_HLobby Handle, const EOS_Lobby_LeaveRTCRoomOptions* Options, void* ClientData, const EOS_Lobby_OnLeaveRTCRoomCallback CompletionDelegate);
|
| 537 |
+
|
| 538 |
+
/**
|
| 539 |
+
* Get the current connection status of the RTC Room for a lobby.
|
| 540 |
+
*
|
| 541 |
+
* The RTC Room connection status is independent of the lobby connection status, however the lobby system will attempt to keep
|
| 542 |
+
* them consistent, automatically connecting to the RTC room after joining a lobby which has an associated RTC room and disconnecting
|
| 543 |
+
* from the RTC room when a lobby is left or disconnected.
|
| 544 |
+
*
|
| 545 |
+
* This function will only succeed when called on a lobby the local user is currently a member of.
|
| 546 |
+
*
|
| 547 |
+
* @param Options Structure containing information about the lobby to query the RTC Room connection status for
|
| 548 |
+
* @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.
|
| 549 |
+
*
|
| 550 |
+
* @return EOS_EResult containing the result of the operation.
|
| 551 |
+
* Possible result codes:
|
| 552 |
+
* - 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.
|
| 553 |
+
* - EOS_NotFound if the lobby doesn't exist
|
| 554 |
+
* - EOS_Disabled if the lobby exists, but did not have the RTC Room feature enabled when created
|
| 555 |
+
* - EOS_InvalidParameters if bOutIsConnected is NULL, or any other parameters are NULL or invalid
|
| 556 |
+
*
|
| 557 |
+
* @see EOS_Lobby_AddNotifyRTCRoomConnectionChanged
|
| 558 |
+
* @see EOS_Lobby_IsRTCRoomConnectedOptions
|
| 559 |
+
*/
|
| 560 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_IsRTCRoomConnected(EOS_HLobby Handle, const EOS_Lobby_IsRTCRoomConnectedOptions* Options, EOS_Bool* bOutIsConnected);
|
| 561 |
+
|
| 562 |
+
/**
|
| 563 |
+
* Register to receive notifications of when the RTC Room for a particular lobby has a connection status change.
|
| 564 |
+
*
|
| 565 |
+
* The RTC Room connection status is independent of the lobby connection status, however the lobby system will attempt to keep
|
| 566 |
+
* them consistent, automatically connecting to the RTC room after joining a lobby which has an associated RTC room and disconnecting
|
| 567 |
+
* from the RTC room when a lobby is left or disconnected.
|
| 568 |
+
*
|
| 569 |
+
* This notification is entirely informational and requires no action in response by the application. If the connected status is offline
|
| 570 |
+
* (bIsConnected is EOS_FALSE), the connection will automatically attempt to reconnect. The purpose of this notification is to allow
|
| 571 |
+
* applications to show the current connection status of the RTC room when the connection is not established.
|
| 572 |
+
*
|
| 573 |
+
* Unlike EOS_RTC_AddNotifyDisconnected, EOS_RTC_LeaveRoom should not be called when the RTC room is disconnected.
|
| 574 |
+
*
|
| 575 |
+
* This function will only succeed when called on a lobby the local user is currently a member of.
|
| 576 |
+
*
|
| 577 |
+
* @param Options Structure containing information about the lobby to receive updates about
|
| 578 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 579 |
+
* @param NotificationFn The function to call if the RTC Room's connection status changes
|
| 580 |
+
*
|
| 581 |
+
* @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.
|
| 582 |
+
*
|
| 583 |
+
* @see EOS_Lobby_RemoveNotifyRTCRoomConnectionChanged
|
| 584 |
+
* @see EOS_Lobby_AddNotifyRTCRoomConnectionChangedOptions
|
| 585 |
+
* @see EOS_Lobby_OnRTCRoomConnectionChangedCallback
|
| 586 |
+
*/
|
| 587 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyRTCRoomConnectionChanged(EOS_HLobby Handle, const EOS_Lobby_AddNotifyRTCRoomConnectionChangedOptions* Options, void* ClientData, const EOS_Lobby_OnRTCRoomConnectionChangedCallback NotificationFn);
|
| 588 |
+
|
| 589 |
+
/**
|
| 590 |
+
* Unregister from receiving notifications when an RTC Room's connection status changes.
|
| 591 |
+
*
|
| 592 |
+
* This should be called when the local user is leaving a lobby.
|
| 593 |
+
*
|
| 594 |
+
* @param InId Handle representing the registered callback
|
| 595 |
+
*
|
| 596 |
+
* @see EOS_Lobby_AddNotifyRTCRoomConnectionChanged
|
| 597 |
+
*/
|
| 598 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyRTCRoomConnectionChanged(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 599 |
+
|
| 600 |
+
/**
|
| 601 |
+
* Get the Connection string for an EOS lobby. The connection string describes the presence of a player in terms of game state.
|
| 602 |
+
* Xbox platforms expect titles to embed this into their MultiplayerActivity at creation.
|
| 603 |
+
* When present, the SDK will use this value to populate session presence in the social overlay and facilitate platform invitations.
|
| 604 |
+
*
|
| 605 |
+
* @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.
|
| 606 |
+
* @param OutBuffer The buffer to store the null-terminated ConnectString within
|
| 607 |
+
* @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.
|
| 608 |
+
*
|
| 609 |
+
* @return EOS_EResult containing the result of the operation.
|
| 610 |
+
* Possible result codes:
|
| 611 |
+
* - EOS_Success if retrieving the string was successful.
|
| 612 |
+
* - EOS_InvalidParameters if the OutBuffer or InOutBufferLength are null.
|
| 613 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect.
|
| 614 |
+
* - EOS_NotFound if no lobby is found matching the LobbyID and PUID provided.
|
| 615 |
+
* - EOS_LimitExceeded if the provided InOutBufferLength is too small to contain the resulting string.
|
| 616 |
+
*
|
| 617 |
+
* @see EOS_Lobby_GetConnectStringOptions
|
| 618 |
+
*/
|
| 619 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_GetConnectString(EOS_HLobby Handle, const EOS_Lobby_GetConnectStringOptions* Options, char* OutBuffer, uint32_t* InOutBufferLength);
|
| 620 |
+
|
| 621 |
+
/**
|
| 622 |
+
* Parse the ConnectString for an EOS lobby invitation to extract just the lobby ID.
|
| 623 |
+
* Used for joining a lobby from a connection string (as generated by GetConnectString) found in a platform invitation or presence.
|
| 624 |
+
*
|
| 625 |
+
* @param Options Structure containing the input parameters. API version and ConnectString.
|
| 626 |
+
* @param OutBuffer The buffer to store the null-terminated lobby ID within
|
| 627 |
+
* @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.
|
| 628 |
+
*
|
| 629 |
+
* @return EOS_EResult containing the result of the operation.
|
| 630 |
+
* Possible result codes:
|
| 631 |
+
* - EOS_Success if retrieving the string was successful.
|
| 632 |
+
* - EOS_InvalidParameters if the OutBuffer or InOutBufferLength are null.
|
| 633 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect.
|
| 634 |
+
* - EOS_LimitExceeded if the provided InOutBufferLength is too small to contain the resulting string.
|
| 635 |
+
*
|
| 636 |
+
* @see EOS_Lobby_ParseConnectStringOptions
|
| 637 |
+
*/
|
| 638 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Lobby_ParseConnectString(EOS_HLobby Handle, const EOS_Lobby_ParseConnectStringOptions* Options, char* OutBuffer, uint32_t* InOutBufferLength);
|
| 639 |
+
|
| 640 |
+
/**
|
| 641 |
+
* Register to receive notifications about leave lobby requests performed by the local user via the overlay.
|
| 642 |
+
* 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.
|
| 643 |
+
* @note If the returned NotificationId is valid, you must call EOS_Lobby_RemoveNotifyLeaveLobbyRequested when you no longer wish to have your NotificationHandler called.
|
| 644 |
+
*
|
| 645 |
+
* @param Options Structure containing information about the request.
|
| 646 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate.
|
| 647 |
+
* @param NotificationFn A callback that is fired when a notification is received.
|
| 648 |
+
*
|
| 649 |
+
* @return handle representing the registered callback
|
| 650 |
+
*
|
| 651 |
+
* @see EOS_Lobby_AddNotifyLeaveLobbyRequestedOptions
|
| 652 |
+
* @see EOS_Lobby_OnLeaveLobbyRequestedCallback
|
| 653 |
+
*/
|
| 654 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_Lobby_AddNotifyLeaveLobbyRequested(EOS_HLobby Handle, const EOS_Lobby_AddNotifyLeaveLobbyRequestedOptions* Options, void* ClientData, const EOS_Lobby_OnLeaveLobbyRequestedCallback NotificationFn);
|
| 655 |
+
|
| 656 |
+
/**
|
| 657 |
+
* Unregister from receiving notifications when a user performs a leave lobby action via the overlay.
|
| 658 |
+
*
|
| 659 |
+
* @param InId Handle representing the registered callback
|
| 660 |
+
*/
|
| 661 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_RemoveNotifyLeaveLobbyRequested(EOS_HLobby Handle, EOS_NotificationId InId);
|
| 662 |
+
|
| 663 |
+
/**
|
| 664 |
+
* 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
|
| 665 |
+
* EOS_HLobbyModification methods. Once you are finished, call EOS_Lobby_UpdateLobby with your handle. You must then release your Lobby Modification
|
| 666 |
+
* handle by calling EOS_LobbyModification_Release.
|
| 667 |
+
*/
|
| 668 |
+
|
| 669 |
+
/**
|
| 670 |
+
* Set the bucket ID associated with this lobby.
|
| 671 |
+
* Values such as region, game mode, etc can be combined here depending on game need.
|
| 672 |
+
* Setting this is strongly recommended to improve search performance.
|
| 673 |
+
*
|
| 674 |
+
* @param Options Options associated with the bucket ID of the lobby
|
| 675 |
+
*
|
| 676 |
+
* @return EOS_EResult containing the result of the operation.
|
| 677 |
+
* Possible result codes:
|
| 678 |
+
* - EOS_Success if setting this parameter was successful
|
| 679 |
+
* - EOS_InvalidParameters if the bucket ID is invalid or null
|
| 680 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 681 |
+
*
|
| 682 |
+
* @see EOS_LobbyModification_SetBucketIdOptions
|
| 683 |
+
*/
|
| 684 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetBucketId(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetBucketIdOptions* Options);
|
| 685 |
+
|
| 686 |
+
/**
|
| 687 |
+
* Set the permissions associated with this lobby.
|
| 688 |
+
* The permissions range from "public" to "invite only" and are described by EOS_ELobbyPermissionLevel
|
| 689 |
+
*
|
| 690 |
+
* @param Options Options associated with the permission level of the lobby
|
| 691 |
+
*
|
| 692 |
+
* @return EOS_EResult containing the result of the operation.
|
| 693 |
+
* Possible result codes:
|
| 694 |
+
* - EOS_Success if setting this parameter was successful
|
| 695 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 696 |
+
*
|
| 697 |
+
* @see EOS_LobbyModification_SetPermissionLevelOptions
|
| 698 |
+
*/
|
| 699 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetPermissionLevel(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetPermissionLevelOptions* Options);
|
| 700 |
+
|
| 701 |
+
/**
|
| 702 |
+
* Set the maximum number of members allowed in this lobby.
|
| 703 |
+
* When updating the lobby, it is not possible to reduce this number below the current number of existing members
|
| 704 |
+
*
|
| 705 |
+
* @param Options Options associated with max number of members in this lobby
|
| 706 |
+
*
|
| 707 |
+
* @return EOS_EResult containing the result of the operation.
|
| 708 |
+
* Possible result codes:
|
| 709 |
+
* - EOS_Success if setting this parameter was successful
|
| 710 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 711 |
+
*
|
| 712 |
+
* @see EOS_LobbyModification_SetMaxMembersOptions
|
| 713 |
+
*/
|
| 714 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetMaxMembers(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetMaxMembersOptions* Options);
|
| 715 |
+
|
| 716 |
+
/**
|
| 717 |
+
* Allows enabling or disabling invites for this lobby.
|
| 718 |
+
* The lobby will also need to have `bPresenceEnabled` true.
|
| 719 |
+
*
|
| 720 |
+
* @param Options Options associated with invites allowed flag for this lobby.
|
| 721 |
+
*
|
| 722 |
+
* @return EOS_EResult containing the result of the operation.
|
| 723 |
+
* Possible result codes:
|
| 724 |
+
* - EOS_Success if setting this parameter was successful
|
| 725 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 726 |
+
*
|
| 727 |
+
* @see EOS_LobbyModification_SetInvitesAllowedOptions
|
| 728 |
+
*/
|
| 729 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetInvitesAllowed(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetInvitesAllowedOptions* Options);
|
| 730 |
+
|
| 731 |
+
/**
|
| 732 |
+
* Associate an attribute with this lobby
|
| 733 |
+
* An attribute is something may be public or private with the lobby.
|
| 734 |
+
* If public, it can be queried for in a search, otherwise the data remains known only to lobby members
|
| 735 |
+
*
|
| 736 |
+
* @param Options Options to set the attribute and its visibility state
|
| 737 |
+
*
|
| 738 |
+
* @return EOS_EResult containing the result of the operation.
|
| 739 |
+
* Possible result codes:
|
| 740 |
+
* - EOS_Success if setting this parameter was successful
|
| 741 |
+
* - EOS_InvalidParameters if the attribute is missing information or otherwise invalid
|
| 742 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 743 |
+
*
|
| 744 |
+
* @see EOS_LobbyModification_AddAttributeOptions
|
| 745 |
+
*/
|
| 746 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_AddAttribute(EOS_HLobbyModification Handle, const EOS_LobbyModification_AddAttributeOptions* Options);
|
| 747 |
+
|
| 748 |
+
/**
|
| 749 |
+
* Remove an attribute associated with the lobby
|
| 750 |
+
*
|
| 751 |
+
* @param Options Specify the key of the attribute to remove
|
| 752 |
+
*
|
| 753 |
+
* @return EOS_EResult containing the result of the operation.
|
| 754 |
+
* Possible result codes:
|
| 755 |
+
* - EOS_Success if removing this parameter was successful
|
| 756 |
+
* - EOS_InvalidParameters if the key is null or empty
|
| 757 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 758 |
+
*
|
| 759 |
+
* @see EOS_LobbyModification_RemoveAttributeOptions
|
| 760 |
+
*/
|
| 761 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_RemoveAttribute(EOS_HLobbyModification Handle, const EOS_LobbyModification_RemoveAttributeOptions* Options);
|
| 762 |
+
|
| 763 |
+
/**
|
| 764 |
+
* Associate an attribute with a member of the lobby
|
| 765 |
+
* Lobby member data is always private to the lobby
|
| 766 |
+
*
|
| 767 |
+
* @param Options Options to set the attribute and its visibility state
|
| 768 |
+
*
|
| 769 |
+
* @return EOS_EResult containing the result of the operation.
|
| 770 |
+
* Possible result codes:
|
| 771 |
+
* - EOS_Success if setting this parameter was successful
|
| 772 |
+
* - EOS_InvalidParameters if the attribute is missing information or otherwise invalid
|
| 773 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 774 |
+
*
|
| 775 |
+
* @see EOS_LobbyModification_AddMemberAttributeOptions
|
| 776 |
+
*/
|
| 777 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_AddMemberAttribute(EOS_HLobbyModification Handle, const EOS_LobbyModification_AddMemberAttributeOptions* Options);
|
| 778 |
+
|
| 779 |
+
/**
|
| 780 |
+
* Remove an attribute associated with of member of the lobby
|
| 781 |
+
*
|
| 782 |
+
* @param Options Specify the key of the member attribute to remove
|
| 783 |
+
*
|
| 784 |
+
* @return EOS_EResult containing the result of the operation.
|
| 785 |
+
* Possible result codes:
|
| 786 |
+
* - EOS_Success if removing this parameter was successful
|
| 787 |
+
* - EOS_InvalidParameters if the key is null or empty
|
| 788 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 789 |
+
*
|
| 790 |
+
* @see EOS_LobbyModification_RemoveMemberAttributeOptions
|
| 791 |
+
*/
|
| 792 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_RemoveMemberAttribute(EOS_HLobbyModification Handle, const EOS_LobbyModification_RemoveMemberAttributeOptions* Options);
|
| 793 |
+
|
| 794 |
+
/**
|
| 795 |
+
* Set the Allowed Platform IDs for the lobby
|
| 796 |
+
*
|
| 797 |
+
* @param Options Options associated with allowed Platform IDs for this lobby
|
| 798 |
+
*
|
| 799 |
+
* @return EOS_EResult containing the result of the operation.
|
| 800 |
+
* Possible result codes:
|
| 801 |
+
* - EOS_Success if setting this parameter was successful
|
| 802 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 803 |
+
* - 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.
|
| 804 |
+
*
|
| 805 |
+
* @see EOS_LobbyModification_SetAllowedPlatformIdsOptions
|
| 806 |
+
*/
|
| 807 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyModification_SetAllowedPlatformIds(EOS_HLobbyModification Handle, const EOS_LobbyModification_SetAllowedPlatformIdsOptions* Options);
|
| 808 |
+
|
| 809 |
+
#include "eos_lobby_types.h"
|
| 810 |
+
|
| 811 |
+
/**
|
| 812 |
+
* A "read only" representation of an existing lobby that games interact with externally.
|
| 813 |
+
* Both the lobby and lobby search interfaces interface use this common class for lobby management and search results
|
| 814 |
+
*/
|
| 815 |
+
|
| 816 |
+
/**
|
| 817 |
+
* Get the product user ID of the current owner for a given lobby
|
| 818 |
+
*
|
| 819 |
+
* @param Options Structure containing the input parameters
|
| 820 |
+
*
|
| 821 |
+
* @return the product user ID for the lobby owner or null if the input parameters are invalid
|
| 822 |
+
*
|
| 823 |
+
* @see EOS_LobbyDetails_GetLobbyOwnerOptions
|
| 824 |
+
*/
|
| 825 |
+
EOS_DECLARE_FUNC(EOS_ProductUserId) EOS_LobbyDetails_GetLobbyOwner(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetLobbyOwnerOptions* Options);
|
| 826 |
+
|
| 827 |
+
/**
|
| 828 |
+
* 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.
|
| 829 |
+
* 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.
|
| 830 |
+
*
|
| 831 |
+
* @param Options Structure containing the input parameters
|
| 832 |
+
* @param OutLobbyDetailsInfo Out parameter used to receive the EOS_LobbyDetails_Info structure.
|
| 833 |
+
*
|
| 834 |
+
* @return EOS_EResult containing the result of the operation.
|
| 835 |
+
* Possible result codes:
|
| 836 |
+
* - EOS_Success if the information is available and passed out in OutLobbyDetailsInfo
|
| 837 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 838 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 839 |
+
*
|
| 840 |
+
* @see EOS_LobbyDetails_Info
|
| 841 |
+
* @see EOS_LobbyDetails_CopyInfoOptions
|
| 842 |
+
* @see EOS_LobbyDetails_Info_Release
|
| 843 |
+
*/
|
| 844 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyInfo(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyInfoOptions* Options, EOS_LobbyDetails_Info ** OutLobbyDetailsInfo);
|
| 845 |
+
|
| 846 |
+
/**
|
| 847 |
+
* EOS_LobbyDetails_CopyMemberInfo is used to immediately retrieve a copy of lobby member information from an existing lobby.
|
| 848 |
+
* 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.
|
| 849 |
+
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
| 850 |
+
*
|
| 851 |
+
* @param Options Structure containing the input parameters
|
| 852 |
+
* @param OutLobbyDetailsMemberInfo Out parameter used to receive the EOS_LobbyDetails_Info structure.
|
| 853 |
+
*
|
| 854 |
+
* @return EOS_EResult containing the result of the operation.
|
| 855 |
+
* Possible result codes:
|
| 856 |
+
* - EOS_Success if the information is available and passed out in OutLobbyMemberDetailsInfo
|
| 857 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 858 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 859 |
+
* - EOS_NotFound if searching for a target user ID returns no results
|
| 860 |
+
*
|
| 861 |
+
* @see EOS_LobbyDetails_MemberInfo
|
| 862 |
+
* @see EOS_LobbyDetails_CopyMemberInfoOptions
|
| 863 |
+
* @see EOS_LobbyDetails_MemberInfo_Release
|
| 864 |
+
*/
|
| 865 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyMemberInfo(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyMemberInfoOptions* Options, EOS_LobbyDetails_MemberInfo ** OutLobbyDetailsMemberInfo);
|
| 866 |
+
|
| 867 |
+
/**
|
| 868 |
+
* Get the number of attributes associated with this lobby
|
| 869 |
+
*
|
| 870 |
+
* @param Options the Options associated with retrieving the attribute count
|
| 871 |
+
*
|
| 872 |
+
* @return number of attributes on the lobby or 0 if there is an error
|
| 873 |
+
*
|
| 874 |
+
* @see EOS_LobbyDetails_GetAttributeCountOptions
|
| 875 |
+
*/
|
| 876 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_LobbyDetails_GetAttributeCount(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetAttributeCountOptions* Options);
|
| 877 |
+
|
| 878 |
+
/**
|
| 879 |
+
* 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.
|
| 880 |
+
* 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.
|
| 881 |
+
*
|
| 882 |
+
* @param Options Structure containing the input parameters
|
| 883 |
+
* @param OutAttribute Out parameter used to receive the EOS_Lobby_Attribute structure.
|
| 884 |
+
*
|
| 885 |
+
* @return EOS_EResult containing the result of the operation.
|
| 886 |
+
* Possible result codes:
|
| 887 |
+
* - EOS_Success if the information is available and passed out in OutAttribute
|
| 888 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 889 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 890 |
+
*
|
| 891 |
+
* @see EOS_Lobby_Attribute
|
| 892 |
+
* @see EOS_LobbyDetails_CopyAttributeByIndexOptions
|
| 893 |
+
* @see EOS_Lobby_Attribute_Release
|
| 894 |
+
*/
|
| 895 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyAttributeByIndex(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyAttributeByIndexOptions* Options, EOS_Lobby_Attribute ** OutAttribute);
|
| 896 |
+
|
| 897 |
+
/**
|
| 898 |
+
* 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.
|
| 899 |
+
* 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.
|
| 900 |
+
*
|
| 901 |
+
* @param Options Structure containing the input parameters
|
| 902 |
+
* @param OutAttribute Out parameter used to receive the EOS_Lobby_Attribute structure.
|
| 903 |
+
*
|
| 904 |
+
* @return EOS_EResult containing the result of the operation.
|
| 905 |
+
* Possible result codes:
|
| 906 |
+
* - EOS_Success if the information is available and passed out in OutAttribute
|
| 907 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 908 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 909 |
+
*
|
| 910 |
+
* @see EOS_Lobby_Attribute
|
| 911 |
+
* @see EOS_LobbyDetails_CopyAttributeByKeyOptions
|
| 912 |
+
* @see EOS_Lobby_Attribute_Release
|
| 913 |
+
*/
|
| 914 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyAttributeByKey(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyAttributeByKeyOptions* Options, EOS_Lobby_Attribute ** OutAttribute);
|
| 915 |
+
|
| 916 |
+
/**
|
| 917 |
+
* Get the number of members associated with this lobby
|
| 918 |
+
*
|
| 919 |
+
* @param Options the Options associated with retrieving the member count
|
| 920 |
+
*
|
| 921 |
+
* @return number of members in the existing lobby or 0 if there is an error
|
| 922 |
+
*
|
| 923 |
+
* @see EOS_LobbyDetails_GetMemberCountOptions
|
| 924 |
+
*/
|
| 925 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_LobbyDetails_GetMemberCount(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetMemberCountOptions* Options);
|
| 926 |
+
|
| 927 |
+
/**
|
| 928 |
+
* EOS_LobbyDetails_GetMemberByIndex is used to immediately retrieve individual members registered with a lobby.
|
| 929 |
+
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
| 930 |
+
*
|
| 931 |
+
* @param Options Structure containing the input parameters
|
| 932 |
+
*
|
| 933 |
+
* @return the product user ID for the registered member at a given index or null if that index is invalid
|
| 934 |
+
*
|
| 935 |
+
* @see EOS_LobbyDetails_GetMemberCount
|
| 936 |
+
* @see EOS_LobbyDetails_GetMemberByIndexOptions
|
| 937 |
+
*/
|
| 938 |
+
EOS_DECLARE_FUNC(EOS_ProductUserId) EOS_LobbyDetails_GetMemberByIndex(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetMemberByIndexOptions* Options);
|
| 939 |
+
|
| 940 |
+
/**
|
| 941 |
+
* EOS_LobbyDetails_GetMemberAttributeCount is used to immediately retrieve the attribute count for members in a lobby.
|
| 942 |
+
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
| 943 |
+
*
|
| 944 |
+
* @param Options Structure containing the input parameters
|
| 945 |
+
*
|
| 946 |
+
* @return the number of attributes associated with a given lobby member or 0 if that member is invalid
|
| 947 |
+
*
|
| 948 |
+
* @see EOS_LobbyDetails_GetMemberCount
|
| 949 |
+
* @see EOS_LobbyDetails_GetMemberAttributeCountOptions
|
| 950 |
+
*/
|
| 951 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_LobbyDetails_GetMemberAttributeCount(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_GetMemberAttributeCountOptions* Options);
|
| 952 |
+
|
| 953 |
+
/**
|
| 954 |
+
* EOS_LobbyDetails_CopyMemberAttributeByIndex is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.
|
| 955 |
+
* 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.
|
| 956 |
+
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
| 957 |
+
*
|
| 958 |
+
* @param Options Structure containing the input parameters
|
| 959 |
+
* @param OutAttribute Out parameter used to receive the EOS_Lobby_Attribute structure.
|
| 960 |
+
*
|
| 961 |
+
* @return EOS_EResult containing the result of the operation.
|
| 962 |
+
* Possible result codes:
|
| 963 |
+
* - EOS_Success if the information is available and passed out in OutAttribute
|
| 964 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 965 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 966 |
+
*
|
| 967 |
+
* @see EOS_Lobby_Attribute
|
| 968 |
+
* @see EOS_LobbyDetails_CopyMemberAttributeByIndexOptions
|
| 969 |
+
* @see EOS_Lobby_Attribute_Release
|
| 970 |
+
*/
|
| 971 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyMemberAttributeByIndex(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyMemberAttributeByIndexOptions* Options, EOS_Lobby_Attribute ** OutAttribute);
|
| 972 |
+
|
| 973 |
+
/**
|
| 974 |
+
* EOS_LobbyDetails_CopyMemberAttributeByKey is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.
|
| 975 |
+
* 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.
|
| 976 |
+
* Note: this information is only available if you are actively in the lobby. It is not available for search results.
|
| 977 |
+
*
|
| 978 |
+
* @param Options Structure containing the input parameters
|
| 979 |
+
* @param OutAttribute Out parameter used to receive the EOS_Lobby_Attribute structure.
|
| 980 |
+
*
|
| 981 |
+
* @return EOS_EResult containing the result of the operation.
|
| 982 |
+
* Possible result codes:
|
| 983 |
+
* - EOS_Success if the information is available and passed out in OutAttribute
|
| 984 |
+
* - EOS_InvalidParameters if you pass a null pointer for the out parameter
|
| 985 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 986 |
+
*
|
| 987 |
+
* @see EOS_Lobby_Attribute
|
| 988 |
+
* @see EOS_LobbyDetails_CopyMemberAttributeByKeyOptions
|
| 989 |
+
* @see EOS_Lobby_Attribute_Release
|
| 990 |
+
*/
|
| 991 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbyDetails_CopyMemberAttributeByKey(EOS_HLobbyDetails Handle, const EOS_LobbyDetails_CopyMemberAttributeByKeyOptions* Options, EOS_Lobby_Attribute ** OutAttribute);
|
| 992 |
+
|
| 993 |
+
#include "eos_lobby_types.h"
|
| 994 |
+
|
| 995 |
+
/**
|
| 996 |
+
* Class responsible for the creation, setup, and execution of a search query.
|
| 997 |
+
* Search parameters are defined, the query is executed and the search results are returned within this object
|
| 998 |
+
*/
|
| 999 |
+
|
| 1000 |
+
/**
|
| 1001 |
+
* Find lobbies matching the search criteria setup via this lobby search handle.
|
| 1002 |
+
* When the operation completes, this handle will have the search results that can be parsed
|
| 1003 |
+
*
|
| 1004 |
+
* @param Options Structure containing information about the search criteria to use
|
| 1005 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 1006 |
+
* @param CompletionDelegate A callback that is fired when the search operation completes, either successfully or in error
|
| 1007 |
+
*
|
| 1008 |
+
* @see EOS_LobbySearch_FindOptions
|
| 1009 |
+
* @see EOS_LobbySearch_OnFindCallback
|
| 1010 |
+
*/
|
| 1011 |
+
EOS_DECLARE_FUNC(void) EOS_LobbySearch_Find(EOS_HLobbySearch Handle, const EOS_LobbySearch_FindOptions* Options, void* ClientData, const EOS_LobbySearch_OnFindCallback CompletionDelegate);
|
| 1012 |
+
|
| 1013 |
+
/**
|
| 1014 |
+
* 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
|
| 1015 |
+
*
|
| 1016 |
+
* @param Options A specific lobby ID for which to search
|
| 1017 |
+
*
|
| 1018 |
+
* @return EOS_EResult containing the result of the operation.
|
| 1019 |
+
* Possible result codes:
|
| 1020 |
+
* - EOS_Success if setting this lobby ID was successful
|
| 1021 |
+
* - EOS_InvalidParameters if the lobby ID is invalid or null
|
| 1022 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 1023 |
+
*
|
| 1024 |
+
* @see EOS_LobbySearch_SetLobbyIdOptions
|
| 1025 |
+
*/
|
| 1026 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_SetLobbyId(EOS_HLobbySearch Handle, const EOS_LobbySearch_SetLobbyIdOptions* Options);
|
| 1027 |
+
|
| 1028 |
+
/**
|
| 1029 |
+
* Set a target user ID to find. Setting LobbyId or SearchParameters will result in EOS_LobbySearch_Find failing
|
| 1030 |
+
* @note a search result will only be found if this user is in a public lobby
|
| 1031 |
+
*
|
| 1032 |
+
* @param Options a specific target user ID to find
|
| 1033 |
+
*
|
| 1034 |
+
* @return EOS_EResult containing the result of the operation.
|
| 1035 |
+
* Possible result codes:
|
| 1036 |
+
* - EOS_Success if setting this target user ID was successful
|
| 1037 |
+
* - EOS_InvalidParameters if the target user ID is invalid or null
|
| 1038 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 1039 |
+
*
|
| 1040 |
+
* @see EOS_LobbySearch_SetTargetUserIdOptions
|
| 1041 |
+
*/
|
| 1042 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_SetTargetUserId(EOS_HLobbySearch Handle, const EOS_LobbySearch_SetTargetUserIdOptions* Options);
|
| 1043 |
+
|
| 1044 |
+
/**
|
| 1045 |
+
* 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
|
| 1046 |
+
*
|
| 1047 |
+
* @param Options a search parameter and its comparison op
|
| 1048 |
+
*
|
| 1049 |
+
* @return EOS_EResult containing the result of the operation.
|
| 1050 |
+
* Possible result codes:
|
| 1051 |
+
* - EOS_Success if setting this search parameter was successful
|
| 1052 |
+
* - EOS_InvalidParameters if the search criteria is invalid or null
|
| 1053 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 1054 |
+
*
|
| 1055 |
+
* @see EOS_LobbySearch_SetParameterOptions
|
| 1056 |
+
* @see EOS_Lobby_AttributeData
|
| 1057 |
+
* @see EOS_EComparisonOp
|
| 1058 |
+
*/
|
| 1059 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_SetParameter(EOS_HLobbySearch Handle, const EOS_LobbySearch_SetParameterOptions* Options);
|
| 1060 |
+
|
| 1061 |
+
/**
|
| 1062 |
+
* Remove a parameter from the array of search criteria.
|
| 1063 |
+
*
|
| 1064 |
+
* @params Options a search parameter key name to remove
|
| 1065 |
+
*
|
| 1066 |
+
* @return EOS_EResult containing the result of the operation.
|
| 1067 |
+
* Possible result codes:
|
| 1068 |
+
* - EOS_Success if removing this search parameter was successful
|
| 1069 |
+
* - EOS_InvalidParameters if the search key is invalid or null
|
| 1070 |
+
* - EOS_NotFound if the parameter was not a part of the search criteria
|
| 1071 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 1072 |
+
*
|
| 1073 |
+
* @see EOS_LobbySearch_RemoveParameterOptions
|
| 1074 |
+
*/
|
| 1075 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_RemoveParameter(EOS_HLobbySearch Handle, const EOS_LobbySearch_RemoveParameterOptions* Options);
|
| 1076 |
+
|
| 1077 |
+
/**
|
| 1078 |
+
* Set the maximum number of search results to return in the query, can't be more than EOS_LOBBY_MAX_SEARCH_RESULTS
|
| 1079 |
+
*
|
| 1080 |
+
* @param Options maximum number of search results to return in the query
|
| 1081 |
+
*
|
| 1082 |
+
* @return EOS_EResult containing the result of the operation.
|
| 1083 |
+
* Possible result codes:
|
| 1084 |
+
* - EOS_Success if setting the max results was successful
|
| 1085 |
+
* - EOS_InvalidParameters if the number of results requested is invalid
|
| 1086 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 1087 |
+
*
|
| 1088 |
+
* @see EOS_LobbySearch_SetMaxResultsOptions
|
| 1089 |
+
*/
|
| 1090 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_SetMaxResults(EOS_HLobbySearch Handle, const EOS_LobbySearch_SetMaxResultsOptions* Options);
|
| 1091 |
+
|
| 1092 |
+
/**
|
| 1093 |
+
* Get the number of search results found by the search parameters in this search
|
| 1094 |
+
*
|
| 1095 |
+
* @param Options Options associated with the search count
|
| 1096 |
+
*
|
| 1097 |
+
* @return return the number of search results found by the query or 0 if search is not complete
|
| 1098 |
+
*
|
| 1099 |
+
* @see EOS_LobbySearch_GetSearchResultCountOptions
|
| 1100 |
+
*/
|
| 1101 |
+
EOS_DECLARE_FUNC(uint32_t) EOS_LobbySearch_GetSearchResultCount(EOS_HLobbySearch Handle, const EOS_LobbySearch_GetSearchResultCountOptions* Options);
|
| 1102 |
+
|
| 1103 |
+
/**
|
| 1104 |
+
* EOS_LobbySearch_CopySearchResultByIndex is used to immediately retrieve a handle to the lobby information from a given search result.
|
| 1105 |
+
* 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.
|
| 1106 |
+
*
|
| 1107 |
+
* @param Options Structure containing the input parameters
|
| 1108 |
+
* @param OutLobbyDetailsHandle out parameter used to receive the lobby details handle
|
| 1109 |
+
*
|
| 1110 |
+
* @return EOS_EResult containing the result of the operation.
|
| 1111 |
+
* Possible result codes:
|
| 1112 |
+
* - EOS_Success if the information is available and passed out in OutLobbyDetailsHandle
|
| 1113 |
+
* - EOS_InvalidParameters if you pass an invalid index or a null pointer for the out parameter
|
| 1114 |
+
* - EOS_IncompatibleVersion if the API version passed in is incorrect
|
| 1115 |
+
*
|
| 1116 |
+
* @see EOS_LobbySearch_CopySearchResultByIndexOptions
|
| 1117 |
+
* @see EOS_HLobbyDetails
|
| 1118 |
+
* @see EOS_LobbyDetails_Release
|
| 1119 |
+
*/
|
| 1120 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_LobbySearch_CopySearchResultByIndex(EOS_HLobbySearch Handle, const EOS_LobbySearch_CopySearchResultByIndexOptions* Options, EOS_HLobbyDetails* OutLobbyDetailsHandle);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_lobby_types.h
ADDED
|
@@ -0,0 +1,1827 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
#include "eos_ui_types.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
/** Handle to the lobby interface */
|
| 10 |
+
EOS_EXTERN_C typedef struct EOS_LobbyHandle* EOS_HLobby;
|
| 11 |
+
/** Handle to a lobby modification object */
|
| 12 |
+
EOS_EXTERN_C typedef struct EOS_LobbyModificationHandle* EOS_HLobbyModification;
|
| 13 |
+
/** Handle to a single lobby */
|
| 14 |
+
EOS_EXTERN_C typedef struct EOS_LobbyDetailsHandle* EOS_HLobbyDetails;
|
| 15 |
+
/** Handle to the calls responsible for creating a search object */
|
| 16 |
+
EOS_EXTERN_C typedef struct EOS_LobbySearchHandle* EOS_HLobbySearch;
|
| 17 |
+
|
| 18 |
+
/**
|
| 19 |
+
* Release the memory associated with a lobby modification. This must be called on data retrieved from EOS_Lobby_UpdateLobbyModification.
|
| 20 |
+
*
|
| 21 |
+
* @param LobbyModificationHandle - The lobby modification handle to release
|
| 22 |
+
*
|
| 23 |
+
* @see EOS_Lobby_UpdateLobbyModification
|
| 24 |
+
*/
|
| 25 |
+
EOS_DECLARE_FUNC(void) EOS_LobbyModification_Release(EOS_HLobbyModification LobbyModificationHandle);
|
| 26 |
+
|
| 27 |
+
/**
|
| 28 |
+
* Release the memory associated with a single lobby. This must be called on data retrieved from EOS_LobbySearch_CopySearchResultByIndex.
|
| 29 |
+
*
|
| 30 |
+
* @param LobbyHandle - The lobby handle to release
|
| 31 |
+
*
|
| 32 |
+
* @see EOS_LobbySearch_CopySearchResultByIndex
|
| 33 |
+
*/
|
| 34 |
+
EOS_DECLARE_FUNC(void) EOS_LobbyDetails_Release(EOS_HLobbyDetails LobbyHandle);
|
| 35 |
+
|
| 36 |
+
/**
|
| 37 |
+
* Release the memory associated with a lobby search. This must be called on data retrieved from EOS_Lobby_CreateLobbySearch.
|
| 38 |
+
*
|
| 39 |
+
* @param LobbySearchHandle - The lobby search handle to release
|
| 40 |
+
*
|
| 41 |
+
* @see EOS_Lobby_CreateLobbySearch
|
| 42 |
+
*/
|
| 43 |
+
EOS_DECLARE_FUNC(void) EOS_LobbySearch_Release(EOS_HLobbySearch LobbySearchHandle);
|
| 44 |
+
|
| 45 |
+
/** All lobbies are referenced by a unique lobby ID */
|
| 46 |
+
EOS_EXTERN_C typedef const char* EOS_LobbyId;
|
| 47 |
+
|
| 48 |
+
/** The maximum number of lobbies a single user can join at once */
|
| 49 |
+
#define EOS_LOBBY_MAX_LOBBIES 16
|
| 50 |
+
/** The maximum number of players in a lobby */
|
| 51 |
+
#define EOS_LOBBY_MAX_LOBBY_MEMBERS 64
|
| 52 |
+
/** The maximum number of search results for a query */
|
| 53 |
+
#define EOS_LOBBY_MAX_SEARCH_RESULTS 200
|
| 54 |
+
|
| 55 |
+
/** Minimum number of characters allowed in the lobby id override */
|
| 56 |
+
#define EOS_LOBBY_MIN_LOBBYIDOVERRIDE_LENGTH 4
|
| 57 |
+
/** Maximum number of characters allowed in the lobby id override */
|
| 58 |
+
#define EOS_LOBBY_MAX_LOBBYIDOVERRIDE_LENGTH 60
|
| 59 |
+
|
| 60 |
+
/** Maximum number of attributes allowed on the lobby */
|
| 61 |
+
#define EOS_LOBBYMODIFICATION_MAX_ATTRIBUTES 64
|
| 62 |
+
/** Maximum length of the name of the attribute associated with the lobby */
|
| 63 |
+
#define EOS_LOBBYMODIFICATION_MAX_ATTRIBUTE_LENGTH 64
|
| 64 |
+
|
| 65 |
+
/** Permission level gets more restrictive further down */
|
| 66 |
+
EOS_ENUM(EOS_ELobbyPermissionLevel,
|
| 67 |
+
/** Anyone can find this lobby as long as it isn't full */
|
| 68 |
+
EOS_LPL_PUBLICADVERTISED = 0,
|
| 69 |
+
/** Players who have access to presence can see this lobby */
|
| 70 |
+
EOS_LPL_JOINVIAPRESENCE = 1,
|
| 71 |
+
/** Only players with invites registered can see this lobby */
|
| 72 |
+
EOS_LPL_INVITEONLY = 2
|
| 73 |
+
);
|
| 74 |
+
|
| 75 |
+
/** Advertisement properties for a single attribute associated with a lobby */
|
| 76 |
+
EOS_ENUM(EOS_ELobbyAttributeVisibility,
|
| 77 |
+
/** Data is visible to lobby members, searchable and visible in search results. */
|
| 78 |
+
EOS_LAT_PUBLIC = 0,
|
| 79 |
+
/** Data is only visible to the user setting the data. Data is not visible to lobby members, not searchable, and not visible in search results. */
|
| 80 |
+
EOS_LAT_PRIVATE = 1
|
| 81 |
+
);
|
| 82 |
+
|
| 83 |
+
/** Various types of lobby member updates */
|
| 84 |
+
EOS_ENUM(EOS_ELobbyMemberStatus,
|
| 85 |
+
/** The user has joined the lobby */
|
| 86 |
+
EOS_LMS_JOINED = 0,
|
| 87 |
+
/** The user has explicitly left the lobby */
|
| 88 |
+
EOS_LMS_LEFT = 1,
|
| 89 |
+
/** The user has unexpectedly left the lobby */
|
| 90 |
+
EOS_LMS_DISCONNECTED = 2,
|
| 91 |
+
/** The user has been kicked from the lobby */
|
| 92 |
+
EOS_LMS_KICKED = 3,
|
| 93 |
+
/** The user has been promoted to lobby owner */
|
| 94 |
+
EOS_LMS_PROMOTED = 4,
|
| 95 |
+
/** The lobby has been closed and user has been removed */
|
| 96 |
+
EOS_LMS_CLOSED = 5
|
| 97 |
+
);
|
| 98 |
+
/** Defines the type of action to take against RTC room when joining a lobby */
|
| 99 |
+
EOS_ENUM(EOS_ELobbyRTCRoomJoinActionType,
|
| 100 |
+
/** Join RTC Room as soon as user joins the lobby */
|
| 101 |
+
EOS_LRRJAT_AutomaticJoin = 0,
|
| 102 |
+
/** Do not join RTC Room when joining the lobby. User must manually call Join RTC Room */
|
| 103 |
+
EOS_LRRJAT_ManualJoin = 1
|
| 104 |
+
);
|
| 105 |
+
|
| 106 |
+
/** The most recent version of the EOS_LobbyDetails_Info API. */
|
| 107 |
+
#define EOS_LOBBYDETAILS_INFO_API_LATEST 3
|
| 108 |
+
|
| 109 |
+
/**
|
| 110 |
+
* Contains information about a single lobby.
|
| 111 |
+
*/
|
| 112 |
+
EOS_STRUCT(EOS_LobbyDetails_Info, (
|
| 113 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_INFO_API_LATEST. */
|
| 114 |
+
int32_t ApiVersion;
|
| 115 |
+
/** Lobby ID */
|
| 116 |
+
EOS_LobbyId LobbyId;
|
| 117 |
+
/** The Product User ID of the current owner of the lobby */
|
| 118 |
+
EOS_ProductUserId LobbyOwnerUserId;
|
| 119 |
+
/** Permission level of the lobby */
|
| 120 |
+
EOS_ELobbyPermissionLevel PermissionLevel;
|
| 121 |
+
/** Current available space */
|
| 122 |
+
uint32_t AvailableSlots;
|
| 123 |
+
/** Max allowed members in the lobby */
|
| 124 |
+
uint32_t MaxMembers;
|
| 125 |
+
/** If true, users can invite others to this lobby */
|
| 126 |
+
EOS_Bool bAllowInvites;
|
| 127 |
+
/** The main indexed parameter for this lobby, can be any string (i.e. "Region:GameMode") */
|
| 128 |
+
const char* BucketId;
|
| 129 |
+
/** Is host migration allowed */
|
| 130 |
+
EOS_Bool bAllowHostMigration;
|
| 131 |
+
/** Was a Real-Time Communication (RTC) room enabled at lobby creation? */
|
| 132 |
+
EOS_Bool bRTCRoomEnabled;
|
| 133 |
+
/** Is EOS_Lobby_JoinLobbyById allowed */
|
| 134 |
+
EOS_Bool bAllowJoinById;
|
| 135 |
+
/** Does rejoining after being kicked require an invite */
|
| 136 |
+
EOS_Bool bRejoinAfterKickRequiresInvite;
|
| 137 |
+
/** If true, this lobby will be associated with the local user's presence information. */
|
| 138 |
+
EOS_Bool bPresenceEnabled;
|
| 139 |
+
/**
|
| 140 |
+
* Array of platform IDs indicating the player platforms allowed to register with the lobby. Platform IDs are
|
| 141 |
+
* found in the EOS header file (eos_common.h), for example EOS_OPT_Epic. For some platforms the value will be
|
| 142 |
+
* in the EOS Platform specific header file. If null, the lobby will be unrestricted.
|
| 143 |
+
*/
|
| 144 |
+
const uint32_t* AllowedPlatformIds;
|
| 145 |
+
/** Number of platform IDs in the array */
|
| 146 |
+
uint32_t AllowedPlatformIdsCount;
|
| 147 |
+
));
|
| 148 |
+
|
| 149 |
+
/**
|
| 150 |
+
* Release the memory associated with a lobby details info. This must be called on data retrieved from EOS_LobbyDetails_CopyInfo.
|
| 151 |
+
*
|
| 152 |
+
* @param LobbyDetailsInfo - The lobby details info to release
|
| 153 |
+
*
|
| 154 |
+
* @see EOS_LobbyDetails_CopyInfo
|
| 155 |
+
*/
|
| 156 |
+
EOS_DECLARE_FUNC(void) EOS_LobbyDetails_Info_Release(EOS_LobbyDetails_Info* LobbyDetailsInfo);
|
| 157 |
+
|
| 158 |
+
/** The most recent version of the EOS_Lobby_LocalRTCOptions structure. */
|
| 159 |
+
#define EOS_LOBBY_LOCALRTCOPTIONS_API_LATEST 2
|
| 160 |
+
|
| 161 |
+
/**
|
| 162 |
+
* Input parameters to use with Lobby RTC Rooms.
|
| 163 |
+
*/
|
| 164 |
+
EOS_STRUCT(EOS_Lobby_LocalRTCOptions, (
|
| 165 |
+
/** API Version: Set this to EOS_LOBBY_LOCALRTCOPTIONS_API_LATEST. */
|
| 166 |
+
int32_t ApiVersion;
|
| 167 |
+
/** Flags for the local user in this room. The default is 0 if this struct is not specified. @see EOS_RTC_JoinRoomOptions::Flags */
|
| 168 |
+
uint32_t Flags;
|
| 169 |
+
/**
|
| 170 |
+
* Set to EOS_TRUE to enable Manual Audio Input. If manual audio input is enabled, audio recording is not started and the audio buffers
|
| 171 |
+
* must be passed manually using EOS_RTCAudio_SendAudio. The default is EOS_FALSE if this struct is not specified.
|
| 172 |
+
*/
|
| 173 |
+
EOS_Bool bUseManualAudioInput;
|
| 174 |
+
/**
|
| 175 |
+
* Set to EOS_TRUE to enable Manual Audio Output. If manual audio output is enabled, audio rendering is not started and the audio buffers
|
| 176 |
+
* must be received with EOS_RTCAudio_AddNotifyAudioBeforeRender and rendered manually. The default is EOS_FALSE if this struct is not
|
| 177 |
+
* specified.
|
| 178 |
+
*/
|
| 179 |
+
EOS_Bool bUseManualAudioOutput;
|
| 180 |
+
/**
|
| 181 |
+
* Set to EOS_TRUE to start the audio input device's stream as muted when first connecting to the RTC room.
|
| 182 |
+
*
|
| 183 |
+
* It must be manually unmuted with a call to EOS_RTCAudio_UpdateSending. If manual audio output is enabled, this value is ignored.
|
| 184 |
+
* The default value is EOS_FALSE if this struct is not specified.
|
| 185 |
+
*/
|
| 186 |
+
EOS_Bool bLocalAudioDeviceInputStartsMuted;
|
| 187 |
+
/**
|
| 188 |
+
* Reserved field, should be nullptr by default
|
| 189 |
+
*/
|
| 190 |
+
void* Reserved;
|
| 191 |
+
));
|
| 192 |
+
|
| 193 |
+
/** The most recent version of the EOS_Lobby_CreateLobby API. */
|
| 194 |
+
#define EOS_LOBBY_CREATELOBBY_API_LATEST 10
|
| 195 |
+
|
| 196 |
+
/**
|
| 197 |
+
* Input parameters for the EOS_Lobby_CreateLobby function.
|
| 198 |
+
*/
|
| 199 |
+
EOS_STRUCT(EOS_Lobby_CreateLobbyOptions, (
|
| 200 |
+
/** API Version: Set this to EOS_LOBBY_CREATELOBBY_API_LATEST. */
|
| 201 |
+
int32_t ApiVersion;
|
| 202 |
+
/** The Product User ID of the local user creating the lobby; this user will automatically join the lobby as its owner */
|
| 203 |
+
EOS_ProductUserId LocalUserId;
|
| 204 |
+
/** The maximum number of users who can be in the lobby at a time */
|
| 205 |
+
uint32_t MaxLobbyMembers;
|
| 206 |
+
/** The initial permission level of the lobby */
|
| 207 |
+
EOS_ELobbyPermissionLevel PermissionLevel;
|
| 208 |
+
/**
|
| 209 |
+
* If true, this lobby will be associated with the local user's presence information. A user's presence can only be associated with one lobby at a time.
|
| 210 |
+
* This affects the ability of the Social Overlay to show game related actions to take in the user's social graph.
|
| 211 |
+
*
|
| 212 |
+
* @note The Social Overlay can handle only one of the following three options at a time:
|
| 213 |
+
* * using the bPresenceEnabled flags within the Sessions interface
|
| 214 |
+
* * using the bPresenceEnabled flags within the Lobby interface
|
| 215 |
+
* * using EOS_PresenceModification_SetJoinInfo
|
| 216 |
+
*
|
| 217 |
+
* @see EOS_PresenceModification_SetJoinInfoOptions
|
| 218 |
+
* @see EOS_Lobby_JoinLobbyOptions
|
| 219 |
+
* @see EOS_Lobby_JoinLobbyByIdOptions
|
| 220 |
+
* @see EOS_Sessions_CreateSessionModificationOptions
|
| 221 |
+
* @see EOS_Sessions_JoinSessionOptions
|
| 222 |
+
*/
|
| 223 |
+
EOS_Bool bPresenceEnabled;
|
| 224 |
+
/** Are members of the lobby allowed to invite others */
|
| 225 |
+
EOS_Bool bAllowInvites;
|
| 226 |
+
/** Bucket ID associated with the lobby */
|
| 227 |
+
const char* BucketId;
|
| 228 |
+
/**
|
| 229 |
+
* Is host migration allowed (will the lobby stay open if the original host leaves?)
|
| 230 |
+
* NOTE: EOS_Lobby_PromoteMember is still allowed regardless of this setting
|
| 231 |
+
*/
|
| 232 |
+
EOS_Bool bDisableHostMigration;
|
| 233 |
+
/**
|
| 234 |
+
* Creates a real-time communication (RTC) room for all members of this lobby. All members of the lobby will automatically join the RTC
|
| 235 |
+
* room when they connect to the lobby and they will automatically leave the RTC room when they leave or are removed from the lobby.
|
| 236 |
+
* While the joining and leaving of the RTC room is automatic, applications will still need to use the EOS RTC interfaces to handle all
|
| 237 |
+
* other functionality for the room.
|
| 238 |
+
*
|
| 239 |
+
* @see EOS_Lobby_GetRTCRoomName
|
| 240 |
+
* @see EOS_Lobby_AddNotifyRTCRoomConnectionChanged
|
| 241 |
+
*/
|
| 242 |
+
EOS_Bool bEnableRTCRoom;
|
| 243 |
+
/**
|
| 244 |
+
* (Optional) Allows the local application to set local audio options for the RTC Room if it is enabled. Set this to NULL if the RTC
|
| 245 |
+
* RTC room is disabled or you would like to use the defaults.
|
| 246 |
+
*/
|
| 247 |
+
const EOS_Lobby_LocalRTCOptions* LocalRTCOptions;
|
| 248 |
+
/**
|
| 249 |
+
* (Optional) Set to a globally unique value to override the backend assignment
|
| 250 |
+
* If not specified the backend service will assign one to the lobby. Do not mix and match override and non override settings.
|
| 251 |
+
* This value can be of size [EOS_LOBBY_MIN_LOBBYIDOVERRIDE_LENGTH, EOS_LOBBY_MAX_LOBBYIDOVERRIDE_LENGTH]
|
| 252 |
+
*/
|
| 253 |
+
EOS_LobbyId LobbyId;
|
| 254 |
+
/**
|
| 255 |
+
* Is EOS_Lobby_JoinLobbyById allowed.
|
| 256 |
+
* This is provided to support cases where an integrated platform's invite system is used.
|
| 257 |
+
* In these cases the game should provide the lobby ID securely to the invited player. Such as by attaching the
|
| 258 |
+
* lobby ID to the integrated platform's session data or sending the lobby ID within the invite data.
|
| 259 |
+
*/
|
| 260 |
+
EOS_Bool bEnableJoinById;
|
| 261 |
+
/**
|
| 262 |
+
* Does rejoining after being kicked require an invite?
|
| 263 |
+
* When this is set, a kicked player cannot return to the session even if the session was set with
|
| 264 |
+
* EOS_LPL_PUBLICADVERTISED. When this is set, a player with invite privileges must use EOS_Lobby_SendInvite to
|
| 265 |
+
* allow the kicked player to return to the session.
|
| 266 |
+
*/
|
| 267 |
+
EOS_Bool bRejoinAfterKickRequiresInvite;
|
| 268 |
+
/**
|
| 269 |
+
* Array of platform IDs indicating the player platforms allowed to register with the session. Platform IDs are
|
| 270 |
+
* found in the EOS header file, e.g. EOS_OPT_Epic. For some platforms, the value will be in the EOS Platform specific
|
| 271 |
+
* header file. If null, the lobby will be unrestricted.
|
| 272 |
+
*/
|
| 273 |
+
const uint32_t* AllowedPlatformIds;
|
| 274 |
+
/** Number of platform IDs in the array */
|
| 275 |
+
uint32_t AllowedPlatformIdsCount;
|
| 276 |
+
/**
|
| 277 |
+
* This value indicates whether or not the lobby owner allows crossplay interactions. If false, the lobby owner
|
| 278 |
+
* will be treated as allowing crossplay. If it is set to true, AllowedPlatformIds must have a single entry that matches
|
| 279 |
+
* the platform of the lobby owner.
|
| 280 |
+
*/
|
| 281 |
+
EOS_Bool bCrossplayOptOut;
|
| 282 |
+
/**
|
| 283 |
+
* If bEnableRTCRoom is true, this value indicates the action to take against the RTC Room when joining the lobby. This may be used
|
| 284 |
+
* to indicate the RTCRoom should be joined immediately or manually at a later time.
|
| 285 |
+
*/
|
| 286 |
+
EOS_ELobbyRTCRoomJoinActionType RTCRoomJoinActionType;
|
| 287 |
+
));
|
| 288 |
+
|
| 289 |
+
/**
|
| 290 |
+
* Output parameters for the EOS_Lobby_CreateLobby function.
|
| 291 |
+
*/
|
| 292 |
+
EOS_STRUCT(EOS_Lobby_CreateLobbyCallbackInfo, (
|
| 293 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 294 |
+
EOS_EResult ResultCode;
|
| 295 |
+
/** Context that was passed into EOS_Lobby_CreateLobby */
|
| 296 |
+
void* ClientData;
|
| 297 |
+
/** The new lobby's ID */
|
| 298 |
+
EOS_LobbyId LobbyId;
|
| 299 |
+
));
|
| 300 |
+
|
| 301 |
+
/**
|
| 302 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_CreateLobby
|
| 303 |
+
* @param Data A EOS_Lobby_CreateLobby CallbackInfo containing the output information and result
|
| 304 |
+
*/
|
| 305 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnCreateLobbyCallback, const EOS_Lobby_CreateLobbyCallbackInfo* Data);
|
| 306 |
+
|
| 307 |
+
/** The most recent version of the EOS_Lobby_DestroyLobby API. */
|
| 308 |
+
#define EOS_LOBBY_DESTROYLOBBY_API_LATEST 1
|
| 309 |
+
|
| 310 |
+
/**
|
| 311 |
+
* Input parameters for the EOS_Lobby_DestroyLobby function.
|
| 312 |
+
*/
|
| 313 |
+
EOS_STRUCT(EOS_Lobby_DestroyLobbyOptions, (
|
| 314 |
+
/** API Version: Set this to EOS_LOBBY_DESTROYLOBBY_API_LATEST. */
|
| 315 |
+
int32_t ApiVersion;
|
| 316 |
+
/** The Product User ID of the local user requesting destruction of the lobby; this user must currently own the lobby */
|
| 317 |
+
EOS_ProductUserId LocalUserId;
|
| 318 |
+
/** The ID of the lobby to destroy */
|
| 319 |
+
EOS_LobbyId LobbyId;
|
| 320 |
+
));
|
| 321 |
+
|
| 322 |
+
/**
|
| 323 |
+
* Output parameters for the EOS_Lobby_DestroyLobby function.
|
| 324 |
+
*/
|
| 325 |
+
EOS_STRUCT(EOS_Lobby_DestroyLobbyCallbackInfo, (
|
| 326 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 327 |
+
EOS_EResult ResultCode;
|
| 328 |
+
/** Context that was passed into EOS_Lobby_DestroyLobby */
|
| 329 |
+
void* ClientData;
|
| 330 |
+
/** The destroyed lobby's ID */
|
| 331 |
+
EOS_LobbyId LobbyId;
|
| 332 |
+
));
|
| 333 |
+
|
| 334 |
+
/**
|
| 335 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_DestroyLobby
|
| 336 |
+
* @param Data A EOS_Lobby_DestroyLobby CallbackInfo containing the output information and result
|
| 337 |
+
*/
|
| 338 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnDestroyLobbyCallback, const EOS_Lobby_DestroyLobbyCallbackInfo* Data);
|
| 339 |
+
|
| 340 |
+
|
| 341 |
+
/** The most recent version of the EOS_Lobby_JoinLobby API. */
|
| 342 |
+
#define EOS_LOBBY_JOINLOBBY_API_LATEST 5
|
| 343 |
+
|
| 344 |
+
/**
|
| 345 |
+
* Input parameters for the EOS_Lobby_JoinLobby function.
|
| 346 |
+
*/
|
| 347 |
+
EOS_STRUCT(EOS_Lobby_JoinLobbyOptions, (
|
| 348 |
+
/** API Version: Set this to EOS_LOBBY_JOINLOBBY_API_LATEST. */
|
| 349 |
+
int32_t ApiVersion;
|
| 350 |
+
/** The handle of the lobby to join */
|
| 351 |
+
EOS_HLobbyDetails LobbyDetailsHandle;
|
| 352 |
+
/** The Product User ID of the local user joining the lobby */
|
| 353 |
+
EOS_ProductUserId LocalUserId;
|
| 354 |
+
/**
|
| 355 |
+
* If true, this lobby will be associated with the local user's presence information. A user can only associate one lobby at a time with their presence information.
|
| 356 |
+
* This affects the ability of the Social Overlay to show game related actions to take in the user's social graph.
|
| 357 |
+
*
|
| 358 |
+
* @note The Social Overlay can handle only one of the following three options at a time:
|
| 359 |
+
* * using the bPresenceEnabled flags within the Sessions interface
|
| 360 |
+
* * using the bPresenceEnabled flags within the Lobby interface
|
| 361 |
+
* * using EOS_PresenceModification_SetJoinInfo
|
| 362 |
+
*
|
| 363 |
+
* @see EOS_PresenceModification_SetJoinInfoOptions
|
| 364 |
+
* @see EOS_Lobby_CreateLobbyOptions
|
| 365 |
+
* @see EOS_Lobby_JoinLobbyOptions
|
| 366 |
+
* @see EOS_Sessions_CreateSessionModificationOptions
|
| 367 |
+
* @see EOS_Sessions_JoinSessionOptions
|
| 368 |
+
*/
|
| 369 |
+
EOS_Bool bPresenceEnabled;
|
| 370 |
+
/**
|
| 371 |
+
* (Optional) Set this value to override the default local options for the RTC Room, if it is enabled for this lobby. Set this to NULL if
|
| 372 |
+
* your application does not use the Lobby RTC Rooms feature, or if you would like to use the default settings. This option is ignored if
|
| 373 |
+
* the specified lobby does not have an RTC Room enabled and will not cause errors.
|
| 374 |
+
*/
|
| 375 |
+
const EOS_Lobby_LocalRTCOptions* LocalRTCOptions;
|
| 376 |
+
/**
|
| 377 |
+
* This value indicates whether or not the local user allows crossplay interactions. If it is false, the local user
|
| 378 |
+
* will be treated as allowing crossplay.
|
| 379 |
+
*/
|
| 380 |
+
EOS_Bool bCrossplayOptOut;
|
| 381 |
+
/**
|
| 382 |
+
* For lobbies with the RTC Room feature enabled, this value indicates the action to take against the RTC Room when joining the lobby. This may be used
|
| 383 |
+
* to indicate the RTCRoom should be joined immediately or manually at a later time.
|
| 384 |
+
*/
|
| 385 |
+
EOS_ELobbyRTCRoomJoinActionType RTCRoomJoinActionType;
|
| 386 |
+
));
|
| 387 |
+
|
| 388 |
+
/**
|
| 389 |
+
* Output parameters for the EOS_Lobby_JoinLobby function.
|
| 390 |
+
*/
|
| 391 |
+
EOS_STRUCT(EOS_Lobby_JoinLobbyCallbackInfo, (
|
| 392 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 393 |
+
EOS_EResult ResultCode;
|
| 394 |
+
/** Context that was passed into EOS_Lobby_JoinLobby */
|
| 395 |
+
void* ClientData;
|
| 396 |
+
/** The ID of the lobby */
|
| 397 |
+
EOS_LobbyId LobbyId;
|
| 398 |
+
));
|
| 399 |
+
|
| 400 |
+
/**
|
| 401 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_JoinLobby
|
| 402 |
+
* @param Data A EOS_Lobby_JoinLobby CallbackInfo containing the output information and result
|
| 403 |
+
*/
|
| 404 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnJoinLobbyCallback, const EOS_Lobby_JoinLobbyCallbackInfo* Data);
|
| 405 |
+
|
| 406 |
+
/** The most recent version of the EOS_Lobby_JoinLobbyById API. */
|
| 407 |
+
#define EOS_LOBBY_JOINLOBBYBYID_API_LATEST 3
|
| 408 |
+
|
| 409 |
+
/**
|
| 410 |
+
* Input parameters for the EOS_Lobby_JoinLobbyById function.
|
| 411 |
+
*/
|
| 412 |
+
EOS_STRUCT(EOS_Lobby_JoinLobbyByIdOptions, (
|
| 413 |
+
/** API Version: Set this to EOS_LOBBY_JOINLOBBYBYID_API_LATEST. */
|
| 414 |
+
int32_t ApiVersion;
|
| 415 |
+
/** The ID of the lobby */
|
| 416 |
+
EOS_LobbyId LobbyId;
|
| 417 |
+
/** The Product User ID of the local user joining the lobby */
|
| 418 |
+
EOS_ProductUserId LocalUserId;
|
| 419 |
+
/** If true, this lobby will be associated with the user's presence information. A user can only associate one lobby at a time with their presence information.
|
| 420 |
+
* This affects the ability of the Social Overlay to show game related actions to take in the user's social graph.
|
| 421 |
+
*
|
| 422 |
+
* @note The Social Overlay can handle only one of the following three options at a time:
|
| 423 |
+
* * using the bPresenceEnabled flags within the Sessions interface
|
| 424 |
+
* * using the bPresenceEnabled flags within the Lobby interface
|
| 425 |
+
* * using EOS_PresenceModification_SetJoinInfo
|
| 426 |
+
*
|
| 427 |
+
* @see EOS_PresenceModification_SetJoinInfoOptions
|
| 428 |
+
* @see EOS_Lobby_CreateLobbyOptions
|
| 429 |
+
* @see EOS_Lobby_JoinLobbyOptions
|
| 430 |
+
* @see EOS_Lobby_JoinLobbyByIdOptions
|
| 431 |
+
* @see EOS_Sessions_CreateSessionModificationOptions
|
| 432 |
+
* @see EOS_Sessions_JoinSessionOptions
|
| 433 |
+
*/
|
| 434 |
+
EOS_Bool bPresenceEnabled;
|
| 435 |
+
/**
|
| 436 |
+
* (Optional) Set this value to override the default local options for the RTC Room, if it is enabled for this lobby. Set this to NULL if
|
| 437 |
+
* your application does not use the Lobby RTC Rooms feature, or if you would like to use the default settings. This option is ignored if
|
| 438 |
+
* the specified lobby does not have an RTC Room enabled and will not cause errors.
|
| 439 |
+
*/
|
| 440 |
+
const EOS_Lobby_LocalRTCOptions* LocalRTCOptions;
|
| 441 |
+
/**
|
| 442 |
+
* This value indicates whether or not the local user allows crossplay interactions. If it is false, the local user
|
| 443 |
+
* will be treated as allowing crossplay.
|
| 444 |
+
*/
|
| 445 |
+
EOS_Bool bCrossplayOptOut;
|
| 446 |
+
/**
|
| 447 |
+
* For lobbies with the RTC Room feature enabled, this value indicates the action to take against the RTC Room when joining the lobby. This may be used
|
| 448 |
+
* to indicate the RTCRoom should be joined immediately or manually at a later time.
|
| 449 |
+
*/
|
| 450 |
+
EOS_ELobbyRTCRoomJoinActionType RTCRoomJoinActionType;
|
| 451 |
+
));
|
| 452 |
+
|
| 453 |
+
/**
|
| 454 |
+
* Output parameters for the EOS_Lobby_JoinLobbyById function.
|
| 455 |
+
*/
|
| 456 |
+
EOS_STRUCT(EOS_Lobby_JoinLobbyByIdCallbackInfo, (
|
| 457 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 458 |
+
EOS_EResult ResultCode;
|
| 459 |
+
/** Context that was passed into EOS_Lobby_JoinLobbyById */
|
| 460 |
+
void* ClientData;
|
| 461 |
+
/** The ID of the lobby */
|
| 462 |
+
EOS_LobbyId LobbyId;
|
| 463 |
+
));
|
| 464 |
+
|
| 465 |
+
/**
|
| 466 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_JoinLobbyById
|
| 467 |
+
* @param Data A EOS_Lobby_JoinLobbyById CallbackInfo containing the output information and result
|
| 468 |
+
*/
|
| 469 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnJoinLobbyByIdCallback, const EOS_Lobby_JoinLobbyByIdCallbackInfo* Data);
|
| 470 |
+
|
| 471 |
+
/** The most recent version of the EOS_Lobby_LeaveLobby API. */
|
| 472 |
+
#define EOS_LOBBY_LEAVELOBBY_API_LATEST 1
|
| 473 |
+
|
| 474 |
+
/**
|
| 475 |
+
* Input parameters for the EOS_Lobby_LeaveLobby function.
|
| 476 |
+
*/
|
| 477 |
+
EOS_STRUCT(EOS_Lobby_LeaveLobbyOptions, (
|
| 478 |
+
/** API Version: Set this to EOS_LOBBY_LEAVELOBBY_API_LATEST. */
|
| 479 |
+
int32_t ApiVersion;
|
| 480 |
+
/** The Product User ID of the local user leaving the lobby */
|
| 481 |
+
EOS_ProductUserId LocalUserId;
|
| 482 |
+
/** The ID of the lobby */
|
| 483 |
+
EOS_LobbyId LobbyId;
|
| 484 |
+
));
|
| 485 |
+
|
| 486 |
+
/**
|
| 487 |
+
* Output parameters for the EOS_Lobby_LeaveLobby function.
|
| 488 |
+
*/
|
| 489 |
+
EOS_STRUCT(EOS_Lobby_LeaveLobbyCallbackInfo, (
|
| 490 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 491 |
+
EOS_EResult ResultCode;
|
| 492 |
+
/** Context that was passed into EOS_Lobby_LeaveLobby */
|
| 493 |
+
void* ClientData;
|
| 494 |
+
/** The ID of the lobby */
|
| 495 |
+
EOS_LobbyId LobbyId;
|
| 496 |
+
));
|
| 497 |
+
|
| 498 |
+
/**
|
| 499 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_LeaveLobby
|
| 500 |
+
* @param Data A EOS_Lobby_LeaveLobby CallbackInfo containing the output information and result
|
| 501 |
+
*/
|
| 502 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLeaveLobbyCallback, const EOS_Lobby_LeaveLobbyCallbackInfo* Data);
|
| 503 |
+
|
| 504 |
+
/** The most recent version of the EOS_Lobby_UpdateLobbyModification API. */
|
| 505 |
+
#define EOS_LOBBY_UPDATELOBBYMODIFICATION_API_LATEST 1
|
| 506 |
+
|
| 507 |
+
/**
|
| 508 |
+
* Input parameters for the EOS_Lobby_UpdateLobbyModification function.
|
| 509 |
+
*/
|
| 510 |
+
EOS_STRUCT(EOS_Lobby_UpdateLobbyModificationOptions, (
|
| 511 |
+
/** API Version: Set this to EOS_LOBBY_UPDATELOBBYMODIFICATION_API_LATEST. */
|
| 512 |
+
int32_t ApiVersion;
|
| 513 |
+
/** The ID of the local user making modifications. Must be the owner to modify lobby data, but any lobby member can modify their own attributes. */
|
| 514 |
+
EOS_ProductUserId LocalUserId;
|
| 515 |
+
/** The ID of the lobby */
|
| 516 |
+
EOS_LobbyId LobbyId;
|
| 517 |
+
));
|
| 518 |
+
|
| 519 |
+
/** The most recent version of the EOS_Lobby_UpdateLobby API. */
|
| 520 |
+
#define EOS_LOBBY_UPDATELOBBY_API_LATEST 1
|
| 521 |
+
|
| 522 |
+
/**
|
| 523 |
+
* Input parameters for the EOS_Lobby_UpdateLobby function.
|
| 524 |
+
*/
|
| 525 |
+
EOS_STRUCT(EOS_Lobby_UpdateLobbyOptions, (
|
| 526 |
+
/** API Version: Set this to EOS_LOBBY_UPDATELOBBY_API_LATEST. */
|
| 527 |
+
int32_t ApiVersion;
|
| 528 |
+
/** Builder handle */
|
| 529 |
+
EOS_HLobbyModification LobbyModificationHandle;
|
| 530 |
+
));
|
| 531 |
+
|
| 532 |
+
/**
|
| 533 |
+
* Output parameters for the EOS_Lobby_UpdateLobby function.
|
| 534 |
+
*/
|
| 535 |
+
EOS_STRUCT(EOS_Lobby_UpdateLobbyCallbackInfo, (
|
| 536 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 537 |
+
EOS_EResult ResultCode;
|
| 538 |
+
/** Context that was passed into EOS_Lobby_UpdateLobby */
|
| 539 |
+
void* ClientData;
|
| 540 |
+
/** The ID of the lobby */
|
| 541 |
+
EOS_LobbyId LobbyId;
|
| 542 |
+
));
|
| 543 |
+
|
| 544 |
+
/**
|
| 545 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_UpdateLobby
|
| 546 |
+
* @param Data A EOS_Lobby_UpdateLobby CallbackInfo containing the output information and result
|
| 547 |
+
*/
|
| 548 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnUpdateLobbyCallback, const EOS_Lobby_UpdateLobbyCallbackInfo* Data);
|
| 549 |
+
|
| 550 |
+
/** The most recent version of the EOS_Lobby_JoinRTCRoom API. */
|
| 551 |
+
#define EOS_LOBBY_JOINRTCROOM_API_LATEST 1
|
| 552 |
+
|
| 553 |
+
/**
|
| 554 |
+
* Input parameters for the EOS_Lobby_JoinRTCRoom function.
|
| 555 |
+
*/
|
| 556 |
+
EOS_STRUCT(EOS_Lobby_JoinRTCRoomOptions, (
|
| 557 |
+
/** API Version: Set this to EOS_LOBBY_JOINRTCROOM_API_LATEST. */
|
| 558 |
+
int32_t ApiVersion;
|
| 559 |
+
/** The ID of the lobby to join the RTC Room of */
|
| 560 |
+
EOS_LobbyId LobbyId;
|
| 561 |
+
/** The Product User ID of the local user in the lobby */
|
| 562 |
+
EOS_ProductUserId LocalUserId;
|
| 563 |
+
/**
|
| 564 |
+
* Allows the local application to set local audio options for the RTC Room if it is enabled.
|
| 565 |
+
* Only updates audio options when explicitly set; does not provide defaults.
|
| 566 |
+
*/
|
| 567 |
+
const EOS_Lobby_LocalRTCOptions* LocalRTCOptions;
|
| 568 |
+
));
|
| 569 |
+
|
| 570 |
+
/**
|
| 571 |
+
* Output parameters for the EOS_Lobby_JoinRTCRoom function.
|
| 572 |
+
*/
|
| 573 |
+
EOS_STRUCT(EOS_Lobby_JoinRTCRoomCallbackInfo, (
|
| 574 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 575 |
+
EOS_EResult ResultCode;
|
| 576 |
+
/** Context that was passed into EOS_Lobby_JoinRTCRoom */
|
| 577 |
+
void* ClientData;
|
| 578 |
+
/** The ID of the lobby */
|
| 579 |
+
EOS_LobbyId LobbyId;
|
| 580 |
+
));
|
| 581 |
+
|
| 582 |
+
/**
|
| 583 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_JoinRTCRoom
|
| 584 |
+
* @param Data A EOS_Lobby_JoinRTCRoom CallbackInfo containing the output information and result
|
| 585 |
+
*/
|
| 586 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnJoinRTCRoomCallback, const EOS_Lobby_JoinRTCRoomCallbackInfo* Data);
|
| 587 |
+
/** The most recent version of the EOS_Lobby_LeaveRTCRoom API. */
|
| 588 |
+
#define EOS_LOBBY_LEAVERTCROOM_API_LATEST 1
|
| 589 |
+
|
| 590 |
+
/**
|
| 591 |
+
* Input parameters for the EOS_Lobby_LeaveRTCRoom function.
|
| 592 |
+
*/
|
| 593 |
+
EOS_STRUCT(EOS_Lobby_LeaveRTCRoomOptions, (
|
| 594 |
+
/** API Version: Set this to EOS_LOBBY_LEAVERTCROOM_API_LATEST. */
|
| 595 |
+
int32_t ApiVersion;
|
| 596 |
+
/** The ID of the lobby owning the RTC Room to leave */
|
| 597 |
+
EOS_LobbyId LobbyId;
|
| 598 |
+
/** The Product User ID of the local user in the lobby */
|
| 599 |
+
EOS_ProductUserId LocalUserId;
|
| 600 |
+
));
|
| 601 |
+
/**
|
| 602 |
+
* Output parameters for the EOS_Lobby_LeaveRTCRoom function.
|
| 603 |
+
*/
|
| 604 |
+
EOS_STRUCT(EOS_Lobby_LeaveRTCRoomCallbackInfo, (
|
| 605 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 606 |
+
EOS_EResult ResultCode;
|
| 607 |
+
/** Context that was passed into EOS_Lobby_LeaveRTCRoom */
|
| 608 |
+
void* ClientData;
|
| 609 |
+
/** The ID of the lobby */
|
| 610 |
+
EOS_LobbyId LobbyId;
|
| 611 |
+
));
|
| 612 |
+
|
| 613 |
+
/**
|
| 614 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_LeaveRTCRoom
|
| 615 |
+
* @param Data A EOS_Lobby_LeaveRTCRoom CallbackInfo containing the output information and result
|
| 616 |
+
*/
|
| 617 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLeaveRTCRoomCallback, const EOS_Lobby_LeaveRTCRoomCallbackInfo* Data);
|
| 618 |
+
|
| 619 |
+
/** The most recent version of the EOS_Lobby_PromoteMember API. */
|
| 620 |
+
#define EOS_LOBBY_PROMOTEMEMBER_API_LATEST 1
|
| 621 |
+
|
| 622 |
+
/**
|
| 623 |
+
* Input parameters for the EOS_Lobby_PromoteMember function.
|
| 624 |
+
*/
|
| 625 |
+
EOS_STRUCT(EOS_Lobby_PromoteMemberOptions, (
|
| 626 |
+
/** API Version: Set this to EOS_LOBBY_PROMOTEMEMBER_API_LATEST. */
|
| 627 |
+
int32_t ApiVersion;
|
| 628 |
+
/** The ID of the lobby */
|
| 629 |
+
EOS_LobbyId LobbyId;
|
| 630 |
+
/** The Product User ID of the local user making the request */
|
| 631 |
+
EOS_ProductUserId LocalUserId;
|
| 632 |
+
/** The Product User ID of the member to promote to owner of the lobby */
|
| 633 |
+
EOS_ProductUserId TargetUserId;
|
| 634 |
+
));
|
| 635 |
+
|
| 636 |
+
/**
|
| 637 |
+
* Output parameters for the EOS_Lobby_PromoteMember function.
|
| 638 |
+
*/
|
| 639 |
+
EOS_STRUCT(EOS_Lobby_PromoteMemberCallbackInfo, (
|
| 640 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 641 |
+
EOS_EResult ResultCode;
|
| 642 |
+
/** Context that was passed into EOS_Lobby_PromoteMember */
|
| 643 |
+
void* ClientData;
|
| 644 |
+
/** The ID of the lobby where the user was promoted */
|
| 645 |
+
EOS_LobbyId LobbyId;
|
| 646 |
+
));
|
| 647 |
+
|
| 648 |
+
/**
|
| 649 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_PromoteMember
|
| 650 |
+
* @param Data A EOS_Lobby_PromoteMember CallbackInfo containing the output information and result
|
| 651 |
+
*/
|
| 652 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnPromoteMemberCallback, const EOS_Lobby_PromoteMemberCallbackInfo* Data);
|
| 653 |
+
|
| 654 |
+
|
| 655 |
+
/** The most recent version of the EOS_Lobby_KickMember API. */
|
| 656 |
+
#define EOS_LOBBY_KICKMEMBER_API_LATEST 1
|
| 657 |
+
|
| 658 |
+
/**
|
| 659 |
+
* Input parameters for the EOS_Lobby_KickMember function.
|
| 660 |
+
*/
|
| 661 |
+
EOS_STRUCT(EOS_Lobby_KickMemberOptions, (
|
| 662 |
+
/** API Version: Set this to EOS_LOBBY_KICKMEMBER_API_LATEST. */
|
| 663 |
+
int32_t ApiVersion;
|
| 664 |
+
/** The ID of the lobby */
|
| 665 |
+
EOS_LobbyId LobbyId;
|
| 666 |
+
/** The Product User ID of the local user requesting the removal; this user must be the lobby owner */
|
| 667 |
+
EOS_ProductUserId LocalUserId;
|
| 668 |
+
/** The Product User ID of the lobby member to remove */
|
| 669 |
+
EOS_ProductUserId TargetUserId;
|
| 670 |
+
));
|
| 671 |
+
|
| 672 |
+
/**
|
| 673 |
+
* Output parameters for the EOS_Lobby_KickMember function.
|
| 674 |
+
*/
|
| 675 |
+
EOS_STRUCT(EOS_Lobby_KickMemberCallbackInfo, (
|
| 676 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 677 |
+
EOS_EResult ResultCode;
|
| 678 |
+
/** Context that was passed into EOS_Lobby_KickMember */
|
| 679 |
+
void* ClientData;
|
| 680 |
+
/** The ID of the lobby */
|
| 681 |
+
EOS_LobbyId LobbyId;
|
| 682 |
+
));
|
| 683 |
+
|
| 684 |
+
/**
|
| 685 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_KickMember
|
| 686 |
+
* @param Data A EOS_Lobby_KickMember CallbackInfo containing the output information and result
|
| 687 |
+
*/
|
| 688 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnKickMemberCallback, const EOS_Lobby_KickMemberCallbackInfo* Data);
|
| 689 |
+
|
| 690 |
+
/** The most recent version of the EOS_Lobby_HardMuteMember API. */
|
| 691 |
+
#define EOS_LOBBY_HARDMUTEMEMBER_API_LATEST 1
|
| 692 |
+
|
| 693 |
+
/**
|
| 694 |
+
* Input parameters for the EOS_Lobby_HardMuteMember function.
|
| 695 |
+
*/
|
| 696 |
+
EOS_STRUCT(EOS_Lobby_HardMuteMemberOptions, (
|
| 697 |
+
/** API Version: Set this to EOS_LOBBY_HARDMUTEMEMBER_API_LATEST. */
|
| 698 |
+
int32_t ApiVersion;
|
| 699 |
+
/** The ID of the lobby */
|
| 700 |
+
EOS_LobbyId LobbyId;
|
| 701 |
+
/** The Product User ID of the local user requesting the hard mute; this user must be the lobby owner */
|
| 702 |
+
EOS_ProductUserId LocalUserId;
|
| 703 |
+
/** The Product User ID of the lobby member to hard mute */
|
| 704 |
+
EOS_ProductUserId TargetUserId;
|
| 705 |
+
/** TargetUserId hard mute status (mute on or off) */
|
| 706 |
+
EOS_Bool bHardMute;
|
| 707 |
+
));
|
| 708 |
+
|
| 709 |
+
/**
|
| 710 |
+
* Output parameters for the EOS_Lobby_HardMuteMember function.
|
| 711 |
+
*/
|
| 712 |
+
EOS_STRUCT(EOS_Lobby_HardMuteMemberCallbackInfo, (
|
| 713 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 714 |
+
EOS_EResult ResultCode;
|
| 715 |
+
/** Context that was passed into EOS_Lobby_HardMuteMember */
|
| 716 |
+
void* ClientData;
|
| 717 |
+
/** The ID of the lobby */
|
| 718 |
+
EOS_LobbyId LobbyId;
|
| 719 |
+
/** The Product User ID of the lobby member whose mute status has been updated */
|
| 720 |
+
EOS_ProductUserId TargetUserId;
|
| 721 |
+
));
|
| 722 |
+
|
| 723 |
+
/**
|
| 724 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_HardMuteMember
|
| 725 |
+
* @param Data A EOS_Lobby_HardMuteMember CallbackInfo containing the output information and result
|
| 726 |
+
*/
|
| 727 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnHardMuteMemberCallback, const EOS_Lobby_HardMuteMemberCallbackInfo* Data);
|
| 728 |
+
|
| 729 |
+
/** The most recent version of the EOS_Lobby_AddNotifyLobbyUpdateReceived API. */
|
| 730 |
+
#define EOS_LOBBY_ADDNOTIFYLOBBYUPDATERECEIVED_API_LATEST 1
|
| 731 |
+
|
| 732 |
+
/**
|
| 733 |
+
* Input parameters for the EOS_Lobby_AddNotifyLobbyUpdateReceived function.
|
| 734 |
+
*/
|
| 735 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyLobbyUpdateReceivedOptions, (
|
| 736 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYLOBBYUPDATERECEIVED_API_LATEST. */
|
| 737 |
+
int32_t ApiVersion;
|
| 738 |
+
));
|
| 739 |
+
|
| 740 |
+
/**
|
| 741 |
+
* Output parameters for the EOS_Lobby_OnLobbyUpdateReceivedCallback Function.
|
| 742 |
+
*/
|
| 743 |
+
EOS_STRUCT(EOS_Lobby_LobbyUpdateReceivedCallbackInfo, (
|
| 744 |
+
/** Context that was passed into EOS_Lobby_AddNotifyLobbyUpdateReceived */
|
| 745 |
+
void* ClientData;
|
| 746 |
+
/** The ID of the lobby */
|
| 747 |
+
EOS_LobbyId LobbyId;
|
| 748 |
+
));
|
| 749 |
+
|
| 750 |
+
/**
|
| 751 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyLobbyUpdateReceived
|
| 752 |
+
*
|
| 753 |
+
* @param Data A EOS_Lobby_LobbyUpdateReceivedCallbackInfo containing the output information and result
|
| 754 |
+
*/
|
| 755 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLobbyUpdateReceivedCallback, const EOS_Lobby_LobbyUpdateReceivedCallbackInfo* Data);
|
| 756 |
+
|
| 757 |
+
/** The most recent version of the EOS_Lobby_AddNotifyLobbyMemberUpdateReceived API. */
|
| 758 |
+
#define EOS_LOBBY_ADDNOTIFYLOBBYMEMBERUPDATERECEIVED_API_LATEST 1
|
| 759 |
+
|
| 760 |
+
/**
|
| 761 |
+
* Input parameters for the EOS_Lobby_AddNotifyLobbyMemberUpdateReceived function.
|
| 762 |
+
*/
|
| 763 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyLobbyMemberUpdateReceivedOptions, (
|
| 764 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYLOBBYMEMBERUPDATERECEIVED_API_LATEST. */
|
| 765 |
+
int32_t ApiVersion;
|
| 766 |
+
));
|
| 767 |
+
|
| 768 |
+
/**
|
| 769 |
+
* Output parameters for the EOS_Lobby_OnLobbyMemberUpdateReceivedCallback Function.
|
| 770 |
+
*/
|
| 771 |
+
EOS_STRUCT(EOS_Lobby_LobbyMemberUpdateReceivedCallbackInfo, (
|
| 772 |
+
/** Context that was passed into EOS_Lobby_AddNotifyLobbyMemberUpdateReceived */
|
| 773 |
+
void* ClientData;
|
| 774 |
+
/** The ID of the lobby */
|
| 775 |
+
EOS_LobbyId LobbyId;
|
| 776 |
+
/** The Product User ID of the lobby member */
|
| 777 |
+
EOS_ProductUserId TargetUserId;
|
| 778 |
+
));
|
| 779 |
+
|
| 780 |
+
/**
|
| 781 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyLobbyMemberUpdateReceived
|
| 782 |
+
*
|
| 783 |
+
* @param Data A EOS_Lobby_LobbyMemberUpdateReceivedCallbackInfo containing the output information and result
|
| 784 |
+
*/
|
| 785 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLobbyMemberUpdateReceivedCallback, const EOS_Lobby_LobbyMemberUpdateReceivedCallbackInfo* Data);
|
| 786 |
+
|
| 787 |
+
/** The most recent version of the EOS_Lobby_AddNotifyLobbyMemberStatusReceived API. */
|
| 788 |
+
#define EOS_LOBBY_ADDNOTIFYLOBBYMEMBERSTATUSRECEIVED_API_LATEST 1
|
| 789 |
+
|
| 790 |
+
/**
|
| 791 |
+
* Input parameters for the EOS_Lobby_AddNotifyLobbyMemberStatusReceived function.
|
| 792 |
+
*/
|
| 793 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyLobbyMemberStatusReceivedOptions, (
|
| 794 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYLOBBYMEMBERSTATUSRECEIVED_API_LATEST. */
|
| 795 |
+
int32_t ApiVersion;
|
| 796 |
+
));
|
| 797 |
+
|
| 798 |
+
/**
|
| 799 |
+
* Output parameters for the EOS_Lobby_AddNotifyLobbyMemberStatusReceived function.
|
| 800 |
+
*/
|
| 801 |
+
EOS_STRUCT(EOS_Lobby_LobbyMemberStatusReceivedCallbackInfo, (
|
| 802 |
+
/** Context that was passed into EOS_Lobby_AddNotifyLobbyMemberStatusReceived */
|
| 803 |
+
void* ClientData;
|
| 804 |
+
/** The ID of the lobby */
|
| 805 |
+
EOS_LobbyId LobbyId;
|
| 806 |
+
/** The Product User ID of the lobby member */
|
| 807 |
+
EOS_ProductUserId TargetUserId;
|
| 808 |
+
/** Latest status of the user */
|
| 809 |
+
EOS_ELobbyMemberStatus CurrentStatus;
|
| 810 |
+
));
|
| 811 |
+
|
| 812 |
+
/**
|
| 813 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_AddNotifyLobbyMemberStatusReceived
|
| 814 |
+
* @param Data A EOS_Lobby_LobbyMemberStatusReceivedCallbackInfo CallbackInfo containing the output information and result
|
| 815 |
+
*/
|
| 816 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLobbyMemberStatusReceivedCallback, const EOS_Lobby_LobbyMemberStatusReceivedCallbackInfo* Data);
|
| 817 |
+
|
| 818 |
+
/** Max length of an invite ID */
|
| 819 |
+
#define EOS_LOBBY_INVITEID_MAX_LENGTH 64
|
| 820 |
+
|
| 821 |
+
/** The most recent version of the EOS_Lobby_AddNotifyLobbyInviteReceived API. */
|
| 822 |
+
#define EOS_LOBBY_ADDNOTIFYLOBBYINVITERECEIVED_API_LATEST 1
|
| 823 |
+
|
| 824 |
+
/**
|
| 825 |
+
* Input parameters for the EOS_Lobby_AddNotifyLobbyInviteReceived function.
|
| 826 |
+
*/
|
| 827 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyLobbyInviteReceivedOptions, (
|
| 828 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYLOBBYINVITERECEIVED_API_LATEST. */
|
| 829 |
+
int32_t ApiVersion;
|
| 830 |
+
));
|
| 831 |
+
|
| 832 |
+
/**
|
| 833 |
+
* Output parameters for the EOS_Lobby_OnLobbyInviteReceivedCallback Function.
|
| 834 |
+
*/
|
| 835 |
+
EOS_STRUCT(EOS_Lobby_LobbyInviteReceivedCallbackInfo, (
|
| 836 |
+
/** Context that was passed into EOS_Lobby_AddNotifyLobbyInviteReceived */
|
| 837 |
+
void* ClientData;
|
| 838 |
+
/** The ID of the invitation */
|
| 839 |
+
const char* InviteId;
|
| 840 |
+
/** The Product User ID of the local user who received the invitation */
|
| 841 |
+
EOS_ProductUserId LocalUserId;
|
| 842 |
+
/** The Product User ID of the user who sent the invitation */
|
| 843 |
+
EOS_ProductUserId TargetUserId;
|
| 844 |
+
));
|
| 845 |
+
|
| 846 |
+
/**
|
| 847 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyLobbyInviteReceived
|
| 848 |
+
*
|
| 849 |
+
* @param Data A EOS_Lobby_LobbyInviteReceivedCallbackInfo containing the output information and result
|
| 850 |
+
*/
|
| 851 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLobbyInviteReceivedCallback, const EOS_Lobby_LobbyInviteReceivedCallbackInfo* Data);
|
| 852 |
+
|
| 853 |
+
/** The most recent version of the EOS_Lobby_AddNotifyLobbyInviteAccepted API. */
|
| 854 |
+
#define EOS_LOBBY_ADDNOTIFYLOBBYINVITEACCEPTED_API_LATEST 1
|
| 855 |
+
|
| 856 |
+
/**
|
| 857 |
+
* Input parameters for the EOS_Lobby_AddNotifyLobbyInviteAccepted function.
|
| 858 |
+
*/
|
| 859 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyLobbyInviteAcceptedOptions, (
|
| 860 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYLOBBYINVITEACCEPTED_API_LATEST. */
|
| 861 |
+
int32_t ApiVersion;
|
| 862 |
+
));
|
| 863 |
+
|
| 864 |
+
/**
|
| 865 |
+
* Output parameters for the EOS_Lobby_OnLobbyInviteAcceptedCallback Function.
|
| 866 |
+
*/
|
| 867 |
+
EOS_STRUCT(EOS_Lobby_LobbyInviteAcceptedCallbackInfo, (
|
| 868 |
+
/** Context that was passed into EOS_Lobby_AddNotifyLobbyInviteAccepted */
|
| 869 |
+
void* ClientData;
|
| 870 |
+
/** The invite ID */
|
| 871 |
+
const char* InviteId;
|
| 872 |
+
/** The Product User ID of the local user who received the invitation */
|
| 873 |
+
EOS_ProductUserId LocalUserId;
|
| 874 |
+
/** The Product User ID of the user who sent the invitation */
|
| 875 |
+
EOS_ProductUserId TargetUserId;
|
| 876 |
+
/** Lobby ID that the user has been invited to */
|
| 877 |
+
EOS_LobbyId LobbyId;
|
| 878 |
+
));
|
| 879 |
+
|
| 880 |
+
/**
|
| 881 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyLobbyInviteAccepted
|
| 882 |
+
*
|
| 883 |
+
* @param Data A EOS_Lobby_LobbyInviteAcceptedCallbackInfo containing the output information and result
|
| 884 |
+
*/
|
| 885 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLobbyInviteAcceptedCallback, const EOS_Lobby_LobbyInviteAcceptedCallbackInfo* Data);
|
| 886 |
+
|
| 887 |
+
/** The most recent version of the EOS_Lobby_AddNotifyJoinLobbyAccepted API. */
|
| 888 |
+
#define EOS_LOBBY_ADDNOTIFYJOINLOBBYACCEPTED_API_LATEST 1
|
| 889 |
+
|
| 890 |
+
/**
|
| 891 |
+
* Input parameters for the EOS_Lobby_AddNotifyJoinLobbyAccepted function.
|
| 892 |
+
*/
|
| 893 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyJoinLobbyAcceptedOptions, (
|
| 894 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYJOINLOBBYACCEPTED_API_LATEST. */
|
| 895 |
+
int32_t ApiVersion;
|
| 896 |
+
));
|
| 897 |
+
|
| 898 |
+
/** The most recent version of the EOS_Lobby_AddNotifyLobbyInviteRejected API. */
|
| 899 |
+
#define EOS_LOBBY_ADDNOTIFYLOBBYINVITEREJECTED_API_LATEST 1
|
| 900 |
+
|
| 901 |
+
/**
|
| 902 |
+
* Input parameters for the EOS_Lobby_AddNotifyLobbyInviteRejected function.
|
| 903 |
+
*/
|
| 904 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyLobbyInviteRejectedOptions, (
|
| 905 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYLOBBYINVITEREJECTED_API_LATEST. */
|
| 906 |
+
int32_t ApiVersion;
|
| 907 |
+
));
|
| 908 |
+
|
| 909 |
+
/**
|
| 910 |
+
* Output parameters for the EOS_Lobby_OnLobbyInviteRejectedCallback Function.
|
| 911 |
+
*/
|
| 912 |
+
EOS_STRUCT(EOS_Lobby_LobbyInviteRejectedCallbackInfo, (
|
| 913 |
+
/** Context that was passed into EOS_Lobby_AddNotifyLobbyInviteRejected */
|
| 914 |
+
void* ClientData;
|
| 915 |
+
/** The invite ID */
|
| 916 |
+
const char* InviteId;
|
| 917 |
+
/** The Product User ID of the local user who received the invitation */
|
| 918 |
+
EOS_ProductUserId LocalUserId;
|
| 919 |
+
/** The Product User ID of the user who sent the invitation */
|
| 920 |
+
EOS_ProductUserId TargetUserId;
|
| 921 |
+
/** Lobby ID that the user has been invited to */
|
| 922 |
+
EOS_LobbyId LobbyId;
|
| 923 |
+
));
|
| 924 |
+
|
| 925 |
+
/**
|
| 926 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyLobbyInviteRejected
|
| 927 |
+
*
|
| 928 |
+
* @param Data A EOS_Lobby_LobbyInviteRejectedCallbackInfo containing the output information and result
|
| 929 |
+
*/
|
| 930 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLobbyInviteRejectedCallback, const EOS_Lobby_LobbyInviteRejectedCallbackInfo* Data);
|
| 931 |
+
|
| 932 |
+
/**
|
| 933 |
+
* Output parameters for the EOS_Lobby_OnJoinLobbyAcceptedCallback Function.
|
| 934 |
+
*/
|
| 935 |
+
EOS_STRUCT(EOS_Lobby_JoinLobbyAcceptedCallbackInfo, (
|
| 936 |
+
/** Context that was passed into EOS_Lobby_AddNotifyJoinLobbyAccepted */
|
| 937 |
+
void* ClientData;
|
| 938 |
+
/** The Product User ID of the local user who is joining */
|
| 939 |
+
EOS_ProductUserId LocalUserId;
|
| 940 |
+
/**
|
| 941 |
+
* The UI Event associated with this Join Game event.
|
| 942 |
+
* This should be used with EOS_Lobby_CopyLobbyDetailsHandleByUiEventId to get a handle to be used
|
| 943 |
+
* when calling EOS_Lobby_JoinLobby.
|
| 944 |
+
*/
|
| 945 |
+
EOS_UI_EventId UiEventId;
|
| 946 |
+
));
|
| 947 |
+
|
| 948 |
+
/**
|
| 949 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyJoinLobbyAccepted
|
| 950 |
+
*
|
| 951 |
+
* @param Data A EOS_Lobby_JoinLobbyAcceptedCallbackInfo containing the output information and result
|
| 952 |
+
*
|
| 953 |
+
* @note The lobby for the join game must be joined.
|
| 954 |
+
*
|
| 955 |
+
* @see EOS_Lobby_CopyLobbyDetailsHandleByUiEventId
|
| 956 |
+
* @see EOS_Lobby_JoinLobby
|
| 957 |
+
*/
|
| 958 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnJoinLobbyAcceptedCallback, const EOS_Lobby_JoinLobbyAcceptedCallbackInfo* Data);
|
| 959 |
+
|
| 960 |
+
/** The most recent version of the EOS_Lobby_AddNotifySendLobbyNativeInviteRequested API. */
|
| 961 |
+
#define EOS_LOBBY_ADDNOTIFYSENDLOBBYNATIVEINVITEREQUESTED_API_LATEST 1
|
| 962 |
+
|
| 963 |
+
/**
|
| 964 |
+
* Input parameters for the EOS_Lobby_AddNotifySendLobbyNativeInviteRequested function.
|
| 965 |
+
*/
|
| 966 |
+
EOS_STRUCT(EOS_Lobby_AddNotifySendLobbyNativeInviteRequestedOptions, (
|
| 967 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYSENDLOBBYNATIVEINVITEREQUESTED_API_LATEST. */
|
| 968 |
+
int32_t ApiVersion;
|
| 969 |
+
));
|
| 970 |
+
|
| 971 |
+
/**
|
| 972 |
+
* Output parameters for the EOS_Lobby_OnSendLobbyNativeInviteRequestedCallback Function.
|
| 973 |
+
*/
|
| 974 |
+
EOS_STRUCT(EOS_Lobby_SendLobbyNativeInviteRequestedCallbackInfo, (
|
| 975 |
+
/** Context that was passed into EOS_Lobby_AddNotifySendLobbyNativeInviteRequested */
|
| 976 |
+
void* ClientData;
|
| 977 |
+
/**
|
| 978 |
+
* Identifies this event which will need to be acknowledged with EOS_UI_AcknowledgeEventId().
|
| 979 |
+
* @see EOS_UI_AcknowledgeEventId
|
| 980 |
+
*/
|
| 981 |
+
EOS_UI_EventId UiEventId;
|
| 982 |
+
/** The Product User ID of the local user who is inviting. */
|
| 983 |
+
EOS_ProductUserId LocalUserId;
|
| 984 |
+
/**
|
| 985 |
+
* The Native Platform Account Type. If only a single integrated platform is configured then
|
| 986 |
+
* this will always reference that platform.
|
| 987 |
+
*/
|
| 988 |
+
EOS_IntegratedPlatformType TargetNativeAccountType;
|
| 989 |
+
/** The Native Platform Account ID of the target user being invited. */
|
| 990 |
+
const char* TargetUserNativeAccountId;
|
| 991 |
+
/** Lobby ID that the user is being invited to */
|
| 992 |
+
EOS_LobbyId LobbyId;
|
| 993 |
+
));
|
| 994 |
+
|
| 995 |
+
/**
|
| 996 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifySendLobbyNativeInviteRequested
|
| 997 |
+
*
|
| 998 |
+
* @param Data A EOS_Lobby_SendLobbyNativeInviteRequestedCallbackInfo containing the output information and result
|
| 999 |
+
*
|
| 1000 |
+
* @note After processing the callback EOS_UI_AcknowledgeEventId must be called.
|
| 1001 |
+
*
|
| 1002 |
+
* @see EOS_UI_AcknowledgeEventId
|
| 1003 |
+
*/
|
| 1004 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnSendLobbyNativeInviteRequestedCallback, const EOS_Lobby_SendLobbyNativeInviteRequestedCallbackInfo* Data);
|
| 1005 |
+
|
| 1006 |
+
|
| 1007 |
+
/** The most recent version of the EOS_Lobby_CopyLobbyDetailsHandleByInviteId API. */
|
| 1008 |
+
#define EOS_LOBBY_COPYLOBBYDETAILSHANDLEBYINVITEID_API_LATEST 1
|
| 1009 |
+
|
| 1010 |
+
/**
|
| 1011 |
+
* Input parameters for the EOS_Lobby_CopyLobbyDetailsHandleByInviteId function.
|
| 1012 |
+
*/
|
| 1013 |
+
EOS_STRUCT(EOS_Lobby_CopyLobbyDetailsHandleByInviteIdOptions, (
|
| 1014 |
+
/** API Version: Set this to EOS_LOBBY_COPYLOBBYDETAILSHANDLEBYINVITEID_API_LATEST. */
|
| 1015 |
+
int32_t ApiVersion;
|
| 1016 |
+
/** The ID of an invitation to join the lobby */
|
| 1017 |
+
const char* InviteId;
|
| 1018 |
+
));
|
| 1019 |
+
|
| 1020 |
+
/** The most recent version of the EOS_Lobby_CopyLobbyDetailsHandleByUiEventId API. */
|
| 1021 |
+
#define EOS_LOBBY_COPYLOBBYDETAILSHANDLEBYUIEVENTID_API_LATEST 1
|
| 1022 |
+
|
| 1023 |
+
/**
|
| 1024 |
+
* Input parameters for the EOS_Lobby_CopyLobbyDetailsHandleByUiEventId function.
|
| 1025 |
+
*/
|
| 1026 |
+
EOS_STRUCT(EOS_Lobby_CopyLobbyDetailsHandleByUiEventIdOptions, (
|
| 1027 |
+
/** API Version: Set this to EOS_LOBBY_COPYLOBBYDETAILSHANDLEBYUIEVENTID_API_LATEST. */
|
| 1028 |
+
int32_t ApiVersion;
|
| 1029 |
+
/** UI Event associated with the lobby */
|
| 1030 |
+
EOS_UI_EventId UiEventId;
|
| 1031 |
+
));
|
| 1032 |
+
|
| 1033 |
+
/** The most recent version of the EOS_Lobby_CreateLobbySearch API. */
|
| 1034 |
+
#define EOS_LOBBY_CREATELOBBYSEARCH_API_LATEST 1
|
| 1035 |
+
|
| 1036 |
+
/**
|
| 1037 |
+
* Input parameters for the EOS_Lobby_CreateLobbySearch function.
|
| 1038 |
+
*/
|
| 1039 |
+
EOS_STRUCT(EOS_Lobby_CreateLobbySearchOptions, (
|
| 1040 |
+
/** API Version: Set this to EOS_LOBBY_CREATELOBBYSEARCH_API_LATEST. */
|
| 1041 |
+
int32_t ApiVersion;
|
| 1042 |
+
/** Maximum number of results allowed from the search */
|
| 1043 |
+
uint32_t MaxResults;
|
| 1044 |
+
));
|
| 1045 |
+
|
| 1046 |
+
/** The most recent version of the EOS_Lobby_SendInvite API. */
|
| 1047 |
+
#define EOS_LOBBY_SENDINVITE_API_LATEST 1
|
| 1048 |
+
|
| 1049 |
+
/**
|
| 1050 |
+
* Input parameters for the EOS_Lobby_SendInvite function.
|
| 1051 |
+
*/
|
| 1052 |
+
EOS_STRUCT(EOS_Lobby_SendInviteOptions, (
|
| 1053 |
+
/** API Version: Set this to EOS_LOBBY_SENDINVITE_API_LATEST. */
|
| 1054 |
+
int32_t ApiVersion;
|
| 1055 |
+
/** The ID of the lobby associated with the invitation */
|
| 1056 |
+
EOS_LobbyId LobbyId;
|
| 1057 |
+
/** The Product User ID of the local user sending the invitation */
|
| 1058 |
+
EOS_ProductUserId LocalUserId;
|
| 1059 |
+
/** The Product User ID of the user receiving the invitation */
|
| 1060 |
+
EOS_ProductUserId TargetUserId;
|
| 1061 |
+
));
|
| 1062 |
+
|
| 1063 |
+
/**
|
| 1064 |
+
* Output parameters for the EOS_Lobby_SendInvite function.
|
| 1065 |
+
*/
|
| 1066 |
+
EOS_STRUCT(EOS_Lobby_SendInviteCallbackInfo, (
|
| 1067 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 1068 |
+
EOS_EResult ResultCode;
|
| 1069 |
+
/** Context that was passed into EOS_Lobby_SendInvite */
|
| 1070 |
+
void* ClientData;
|
| 1071 |
+
/** The ID of the lobby */
|
| 1072 |
+
EOS_LobbyId LobbyId;
|
| 1073 |
+
));
|
| 1074 |
+
|
| 1075 |
+
/**
|
| 1076 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_SendInvite
|
| 1077 |
+
* @param Data A EOS_Lobby_SendInvite CallbackInfo containing the output information and result
|
| 1078 |
+
*/
|
| 1079 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnSendInviteCallback, const EOS_Lobby_SendInviteCallbackInfo* Data);
|
| 1080 |
+
|
| 1081 |
+
/** The most recent version of the EOS_Lobby_RejectInvite API. */
|
| 1082 |
+
#define EOS_LOBBY_REJECTINVITE_API_LATEST 1
|
| 1083 |
+
|
| 1084 |
+
/**
|
| 1085 |
+
* Input parameters for the EOS_Lobby_RejectInvite function.
|
| 1086 |
+
*/
|
| 1087 |
+
EOS_STRUCT(EOS_Lobby_RejectInviteOptions, (
|
| 1088 |
+
/** API Version: Set this to EOS_LOBBY_REJECTINVITE_API_LATEST. */
|
| 1089 |
+
int32_t ApiVersion;
|
| 1090 |
+
/** The ID of the lobby associated with the invitation */
|
| 1091 |
+
const char* InviteId;
|
| 1092 |
+
/** The Product User ID of the local user who is rejecting the invitation */
|
| 1093 |
+
EOS_ProductUserId LocalUserId;
|
| 1094 |
+
));
|
| 1095 |
+
|
| 1096 |
+
/**
|
| 1097 |
+
* Output parameters for the EOS_Lobby_RejectInvite function.
|
| 1098 |
+
*/
|
| 1099 |
+
EOS_STRUCT(EOS_Lobby_RejectInviteCallbackInfo, (
|
| 1100 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 1101 |
+
EOS_EResult ResultCode;
|
| 1102 |
+
/** Context that was passed into EOS_Lobby_RejectInvite */
|
| 1103 |
+
void* ClientData;
|
| 1104 |
+
/** The ID of the invitation being rejected */
|
| 1105 |
+
const char* InviteId;
|
| 1106 |
+
));
|
| 1107 |
+
|
| 1108 |
+
/**
|
| 1109 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_RejectInvite
|
| 1110 |
+
* @param Data A EOS_Lobby_RejectInvite CallbackInfo containing the output information and result
|
| 1111 |
+
*/
|
| 1112 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnRejectInviteCallback, const EOS_Lobby_RejectInviteCallbackInfo* Data);
|
| 1113 |
+
|
| 1114 |
+
/** The most recent version of the EOS_Lobby_QueryInvites API. */
|
| 1115 |
+
#define EOS_LOBBY_QUERYINVITES_API_LATEST 1
|
| 1116 |
+
|
| 1117 |
+
/**
|
| 1118 |
+
* Input parameters for the EOS_Lobby_QueryInvites function.
|
| 1119 |
+
*/
|
| 1120 |
+
EOS_STRUCT(EOS_Lobby_QueryInvitesOptions, (
|
| 1121 |
+
/** API Version: Set this to EOS_LOBBY_QUERYINVITES_API_LATEST. */
|
| 1122 |
+
int32_t ApiVersion;
|
| 1123 |
+
/** The Product User ID of the local user whose invitations you want to retrieve */
|
| 1124 |
+
EOS_ProductUserId LocalUserId;
|
| 1125 |
+
));
|
| 1126 |
+
|
| 1127 |
+
/**
|
| 1128 |
+
* Output parameters for the EOS_Lobby_QueryInvites function.
|
| 1129 |
+
*/
|
| 1130 |
+
EOS_STRUCT(EOS_Lobby_QueryInvitesCallbackInfo, (
|
| 1131 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 1132 |
+
EOS_EResult ResultCode;
|
| 1133 |
+
/** Context that was passed into EOS_Lobby_QueryInvites */
|
| 1134 |
+
void* ClientData;
|
| 1135 |
+
/** The Product User ID of the local user that made the request */
|
| 1136 |
+
EOS_ProductUserId LocalUserId;
|
| 1137 |
+
));
|
| 1138 |
+
|
| 1139 |
+
/**
|
| 1140 |
+
* Function prototype definition for callbacks passed to EOS_Lobby_QueryInvites
|
| 1141 |
+
* @param Data A EOS_Lobby_QueryInvites CallbackInfo containing the output information and result
|
| 1142 |
+
*/
|
| 1143 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnQueryInvitesCallback, const EOS_Lobby_QueryInvitesCallbackInfo* Data);
|
| 1144 |
+
|
| 1145 |
+
|
| 1146 |
+
/** The most recent version of the EOS_Lobby_GetInviteCount API. */
|
| 1147 |
+
#define EOS_LOBBY_GETINVITECOUNT_API_LATEST 1
|
| 1148 |
+
|
| 1149 |
+
/**
|
| 1150 |
+
* Input parameters for the EOS_Lobby_GetInviteCount function.
|
| 1151 |
+
*/
|
| 1152 |
+
EOS_STRUCT(EOS_Lobby_GetInviteCountOptions, (
|
| 1153 |
+
/** API Version: Set this to EOS_LOBBY_GETINVITECOUNT_API_LATEST. */
|
| 1154 |
+
int32_t ApiVersion;
|
| 1155 |
+
/** The Product User ID of the local user whose cached lobby invitations you want to count */
|
| 1156 |
+
EOS_ProductUserId LocalUserId;
|
| 1157 |
+
));
|
| 1158 |
+
|
| 1159 |
+
/** The most recent version of the EOS_Lobby_GetInviteIdByIndex API. */
|
| 1160 |
+
#define EOS_LOBBY_GETINVITEIDBYINDEX_API_LATEST 1
|
| 1161 |
+
|
| 1162 |
+
/**
|
| 1163 |
+
* Input parameters for the EOS_Lobby_GetInviteIdByIndex function.
|
| 1164 |
+
*/
|
| 1165 |
+
EOS_STRUCT(EOS_Lobby_GetInviteIdByIndexOptions, (
|
| 1166 |
+
/** API Version: Set this to EOS_LOBBY_GETINVITEIDBYINDEX_API_LATEST. */
|
| 1167 |
+
int32_t ApiVersion;
|
| 1168 |
+
/** The Product User ID of the local user who received the cached invitation */
|
| 1169 |
+
EOS_ProductUserId LocalUserId;
|
| 1170 |
+
/** The index of the invitation ID to retrieve */
|
| 1171 |
+
uint32_t Index;
|
| 1172 |
+
));
|
| 1173 |
+
|
| 1174 |
+
/** The most recent version of the EOS_Lobby_CopyLobbyDetailsHandle API. */
|
| 1175 |
+
#define EOS_LOBBY_COPYLOBBYDETAILSHANDLE_API_LATEST 1
|
| 1176 |
+
|
| 1177 |
+
/**
|
| 1178 |
+
* Input parameters for the EOS_Lobby_CopyLobbyDetailsHandle function.
|
| 1179 |
+
*/
|
| 1180 |
+
EOS_STRUCT(EOS_Lobby_CopyLobbyDetailsHandleOptions, (
|
| 1181 |
+
/** API Version: Set this to EOS_LOBBY_COPYLOBBYDETAILSHANDLE_API_LATEST. */
|
| 1182 |
+
int32_t ApiVersion;
|
| 1183 |
+
/** The ID of the lobby */
|
| 1184 |
+
EOS_LobbyId LobbyId;
|
| 1185 |
+
/** The Product User ID of the local user making the request */
|
| 1186 |
+
EOS_ProductUserId LocalUserId;
|
| 1187 |
+
));
|
| 1188 |
+
|
| 1189 |
+
|
| 1190 |
+
/** The most recent version of the EOS_Lobby_GetRTCRoomName API. */
|
| 1191 |
+
#define EOS_LOBBY_GETRTCROOMNAME_API_LATEST 1
|
| 1192 |
+
|
| 1193 |
+
/**
|
| 1194 |
+
* Input parameters for the EOS_Lobby_GetRTCRoomName function.
|
| 1195 |
+
*/
|
| 1196 |
+
EOS_STRUCT(EOS_Lobby_GetRTCRoomNameOptions, (
|
| 1197 |
+
/** API Version: Set this to EOS_LOBBY_GETRTCROOMNAME_API_LATEST. */
|
| 1198 |
+
int32_t ApiVersion;
|
| 1199 |
+
/** The ID of the lobby to get the RTC Room name for */
|
| 1200 |
+
EOS_LobbyId LobbyId;
|
| 1201 |
+
/** The Product User ID of the local user in the lobby */
|
| 1202 |
+
EOS_ProductUserId LocalUserId;
|
| 1203 |
+
));
|
| 1204 |
+
|
| 1205 |
+
|
| 1206 |
+
/** The most recent version of the EOS_Lobby_IsRTCRoomConnected API. */
|
| 1207 |
+
#define EOS_LOBBY_ISRTCROOMCONNECTED_API_LATEST 1
|
| 1208 |
+
|
| 1209 |
+
/**
|
| 1210 |
+
* Input parameters for the EOS_Lobby_IsRTCRoomConnected function.
|
| 1211 |
+
*/
|
| 1212 |
+
EOS_STRUCT(EOS_Lobby_IsRTCRoomConnectedOptions, (
|
| 1213 |
+
/** API Version: Set this to EOS_LOBBY_ISRTCROOMCONNECTED_API_LATEST. */
|
| 1214 |
+
int32_t ApiVersion;
|
| 1215 |
+
/** The ID of the lobby to get the RTC Room name for */
|
| 1216 |
+
EOS_LobbyId LobbyId;
|
| 1217 |
+
/** The Product User ID of the local user in the lobby */
|
| 1218 |
+
EOS_ProductUserId LocalUserId;
|
| 1219 |
+
));
|
| 1220 |
+
|
| 1221 |
+
|
| 1222 |
+
/** The most recent version of the EOS_Lobby_AddNotifyRTCRoomConnectionChanged API. */
|
| 1223 |
+
#define EOS_LOBBY_ADDNOTIFYRTCROOMCONNECTIONCHANGED_API_LATEST 2
|
| 1224 |
+
|
| 1225 |
+
/**
|
| 1226 |
+
* Input parameters for the EOS_Lobby_AddNotifyRTCRoomConnectionChanged function.
|
| 1227 |
+
*/
|
| 1228 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyRTCRoomConnectionChangedOptions, (
|
| 1229 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYRTCROOMCONNECTIONCHANGED_API_LATEST. */
|
| 1230 |
+
int32_t ApiVersion;
|
| 1231 |
+
/** The ID of the lobby to receive RTC Room connection change notifications for
|
| 1232 |
+
* This is deprecated and no longer needed. The notification is raised for any LobbyId or LocalUserId. If any filtering is required, the callback struct (EOS_Lobby_RTCRoomConnectionChangedCallbackInfo) has both a LobbyId and LocalUserId field.
|
| 1233 |
+
**/
|
| 1234 |
+
EOS_LobbyId LobbyId_DEPRECATED;
|
| 1235 |
+
/** The Product User ID of the local user in the lobby
|
| 1236 |
+
* This is deprecated and no longer needed. The notification is raised for any LobbyId or LocalUserId. If any filtering is required, the callback struct (EOS_Lobby_RTCRoomConnectionChangedCallbackInfo) has both a LobbyId and LocalUserId field.
|
| 1237 |
+
**/
|
| 1238 |
+
EOS_ProductUserId LocalUserId_DEPRECATED;
|
| 1239 |
+
));
|
| 1240 |
+
|
| 1241 |
+
/**
|
| 1242 |
+
* Output parameters for the EOS_Lobby_AddNotifyRTCRoomConnectionChanged function.
|
| 1243 |
+
*/
|
| 1244 |
+
EOS_STRUCT(EOS_Lobby_RTCRoomConnectionChangedCallbackInfo, (
|
| 1245 |
+
/** Context that was passed into EOS_Lobby_AddNotifyRTCRoomConnectionChanged */
|
| 1246 |
+
void* ClientData;
|
| 1247 |
+
/** The ID of the lobby which had a RTC Room connection state change */
|
| 1248 |
+
EOS_LobbyId LobbyId;
|
| 1249 |
+
/** The Product User ID of the local user who is in the lobby and registered for notifications */
|
| 1250 |
+
EOS_ProductUserId LocalUserId;
|
| 1251 |
+
/** The new connection state of the room */
|
| 1252 |
+
EOS_Bool bIsConnected;
|
| 1253 |
+
/**
|
| 1254 |
+
If bIsConnected is EOS_FALSE, this result will be the reason we were disconnected.
|
| 1255 |
+
* EOS_Success: The room was left locally. This may be because: the associated lobby was Left or Destroyed, the connection to the lobby was interrupted, or because the SDK is being shutdown. If the lobby connection returns (lobby did not permanently go away), we will reconnect.
|
| 1256 |
+
* EOS_NoConnection: There was a network issue connecting to the server. We will attempt to reconnect soon.
|
| 1257 |
+
* EOS_RTC_UserKicked: The user has been kicked by the server. We will not reconnect.
|
| 1258 |
+
* EOS_RTC_UserBanned: The user has been banned by the server. We will not reconnect.
|
| 1259 |
+
* EOS_ServiceFailure: A known error occurred during interaction with the server. We will attempt to reconnect soon.
|
| 1260 |
+
* EOS_UnexpectedError: Unexpected error. We will attempt to reconnect soon.
|
| 1261 |
+
*/
|
| 1262 |
+
EOS_EResult DisconnectReason;
|
| 1263 |
+
));
|
| 1264 |
+
|
| 1265 |
+
/**
|
| 1266 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyRTCRoomConnectionChanged
|
| 1267 |
+
*
|
| 1268 |
+
* @param Data containing the connection state of the RTC Room for a lobby
|
| 1269 |
+
*
|
| 1270 |
+
* @see EOS_Lobby_IsRTCRoomConnected
|
| 1271 |
+
*/
|
| 1272 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnRTCRoomConnectionChangedCallback, const EOS_Lobby_RTCRoomConnectionChangedCallbackInfo* Data);
|
| 1273 |
+
|
| 1274 |
+
|
| 1275 |
+
/** Search for a matching bucket ID (value is string) */
|
| 1276 |
+
#define EOS_LOBBY_SEARCH_BUCKET_ID "bucket"
|
| 1277 |
+
/** Search for lobbies that contain at least this number of members (value is int) */
|
| 1278 |
+
#define EOS_LOBBY_SEARCH_MINCURRENTMEMBERS "mincurrentmembers"
|
| 1279 |
+
/** Search for a match with min free space (value is int) */
|
| 1280 |
+
#define EOS_LOBBY_SEARCH_MINSLOTSAVAILABLE "minslotsavailable"
|
| 1281 |
+
|
| 1282 |
+
/** The most recent version of the EOS_Lobby_AttributeData struct. */
|
| 1283 |
+
#define EOS_LOBBY_ATTRIBUTEDATA_API_LATEST 1
|
| 1284 |
+
|
| 1285 |
+
/**
|
| 1286 |
+
* Contains information about lobby and lobby member data
|
| 1287 |
+
*/
|
| 1288 |
+
EOS_STRUCT(EOS_Lobby_AttributeData, (
|
| 1289 |
+
/** API Version: Set this to EOS_LOBBY_ATTRIBUTEDATA_API_LATEST. */
|
| 1290 |
+
int32_t ApiVersion;
|
| 1291 |
+
/** Name of the lobby attribute */
|
| 1292 |
+
const char* Key;
|
| 1293 |
+
/** Value of the lobby attribute */
|
| 1294 |
+
union
|
| 1295 |
+
{
|
| 1296 |
+
/** Stored as an 8 byte integer */
|
| 1297 |
+
int64_t AsInt64;
|
| 1298 |
+
/** Stored as a double precision floating point */
|
| 1299 |
+
double AsDouble;
|
| 1300 |
+
/** Stored as a boolean */
|
| 1301 |
+
EOS_Bool AsBool;
|
| 1302 |
+
/** Stored as a null terminated UTF8 string. Should not be nullptr */
|
| 1303 |
+
const char* AsUtf8;
|
| 1304 |
+
} Value;
|
| 1305 |
+
|
| 1306 |
+
/** Type of value stored in the union */
|
| 1307 |
+
EOS_ELobbyAttributeType ValueType;
|
| 1308 |
+
));
|
| 1309 |
+
|
| 1310 |
+
/** The most recent version of the EOS_Lobby_Attribute struct. */
|
| 1311 |
+
#define EOS_LOBBY_ATTRIBUTE_API_LATEST 1
|
| 1312 |
+
|
| 1313 |
+
/**
|
| 1314 |
+
* An attribute and its visibility setting stored with a lobby.
|
| 1315 |
+
* Used to store both lobby and lobby member data
|
| 1316 |
+
*/
|
| 1317 |
+
EOS_STRUCT(EOS_Lobby_Attribute, (
|
| 1318 |
+
/** API Version: Set this to EOS_LOBBY_ATTRIBUTE_API_LATEST. */
|
| 1319 |
+
int32_t ApiVersion;
|
| 1320 |
+
/** Key/Value pair describing the attribute */
|
| 1321 |
+
EOS_Lobby_AttributeData* Data;
|
| 1322 |
+
/** Is this attribute public or private to the lobby and its members */
|
| 1323 |
+
EOS_ELobbyAttributeVisibility Visibility;
|
| 1324 |
+
));
|
| 1325 |
+
|
| 1326 |
+
/**
|
| 1327 |
+
* Release the memory associated with a lobby attribute. This must be called on data retrieved from the various Copy functions in the
|
| 1328 |
+
* LobbyDetails interface which return an EOS_Lobby_Attribute.
|
| 1329 |
+
*
|
| 1330 |
+
* @param LobbyAttribute - The lobby attribute to release
|
| 1331 |
+
*
|
| 1332 |
+
* @see EOS_LobbyDetails_CopyAttributeByIndex
|
| 1333 |
+
* @see EOS_LobbyDetails_CopyAttributeByKey
|
| 1334 |
+
* @see EOS_LobbyDetails_CopyMemberAttributeByIndex
|
| 1335 |
+
* @see EOS_LobbyDetails_CopyMemberAttributeByKey
|
| 1336 |
+
*/
|
| 1337 |
+
EOS_DECLARE_FUNC(void) EOS_Lobby_Attribute_Release(EOS_Lobby_Attribute* LobbyAttribute);
|
| 1338 |
+
|
| 1339 |
+
/** The most recent version of the EOS_Lobby_GetConnectString API. */
|
| 1340 |
+
#define EOS_LOBBY_GETCONNECTSTRING_API_LATEST 1
|
| 1341 |
+
|
| 1342 |
+
/** The buffer size to provide to the EOS_Lobby_GetConnectString API. */
|
| 1343 |
+
#define EOS_LOBBY_GETCONNECTSTRING_BUFFER_SIZE 256
|
| 1344 |
+
|
| 1345 |
+
/**
|
| 1346 |
+
* Input parameters for the EOS_Lobby_GetConnectString function.
|
| 1347 |
+
*/
|
| 1348 |
+
EOS_STRUCT(EOS_Lobby_GetConnectStringOptions, (
|
| 1349 |
+
/** API Version: Set this to EOS_LOBBY_GETCONNECTSTRING_API_LATEST. */
|
| 1350 |
+
int32_t ApiVersion;
|
| 1351 |
+
/** The Product User ID of the local user requesting the connection string generated from the lobby; this user must currently own the lobby */
|
| 1352 |
+
EOS_ProductUserId LocalUserId;
|
| 1353 |
+
/** The ID of the lobby to generate a connection string for */
|
| 1354 |
+
EOS_LobbyId LobbyId;
|
| 1355 |
+
));
|
| 1356 |
+
|
| 1357 |
+
/** The most recent version of the EOS_Lobby_ParseConnectString API. */
|
| 1358 |
+
#define EOS_LOBBY_PARSECONNECTSTRING_API_LATEST 1
|
| 1359 |
+
|
| 1360 |
+
/** The buffer size to provide to the EOS_Lobby_ParseConnectString API. */
|
| 1361 |
+
#define EOS_LOBBY_PARSECONNECTSTRING_BUFFER_SIZE 256
|
| 1362 |
+
|
| 1363 |
+
/**
|
| 1364 |
+
* Input parameters for the EOS_Lobby_GetConnectString function.
|
| 1365 |
+
*/
|
| 1366 |
+
EOS_STRUCT(EOS_Lobby_ParseConnectStringOptions, (
|
| 1367 |
+
/** API Version: Set this to EOS_LOBBY_PARSECONNECTSTRING_API_LATEST. */
|
| 1368 |
+
int32_t ApiVersion;
|
| 1369 |
+
/** The connection string to parse */
|
| 1370 |
+
const char* ConnectString;
|
| 1371 |
+
));
|
| 1372 |
+
|
| 1373 |
+
/** The most recent version of the EOS_LobbyModification_SetBucketId API. */
|
| 1374 |
+
#define EOS_LOBBYMODIFICATION_SETBUCKETID_API_LATEST 1
|
| 1375 |
+
|
| 1376 |
+
/**
|
| 1377 |
+
* Input parameters for the EOS_LobbyModification_SetBucketId function.
|
| 1378 |
+
*/
|
| 1379 |
+
EOS_STRUCT(EOS_LobbyModification_SetBucketIdOptions, (
|
| 1380 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_SETBUCKETID_API_LATEST. */
|
| 1381 |
+
int32_t ApiVersion;
|
| 1382 |
+
/** The new bucket id associated with the lobby */
|
| 1383 |
+
const char* BucketId;
|
| 1384 |
+
));
|
| 1385 |
+
|
| 1386 |
+
/** The most recent version of the EOS_LobbyModification_SetPermissionLevel API. */
|
| 1387 |
+
#define EOS_LOBBYMODIFICATION_SETPERMISSIONLEVEL_API_LATEST 1
|
| 1388 |
+
|
| 1389 |
+
/**
|
| 1390 |
+
* Input parameters for the EOS_LobbyModification_SetPermissionLevel function.
|
| 1391 |
+
*/
|
| 1392 |
+
EOS_STRUCT(EOS_LobbyModification_SetPermissionLevelOptions, (
|
| 1393 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_SETPERMISSIONLEVEL_API_LATEST. */
|
| 1394 |
+
int32_t ApiVersion;
|
| 1395 |
+
/** Permission level of the lobby */
|
| 1396 |
+
EOS_ELobbyPermissionLevel PermissionLevel;
|
| 1397 |
+
));
|
| 1398 |
+
|
| 1399 |
+
/** The most recent version of the EOS_LobbyModification_SetMaxMembers API. */
|
| 1400 |
+
#define EOS_LOBBYMODIFICATION_SETMAXMEMBERS_API_LATEST 1
|
| 1401 |
+
|
| 1402 |
+
/**
|
| 1403 |
+
* Input parameters for the EOS_LobbyModification_SetMaxMembers function.
|
| 1404 |
+
*/
|
| 1405 |
+
EOS_STRUCT(EOS_LobbyModification_SetMaxMembersOptions, (
|
| 1406 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_SETMAXMEMBERS_API_LATEST. */
|
| 1407 |
+
int32_t ApiVersion;
|
| 1408 |
+
/** New maximum number of lobby members */
|
| 1409 |
+
uint32_t MaxMembers;
|
| 1410 |
+
));
|
| 1411 |
+
|
| 1412 |
+
/** The most recent version of the EOS_LobbyModification_SetInvitesAllowed API. */
|
| 1413 |
+
#define EOS_LOBBYMODIFICATION_SETINVITESALLOWED_API_LATEST 1
|
| 1414 |
+
|
| 1415 |
+
/**
|
| 1416 |
+
* Input parameters for the EOS_LobbyModification_SetInvitesAllowed Function.
|
| 1417 |
+
*/
|
| 1418 |
+
EOS_STRUCT(EOS_LobbyModification_SetInvitesAllowedOptions, (
|
| 1419 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_SETINVITESALLOWED_API_LATEST. */
|
| 1420 |
+
int32_t ApiVersion;
|
| 1421 |
+
/** If true then invites can currently be sent for the associated lobby */
|
| 1422 |
+
EOS_Bool bInvitesAllowed;
|
| 1423 |
+
));
|
| 1424 |
+
|
| 1425 |
+
/** The most recent version of the EOS_LobbyModification_AddAttribute API. */
|
| 1426 |
+
#define EOS_LOBBYMODIFICATION_ADDATTRIBUTE_API_LATEST 2
|
| 1427 |
+
|
| 1428 |
+
/**
|
| 1429 |
+
* Input parameters for the EOS_LobbyModification_AddAttribute function.
|
| 1430 |
+
*/
|
| 1431 |
+
EOS_STRUCT(EOS_LobbyModification_AddAttributeOptions, (
|
| 1432 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_ADDATTRIBUTE_API_LATEST. */
|
| 1433 |
+
int32_t ApiVersion;
|
| 1434 |
+
/** Key/Value pair describing the attribute to add to the lobby */
|
| 1435 |
+
const EOS_Lobby_AttributeData* Attribute;
|
| 1436 |
+
/** Is this attribute public or private to the lobby and its members */
|
| 1437 |
+
EOS_ELobbyAttributeVisibility Visibility;
|
| 1438 |
+
));
|
| 1439 |
+
|
| 1440 |
+
|
| 1441 |
+
/** The most recent version of the EOS_LobbyModification_RemoveAttribute API. */
|
| 1442 |
+
#define EOS_LOBBYMODIFICATION_REMOVEATTRIBUTE_API_LATEST 1
|
| 1443 |
+
|
| 1444 |
+
/**
|
| 1445 |
+
* Input parameters for the EOS_LobbyModification_RemoveAttribute function.
|
| 1446 |
+
*/
|
| 1447 |
+
EOS_STRUCT(EOS_LobbyModification_RemoveAttributeOptions, (
|
| 1448 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_REMOVEATTRIBUTE_API_LATEST. */
|
| 1449 |
+
int32_t ApiVersion;
|
| 1450 |
+
/** Name of the key */
|
| 1451 |
+
const char* Key;
|
| 1452 |
+
));
|
| 1453 |
+
|
| 1454 |
+
/** The most recent version of the EOS_LobbyModification_AddMemberAttribute API. */
|
| 1455 |
+
#define EOS_LOBBYMODIFICATION_ADDMEMBERATTRIBUTE_API_LATEST 2
|
| 1456 |
+
|
| 1457 |
+
/**
|
| 1458 |
+
* Input parameters for the EOS_LobbyModification_AddMemberAttribute function.
|
| 1459 |
+
*/
|
| 1460 |
+
EOS_STRUCT(EOS_LobbyModification_AddMemberAttributeOptions, (
|
| 1461 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_ADDMEMBERATTRIBUTE_API_LATEST. */
|
| 1462 |
+
int32_t ApiVersion;
|
| 1463 |
+
/** Key/Value pair describing the attribute to add to the lobby member */
|
| 1464 |
+
const EOS_Lobby_AttributeData* Attribute;
|
| 1465 |
+
/** Is this attribute public or private to the rest of the lobby members */
|
| 1466 |
+
EOS_ELobbyAttributeVisibility Visibility;
|
| 1467 |
+
));
|
| 1468 |
+
|
| 1469 |
+
/** The most recent version of the EOS_LobbyModification_RemoveMemberAttribute API. */
|
| 1470 |
+
#define EOS_LOBBYMODIFICATION_REMOVEMEMBERATTRIBUTE_API_LATEST 1
|
| 1471 |
+
|
| 1472 |
+
/**
|
| 1473 |
+
* Input parameters for the EOS_LobbyModification_RemoveMemberAttribute function.
|
| 1474 |
+
*/
|
| 1475 |
+
EOS_STRUCT(EOS_LobbyModification_RemoveMemberAttributeOptions, (
|
| 1476 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_REMOVEMEMBERATTRIBUTE_API_LATEST. */
|
| 1477 |
+
int32_t ApiVersion;
|
| 1478 |
+
/** Name of the key */
|
| 1479 |
+
const char* Key;
|
| 1480 |
+
));
|
| 1481 |
+
|
| 1482 |
+
/** The most recent version of the EOS_LobbyModification_SetAllowedPlatformIds API. */
|
| 1483 |
+
#define EOS_LOBBYMODIFICATION_SETALLOWEDPLATFORMIDS_API_LATEST 1
|
| 1484 |
+
|
| 1485 |
+
/**
|
| 1486 |
+
* Input parameters for the EOS_LobbyModification_SetAllowedPlatformIdsOptions function.
|
| 1487 |
+
*/
|
| 1488 |
+
EOS_STRUCT(EOS_LobbyModification_SetAllowedPlatformIdsOptions, (
|
| 1489 |
+
/** API Version: Set this to EOS_LOBBYMODIFICATION_SETALLOWEDPLATFORMIDS_API_LATEST. */
|
| 1490 |
+
int32_t ApiVersion;
|
| 1491 |
+
/**
|
| 1492 |
+
* Array of platform IDs indicating the player platforms allowed to register with the lobby. Platform IDs are
|
| 1493 |
+
* found in the EOS header file (eos_common.h), for example EOS_OPT_Epic. For some platforms the value will be
|
| 1494 |
+
* in the EOS Platform specific header file. If null, the lobby will be unrestricted.
|
| 1495 |
+
*/
|
| 1496 |
+
const uint32_t* AllowedPlatformIds;
|
| 1497 |
+
/** Number of platform IDs in the array */
|
| 1498 |
+
uint32_t AllowedPlatformIdsCount;
|
| 1499 |
+
));
|
| 1500 |
+
|
| 1501 |
+
/** The most recent version of the EOS_LobbyDetails_GetLobbyOwner API. */
|
| 1502 |
+
#define EOS_LOBBYDETAILS_GETLOBBYOWNER_API_LATEST 1
|
| 1503 |
+
|
| 1504 |
+
/**
|
| 1505 |
+
* Input parameters for the EOS_LobbyDetails_GetLobbyOwner function.
|
| 1506 |
+
*/
|
| 1507 |
+
EOS_STRUCT(EOS_LobbyDetails_GetLobbyOwnerOptions, (
|
| 1508 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_GETLOBBYOWNER_API_LATEST. */
|
| 1509 |
+
int32_t ApiVersion;
|
| 1510 |
+
));
|
| 1511 |
+
|
| 1512 |
+
/** The most recent version of the EOS_LobbyDetails_CopyInfo API. */
|
| 1513 |
+
#define EOS_LOBBYDETAILS_COPYINFO_API_LATEST 1
|
| 1514 |
+
|
| 1515 |
+
/**
|
| 1516 |
+
* Input parameters for the EOS_LobbyDetails_CopyInfo function.
|
| 1517 |
+
*/
|
| 1518 |
+
EOS_STRUCT(EOS_LobbyDetails_CopyInfoOptions, (
|
| 1519 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_COPYINFO_API_LATEST. */
|
| 1520 |
+
int32_t ApiVersion;
|
| 1521 |
+
));
|
| 1522 |
+
|
| 1523 |
+
|
| 1524 |
+
/** The most recent version of the EOS_LobbyDetails_GetAttributeCount API. */
|
| 1525 |
+
#define EOS_LOBBYDETAILS_GETATTRIBUTECOUNT_API_LATEST 1
|
| 1526 |
+
|
| 1527 |
+
/**
|
| 1528 |
+
* Input parameters for the EOS_LobbyDetails_GetAttributeCount function.
|
| 1529 |
+
*/
|
| 1530 |
+
EOS_STRUCT(EOS_LobbyDetails_GetAttributeCountOptions, (
|
| 1531 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_GETATTRIBUTECOUNT_API_LATEST. */
|
| 1532 |
+
int32_t ApiVersion;
|
| 1533 |
+
));
|
| 1534 |
+
|
| 1535 |
+
|
| 1536 |
+
/** The most recent version of the EOS_LobbyDetails_CopyAttributeByIndex API. */
|
| 1537 |
+
#define EOS_LOBBYDETAILS_COPYATTRIBUTEBYINDEX_API_LATEST 1
|
| 1538 |
+
|
| 1539 |
+
/**
|
| 1540 |
+
* Input parameters for the EOS_LobbyDetails_CopyAttributeByIndex function.
|
| 1541 |
+
*/
|
| 1542 |
+
EOS_STRUCT(EOS_LobbyDetails_CopyAttributeByIndexOptions, (
|
| 1543 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_COPYATTRIBUTEBYINDEX_API_LATEST. */
|
| 1544 |
+
int32_t ApiVersion;
|
| 1545 |
+
/**
|
| 1546 |
+
* The index of the attribute to retrieve
|
| 1547 |
+
* @see EOS_LobbyDetails_GetAttributeCount
|
| 1548 |
+
*/
|
| 1549 |
+
uint32_t AttrIndex;
|
| 1550 |
+
));
|
| 1551 |
+
|
| 1552 |
+
|
| 1553 |
+
/** The most recent version of the EOS_LobbyDetails_CopyAttributeByKey API. */
|
| 1554 |
+
#define EOS_LOBBYDETAILS_COPYATTRIBUTEBYKEY_API_LATEST 1
|
| 1555 |
+
|
| 1556 |
+
/**
|
| 1557 |
+
* Input parameters for the EOS_LobbyDetails_CopyAttributeByKey function.
|
| 1558 |
+
*/
|
| 1559 |
+
EOS_STRUCT(EOS_LobbyDetails_CopyAttributeByKeyOptions, (
|
| 1560 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_COPYATTRIBUTEBYKEY_API_LATEST. */
|
| 1561 |
+
int32_t ApiVersion;
|
| 1562 |
+
/** Name of the attribute */
|
| 1563 |
+
const char* AttrKey;
|
| 1564 |
+
));
|
| 1565 |
+
|
| 1566 |
+
/** The most recent version of the EOS_LobbyDetails_GetMemberAttributeCount API. */
|
| 1567 |
+
#define EOS_LOBBYDETAILS_GETMEMBERATTRIBUTECOUNT_API_LATEST 1
|
| 1568 |
+
|
| 1569 |
+
/**
|
| 1570 |
+
* Input parameters for the EOS_LobbyDetails_GetMemberAttributeCount function.
|
| 1571 |
+
*/
|
| 1572 |
+
EOS_STRUCT(EOS_LobbyDetails_GetMemberAttributeCountOptions, (
|
| 1573 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_GETMEMBERATTRIBUTECOUNT_API_LATEST. */
|
| 1574 |
+
int32_t ApiVersion;
|
| 1575 |
+
/** The Product User ID of the lobby member */
|
| 1576 |
+
EOS_ProductUserId TargetUserId;
|
| 1577 |
+
));
|
| 1578 |
+
|
| 1579 |
+
/** The most recent version of the EOS_LobbyDetails_CopyMemberAttributeByIndex API. */
|
| 1580 |
+
#define EOS_LOBBYDETAILS_COPYMEMBERATTRIBUTEBYINDEX_API_LATEST 1
|
| 1581 |
+
|
| 1582 |
+
/**
|
| 1583 |
+
* Input parameters for the EOS_LobbyDetails_CopyMemberAttributeByIndex function.
|
| 1584 |
+
*/
|
| 1585 |
+
EOS_STRUCT(EOS_LobbyDetails_CopyMemberAttributeByIndexOptions, (
|
| 1586 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_COPYMEMBERATTRIBUTEBYINDEX_API_LATEST. */
|
| 1587 |
+
int32_t ApiVersion;
|
| 1588 |
+
/** The Product User ID of the lobby member */
|
| 1589 |
+
EOS_ProductUserId TargetUserId;
|
| 1590 |
+
/** The index of the attribute to copy */
|
| 1591 |
+
uint32_t AttrIndex;
|
| 1592 |
+
));
|
| 1593 |
+
|
| 1594 |
+
/** The most recent version of the EOS_LobbyDetails_CopyMemberAttributeByKey API. */
|
| 1595 |
+
#define EOS_LOBBYDETAILS_COPYMEMBERATTRIBUTEBYKEY_API_LATEST 1
|
| 1596 |
+
|
| 1597 |
+
/**
|
| 1598 |
+
* Input parameters for the EOS_LobbyDetails_CopyMemberAttributeByKey function.
|
| 1599 |
+
*/
|
| 1600 |
+
EOS_STRUCT(EOS_LobbyDetails_CopyMemberAttributeByKeyOptions, (
|
| 1601 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_COPYMEMBERATTRIBUTEBYKEY_API_LATEST. */
|
| 1602 |
+
int32_t ApiVersion;
|
| 1603 |
+
/** The Product User ID of the lobby member */
|
| 1604 |
+
EOS_ProductUserId TargetUserId;
|
| 1605 |
+
/** Name of the attribute to copy */
|
| 1606 |
+
const char* AttrKey;
|
| 1607 |
+
));
|
| 1608 |
+
|
| 1609 |
+
/** The most recent version of the EOS_LobbyDetails_GetMemberCount API. */
|
| 1610 |
+
#define EOS_LOBBYDETAILS_GETMEMBERCOUNT_API_LATEST 1
|
| 1611 |
+
|
| 1612 |
+
/**
|
| 1613 |
+
* Input parameters for the EOS_LobbyDetails_GetMemberCount function.
|
| 1614 |
+
*/
|
| 1615 |
+
EOS_STRUCT(EOS_LobbyDetails_GetMemberCountOptions, (
|
| 1616 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_GETMEMBERCOUNT_API_LATEST. */
|
| 1617 |
+
int32_t ApiVersion;
|
| 1618 |
+
));
|
| 1619 |
+
|
| 1620 |
+
/** The most recent version of the EOS_LobbyDetails_GetMemberByIndex API. */
|
| 1621 |
+
#define EOS_LOBBYDETAILS_GETMEMBERBYINDEX_API_LATEST 1
|
| 1622 |
+
|
| 1623 |
+
/**
|
| 1624 |
+
* Input parameters for the EOS_LobbyDetails_GetMemberByIndex function.
|
| 1625 |
+
*/
|
| 1626 |
+
EOS_STRUCT(EOS_LobbyDetails_GetMemberByIndexOptions, (
|
| 1627 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_GETMEMBERBYINDEX_API_LATEST. */
|
| 1628 |
+
int32_t ApiVersion;
|
| 1629 |
+
/** Index of the member to retrieve */
|
| 1630 |
+
uint32_t MemberIndex;
|
| 1631 |
+
));
|
| 1632 |
+
|
| 1633 |
+
/** The most recent version of the EOS_LobbySearch_Find API. */
|
| 1634 |
+
#define EOS_LOBBYSEARCH_FIND_API_LATEST 1
|
| 1635 |
+
|
| 1636 |
+
/**
|
| 1637 |
+
* Input parameters for the EOS_LobbySearch_Find function.
|
| 1638 |
+
*/
|
| 1639 |
+
EOS_STRUCT(EOS_LobbySearch_FindOptions, (
|
| 1640 |
+
/** API Version: Set this to EOS_LOBBYSEARCH_FIND_API_LATEST. */
|
| 1641 |
+
int32_t ApiVersion;
|
| 1642 |
+
/** The Product User ID of the user making the search request */
|
| 1643 |
+
EOS_ProductUserId LocalUserId;
|
| 1644 |
+
));
|
| 1645 |
+
|
| 1646 |
+
/**
|
| 1647 |
+
* Output parameters for the EOS_LobbySearch_Find function.
|
| 1648 |
+
*/
|
| 1649 |
+
EOS_STRUCT(EOS_LobbySearch_FindCallbackInfo, (
|
| 1650 |
+
/** The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. */
|
| 1651 |
+
EOS_EResult ResultCode;
|
| 1652 |
+
/** Context that was passed into EOS_LobbySearch_Find */
|
| 1653 |
+
void* ClientData;
|
| 1654 |
+
));
|
| 1655 |
+
|
| 1656 |
+
/**
|
| 1657 |
+
* Function prototype definition for callbacks passed to EOS_LobbySearch_Find
|
| 1658 |
+
* @param Data A EOS_LobbySearch_Find CallbackInfo containing the output information and result
|
| 1659 |
+
*/
|
| 1660 |
+
EOS_DECLARE_CALLBACK(EOS_LobbySearch_OnFindCallback, const EOS_LobbySearch_FindCallbackInfo* Data);
|
| 1661 |
+
|
| 1662 |
+
/** The most recent version of the EOS_LobbySearch_SetLobbyId API. */
|
| 1663 |
+
#define EOS_LOBBYSEARCH_SETLOBBYID_API_LATEST 1
|
| 1664 |
+
|
| 1665 |
+
/**
|
| 1666 |
+
* Input parameters for the EOS_LobbySearch_SetLobbyId function.
|
| 1667 |
+
*/
|
| 1668 |
+
EOS_STRUCT(EOS_LobbySearch_SetLobbyIdOptions, (
|
| 1669 |
+
/** API Version: Set this to EOS_LOBBYSEARCH_SETLOBBYID_API_LATEST. */
|
| 1670 |
+
int32_t ApiVersion;
|
| 1671 |
+
/** The ID of the lobby to find */
|
| 1672 |
+
EOS_LobbyId LobbyId;
|
| 1673 |
+
));
|
| 1674 |
+
|
| 1675 |
+
/** The most recent version of the EOS_LobbySearch_SetTargetUserId API. */
|
| 1676 |
+
#define EOS_LOBBYSEARCH_SETTARGETUSERID_API_LATEST 1
|
| 1677 |
+
|
| 1678 |
+
/**
|
| 1679 |
+
* Input parameters for the EOS_LobbySearch_SetTargetUserId function.
|
| 1680 |
+
*/
|
| 1681 |
+
EOS_STRUCT(EOS_LobbySearch_SetTargetUserIdOptions, (
|
| 1682 |
+
/** API Version: Set this to EOS_LOBBYSEARCH_SETTARGETUSERID_API_LATEST. */
|
| 1683 |
+
int32_t ApiVersion;
|
| 1684 |
+
/** Search lobbies for given user by Product User ID, returning any lobbies where this user is currently registered */
|
| 1685 |
+
EOS_ProductUserId TargetUserId;
|
| 1686 |
+
));
|
| 1687 |
+
|
| 1688 |
+
/** The most recent version of the EOS_LobbySearch_SetParameter API. */
|
| 1689 |
+
#define EOS_LOBBYSEARCH_SETPARAMETER_API_LATEST 1
|
| 1690 |
+
|
| 1691 |
+
/**
|
| 1692 |
+
* Input parameters for the EOS_LobbySearch_SetParameter function.
|
| 1693 |
+
*/
|
| 1694 |
+
EOS_STRUCT(EOS_LobbySearch_SetParameterOptions, (
|
| 1695 |
+
/** API Version: Set this to EOS_LOBBYSEARCH_SETPARAMETER_API_LATEST. */
|
| 1696 |
+
int32_t ApiVersion;
|
| 1697 |
+
/** Search parameter describing a key and a value to compare */
|
| 1698 |
+
const EOS_Lobby_AttributeData* Parameter;
|
| 1699 |
+
/** The type of comparison to make against the search parameter */
|
| 1700 |
+
EOS_EComparisonOp ComparisonOp;
|
| 1701 |
+
));
|
| 1702 |
+
|
| 1703 |
+
/** The most recent version of the EOS_LobbySearch_RemoveParameter API. */
|
| 1704 |
+
#define EOS_LOBBYSEARCH_REMOVEPARAMETER_API_LATEST 1
|
| 1705 |
+
|
| 1706 |
+
/**
|
| 1707 |
+
* Input parameters for the EOS_LobbySearch_RemoveParameter function.
|
| 1708 |
+
*/
|
| 1709 |
+
EOS_STRUCT(EOS_LobbySearch_RemoveParameterOptions, (
|
| 1710 |
+
/** API Version: Set this to EOS_LOBBYSEARCH_REMOVEPARAMETER_API_LATEST. */
|
| 1711 |
+
int32_t ApiVersion;
|
| 1712 |
+
/** Search parameter key to remove from the search */
|
| 1713 |
+
const char* Key;
|
| 1714 |
+
/** Search comparison operation associated with the key to remove */
|
| 1715 |
+
EOS_EComparisonOp ComparisonOp;
|
| 1716 |
+
));
|
| 1717 |
+
|
| 1718 |
+
/** The most recent version of the EOS_LobbySearch_SetMaxResults API. */
|
| 1719 |
+
#define EOS_LOBBYSEARCH_SETMAXRESULTS_API_LATEST 1
|
| 1720 |
+
|
| 1721 |
+
/**
|
| 1722 |
+
* Input parameters for the EOS_LobbySearch_SetMaxResults function.
|
| 1723 |
+
*/
|
| 1724 |
+
EOS_STRUCT(EOS_LobbySearch_SetMaxResultsOptions, (
|
| 1725 |
+
/** API Version: Set this to EOS_LOBBYSEARCH_SETMAXRESULTS_API_LATEST. */
|
| 1726 |
+
int32_t ApiVersion;
|
| 1727 |
+
/** Maximum number of search results to return from the query */
|
| 1728 |
+
uint32_t MaxResults;
|
| 1729 |
+
));
|
| 1730 |
+
|
| 1731 |
+
/** The most recent version of the EOS_LobbySearch_GetSearchResultCount API. */
|
| 1732 |
+
#define EOS_LOBBYSEARCH_GETSEARCHRESULTCOUNT_API_LATEST 1
|
| 1733 |
+
|
| 1734 |
+
/**
|
| 1735 |
+
* Input parameters for the EOS_LobbySearch_GetSearchResultCount function.
|
| 1736 |
+
*/
|
| 1737 |
+
EOS_STRUCT(EOS_LobbySearch_GetSearchResultCountOptions, (
|
| 1738 |
+
/** API Version: Set this to EOS_LOBBYSEARCH_GETSEARCHRESULTCOUNT_API_LATEST. */
|
| 1739 |
+
int32_t ApiVersion;
|
| 1740 |
+
));
|
| 1741 |
+
|
| 1742 |
+
/** The most recent version of the EOS_LobbySearch_CopySearchResultByIndex API. */
|
| 1743 |
+
#define EOS_LOBBYSEARCH_COPYSEARCHRESULTBYINDEX_API_LATEST 1
|
| 1744 |
+
|
| 1745 |
+
/**
|
| 1746 |
+
* Input parameters for the EOS_LobbySearch_CopySearchResultByIndex function.
|
| 1747 |
+
*/
|
| 1748 |
+
EOS_STRUCT(EOS_LobbySearch_CopySearchResultByIndexOptions, (
|
| 1749 |
+
/** API Version: Set this to EOS_LOBBYSEARCH_COPYSEARCHRESULTBYINDEX_API_LATEST. */
|
| 1750 |
+
int32_t ApiVersion;
|
| 1751 |
+
/**
|
| 1752 |
+
* The index of the lobby to retrieve within the completed search query
|
| 1753 |
+
* @see EOS_LobbySearch_GetSearchResultCount
|
| 1754 |
+
*/
|
| 1755 |
+
uint32_t LobbyIndex;
|
| 1756 |
+
));
|
| 1757 |
+
|
| 1758 |
+
/** The most recent version of the EOS_LobbyDetails_CopyMemberInfo API. */
|
| 1759 |
+
#define EOS_LOBBYDETAILS_COPYMEMBERINFO_API_LATEST 1
|
| 1760 |
+
|
| 1761 |
+
/**
|
| 1762 |
+
* Input parameters for the EOS_LobbyDetails_CopyMemberInfo function.
|
| 1763 |
+
*/
|
| 1764 |
+
EOS_STRUCT(EOS_LobbyDetails_CopyMemberInfoOptions, (
|
| 1765 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_COPYMEMBERINFO_API_LATEST. */
|
| 1766 |
+
int32_t ApiVersion;
|
| 1767 |
+
/** The Product User ID of the lobby member to copy. */
|
| 1768 |
+
EOS_ProductUserId TargetUserId;
|
| 1769 |
+
));
|
| 1770 |
+
|
| 1771 |
+
/** The most recent version of the EOS_LobbyDetails_MemberInfo API. */
|
| 1772 |
+
#define EOS_LOBBYDETAILS_MEMBERINFO_API_LATEST 1
|
| 1773 |
+
|
| 1774 |
+
/**
|
| 1775 |
+
* Contains information about a member of a lobby.
|
| 1776 |
+
*/
|
| 1777 |
+
EOS_STRUCT(EOS_LobbyDetails_MemberInfo, (
|
| 1778 |
+
/** API Version: Set this to EOS_LOBBYDETAILS_MEMBERINFO_API_LATEST. */
|
| 1779 |
+
int32_t ApiVersion;
|
| 1780 |
+
/** The Product User ID of the lobby member. */
|
| 1781 |
+
EOS_ProductUserId UserId;
|
| 1782 |
+
/** The platform of the lobby member. */
|
| 1783 |
+
EOS_OnlinePlatformType Platform;
|
| 1784 |
+
/** Does this member allow crossplay */
|
| 1785 |
+
EOS_Bool bAllowsCrossplay;
|
| 1786 |
+
));
|
| 1787 |
+
|
| 1788 |
+
/**
|
| 1789 |
+
* Release the memory associated with a member info. This must be called on data retrieved from EOS_LobbyDetails_CopyMemberInfo.
|
| 1790 |
+
*
|
| 1791 |
+
* @param LobbyDetailsMemberInfo - The lobby details member info to release
|
| 1792 |
+
*
|
| 1793 |
+
* @see EOS_LobbyDetails_CopyMemberInfo
|
| 1794 |
+
*/
|
| 1795 |
+
EOS_DECLARE_FUNC(void) EOS_LobbyDetails_MemberInfo_Release(EOS_LobbyDetails_MemberInfo* LobbyDetailsMemberInfo);
|
| 1796 |
+
|
| 1797 |
+
/** The most recent version of the EOS_Lobby_AddNotifyLeaveLobbyRequested API. */
|
| 1798 |
+
#define EOS_LOBBY_ADDNOTIFYLEAVELOBBYREQUESTED_API_LATEST 1
|
| 1799 |
+
|
| 1800 |
+
/**
|
| 1801 |
+
* Input parameters for the EOS_Lobby_AddNotifyLeaveLobbyRequested function.
|
| 1802 |
+
*/
|
| 1803 |
+
EOS_STRUCT(EOS_Lobby_AddNotifyLeaveLobbyRequestedOptions, (
|
| 1804 |
+
/** API Version: Set this to EOS_LOBBY_ADDNOTIFYLEAVELOBBYREQUESTED_API_LATEST. */
|
| 1805 |
+
int32_t ApiVersion;
|
| 1806 |
+
));
|
| 1807 |
+
|
| 1808 |
+
/**
|
| 1809 |
+
* Output parameters for the EOS_Lobby_OnLeaveLobbyRequestedCallback Function.
|
| 1810 |
+
*/
|
| 1811 |
+
EOS_STRUCT(EOS_Lobby_LeaveLobbyRequestedCallbackInfo, (
|
| 1812 |
+
/** Context that was passed into EOS_Lobby_OnLeaveLobbyRequestedCallback */
|
| 1813 |
+
void* ClientData;
|
| 1814 |
+
/** The Product User ID of the local user who received the leave lobby notification. */
|
| 1815 |
+
EOS_ProductUserId LocalUserId;
|
| 1816 |
+
/** Lobby ID associated with the leave lobby request. */
|
| 1817 |
+
EOS_LobbyId LobbyId;
|
| 1818 |
+
));
|
| 1819 |
+
|
| 1820 |
+
/**
|
| 1821 |
+
* Function prototype definition for notifications that comes from EOS_Lobby_AddNotifyLeaveLobbyRequested.
|
| 1822 |
+
*
|
| 1823 |
+
* @param Data A pointer to EOS_Lobby_LeaveLobbyRequestedCallbackInfo containing the output information.
|
| 1824 |
+
*/
|
| 1825 |
+
EOS_DECLARE_CALLBACK(EOS_Lobby_OnLeaveLobbyRequestedCallback, const EOS_Lobby_LeaveLobbyRequestedCallbackInfo* Data);
|
| 1826 |
+
|
| 1827 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_logging.h
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Logging Interface grants access to log output coming from the SDK at various levels of detail.
|
| 8 |
+
* Unlike other interfaces, the Logging Interface does not require a handle from the Platform Interface,
|
| 9 |
+
* as it functions entirely on the local system.
|
| 10 |
+
*/
|
| 11 |
+
|
| 12 |
+
#pragma pack(push, 8)
|
| 13 |
+
|
| 14 |
+
/**
|
| 15 |
+
* Logging levels. When a log message is output, it has an associated log level.
|
| 16 |
+
* Messages will only be sent to the callback function if the message's associated log level is less than or equal to the configured log level for that category.
|
| 17 |
+
*
|
| 18 |
+
* @see EOS_Logging_SetCallback
|
| 19 |
+
* @see EOS_Logging_SetLogLevel
|
| 20 |
+
*/
|
| 21 |
+
EOS_ENUM(EOS_ELogLevel,
|
| 22 |
+
/** The default value, disables logging */
|
| 23 |
+
EOS_LOG_Off = 0,
|
| 24 |
+
/** The Fatal logging level */
|
| 25 |
+
EOS_LOG_Fatal = 100,
|
| 26 |
+
/** The Error logging level */
|
| 27 |
+
EOS_LOG_Error = 200,
|
| 28 |
+
/** The Warning logging level */
|
| 29 |
+
EOS_LOG_Warning = 300,
|
| 30 |
+
/** The Info logging level */
|
| 31 |
+
EOS_LOG_Info = 400,
|
| 32 |
+
/** The Verbose logging level */
|
| 33 |
+
EOS_LOG_Verbose = 500,
|
| 34 |
+
/** The VeryVerbose logging level */
|
| 35 |
+
EOS_LOG_VeryVerbose = 600
|
| 36 |
+
);
|
| 37 |
+
|
| 38 |
+
/**
|
| 39 |
+
* Logging Categories
|
| 40 |
+
*/
|
| 41 |
+
|
| 42 |
+
#define PROCESS_CATEGORY(CategoryName, EOSCategoryLabel, EOSCategoryValue) EOSCategoryLabel = EOSCategoryValue,
|
| 43 |
+
#define PROCESS_CATEGORY_LAST(CategoryName, EOSCategoryLabel, EOSCategoryValue) EOSCategoryLabel = EOSCategoryValue
|
| 44 |
+
|
| 45 |
+
EOS_ENUM_START(EOS_ELogCategory)
|
| 46 |
+
#include "eos_logging_categories.h"
|
| 47 |
+
EOS_ENUM_END(EOS_ELogCategory);
|
| 48 |
+
|
| 49 |
+
#undef PROCESS_CATEGORY
|
| 50 |
+
#undef PROCESS_CATEGORY_LAST
|
| 51 |
+
|
| 52 |
+
/** A structure representing a log message */
|
| 53 |
+
EOS_STRUCT(EOS_LogMessage, (
|
| 54 |
+
/** A string representation of the log message category, encoded in UTF-8. Only valid during the life of the callback, so copy the string if you need it later. */
|
| 55 |
+
const char* Category;
|
| 56 |
+
/** The log message, encoded in UTF-8. Only valid during the life of the callback, so copy the string if you need it later. */
|
| 57 |
+
const char* Message;
|
| 58 |
+
/** The log level associated with the message */
|
| 59 |
+
EOS_ELogLevel Level;
|
| 60 |
+
));
|
| 61 |
+
|
| 62 |
+
/**
|
| 63 |
+
* Function prototype definition for functions that receive log messages.
|
| 64 |
+
*
|
| 65 |
+
* @param Message A EOS_LogMessage containing the log category, log level, and message.
|
| 66 |
+
* @see EOS_LogMessage
|
| 67 |
+
*/
|
| 68 |
+
EOS_EXTERN_C typedef void (EOS_CALL * EOS_LogMessageFunc)(const EOS_LogMessage* Message);
|
| 69 |
+
|
| 70 |
+
/**
|
| 71 |
+
* Set the callback function to use for SDK log messages. Any previously set callback will no longer be called.
|
| 72 |
+
*
|
| 73 |
+
* @param Callback the function to call when the SDK logs messages
|
| 74 |
+
* @return EOS_Success is returned if the callback will be used for future log messages.
|
| 75 |
+
* EOS_NotConfigured is returned if the SDK has not yet been initialized, or if it has been shut down
|
| 76 |
+
*
|
| 77 |
+
* @see EOS_Initialize
|
| 78 |
+
*/
|
| 79 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Logging_SetCallback(EOS_LogMessageFunc Callback);
|
| 80 |
+
|
| 81 |
+
/**
|
| 82 |
+
* Set the logging level for the specified logging category. By default all log categories will callback for Warnings, Errors, and Fatals.
|
| 83 |
+
*
|
| 84 |
+
* @param LogCategory the specific log category to configure. Use EOS_LC_ALL_CATEGORIES to configure all categories simultaneously to the same log level.
|
| 85 |
+
* @param LogLevel the log level to use for the log category
|
| 86 |
+
*
|
| 87 |
+
* @return EOS_Success is returned if the log levels are now in use.
|
| 88 |
+
* EOS_NotConfigured is returned if the SDK has not yet been initialized, or if it has been shut down.
|
| 89 |
+
*/
|
| 90 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Logging_SetLogLevel(EOS_ELogCategory LogCategory, EOS_ELogLevel LogLevel);
|
| 91 |
+
|
| 92 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_logging_categories.h
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
// This file is not intended to be included directly. Include eos_logging.h instead.
|
| 4 |
+
|
| 5 |
+
/**
|
| 6 |
+
* Logging Categories
|
| 7 |
+
* To use:
|
| 8 |
+
* 1. #define PROCESS_CATEGORY(CategoryName, EOSCategoryLabel, EOSCategoryValue)
|
| 9 |
+
* 2. #define PROCESS_CATEGORY_LAST(CategoryName, EOSCategoryLabel, EOSCategoryValue)
|
| 10 |
+
* 3. #include "eos_logging_categories.h"
|
| 11 |
+
* 4. #undef PROCESS_CATEGORY_LAST
|
| 12 |
+
* 5. #undef PROCESS_CATEGORY
|
| 13 |
+
*/
|
| 14 |
+
|
| 15 |
+
#if defined(PROCESS_CATEGORY)
|
| 16 |
+
|
| 17 |
+
/** Low level logs unrelated to specific services */
|
| 18 |
+
PROCESS_CATEGORY(LogEOS, EOS_LC_Core, 0)
|
| 19 |
+
/** Logs related to the Auth service */
|
| 20 |
+
PROCESS_CATEGORY(LogEOSAuth, EOS_LC_Auth, 1)
|
| 21 |
+
/** Logs related to the Friends service */
|
| 22 |
+
PROCESS_CATEGORY(LogEOSFriends, EOS_LC_Friends, 2)
|
| 23 |
+
/** Logs related to the Presence service */
|
| 24 |
+
PROCESS_CATEGORY(LogEOSPresence, EOS_LC_Presence, 3)
|
| 25 |
+
/** Logs related to the UserInfo service */
|
| 26 |
+
PROCESS_CATEGORY(LogEOSUserInfo, EOS_LC_UserInfo, 4)
|
| 27 |
+
/** Logs related to HTTP serialization */
|
| 28 |
+
PROCESS_CATEGORY(LogHttpSerialization, EOS_LC_HttpSerialization, 5)
|
| 29 |
+
/** Logs related to the Ecommerce service */
|
| 30 |
+
PROCESS_CATEGORY(LogEOSEcom, EOS_LC_Ecom, 6)
|
| 31 |
+
/** Logs related to the P2P service */
|
| 32 |
+
PROCESS_CATEGORY(LogEOSP2P, EOS_LC_P2P, 7)
|
| 33 |
+
/** Logs related to the Sessions service */
|
| 34 |
+
PROCESS_CATEGORY(LogEOSSessions, EOS_LC_Sessions, 8)
|
| 35 |
+
/** Logs related to rate limiting */
|
| 36 |
+
PROCESS_CATEGORY(LogEOSRateLimiter, EOS_LC_RateLimiter, 9)
|
| 37 |
+
/** Logs related to the PlayerDataStorage service */
|
| 38 |
+
PROCESS_CATEGORY(LogEOSPlayerDataStorage, EOS_LC_PlayerDataStorage, 10)
|
| 39 |
+
/** Logs related to sdk analytics */
|
| 40 |
+
PROCESS_CATEGORY(LogEOSAnalytics, EOS_LC_Analytics, 11)
|
| 41 |
+
/** Logs related to the messaging service */
|
| 42 |
+
PROCESS_CATEGORY(LogEOSMessaging, EOS_LC_Messaging, 12)
|
| 43 |
+
/** Logs related to the Connect service */
|
| 44 |
+
PROCESS_CATEGORY(LogEOSConnect, EOS_LC_Connect, 13)
|
| 45 |
+
/** Logs related to the Overlay */
|
| 46 |
+
PROCESS_CATEGORY(LogEOSOverlay, EOS_LC_Overlay, 14)
|
| 47 |
+
/** Logs related to the Achievements service */
|
| 48 |
+
PROCESS_CATEGORY(LogEOSAchievements, EOS_LC_Achievements, 15)
|
| 49 |
+
/** Logs related to the Stats service */
|
| 50 |
+
PROCESS_CATEGORY(LogEOSStats, EOS_LC_Stats, 16)
|
| 51 |
+
/** Logs related to the UI service */
|
| 52 |
+
PROCESS_CATEGORY(LogEOSUI, EOS_LC_UI, 17)
|
| 53 |
+
/** Logs related to the lobby service */
|
| 54 |
+
PROCESS_CATEGORY(LogEOSLobby, EOS_LC_Lobby, 18)
|
| 55 |
+
/** Logs related to the Leaderboards service */
|
| 56 |
+
PROCESS_CATEGORY(LogEOSLeaderboards, EOS_LC_Leaderboards, 19)
|
| 57 |
+
/** Logs related to an internal Keychain feature that the authentication interfaces use */
|
| 58 |
+
PROCESS_CATEGORY(LogEOSKeychain, EOS_LC_Keychain, 20)
|
| 59 |
+
/** Logs related to integrated platforms */
|
| 60 |
+
PROCESS_CATEGORY(LogEOSIntegratedPlatform, EOS_LC_IntegratedPlatform, 21)
|
| 61 |
+
/** Logs related to Title Storage */
|
| 62 |
+
PROCESS_CATEGORY(LogEOSTitleStorage, EOS_LC_TitleStorage, 22)
|
| 63 |
+
/** Logs related to the Mods service */
|
| 64 |
+
PROCESS_CATEGORY(LogEOSMods, EOS_LC_Mods, 23)
|
| 65 |
+
/** Logs related to the Anti-Cheat service */
|
| 66 |
+
PROCESS_CATEGORY(LogEOSAntiCheat, EOS_LC_AntiCheat, 24)
|
| 67 |
+
/** Logs related to reports client. */
|
| 68 |
+
PROCESS_CATEGORY(LogEOSReports, EOS_LC_Reports, 25)
|
| 69 |
+
/** Logs related to the Sanctions service */
|
| 70 |
+
PROCESS_CATEGORY(LogEOSSanctions, EOS_LC_Sanctions, 26)
|
| 71 |
+
/** Logs related to the Progression Snapshot service */
|
| 72 |
+
PROCESS_CATEGORY(LogEOSProgressionSnapshots, EOS_LC_ProgressionSnapshots, 27)
|
| 73 |
+
/** Logs related to the Kids Web Services integration */
|
| 74 |
+
PROCESS_CATEGORY(LogEOSKWS, EOS_LC_KWS, 28)
|
| 75 |
+
/** Logs related to the RTC API */
|
| 76 |
+
PROCESS_CATEGORY(LogEOSRTC, EOS_LC_RTC, 29)
|
| 77 |
+
/** Logs related to the RTC Admin API */
|
| 78 |
+
PROCESS_CATEGORY(LogEOSRTCAdmin, EOS_LC_RTCAdmin, 30)
|
| 79 |
+
/** Logs related to the Custom Invites API */
|
| 80 |
+
PROCESS_CATEGORY(LogEOSCustomInvites, EOS_LC_CustomInvites, 31)
|
| 81 |
+
/** Logs related to EOS HTTP activity */
|
| 82 |
+
PROCESS_CATEGORY(LogEOSHTTP, EOS_LC_HTTP, 41)
|
| 83 |
+
|
| 84 |
+
#endif // defined(PROCESS_CATEGORY)
|
| 85 |
+
|
| 86 |
+
#if defined(PROCESS_CATEGORY_LAST)
|
| 87 |
+
|
| 88 |
+
/** Not a real log category. Used by EOS_Logging_SetLogLevel to set the log level for all categories at the same time */
|
| 89 |
+
PROCESS_CATEGORY_LAST(Invalid, EOS_LC_ALL_CATEGORIES, 0x7fffffff)
|
| 90 |
+
|
| 91 |
+
#endif // PROCESS_CATEGORY_LAST
|
| 92 |
+
|
| 93 |
+
#if !defined(PROCESS_CATEGORY) && !defined(PROCESS_CATEGORY_LAST)
|
| 94 |
+
#error "eos_logging_categories.h requires PROCESS_CATEGORY(CategoryName, EOSCategoryLabel, EOSCategoryValue) and/or PROCESS_CATEGORY_LAST(CategoryName, EOSCategoryLabel, EOSCategoryValue) to be defined before inclusion."
|
| 95 |
+
#endif // !defined(PROCESS_CATEGORY) && !defined(PROCESS_CATEGORY_LAST)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_metrics.h
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_metrics_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Metrics Interface tracks your application's usage and populates the Game Analytics dashboard in the Developer Portal.
|
| 8 |
+
* This data includes active, online instances of the game's client and server, and past sessions played by local players.
|
| 9 |
+
* All Metrics Interface calls take a handle of type EOS_HMetrics as the first parameter.
|
| 10 |
+
* This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetMetricsInterface function.
|
| 11 |
+
*
|
| 12 |
+
* @see EOS_Platform_GetMetricsInterface
|
| 13 |
+
*/
|
| 14 |
+
|
| 15 |
+
/**
|
| 16 |
+
* Logs the start of a new game session for a local player.
|
| 17 |
+
*
|
| 18 |
+
* The game client should call this function whenever it joins into a new multiplayer, peer-to-peer or single player game session.
|
| 19 |
+
* Each call to BeginPlayerSession must be matched with a corresponding call to EndPlayerSession.
|
| 20 |
+
*
|
| 21 |
+
* @param Options Structure containing the local player's game account and the game session information.
|
| 22 |
+
*
|
| 23 |
+
* @return Returns EOS_Success on success, or an error code if the input parameters are invalid or an active session for the player already exists.
|
| 24 |
+
*
|
| 25 |
+
* @see EOS_Metrics_BeginPlayerSessionOptions
|
| 26 |
+
*/
|
| 27 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Metrics_BeginPlayerSession(EOS_HMetrics Handle, const EOS_Metrics_BeginPlayerSessionOptions* Options);
|
| 28 |
+
|
| 29 |
+
/**
|
| 30 |
+
* Logs the end of a game session for a local player.
|
| 31 |
+
*
|
| 32 |
+
* Call once when the game client leaves the active game session.
|
| 33 |
+
* Each call to BeginPlayerSession must be matched with a corresponding call to EndPlayerSession.
|
| 34 |
+
*
|
| 35 |
+
* @param Options Structure containing the account id of the player whose session to end.
|
| 36 |
+
*
|
| 37 |
+
* @return Returns EOS_Success on success, or an error code if the input parameters are invalid or there was no active session for the player.
|
| 38 |
+
*
|
| 39 |
+
* @see EOS_Metrics_EndPlayerSessionOptions
|
| 40 |
+
*/
|
| 41 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Metrics_EndPlayerSession(EOS_HMetrics Handle, const EOS_Metrics_EndPlayerSessionOptions* Options);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_metrics_types.h
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
EOS_EXTERN_C typedef struct EOS_MetricsHandle* EOS_HMetrics;
|
| 10 |
+
|
| 11 |
+
/** User game controller types. */
|
| 12 |
+
EOS_ENUM(EOS_EUserControllerType,
|
| 13 |
+
/** The game controller type is unknown. */
|
| 14 |
+
EOS_UCT_Unknown = 0,
|
| 15 |
+
/** Mouse and keyboard controller. */
|
| 16 |
+
EOS_UCT_MouseKeyboard = 1,
|
| 17 |
+
/** Gamepad controller. */
|
| 18 |
+
EOS_UCT_GamepadControl = 2,
|
| 19 |
+
/** Touch controller. */
|
| 20 |
+
EOS_UCT_TouchControl = 3
|
| 21 |
+
);
|
| 22 |
+
|
| 23 |
+
/** Account ID type for EOS_Metrics_BeginPlayerSession and EOS_Metrics_EndPlayerSession. */
|
| 24 |
+
EOS_ENUM(EOS_EMetricsAccountIdType,
|
| 25 |
+
/** An Epic Account ID. */
|
| 26 |
+
EOS_MAIT_Epic = 0,
|
| 27 |
+
/** An external service Account ID. */
|
| 28 |
+
EOS_MAIT_External = 1
|
| 29 |
+
);
|
| 30 |
+
|
| 31 |
+
/** The most recent version of the EOS_Metrics_BeginPlayerSessionOptions struct. */
|
| 32 |
+
#define EOS_METRICS_BEGINPLAYERSESSION_API_LATEST 1
|
| 33 |
+
|
| 34 |
+
/** BeginPlayerSession. */
|
| 35 |
+
EOS_STRUCT(EOS_Metrics_BeginPlayerSessionOptions, (
|
| 36 |
+
/** API Version: Set this to EOS_METRICS_BEGINPLAYERSESSION_API_LATEST. */
|
| 37 |
+
int32_t ApiVersion;
|
| 38 |
+
/** Account ID type that is set in the union. */
|
| 39 |
+
EOS_EMetricsAccountIdType AccountIdType;
|
| 40 |
+
/** The Account ID for the player whose session is beginning. */
|
| 41 |
+
union
|
| 42 |
+
{
|
| 43 |
+
/** An Epic Account ID. Set this field when AccountIdType is set to EOS_MAIT_Epic. */
|
| 44 |
+
EOS_EpicAccountId Epic;
|
| 45 |
+
/** An Account ID for another service. Set this field when AccountIdType is set to EOS_MAIT_External. */
|
| 46 |
+
const char* External;
|
| 47 |
+
} AccountId;
|
| 48 |
+
/** The in-game display name for the user as UTF-8 string. */
|
| 49 |
+
const char* DisplayName;
|
| 50 |
+
/** The user's game controller type. */
|
| 51 |
+
EOS_EUserControllerType ControllerType;
|
| 52 |
+
/**
|
| 53 |
+
* IP address of the game server hosting the game session. For a localhost session, set to NULL.
|
| 54 |
+
*
|
| 55 |
+
* @details Must be in either one of the following IPv4 or IPv6 string formats:
|
| 56 |
+
* * "127.0.0.1".
|
| 57 |
+
* * "1200:0000:AB00:1234:0000:2552:7777:1313".
|
| 58 |
+
* If both IPv4 and IPv6 addresses are available, use the IPv6 address.
|
| 59 |
+
*/
|
| 60 |
+
const char* ServerIp;
|
| 61 |
+
/**
|
| 62 |
+
* Optional, application-defined custom match session identifier. If the identifier is not used, set to NULL.
|
| 63 |
+
*
|
| 64 |
+
* @details The game can tag each game session with a custom session match identifier,
|
| 65 |
+
* which will be shown in the Played Sessions listing at the user profile dashboard.
|
| 66 |
+
*/
|
| 67 |
+
const char* GameSessionId;
|
| 68 |
+
));
|
| 69 |
+
|
| 70 |
+
/** The most recent version of the EOS_Metrics_EndPlayerSessionOptions struct. */
|
| 71 |
+
#define EOS_METRICS_ENDPLAYERSESSION_API_LATEST 1
|
| 72 |
+
|
| 73 |
+
/** EndPlayerSession. */
|
| 74 |
+
EOS_STRUCT(EOS_Metrics_EndPlayerSessionOptions, (
|
| 75 |
+
/** API Version: Set this to EOS_METRICS_ENDPLAYERSESSION_API_LATEST. */
|
| 76 |
+
int32_t ApiVersion;
|
| 77 |
+
/** The Account ID type that is set in the union. */
|
| 78 |
+
EOS_EMetricsAccountIdType AccountIdType;
|
| 79 |
+
/** The Account ID for the player whose session is ending. */
|
| 80 |
+
union
|
| 81 |
+
{
|
| 82 |
+
/** An Epic Account ID. Set this field when AccountIdType is set to EOS_MAIT_Epic. */
|
| 83 |
+
EOS_EpicAccountId Epic;
|
| 84 |
+
/** An Account ID for another service. Set this field when AccountIdType is set to EOS_MAIT_External. */
|
| 85 |
+
const char* External;
|
| 86 |
+
} AccountId;
|
| 87 |
+
));
|
| 88 |
+
|
| 89 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_mods.h
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_mods_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The Mods Interface is used to manage a user's mods. Allowing a user to install/uninstall/enumerate mods.
|
| 8 |
+
* All Mods Interface calls take a handle of type EOS_HMods as the first parameter.
|
| 9 |
+
* This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetModsInterface function.
|
| 10 |
+
*
|
| 11 |
+
* NOTE: At this time, this feature is only available for desktop platforms and for products that are part of the Epic Games store.
|
| 12 |
+
*
|
| 13 |
+
* @see EOS_Platform_GetModsInterface
|
| 14 |
+
*/
|
| 15 |
+
|
| 16 |
+
/**
|
| 17 |
+
* Starts an asynchronous task that makes a request to install the specified mod.
|
| 18 |
+
*
|
| 19 |
+
* @param Options structure containing the game and mod identifiers
|
| 20 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 21 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 22 |
+
*
|
| 23 |
+
* @see the section related to mods in eos_result.h for more details.
|
| 24 |
+
* @see EOS_Mods_InstallModOptions
|
| 25 |
+
* @see EOS_Mods_OnInstallModCallback
|
| 26 |
+
*/
|
| 27 |
+
EOS_DECLARE_FUNC(void) EOS_Mods_InstallMod(EOS_HMods Handle, const EOS_Mods_InstallModOptions* Options, void* ClientData, const EOS_Mods_OnInstallModCallback CompletionDelegate);
|
| 28 |
+
|
| 29 |
+
/**
|
| 30 |
+
* Starts an asynchronous task that makes a request to uninstall the specified mod.
|
| 31 |
+
*
|
| 32 |
+
* @param Options structure containing the game and mod identifiers
|
| 33 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 34 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 35 |
+
*
|
| 36 |
+
* @see the section related to mods in eos_result.h for more details.
|
| 37 |
+
* @see EOS_Mods_UninstallModOptions
|
| 38 |
+
* @see EOS_Mods_OnUninstallModCallback
|
| 39 |
+
*/
|
| 40 |
+
EOS_DECLARE_FUNC(void) EOS_Mods_UninstallMod(EOS_HMods Handle, const EOS_Mods_UninstallModOptions* Options, void* ClientData, const EOS_Mods_OnUninstallModCallback CompletionDelegate);
|
| 41 |
+
|
| 42 |
+
/**
|
| 43 |
+
* Starts an asynchronous task that makes a request to enumerate mods for the specified game.
|
| 44 |
+
* Types of the mods to enumerate can be specified through EOS_Mods_EnumerateModsOptions
|
| 45 |
+
*
|
| 46 |
+
* @param Options structure containing the game identifiers
|
| 47 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 48 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error
|
| 49 |
+
*
|
| 50 |
+
* @see the section related to mods in eos_result.h for more details.
|
| 51 |
+
* @see EOS_Mods_EnumerateModsOptions
|
| 52 |
+
* @see EOS_Mods_OnEnumerateModsCallback
|
| 53 |
+
*/
|
| 54 |
+
EOS_DECLARE_FUNC(void) EOS_Mods_EnumerateMods(EOS_HMods Handle, const EOS_Mods_EnumerateModsOptions* Options, void* ClientData, const EOS_Mods_OnEnumerateModsCallback CompletionDelegate);
|
| 55 |
+
|
| 56 |
+
/**
|
| 57 |
+
* Get cached enumerated mods object. If successful, this data must be released by calling EOS_Mods_ModInfo_Release
|
| 58 |
+
* Types of the cached enumerated mods can be specified through EOS_Mods_CopyModInfoOptions
|
| 59 |
+
*
|
| 60 |
+
* @param Options structure containing the game identifier for which requesting enumerated mods
|
| 61 |
+
* @param OutEnumeratedMods Enumerated mods Info. If the returned result is success, this will be set to data that must be later released, otherwise this will be set to NULL
|
| 62 |
+
* @return Success if we have cached data, or an error result if the request was invalid or we do not have cached data.
|
| 63 |
+
*
|
| 64 |
+
* @see EOS_Mods_ModInfo_Release
|
| 65 |
+
* @see EOS_Mods_CopyModInfoOptions
|
| 66 |
+
* @see EOS_Mods_ModInfo
|
| 67 |
+
*
|
| 68 |
+
* This request may fail with an EOS_NotFound code if an enumeration of a certain type was not performed before this call.
|
| 69 |
+
*/
|
| 70 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_Mods_CopyModInfo(EOS_HMods Handle, const EOS_Mods_CopyModInfoOptions* Options, EOS_Mods_ModInfo ** OutEnumeratedMods);
|
| 71 |
+
|
| 72 |
+
/**
|
| 73 |
+
* Starts an asynchronous task that makes a request to update the specified mod to the latest version.
|
| 74 |
+
*
|
| 75 |
+
* @param Options structure containing the game and mod identifiers
|
| 76 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 77 |
+
* @param CompletionDelegate a callback that is fired when the async operation completes, either successfully or in error. If the mod is up to date then the operation will complete with success.
|
| 78 |
+
*
|
| 79 |
+
* @see the section related to mods in eos_result.h for more details.
|
| 80 |
+
* @see EOS_Mods_UpdateModOptions
|
| 81 |
+
* @see EOS_Mods_OnUpdateModCallback
|
| 82 |
+
*/
|
| 83 |
+
EOS_DECLARE_FUNC(void) EOS_Mods_UpdateMod(EOS_HMods Handle, const EOS_Mods_UpdateModOptions* Options, void* ClientData, const EOS_Mods_OnUpdateModCallback CompletionDelegate);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_mods_types.h
ADDED
|
@@ -0,0 +1,247 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_common.h"
|
| 5 |
+
|
| 6 |
+
#pragma pack(push, 8)
|
| 7 |
+
|
| 8 |
+
EOS_EXTERN_C typedef struct EOS_ModsHandle* EOS_HMods;
|
| 9 |
+
|
| 10 |
+
/** The most recent version of the EOS_Mod_Identifier struct. */
|
| 11 |
+
#define EOS_MOD_IDENTIFIER_API_LATEST 1
|
| 12 |
+
|
| 13 |
+
/**
|
| 14 |
+
* EOS_Mod_Identifier is used to identify a mod.
|
| 15 |
+
*/
|
| 16 |
+
EOS_STRUCT(EOS_Mod_Identifier, (
|
| 17 |
+
/** API Version: Set this to EOS_MOD_IDENTIFIER_API_LATEST. */
|
| 18 |
+
int32_t ApiVersion;
|
| 19 |
+
/** Product namespace id in which this mod item exists */
|
| 20 |
+
const char* NamespaceId;
|
| 21 |
+
/** Item id of the Mod */
|
| 22 |
+
const char* ItemId;
|
| 23 |
+
/** Artifact id of the Mod */
|
| 24 |
+
const char* ArtifactId;
|
| 25 |
+
/** Represent mod item title. */
|
| 26 |
+
const char* Title;
|
| 27 |
+
/** Represent mod item version. */
|
| 28 |
+
const char* Version;
|
| 29 |
+
));
|
| 30 |
+
|
| 31 |
+
|
| 32 |
+
/**
|
| 33 |
+
* EOS_Mods_InstallMod is used to start an asynchronous request to make a mod install request for a game.
|
| 34 |
+
* The following types are used to work with the API.
|
| 35 |
+
*/
|
| 36 |
+
|
| 37 |
+
|
| 38 |
+
/** The most recent version of the EOS_Mods_InstallMod API. */
|
| 39 |
+
#define EOS_MODS_INSTALLMOD_API_LATEST 1
|
| 40 |
+
|
| 41 |
+
/**
|
| 42 |
+
* Input parameters for the EOS_Mods_InstallMod Function.
|
| 43 |
+
*/
|
| 44 |
+
EOS_STRUCT(EOS_Mods_InstallModOptions, (
|
| 45 |
+
/** API Version: Set this to EOS_MODS_INSTALLMOD_API_LATEST. */
|
| 46 |
+
int32_t ApiVersion;
|
| 47 |
+
/** The Epic Account ID of the user for which the mod should be installed */
|
| 48 |
+
EOS_EpicAccountId LocalUserId;
|
| 49 |
+
/** The mod to install */
|
| 50 |
+
const EOS_Mod_Identifier* Mod;
|
| 51 |
+
/** Indicates whether the mod should be uninstalled after exiting the game or not. */
|
| 52 |
+
EOS_Bool bRemoveAfterExit;
|
| 53 |
+
));
|
| 54 |
+
|
| 55 |
+
/**
|
| 56 |
+
* Output parameters for the EOS_Mods_InstallMod Function. These parameters are received through the callback provided to EOS_Mods_InstallMod
|
| 57 |
+
*/
|
| 58 |
+
EOS_STRUCT(EOS_Mods_InstallModCallbackInfo, (
|
| 59 |
+
/** Result code for the operation. EOS_Success is returned if the installation was successful, otherwise one of the error codes is returned. */
|
| 60 |
+
EOS_EResult ResultCode;
|
| 61 |
+
/** The Epic Account ID of the user for which mod installation was requested */
|
| 62 |
+
EOS_EpicAccountId LocalUserId;
|
| 63 |
+
/** Context that is passed into EOS_Mods_InstallMod */
|
| 64 |
+
void* ClientData;
|
| 65 |
+
/** Mod for which installation was requested */
|
| 66 |
+
const EOS_Mod_Identifier* Mod;
|
| 67 |
+
));
|
| 68 |
+
|
| 69 |
+
/**
|
| 70 |
+
* Function prototype definition for callbacks passed to EOS_Mods_InstallMod
|
| 71 |
+
* @param Data A EOS_Mods_InstallModCallbackInfo containing the output information and result
|
| 72 |
+
*/
|
| 73 |
+
EOS_DECLARE_CALLBACK(EOS_Mods_OnInstallModCallback, const EOS_Mods_InstallModCallbackInfo* Data);
|
| 74 |
+
|
| 75 |
+
|
| 76 |
+
/**
|
| 77 |
+
* EOS_Mods_UninstallMod is used to start an asynchronous request to make a mod uninstall request for a game.
|
| 78 |
+
* The following types are used to work with the API.
|
| 79 |
+
*/
|
| 80 |
+
|
| 81 |
+
|
| 82 |
+
/** The most recent version of the EOS_Mods_UninstallModOptions API. */
|
| 83 |
+
#define EOS_MODS_UNINSTALLMOD_API_LATEST 1
|
| 84 |
+
|
| 85 |
+
/**
|
| 86 |
+
* Input parameters for the EOS_Mods_UninstallMod Function.
|
| 87 |
+
*/
|
| 88 |
+
EOS_STRUCT(EOS_Mods_UninstallModOptions, (
|
| 89 |
+
/** API Version: Set this to EOS_MODS_UNINSTALLMOD_API_LATEST. */
|
| 90 |
+
int32_t ApiVersion;
|
| 91 |
+
/** The Epic Account ID of the user for which the mod should be uninstalled */
|
| 92 |
+
EOS_EpicAccountId LocalUserId;
|
| 93 |
+
/** The mod to uninstall */
|
| 94 |
+
const EOS_Mod_Identifier* Mod;
|
| 95 |
+
));
|
| 96 |
+
|
| 97 |
+
/**
|
| 98 |
+
* Output parameters for the EOS_Mods_UninstallMod Function. These parameters are received through the callback provided to EOS_Mods_UninstallMod
|
| 99 |
+
*/
|
| 100 |
+
EOS_STRUCT(EOS_Mods_UninstallModCallbackInfo, (
|
| 101 |
+
/** Result code for the operation. EOS_Success is returned if the uninstallation was successful, otherwise one of the error codes is returned. */
|
| 102 |
+
EOS_EResult ResultCode;
|
| 103 |
+
/** The Epic Account ID of the user for which mod uninstallation was requested */
|
| 104 |
+
EOS_EpicAccountId LocalUserId;
|
| 105 |
+
/** Context that is passed into EOS_Mods_UninstallMod */
|
| 106 |
+
void* ClientData;
|
| 107 |
+
/** Mod for which uninstallation was requested */
|
| 108 |
+
const EOS_Mod_Identifier* Mod;
|
| 109 |
+
));
|
| 110 |
+
|
| 111 |
+
/**
|
| 112 |
+
* Function prototype definition for callbacks passed to EOS_Mods_UninstallMod
|
| 113 |
+
* @param Data A EOS_Mods_UninstallModCallbackInfo containing the output information and result
|
| 114 |
+
*/
|
| 115 |
+
EOS_DECLARE_CALLBACK(EOS_Mods_OnUninstallModCallback, const EOS_Mods_UninstallModCallbackInfo* Data);
|
| 116 |
+
|
| 117 |
+
|
| 118 |
+
/**
|
| 119 |
+
* EOS_Mods_EnumerateMods is used to start an asynchronous request to enumerate mods for a game.
|
| 120 |
+
* The following types are used to work with the API.
|
| 121 |
+
*/
|
| 122 |
+
|
| 123 |
+
|
| 124 |
+
/** The type of mod enumeration. */
|
| 125 |
+
EOS_ENUM(EOS_EModEnumerationType,
|
| 126 |
+
/** Installed mods */
|
| 127 |
+
EOS_MET_INSTALLED = 0,
|
| 128 |
+
/** All available mods*/
|
| 129 |
+
EOS_MET_ALL_AVAILABLE
|
| 130 |
+
);
|
| 131 |
+
|
| 132 |
+
/** The most recent version of the EOS_Mods_EnumerateModsOptions API. */
|
| 133 |
+
#define EOS_MODS_ENUMERATEMODS_API_LATEST 1
|
| 134 |
+
|
| 135 |
+
/**
|
| 136 |
+
* Input parameters for the EOS_Mods_EnumerateMods Function.
|
| 137 |
+
*/
|
| 138 |
+
EOS_STRUCT(EOS_Mods_EnumerateModsOptions, (
|
| 139 |
+
/** API Version: Set this to EOS_MODS_ENUMERATEMODS_API_LATEST. */
|
| 140 |
+
int32_t ApiVersion;
|
| 141 |
+
/** The Epic Account ID of the user for which the mod should be enumerated */
|
| 142 |
+
EOS_EpicAccountId LocalUserId;
|
| 143 |
+
/** Type of the mods to enumerate */
|
| 144 |
+
EOS_EModEnumerationType Type;
|
| 145 |
+
));
|
| 146 |
+
|
| 147 |
+
/**
|
| 148 |
+
* Output parameters for the EOS_Mods_EnumerateMods Function. These parameters are received through the callback provided to EOS_Mods_EnumerateMods
|
| 149 |
+
*/
|
| 150 |
+
EOS_STRUCT(EOS_Mods_EnumerateModsCallbackInfo, (
|
| 151 |
+
/** Result code for the operation. EOS_Success is returned if the enumeration was successful, otherwise one of the error codes is returned. */
|
| 152 |
+
EOS_EResult ResultCode;
|
| 153 |
+
/** The Epic Account ID of the user for which mod enumeration was requested */
|
| 154 |
+
EOS_EpicAccountId LocalUserId;
|
| 155 |
+
/** Context that is passed into EOS_Mods_EnumerateMods */
|
| 156 |
+
void* ClientData;
|
| 157 |
+
/** Type of the enumerated mods */
|
| 158 |
+
EOS_EModEnumerationType Type;
|
| 159 |
+
));
|
| 160 |
+
|
| 161 |
+
/**
|
| 162 |
+
* Function prototype definition for callbacks passed to EOS_Mods_EnumerateMods
|
| 163 |
+
* @param Data A EOS_Mods_EnumerateModsCallbackInfo containing the output information and result
|
| 164 |
+
*/
|
| 165 |
+
EOS_DECLARE_CALLBACK(EOS_Mods_OnEnumerateModsCallback, const EOS_Mods_EnumerateModsCallbackInfo* Data);
|
| 166 |
+
|
| 167 |
+
/** The most recent version of the EOS_Mods_CopyModInfoOptions API. */
|
| 168 |
+
#define EOS_MODS_COPYMODINFO_API_LATEST 1
|
| 169 |
+
|
| 170 |
+
/**
|
| 171 |
+
* Data for the EOS_Mods_CopyModInfo function.
|
| 172 |
+
*/
|
| 173 |
+
EOS_STRUCT(EOS_Mods_CopyModInfoOptions, (
|
| 174 |
+
/** API Version: Set this to EOS_MODS_COPYMODINFO_API_LATEST. */
|
| 175 |
+
int32_t ApiVersion;
|
| 176 |
+
/** The Epic Account ID of the user for which mods should be copied */
|
| 177 |
+
EOS_EpicAccountId LocalUserId;
|
| 178 |
+
/** Type of the enumerated mod to copy */
|
| 179 |
+
EOS_EModEnumerationType Type;
|
| 180 |
+
));
|
| 181 |
+
|
| 182 |
+
/** The most recent version of the EOS_Mods_ModInfo struct. */
|
| 183 |
+
#define EOS_MODS_MODINFO_API_LATEST 1
|
| 184 |
+
|
| 185 |
+
/**
|
| 186 |
+
* Data for the EOS_Mods_CopyModInfo function.
|
| 187 |
+
*
|
| 188 |
+
* @see EOS_Mods_CopyModInfo
|
| 189 |
+
* @see EOS_Mods_ModInfo_Release
|
| 190 |
+
*/
|
| 191 |
+
EOS_STRUCT(EOS_Mods_ModInfo, (
|
| 192 |
+
/** API Version: Set this to EOS_MODS_MODINFO_API_LATEST. */
|
| 193 |
+
int32_t ApiVersion;
|
| 194 |
+
/** The count of enumerated mods */
|
| 195 |
+
int32_t ModsCount;
|
| 196 |
+
/** The array of enumerated mods or NULL if no such type of mods were enumerated */
|
| 197 |
+
EOS_Mod_Identifier* Mods;
|
| 198 |
+
/** Type of the mods */
|
| 199 |
+
EOS_EModEnumerationType Type;
|
| 200 |
+
));
|
| 201 |
+
|
| 202 |
+
/**
|
| 203 |
+
* Release the memory associated with an EOS_Mods_ModInfo structure and its sub-objects. This must be called on data retrieved from EOS_Mods_CopyModInfo.
|
| 204 |
+
*
|
| 205 |
+
* @param ModInfo the info structure to be release
|
| 206 |
+
*
|
| 207 |
+
* @see EOS_Mods_ModInfo
|
| 208 |
+
* @see EOS_Mods_CopyModInfo
|
| 209 |
+
*/
|
| 210 |
+
EOS_DECLARE_FUNC(void) EOS_Mods_ModInfo_Release(EOS_Mods_ModInfo* ModInfo);
|
| 211 |
+
|
| 212 |
+
/** The most recent version of the EOS_Mods_UpdateModOptions API. */
|
| 213 |
+
#define EOS_MODS_UPDATEMOD_API_LATEST 1
|
| 214 |
+
|
| 215 |
+
/**
|
| 216 |
+
* Input parameters for the EOS_Mods_UpdateMod Function.
|
| 217 |
+
*/
|
| 218 |
+
EOS_STRUCT(EOS_Mods_UpdateModOptions, (
|
| 219 |
+
/** API Version: Set this to EOS_MODS_UPDATEMOD_API_LATEST. */
|
| 220 |
+
int32_t ApiVersion;
|
| 221 |
+
/** The Epic Account ID of the user for which the mod should be updated */
|
| 222 |
+
EOS_EpicAccountId LocalUserId;
|
| 223 |
+
/** The mod to update */
|
| 224 |
+
const EOS_Mod_Identifier* Mod;
|
| 225 |
+
));
|
| 226 |
+
|
| 227 |
+
/**
|
| 228 |
+
* Output parameters for the EOS_Mods_UpdateMod Function. These parameters are received through the callback provided to EOS_Mods_UpdateMod
|
| 229 |
+
*/
|
| 230 |
+
EOS_STRUCT(EOS_Mods_UpdateModCallbackInfo, (
|
| 231 |
+
/** Result code for the operation. EOS_Success is returned if the request to update was successful, otherwise one of the error codes is returned. */
|
| 232 |
+
EOS_EResult ResultCode;
|
| 233 |
+
/** The Epic Account ID of the user for which mod update was requested */
|
| 234 |
+
EOS_EpicAccountId LocalUserId;
|
| 235 |
+
/** Context that is passed into EOS_Mods_UpdateMod */
|
| 236 |
+
void* ClientData;
|
| 237 |
+
/** Mod for which update was requested */
|
| 238 |
+
const EOS_Mod_Identifier* Mod;
|
| 239 |
+
));
|
| 240 |
+
|
| 241 |
+
/**
|
| 242 |
+
* Function prototype definition for callbacks passed to EOS_Mods_UpdateMod
|
| 243 |
+
* @param Data A EOS_Mods_UpdateModCallbackInfo containing the output information and result
|
| 244 |
+
*/
|
| 245 |
+
EOS_DECLARE_CALLBACK(EOS_Mods_OnUpdateModCallback, const EOS_Mods_UpdateModCallbackInfo* Data);
|
| 246 |
+
|
| 247 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_p2p.h
ADDED
|
@@ -0,0 +1,391 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_p2p_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* P2P functions to help manage sending and receiving of messages to peers.
|
| 8 |
+
*
|
| 9 |
+
* These functions will attempt to punch through NATs, but will fallback to using Epic relay servers if a direct connection cannot be established.
|
| 10 |
+
*/
|
| 11 |
+
|
| 12 |
+
/**
|
| 13 |
+
* Send a packet to a peer at the specified address. If there is already an open connection to this peer, it will be
|
| 14 |
+
* sent immediately. If there is no open connection, an attempt to connect to the peer will be made. An EOS_Success
|
| 15 |
+
* result only means the data was accepted to be sent, not that it has been successfully delivered to the peer.
|
| 16 |
+
*
|
| 17 |
+
* @param Options Information about the data being sent, by who, to who
|
| 18 |
+
* @return EOS_EResult containing the result of the operation.
|
| 19 |
+
* Possible result codes:
|
| 20 |
+
* - EOS_Success - If packet was queued to be sent successfully
|
| 21 |
+
* - EOS_InvalidParameters - If input was invalid
|
| 22 |
+
* - EOS_InvalidUser - If the LocalUserId is invalid
|
| 23 |
+
* - EOS_InvalidAuth - If the local user is not logged in
|
| 24 |
+
* - EOS_LimitExceeded - If amount of data being sent is too large, or the outgoing packet queue was full
|
| 25 |
+
* - EOS_NoConnection - If bDisableAutoAcceptConnection was set to EOS_TRUE and the connection was not currently accepted (call EOS_P2P_AcceptConnection first, or set bDisableAutoAcceptConnection to EOS_FALSE)
|
| 26 |
+
*
|
| 27 |
+
* @see EOS_P2P_SendPacketOptions
|
| 28 |
+
*/
|
| 29 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_SendPacket(EOS_HP2P Handle, const EOS_P2P_SendPacketOptions* Options);
|
| 30 |
+
|
| 31 |
+
/**
|
| 32 |
+
* Gets the size of the packet that will be returned by ReceivePacket for a particular user, if there is any available
|
| 33 |
+
* packets to be retrieved.
|
| 34 |
+
*
|
| 35 |
+
* @param Options Information about who is requesting the size of their next packet
|
| 36 |
+
* @param OutPacketSizeBytes The amount of bytes required to store the data of the next packet for the requested user
|
| 37 |
+
* @return EOS_EResult containing the result of the operation.
|
| 38 |
+
* Possible result codes:
|
| 39 |
+
* - EOS_Success - If OutPacketSizeBytes was successfully set and there is data to be received
|
| 40 |
+
* - EOS_InvalidParameters - If input was invalid
|
| 41 |
+
* - EOS_InvalidUser - If the LocalUserId is invalid
|
| 42 |
+
* - EOS_InvalidAuth - If the local user is not logged in
|
| 43 |
+
* - EOS_NotFound - If there are no packets available for the requesting user
|
| 44 |
+
*
|
| 45 |
+
* @see EOS_P2P_GetNextReceivedPacketSizeOptions
|
| 46 |
+
*/
|
| 47 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_GetNextReceivedPacketSize(EOS_HP2P Handle, const EOS_P2P_GetNextReceivedPacketSizeOptions* Options, uint32_t* OutPacketSizeBytes);
|
| 48 |
+
|
| 49 |
+
/**
|
| 50 |
+
* Receive the next packet for the local user, and information associated with this packet, if it exists.
|
| 51 |
+
*
|
| 52 |
+
* @param Options Information about who is requesting the size of their next packet, and how much data can be stored safely
|
| 53 |
+
* @param OutPeerId The Remote User who sent data. Only set if there was a packet to receive.
|
| 54 |
+
* @param OutSocketId The Socket ID of the data that was sent. Only set if there was a packet to receive.
|
| 55 |
+
* @param OutChannel The channel the data was sent on. Only set if there was a packet to receive.
|
| 56 |
+
* @param OutData Buffer to store the data being received. Must be at least EOS_P2P_GetNextReceivedPacketSize in length or data will be truncated
|
| 57 |
+
* @param OutBytesWritten The amount of bytes written to OutData. Only set if there was a packet to receive.
|
| 58 |
+
* @return EOS_EResult containing the result of the operation.
|
| 59 |
+
* Possible result codes:
|
| 60 |
+
* - EOS_Success - If the packet was received successfully
|
| 61 |
+
* - EOS_InvalidParameters - If input was invalid
|
| 62 |
+
* - EOS_InvalidUser - If the LocalUserId is invalid
|
| 63 |
+
* - EOS_InvalidAuth - If the local user is not logged in
|
| 64 |
+
* - EOS_NotFound - If there are no packets available for the requesting user
|
| 65 |
+
*
|
| 66 |
+
* @see EOS_P2P_GetNextReceivedPacketSize
|
| 67 |
+
* @see EOS_P2P_ReceivePacketOptions
|
| 68 |
+
*/
|
| 69 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_ReceivePacket(EOS_HP2P Handle, const EOS_P2P_ReceivePacketOptions* Options, EOS_ProductUserId* OutPeerId, EOS_P2P_SocketId* OutSocketId, uint8_t* OutChannel, void* OutData, uint32_t* OutBytesWritten);
|
| 70 |
+
|
| 71 |
+
/**
|
| 72 |
+
* Listen for incoming connection requests on a particular Socket ID, or optionally all Socket IDs. The bound function
|
| 73 |
+
* will only be called if the connection has not already been accepted.
|
| 74 |
+
* If the network status changes from offline or disabled to online, you must call this function again.
|
| 75 |
+
* @param Options Information about who would like notifications, and (optionally) only for a specific socket
|
| 76 |
+
* @param ClientData This value is returned to the caller when ConnectionRequestHandler is invoked
|
| 77 |
+
* @param ConnectionRequestHandler The callback to be fired when we receive a connection request
|
| 78 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 79 |
+
*
|
| 80 |
+
* @see EOS_P2P_RemoveNotifyPeerConnectionRequest
|
| 81 |
+
* @see EOS_P2P_AddNotifyPeerConnectionRequestOptions
|
| 82 |
+
* @see EOS_P2P_OnIncomingConnectionRequestCallback
|
| 83 |
+
*/
|
| 84 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_P2P_AddNotifyPeerConnectionRequest(EOS_HP2P Handle, const EOS_P2P_AddNotifyPeerConnectionRequestOptions* Options, void* ClientData, EOS_P2P_OnIncomingConnectionRequestCallback ConnectionRequestHandler);
|
| 85 |
+
|
| 86 |
+
/**
|
| 87 |
+
* Stop listening for connection requests on a previously bound handler.
|
| 88 |
+
*
|
| 89 |
+
* @param NotificationId The previously bound notification ID
|
| 90 |
+
*
|
| 91 |
+
* @see EOS_P2P_AddNotifyPeerConnectionRequest
|
| 92 |
+
*/
|
| 93 |
+
EOS_DECLARE_FUNC(void) EOS_P2P_RemoveNotifyPeerConnectionRequest(EOS_HP2P Handle, EOS_NotificationId NotificationId);
|
| 94 |
+
|
| 95 |
+
/**
|
| 96 |
+
* Listen for when a connection is established. This is fired when we first connect to a peer, when we reconnect to a peer after a connection interruption,
|
| 97 |
+
* and when our underlying network connection type changes (for example, from a direct connection to relay, or vice versa). Network Connection Type changes
|
| 98 |
+
* will always be broadcast with a EOS_CET_Reconnection connection type, even if the connection was not interrupted.
|
| 99 |
+
* If the network status changes from offline or disabled to online, you must call this function again.
|
| 100 |
+
*
|
| 101 |
+
* @param Options Information about who would like notifications about established connections, and for which socket
|
| 102 |
+
* @param ClientData This value is returned to the caller when ConnectionEstablishedHandler is invoked
|
| 103 |
+
* @param ConnectionEstablishedHandler The callback to be fired when a connection has been established
|
| 104 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 105 |
+
*
|
| 106 |
+
* @see EOS_P2P_AddNotifyPeerConnectionEstablishedOptions
|
| 107 |
+
* @see EOS_P2P_OnPeerConnectionEstablishedCallback
|
| 108 |
+
* @see EOS_P2P_AddNotifyPeerConnectionInterrupted
|
| 109 |
+
* @see EOS_P2P_AddNotifyPeerConnectionClosed
|
| 110 |
+
* @see EOS_P2P_RemoveNotifyPeerConnectionEstablished
|
| 111 |
+
*/
|
| 112 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_P2P_AddNotifyPeerConnectionEstablished(EOS_HP2P Handle, const EOS_P2P_AddNotifyPeerConnectionEstablishedOptions* Options, void* ClientData, EOS_P2P_OnPeerConnectionEstablishedCallback ConnectionEstablishedHandler);
|
| 113 |
+
|
| 114 |
+
/**
|
| 115 |
+
* Stop notifications for connections being established on a previously bound handler.
|
| 116 |
+
*
|
| 117 |
+
* @param NotificationId The previously bound notification ID
|
| 118 |
+
*
|
| 119 |
+
* @see EOS_P2P_AddNotifyPeerConnectionEstablished
|
| 120 |
+
*/
|
| 121 |
+
EOS_DECLARE_FUNC(void) EOS_P2P_RemoveNotifyPeerConnectionEstablished(EOS_HP2P Handle, EOS_NotificationId NotificationId);
|
| 122 |
+
|
| 123 |
+
/**
|
| 124 |
+
* Listen for when a previously opened connection is interrupted. The connection will automatically attempt to reestablish, but it may not be successful.
|
| 125 |
+
*
|
| 126 |
+
* If a connection reconnects, it will trigger the P2P PeerConnectionEstablished notification with the EOS_CET_Reconnection connection type.
|
| 127 |
+
* If a connection fails to reconnect, it will trigger the P2P PeerConnectionClosed notification.
|
| 128 |
+
* Packets remain queued during connection interruptions. When a connection closes, packets are flushed. This includes reliable packets.
|
| 129 |
+
*
|
| 130 |
+
* @param Options Information about who would like notifications about interrupted connections, and for which socket
|
| 131 |
+
* @param ClientData This value is returned to the caller when ConnectionInterruptedHandler is invoked
|
| 132 |
+
* @param ConnectionInterruptedHandler The callback to be fired when an open connection has been interrupted
|
| 133 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 134 |
+
*
|
| 135 |
+
* @see EOS_P2P_AddNotifyPeerConnectionInterruptedOptions
|
| 136 |
+
* @see EOS_P2P_OnPeerConnectionInterruptedCallback
|
| 137 |
+
* @see EOS_P2P_AddNotifyPeerConnectionEstablished
|
| 138 |
+
* @see EOS_P2P_AddNotifyPeerConnectionClosed
|
| 139 |
+
* @see EOS_P2P_RemoveNotifyPeerConnectionInterrupted
|
| 140 |
+
*/
|
| 141 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_P2P_AddNotifyPeerConnectionInterrupted(EOS_HP2P Handle, const EOS_P2P_AddNotifyPeerConnectionInterruptedOptions* Options, void* ClientData, EOS_P2P_OnPeerConnectionInterruptedCallback ConnectionInterruptedHandler);
|
| 142 |
+
|
| 143 |
+
/**
|
| 144 |
+
* Stop notifications for connections being interrupted on a previously bound handler.
|
| 145 |
+
*
|
| 146 |
+
* @param NotificationId The previously bound notification ID
|
| 147 |
+
*
|
| 148 |
+
* @see EOS_P2P_AddNotifyPeerConnectionInterrupted
|
| 149 |
+
*/
|
| 150 |
+
EOS_DECLARE_FUNC(void) EOS_P2P_RemoveNotifyPeerConnectionInterrupted(EOS_HP2P Handle, EOS_NotificationId NotificationId);
|
| 151 |
+
|
| 152 |
+
/**
|
| 153 |
+
* Listen for when a previously accepted connection that was either open or pending is closed.
|
| 154 |
+
* When a connection closes, packets are flushed. This includes reliable packets.
|
| 155 |
+
*
|
| 156 |
+
* @param Options Information about who would like notifications about closed connections, and for which socket
|
| 157 |
+
* @param ClientData This value is returned to the caller when ConnectionClosedHandler is invoked
|
| 158 |
+
* @param ConnectionClosedHandler The callback to be fired when an open connection has been closed
|
| 159 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 160 |
+
*
|
| 161 |
+
* @see EOS_P2P_AddNotifyPeerConnectionClosedOptions
|
| 162 |
+
* @see EOS_P2P_OnRemoteConnectionClosedCallback
|
| 163 |
+
* @see EOS_P2P_AddNotifyPeerConnectionEstablished
|
| 164 |
+
* @see EOS_P2P_AddNotifyPeerConnectionInterrupted
|
| 165 |
+
* @see EOS_P2P_RemoveNotifyPeerConnectionClosed
|
| 166 |
+
*/
|
| 167 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_P2P_AddNotifyPeerConnectionClosed(EOS_HP2P Handle, const EOS_P2P_AddNotifyPeerConnectionClosedOptions* Options, void* ClientData, EOS_P2P_OnRemoteConnectionClosedCallback ConnectionClosedHandler);
|
| 168 |
+
|
| 169 |
+
/**
|
| 170 |
+
* Stop notifications for connections being closed on a previously bound handler.
|
| 171 |
+
*
|
| 172 |
+
* @param NotificationId The previously bound notification ID
|
| 173 |
+
*
|
| 174 |
+
* @see EOS_P2P_AddNotifyPeerConnectionClosed
|
| 175 |
+
*/
|
| 176 |
+
EOS_DECLARE_FUNC(void) EOS_P2P_RemoveNotifyPeerConnectionClosed(EOS_HP2P Handle, EOS_NotificationId NotificationId);
|
| 177 |
+
|
| 178 |
+
/**
|
| 179 |
+
* Accept or Request a connection with a specific peer on a specific Socket ID.
|
| 180 |
+
*
|
| 181 |
+
* If this connection was not already locally accepted, we will securely message the peer, and trigger a PeerConnectionRequest notification notifying
|
| 182 |
+
* them of the connection request. If the PeerConnectionRequest notification is not bound for all Socket IDs or for the requested Socket ID in particular,
|
| 183 |
+
* the request will be silently ignored.
|
| 184 |
+
*
|
| 185 |
+
* If the remote peer accepts the connection, a notification will be broadcast to the EOS_P2P_AddNotifyPeerConnectionEstablished when the connection is
|
| 186 |
+
* ready to send packets.
|
| 187 |
+
*
|
| 188 |
+
* If multiple Socket IDs are accepted with one peer, they will share one physical socket.
|
| 189 |
+
*
|
| 190 |
+
* Even if a connection is already locally accepted, EOS_Success will still be returned if the input was valid.
|
| 191 |
+
*
|
| 192 |
+
* @param Options Information about who would like to accept a connection, and which connection
|
| 193 |
+
* @return EOS_EResult containing the result of the operation.
|
| 194 |
+
* Possible result codes:
|
| 195 |
+
* - EOS_Success - If the provided data is valid
|
| 196 |
+
* - EOS_InvalidParameters - If the provided data is invalid
|
| 197 |
+
* - EOS_InvalidUser - If the LocalUserId or RemoteUserId is invalid
|
| 198 |
+
* - EOS_InvalidAuth - If the local user is not logged in
|
| 199 |
+
*
|
| 200 |
+
* @see EOS_P2P_AcceptConnectionOptions
|
| 201 |
+
*/
|
| 202 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_AcceptConnection(EOS_HP2P Handle, const EOS_P2P_AcceptConnectionOptions* Options);
|
| 203 |
+
|
| 204 |
+
/**
|
| 205 |
+
* For all (or optionally one specific) Socket ID(s) with a specific peer: stop receiving packets, drop any locally queued packets, and if no other
|
| 206 |
+
* Socket ID is using the connection with the peer, close the underlying connection.
|
| 207 |
+
*
|
| 208 |
+
* If your application wants to migrate an existing connection with a peer it already connected to, it is recommended to call EOS_P2P_AcceptConnection
|
| 209 |
+
* with the new Socket ID first before calling EOS_P2P_CloseConnection, to prevent the shared physical socket from being torn down prematurely.
|
| 210 |
+
*
|
| 211 |
+
* @param Options Information about who would like to close a connection, and which connection.
|
| 212 |
+
* @return EOS_EResult containing the result of the operation.
|
| 213 |
+
* Possible result codes:
|
| 214 |
+
* - EOS_Success - If the provided data is valid
|
| 215 |
+
* - EOS_InvalidParameters - If the provided data is invalid
|
| 216 |
+
* - EOS_InvalidUser - If the LocalUserId or RemoteUserId is invalid
|
| 217 |
+
* - EOS_InvalidAuth - If the local user is not logged in
|
| 218 |
+
*
|
| 219 |
+
* @see EOS_P2P_CloseConnectionOptions
|
| 220 |
+
*/
|
| 221 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_CloseConnection(EOS_HP2P Handle, const EOS_P2P_CloseConnectionOptions* Options);
|
| 222 |
+
|
| 223 |
+
/**
|
| 224 |
+
* Close any open Connections for a specific Peer Connection ID.
|
| 225 |
+
*
|
| 226 |
+
* @param Options Information about who would like to close connections, and by what socket ID
|
| 227 |
+
* @return EOS_EResult containing the result of the operation.
|
| 228 |
+
* Possible result codes:
|
| 229 |
+
* - EOS_Success - If the provided data is valid
|
| 230 |
+
* - EOS_InvalidParameters - If the provided data is invalid
|
| 231 |
+
* - EOS_InvalidUser - If the LocalUserId is invalid
|
| 232 |
+
*
|
| 233 |
+
* @see EOS_P2P_CloseConnectionsOptions
|
| 234 |
+
*/
|
| 235 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_CloseConnections(EOS_HP2P Handle, const EOS_P2P_CloseConnectionsOptions* Options);
|
| 236 |
+
|
| 237 |
+
/**
|
| 238 |
+
* Query the current NAT-type of our connection.
|
| 239 |
+
*
|
| 240 |
+
* @param Options Information about what version of the EOS_P2P_QueryNATType API is supported
|
| 241 |
+
* @param ClientData arbitrary data that is passed back to you in the CompletionDelegate
|
| 242 |
+
* @param CompletionDelegate The callback to be fired when we finish querying our NAT type
|
| 243 |
+
*
|
| 244 |
+
* @see EOS_P2P_QueryNATTypeOptions
|
| 245 |
+
* @see EOS_P2P_OnQueryNATTypeCompleteCallback
|
| 246 |
+
*/
|
| 247 |
+
EOS_DECLARE_FUNC(void) EOS_P2P_QueryNATType(EOS_HP2P Handle, const EOS_P2P_QueryNATTypeOptions* Options, void* ClientData, const EOS_P2P_OnQueryNATTypeCompleteCallback CompletionDelegate);
|
| 248 |
+
|
| 249 |
+
/**
|
| 250 |
+
* Get our last-queried NAT-type, if it has been successfully queried.
|
| 251 |
+
*
|
| 252 |
+
* @param Options Information about what version of the EOS_P2P_GetNATType API is supported
|
| 253 |
+
* @param OutNATType The queried NAT Type, or unknown if unknown
|
| 254 |
+
* @return EOS_EResult containing the result of the operation.
|
| 255 |
+
* Possible result codes:
|
| 256 |
+
* - EOS_Success - If we have cached data
|
| 257 |
+
* - EOS_InvalidParameters - If the OutNATType parameter is NULL
|
| 258 |
+
* - EOS_NotFound - If we do not have queried data cached
|
| 259 |
+
*
|
| 260 |
+
* @see EOS_P2P_GetNATTypeOptions
|
| 261 |
+
*/
|
| 262 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_GetNATType(EOS_HP2P Handle, const EOS_P2P_GetNATTypeOptions* Options, EOS_ENATType* OutNATType);
|
| 263 |
+
|
| 264 |
+
/**
|
| 265 |
+
* Set how relay servers are to be used. This setting does not immediately apply to existing connections, but may apply to existing
|
| 266 |
+
* connections if the connection requires renegotiation.
|
| 267 |
+
*
|
| 268 |
+
* @param Options Information about relay server config options
|
| 269 |
+
* @return EOS_EResult containing the result of the operation.
|
| 270 |
+
* Possible result codes:
|
| 271 |
+
* - EOS_Success - If the options were set successfully
|
| 272 |
+
* - EOS_InvalidParameters - If the options are invalid in some way
|
| 273 |
+
* - EOS_Disabled - If relay control cannot be changed on this platform
|
| 274 |
+
*
|
| 275 |
+
* @see EOS_P2P_SetRelayControlOptions
|
| 276 |
+
* @see EOS_ERelayControl
|
| 277 |
+
*/
|
| 278 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_SetRelayControl(EOS_HP2P Handle, const EOS_P2P_SetRelayControlOptions* Options);
|
| 279 |
+
|
| 280 |
+
/**
|
| 281 |
+
* Get the current relay control setting.
|
| 282 |
+
*
|
| 283 |
+
* @param Options Information about what version of the EOS_P2P_GetRelayControl API is supported
|
| 284 |
+
* @param OutRelayControl The relay control setting currently configured
|
| 285 |
+
* @return EOS_EResult containing the result of the operation.
|
| 286 |
+
* Possible result codes:
|
| 287 |
+
* - EOS_Success - if the input was valid
|
| 288 |
+
* - EOS_InvalidParameters - if the input was invalid in some way
|
| 289 |
+
*
|
| 290 |
+
* @see EOS_P2P_GetRelayControlOptions
|
| 291 |
+
* @see EOS_ERelayControl
|
| 292 |
+
*/
|
| 293 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_GetRelayControl(EOS_HP2P Handle, const EOS_P2P_GetRelayControlOptions* Options, EOS_ERelayControl* OutRelayControl);
|
| 294 |
+
|
| 295 |
+
/**
|
| 296 |
+
* Set configuration options related to network ports.
|
| 297 |
+
*
|
| 298 |
+
* @param Options Information about network ports config options
|
| 299 |
+
* @return EOS_EResult containing the result of the operation.
|
| 300 |
+
* Possible result codes:
|
| 301 |
+
* - EOS_Success - if the options were set successfully
|
| 302 |
+
* - EOS_InvalidParameters - if the options are invalid in some way
|
| 303 |
+
*
|
| 304 |
+
* @see EOS_P2P_SetPortRangeOptions
|
| 305 |
+
*/
|
| 306 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_SetPortRange(EOS_HP2P Handle, const EOS_P2P_SetPortRangeOptions* Options);
|
| 307 |
+
|
| 308 |
+
/**
|
| 309 |
+
* Get the current chosen port and the amount of other ports to try above the chosen port if the chosen port is unavailable.
|
| 310 |
+
*
|
| 311 |
+
* @param Options Information about what version of the EOS_P2P_GetPortRange API is supported
|
| 312 |
+
* @param OutPort The port that will be tried first
|
| 313 |
+
* @param OutNumAdditionalPortsToTry The amount of ports to try above the value in OutPort, if OutPort is unavailable
|
| 314 |
+
* @return EOS_EResult containing the result of the operation.
|
| 315 |
+
* Possible result codes:
|
| 316 |
+
* - EOS_Success - if the input options were valid
|
| 317 |
+
* - EOS_InvalidParameters - if the input was invalid in some way
|
| 318 |
+
*
|
| 319 |
+
* @see EOS_P2P_GetPortRangeOptions
|
| 320 |
+
*/
|
| 321 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_GetPortRange(EOS_HP2P Handle, const EOS_P2P_GetPortRangeOptions* Options, uint16_t* OutPort, uint16_t* OutNumAdditionalPortsToTry);
|
| 322 |
+
|
| 323 |
+
/**
|
| 324 |
+
* Sets the maximum packet queue sizes that packets waiting to be sent or received can use. If the packet queue
|
| 325 |
+
* size is made smaller than the current queue size while there are packets in the queue that would push this
|
| 326 |
+
* packet size over, existing packets are kept but new packets may not be added to the full queue until enough
|
| 327 |
+
* packets are sent or received.
|
| 328 |
+
*
|
| 329 |
+
* @param Options Information about packet queue size
|
| 330 |
+
* @return EOS_EResult containing the result of the operation.
|
| 331 |
+
* Possible result codes:
|
| 332 |
+
* - EOS_Success - if the input options were valid
|
| 333 |
+
* - EOS_InvalidParameters - if the input was invalid in some way
|
| 334 |
+
*
|
| 335 |
+
* @see EOS_P2P_SetPacketQueueSizeOptions
|
| 336 |
+
*/
|
| 337 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_SetPacketQueueSize(EOS_HP2P Handle, const EOS_P2P_SetPacketQueueSizeOptions* Options);
|
| 338 |
+
|
| 339 |
+
/**
|
| 340 |
+
* Gets the current cached information related to the incoming and outgoing packet queues.
|
| 341 |
+
*
|
| 342 |
+
* @param Options Information about what version of the EOS_P2P_GetPacketQueueInfo API is supported
|
| 343 |
+
* @param OutPacketQueueInfo The current information of the incoming and outgoing packet queues
|
| 344 |
+
* @return EOS_EResult containing the result of the operation.
|
| 345 |
+
* Possible result codes:
|
| 346 |
+
* - EOS_Success - if the input options were valid
|
| 347 |
+
* - EOS_InvalidParameters - if the input was invalid in some way
|
| 348 |
+
*
|
| 349 |
+
* @see EOS_P2P_GetPacketQueueInfoOptions
|
| 350 |
+
* @see EOS_P2P_PacketQueueInfo
|
| 351 |
+
*/
|
| 352 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_GetPacketQueueInfo(EOS_HP2P Handle, const EOS_P2P_GetPacketQueueInfoOptions* Options, EOS_P2P_PacketQueueInfo* OutPacketQueueInfo);
|
| 353 |
+
|
| 354 |
+
/**
|
| 355 |
+
* Listen for when our packet queue has become full. This event gives an opportunity to read packets to make
|
| 356 |
+
* room for new incoming packets. If this event fires and no packets are read by calling EOS_P2P_ReceivePacket
|
| 357 |
+
* or the packet queue size is not increased by EOS_P2P_SetPacketQueueSize, any packets that are received after
|
| 358 |
+
* this event are discarded until there is room again in the queue.
|
| 359 |
+
*
|
| 360 |
+
* @param Options Information about what version of the EOS_P2P_AddNotifyIncomingPacketQueueFull API is supported
|
| 361 |
+
* @param ClientData Arbitrary data that is passed back to you in the CompletionDelegate
|
| 362 |
+
* @param IncomingPacketQueueFullHandler The callback to be fired when the incoming packet queue is full
|
| 363 |
+
* @return A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
|
| 364 |
+
*
|
| 365 |
+
* @see EOS_P2P_AddNotifyIncomingPacketQueueFullOptions
|
| 366 |
+
* @see EOS_P2P_OnIncomingPacketQueueFullCallback
|
| 367 |
+
*/
|
| 368 |
+
EOS_DECLARE_FUNC(EOS_NotificationId) EOS_P2P_AddNotifyIncomingPacketQueueFull(EOS_HP2P Handle, const EOS_P2P_AddNotifyIncomingPacketQueueFullOptions* Options, void* ClientData, EOS_P2P_OnIncomingPacketQueueFullCallback IncomingPacketQueueFullHandler);
|
| 369 |
+
|
| 370 |
+
/**
|
| 371 |
+
* Stop listening for full incoming packet queue events on a previously bound handler.
|
| 372 |
+
*
|
| 373 |
+
* @param NotificationId The previously bound notification ID
|
| 374 |
+
*/
|
| 375 |
+
EOS_DECLARE_FUNC(void) EOS_P2P_RemoveNotifyIncomingPacketQueueFull(EOS_HP2P Handle, EOS_NotificationId NotificationId);
|
| 376 |
+
|
| 377 |
+
/**
|
| 378 |
+
* Clear queued incoming and outgoing packets.
|
| 379 |
+
*
|
| 380 |
+
* @param Options Information about which queues should be cleared
|
| 381 |
+
* @return EOS_EResult containing the result of the operation.
|
| 382 |
+
* Possible result codes:
|
| 383 |
+
* - EOS_Success - If the input options were valid (even if queues were empty and no packets were cleared)
|
| 384 |
+
* - EOS_IncompatibleVersion - If wrong API version
|
| 385 |
+
* - EOS_InvalidUser - If an invalid/remote user was used
|
| 386 |
+
* - EOS_InvalidAuth - If the local user is not logged in
|
| 387 |
+
* - EOS_InvalidParameters - If input was invalid in some other way
|
| 388 |
+
*
|
| 389 |
+
* @see EOS_P2P_ClearPacketQueueOptions
|
| 390 |
+
*/
|
| 391 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_P2P_ClearPacketQueue(EOS_HP2P Handle, const EOS_P2P_ClearPacketQueueOptions* Options);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_p2p_types.h
ADDED
|
@@ -0,0 +1,604 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
EOS_EXTERN_C typedef struct EOS_P2PHandle* EOS_HP2P;
|
| 10 |
+
|
| 11 |
+
/**
|
| 12 |
+
* A packet's maximum size in bytes
|
| 13 |
+
*/
|
| 14 |
+
#define EOS_P2P_MAX_PACKET_SIZE 1170
|
| 15 |
+
|
| 16 |
+
/**
|
| 17 |
+
* The maximum amount of unique Socket ID connections that can be opened with each remote user. As this limit is only per remote user, you may have more
|
| 18 |
+
* than this number of Socket IDs across multiple remote users.
|
| 19 |
+
*/
|
| 20 |
+
#define EOS_P2P_MAX_CONNECTIONS 32
|
| 21 |
+
|
| 22 |
+
/**
|
| 23 |
+
* Categories of NAT strictness.
|
| 24 |
+
*/
|
| 25 |
+
EOS_ENUM(EOS_ENATType,
|
| 26 |
+
/** NAT type either unknown (remote) or we are unable to determine it (local) */
|
| 27 |
+
EOS_NAT_Unknown = 0,
|
| 28 |
+
/** All peers can directly-connect to you */
|
| 29 |
+
EOS_NAT_Open = 1,
|
| 30 |
+
/** You can directly-connect to other Moderate and Open peers */
|
| 31 |
+
EOS_NAT_Moderate = 2,
|
| 32 |
+
/** You can only directly-connect to Open peers */
|
| 33 |
+
EOS_NAT_Strict = 3
|
| 34 |
+
);
|
| 35 |
+
|
| 36 |
+
/** The most recent version of the EOS_P2P_SocketId structure. */
|
| 37 |
+
#define EOS_P2P_SOCKETID_API_LATEST 1
|
| 38 |
+
|
| 39 |
+
/** The total buffer size of a EOS_P2P_SocketId SocketName, including space for the null-terminator */
|
| 40 |
+
#define EOS_P2P_SOCKETID_SOCKETNAME_SIZE 33
|
| 41 |
+
|
| 42 |
+
/**
|
| 43 |
+
* P2P Socket ID
|
| 44 |
+
*
|
| 45 |
+
* The Socket ID contains an application-defined name for the connection between a local person and another peer.
|
| 46 |
+
*
|
| 47 |
+
* When a remote user receives a connection request from you, they will receive this information. It can be important
|
| 48 |
+
* to only accept connections with a known socket-name and/or from a known user, to prevent leaking of private
|
| 49 |
+
* information, such as a user's IP address. Using the socket name as a secret key can help prevent such leaks. Shared
|
| 50 |
+
* private data, like a private match's Session ID are good candidates for a socket name.
|
| 51 |
+
*/
|
| 52 |
+
EOS_STRUCT(EOS_P2P_SocketId, (
|
| 53 |
+
/** API Version: Set this to EOS_P2P_SOCKETID_API_LATEST. */
|
| 54 |
+
int32_t ApiVersion;
|
| 55 |
+
/** A name for the connection. Must be a NULL-terminated string of between 1-32 alpha-numeric characters (A-Z, a-z, 0-9, '-', '_', ' ', '+', '=', '.') */
|
| 56 |
+
char SocketName[EOS_P2P_SOCKETID_SOCKETNAME_SIZE];
|
| 57 |
+
));
|
| 58 |
+
|
| 59 |
+
/**
|
| 60 |
+
* Types of packet reliability.
|
| 61 |
+
*
|
| 62 |
+
* Ordered packets will only be ordered relative to other ordered packets. Reliable/unreliable and ordered/unordered communication
|
| 63 |
+
* can be sent on the same Socket ID and Channel.
|
| 64 |
+
*/
|
| 65 |
+
EOS_ENUM(EOS_EPacketReliability,
|
| 66 |
+
/** Packets will only be sent once and may be received out of order */
|
| 67 |
+
EOS_PR_UnreliableUnordered = 0,
|
| 68 |
+
/** Packets may be sent multiple times and may be received out of order */
|
| 69 |
+
EOS_PR_ReliableUnordered = 1,
|
| 70 |
+
/** Packets may be sent multiple times and will be received in order */
|
| 71 |
+
EOS_PR_ReliableOrdered = 2
|
| 72 |
+
);
|
| 73 |
+
|
| 74 |
+
/** The most recent version of the EOS_P2P_SendPacket API. */
|
| 75 |
+
#define EOS_P2P_SENDPACKET_API_LATEST 3
|
| 76 |
+
|
| 77 |
+
/**
|
| 78 |
+
* Structure containing information about the data being sent and to which player
|
| 79 |
+
*/
|
| 80 |
+
EOS_STRUCT(EOS_P2P_SendPacketOptions, (
|
| 81 |
+
/** API Version: Set this to EOS_P2P_SENDPACKET_API_LATEST. */
|
| 82 |
+
int32_t ApiVersion;
|
| 83 |
+
/** The Product User ID of the local user who is sending this packet */
|
| 84 |
+
EOS_ProductUserId LocalUserId;
|
| 85 |
+
/** The Product User ID of the Peer you would like to send a packet to */
|
| 86 |
+
EOS_ProductUserId RemoteUserId;
|
| 87 |
+
/** The socket ID for data you are sending in this packet */
|
| 88 |
+
const EOS_P2P_SocketId* SocketId;
|
| 89 |
+
/** Channel associated with this data */
|
| 90 |
+
uint8_t Channel;
|
| 91 |
+
/** The size of the data to be sent to the RemoteUser */
|
| 92 |
+
uint32_t DataLengthBytes;
|
| 93 |
+
/** The data to be sent to the RemoteUser */
|
| 94 |
+
const void* Data;
|
| 95 |
+
/** If false and we do not already have an established connection to the peer, this data will be dropped */
|
| 96 |
+
EOS_Bool bAllowDelayedDelivery;
|
| 97 |
+
/** Sets the reliability of the delivery of this packet. The reliability can be `EOS_PR_UnreliableUnordered`, `EOS_PR_ReliableUnordered`, or `EOS_PR_ReliableOrdered`. */
|
| 98 |
+
EOS_EPacketReliability Reliability;
|
| 99 |
+
/**
|
| 100 |
+
* If set to EOS_TRUE, EOS_P2P_SendPacket will not automatically establish a connection with the RemoteUserId and will require explicit calls to
|
| 101 |
+
* EOS_P2P_AcceptConnection first whenever the connection is closed. If set to EOS_FALSE, EOS_P2P_SendPacket will automatically accept and start
|
| 102 |
+
* the connection any time it is called and the connection is not already open.
|
| 103 |
+
*/
|
| 104 |
+
EOS_Bool bDisableAutoAcceptConnection;
|
| 105 |
+
));
|
| 106 |
+
|
| 107 |
+
/** The most recent version of the EOS_P2P_GetNextReceivedPacketSize API. */
|
| 108 |
+
#define EOS_P2P_GETNEXTRECEIVEDPACKETSIZE_API_LATEST 2
|
| 109 |
+
|
| 110 |
+
/**
|
| 111 |
+
* Structure containing information about who would like to receive a packet.
|
| 112 |
+
*/
|
| 113 |
+
EOS_STRUCT(EOS_P2P_GetNextReceivedPacketSizeOptions, (
|
| 114 |
+
/** API Version: Set this to EOS_P2P_GETNEXTRECEIVEDPACKETSIZE_API_LATEST. */
|
| 115 |
+
int32_t ApiVersion;
|
| 116 |
+
/** The Product User ID of the local user who is receiving the packet */
|
| 117 |
+
EOS_ProductUserId LocalUserId;
|
| 118 |
+
/** An optional channel to request the data for. If NULL, we're retrieving the size of the next packet on any channel. */
|
| 119 |
+
const uint8_t* RequestedChannel;
|
| 120 |
+
|
| 121 |
+
));
|
| 122 |
+
|
| 123 |
+
/** The most recent version of the EOS_P2P_ReceivePacket API. */
|
| 124 |
+
#define EOS_P2P_RECEIVEPACKET_API_LATEST 2
|
| 125 |
+
|
| 126 |
+
/**
|
| 127 |
+
* Structure containing information about who would like to receive a packet, and how much data can be stored safely.
|
| 128 |
+
*/
|
| 129 |
+
EOS_STRUCT(EOS_P2P_ReceivePacketOptions, (
|
| 130 |
+
/** API Version: Set this to EOS_P2P_RECEIVEPACKET_API_LATEST. */
|
| 131 |
+
int32_t ApiVersion;
|
| 132 |
+
/** The Product User ID of the user who is receiving the packet */
|
| 133 |
+
EOS_ProductUserId LocalUserId;
|
| 134 |
+
/** The maximum amount of data in bytes that can be safely copied to OutData in the function call */
|
| 135 |
+
uint32_t MaxDataSizeBytes;
|
| 136 |
+
/** An optional channel to request the data for. If NULL, we're retrieving the next packet on any channel */
|
| 137 |
+
const uint8_t* RequestedChannel;
|
| 138 |
+
));
|
| 139 |
+
|
| 140 |
+
/** The most recent version of the EOS_P2P_AddNotifyPeerConnectionRequest API. */
|
| 141 |
+
#define EOS_P2P_ADDNOTIFYPEERCONNECTIONREQUEST_API_LATEST 1
|
| 142 |
+
|
| 143 |
+
/**
|
| 144 |
+
* Structure containing information about who would like connection notifications, and about which socket.
|
| 145 |
+
*/
|
| 146 |
+
EOS_STRUCT(EOS_P2P_AddNotifyPeerConnectionRequestOptions, (
|
| 147 |
+
/** API Version: Set this to EOS_P2P_ADDNOTIFYPEERCONNECTIONREQUEST_API_LATEST. */
|
| 148 |
+
int32_t ApiVersion;
|
| 149 |
+
/** The Product User ID of the user who is listening for incoming connection requests */
|
| 150 |
+
EOS_ProductUserId LocalUserId;
|
| 151 |
+
/** The optional socket ID to listen for, used as a filter for incoming connection requests; If NULL, incoming connection requests will not be filtered */
|
| 152 |
+
const EOS_P2P_SocketId* SocketId;
|
| 153 |
+
));
|
| 154 |
+
|
| 155 |
+
/**
|
| 156 |
+
* Structure containing information about an incoming connection request.
|
| 157 |
+
*/
|
| 158 |
+
EOS_STRUCT(EOS_P2P_OnIncomingConnectionRequestInfo, (
|
| 159 |
+
/** Client-specified data passed into EOS_P2P_AddNotifyPeerConnectionRequest */
|
| 160 |
+
void* ClientData;
|
| 161 |
+
/** The Product User ID of the local user who is being requested to open a P2P session with RemoteUserId */
|
| 162 |
+
EOS_ProductUserId LocalUserId;
|
| 163 |
+
/** The Product User ID of the remote user who requested a peer connection with the local user */
|
| 164 |
+
EOS_ProductUserId RemoteUserId;
|
| 165 |
+
/** The ID of the socket the Remote User wishes to communicate on */
|
| 166 |
+
const EOS_P2P_SocketId* SocketId;
|
| 167 |
+
));
|
| 168 |
+
|
| 169 |
+
/**
|
| 170 |
+
* Callback for information related to incoming connection requests.
|
| 171 |
+
*/
|
| 172 |
+
EOS_DECLARE_CALLBACK(EOS_P2P_OnIncomingConnectionRequestCallback, const EOS_P2P_OnIncomingConnectionRequestInfo* Data);
|
| 173 |
+
|
| 174 |
+
/** The most recent version of the EOS_P2P_AddNotifyPeerConnectionEstablished API. */
|
| 175 |
+
#define EOS_P2P_ADDNOTIFYPEERCONNECTIONESTABLISHED_API_LATEST 1
|
| 176 |
+
|
| 177 |
+
/**
|
| 178 |
+
* Structure containing information about which connections should be notified
|
| 179 |
+
*/
|
| 180 |
+
EOS_STRUCT(EOS_P2P_AddNotifyPeerConnectionEstablishedOptions, (
|
| 181 |
+
/** API Version: Set this to EOS_P2P_ADDNOTIFYPEERCONNECTIONESTABLISHED_API_LATEST. */
|
| 182 |
+
int32_t ApiVersion;
|
| 183 |
+
/** The Product User ID of the local user who would like to receive notifications */
|
| 184 |
+
EOS_ProductUserId LocalUserId;
|
| 185 |
+
/** The optional socket ID, used as a filter for established connections. If NULL, this function handler will be called for all sockets */
|
| 186 |
+
const EOS_P2P_SocketId* SocketId;
|
| 187 |
+
));
|
| 188 |
+
|
| 189 |
+
/**
|
| 190 |
+
* Type of established connection
|
| 191 |
+
*/
|
| 192 |
+
EOS_ENUM(EOS_EConnectionEstablishedType,
|
| 193 |
+
/** The connection is brand new */
|
| 194 |
+
EOS_CET_NewConnection = 0,
|
| 195 |
+
/** The connection is reestablished (reconnection) */
|
| 196 |
+
EOS_CET_Reconnection = 1
|
| 197 |
+
);
|
| 198 |
+
|
| 199 |
+
/**
|
| 200 |
+
* Types of network connections.
|
| 201 |
+
*/
|
| 202 |
+
EOS_ENUM(EOS_ENetworkConnectionType,
|
| 203 |
+
/** There is no established connection */
|
| 204 |
+
EOS_NCT_NoConnection = 0,
|
| 205 |
+
/** A direct connection to the peer over the Internet or Local Network */
|
| 206 |
+
EOS_NCT_DirectConnection = 1,
|
| 207 |
+
/** A relayed connection using Epic-provided servers to the peer over the Internet */
|
| 208 |
+
EOS_NCT_RelayedConnection = 2
|
| 209 |
+
);
|
| 210 |
+
|
| 211 |
+
/**
|
| 212 |
+
* Structure containing information about a connection being established
|
| 213 |
+
*/
|
| 214 |
+
EOS_STRUCT(EOS_P2P_OnPeerConnectionEstablishedInfo, (
|
| 215 |
+
/** Client-specified data passed into EOS_P2P_AddNotifyPeerConnectionEstablished */
|
| 216 |
+
void* ClientData;
|
| 217 |
+
/** The Product User ID of the local user who is being notified of a connection being established */
|
| 218 |
+
EOS_ProductUserId LocalUserId;
|
| 219 |
+
/** The Product User ID of the remote user who this connection was with */
|
| 220 |
+
EOS_ProductUserId RemoteUserId;
|
| 221 |
+
/** The socket ID of the connection being established */
|
| 222 |
+
const EOS_P2P_SocketId* SocketId;
|
| 223 |
+
/** Information if this is a new connection or reconnection */
|
| 224 |
+
EOS_EConnectionEstablishedType ConnectionType;
|
| 225 |
+
/** What type of network connection is being used for this connection */
|
| 226 |
+
EOS_ENetworkConnectionType NetworkType;
|
| 227 |
+
));
|
| 228 |
+
|
| 229 |
+
/**
|
| 230 |
+
* Callback for information related to new connections being established
|
| 231 |
+
*/
|
| 232 |
+
EOS_DECLARE_CALLBACK(EOS_P2P_OnPeerConnectionEstablishedCallback, const EOS_P2P_OnPeerConnectionEstablishedInfo* Data);
|
| 233 |
+
|
| 234 |
+
|
| 235 |
+
/** The most recent version of the EOS_P2P_AddNotifyPeerConnectionInterrupted API. */
|
| 236 |
+
#define EOS_P2P_ADDNOTIFYPEERCONNECTIONINTERRUPTED_API_LATEST 1
|
| 237 |
+
|
| 238 |
+
/**
|
| 239 |
+
* Structure containing information about who would like notifications about interrupted connections, and for which socket.
|
| 240 |
+
*/
|
| 241 |
+
EOS_STRUCT(EOS_P2P_AddNotifyPeerConnectionInterruptedOptions, (
|
| 242 |
+
/** API Version: Set this to EOS_P2P_ADDNOTIFYPEERCONNECTIONINTERRUPTED_API_LATEST. */
|
| 243 |
+
int32_t ApiVersion;
|
| 244 |
+
/** The Product User ID of the local user who would like notifications */
|
| 245 |
+
EOS_ProductUserId LocalUserId;
|
| 246 |
+
/** An optional socket ID to filter interrupted connections on. If NULL, this function handler will be called for all interrupted connections */
|
| 247 |
+
const EOS_P2P_SocketId* SocketId;
|
| 248 |
+
));
|
| 249 |
+
|
| 250 |
+
/**
|
| 251 |
+
* Structure containing information about a connection that was interrupted.
|
| 252 |
+
*/
|
| 253 |
+
EOS_STRUCT(EOS_P2P_OnPeerConnectionInterruptedInfo, (
|
| 254 |
+
/** Client-specified data passed into EOS_P2P_AddNotifyPeerConnectionInterrupted */
|
| 255 |
+
void* ClientData;
|
| 256 |
+
/** The local user who is being notified of a connection that was interrupted */
|
| 257 |
+
EOS_ProductUserId LocalUserId;
|
| 258 |
+
/** The Product User ID of the remote user who this connection was with */
|
| 259 |
+
EOS_ProductUserId RemoteUserId;
|
| 260 |
+
/** The socket ID of the connection that was interrupted */
|
| 261 |
+
const EOS_P2P_SocketId* SocketId;
|
| 262 |
+
));
|
| 263 |
+
|
| 264 |
+
|
| 265 |
+
/**
|
| 266 |
+
* Callback for information related to open connections that are interrupted.
|
| 267 |
+
*/
|
| 268 |
+
EOS_DECLARE_CALLBACK(EOS_P2P_OnPeerConnectionInterruptedCallback, const EOS_P2P_OnPeerConnectionInterruptedInfo* Data);
|
| 269 |
+
|
| 270 |
+
/** The most recent version of the EOS_P2P_AddNotifyPeerConnectionClosed API. */
|
| 271 |
+
#define EOS_P2P_ADDNOTIFYPEERCONNECTIONCLOSED_API_LATEST 1
|
| 272 |
+
|
| 273 |
+
/**
|
| 274 |
+
* Structure containing information about who would like notifications about closed connections, and for which socket.
|
| 275 |
+
*/
|
| 276 |
+
EOS_STRUCT(EOS_P2P_AddNotifyPeerConnectionClosedOptions, (
|
| 277 |
+
/** API Version: Set this to EOS_P2P_ADDNOTIFYPEERCONNECTIONCLOSED_API_LATEST. */
|
| 278 |
+
int32_t ApiVersion;
|
| 279 |
+
/** The Product User ID of the local user who would like notifications */
|
| 280 |
+
EOS_ProductUserId LocalUserId;
|
| 281 |
+
/** The optional socket ID to listen for to be closed. If NULL, this function handler will be called for all closed connections */
|
| 282 |
+
const EOS_P2P_SocketId* SocketId;
|
| 283 |
+
));
|
| 284 |
+
|
| 285 |
+
/**
|
| 286 |
+
* Reasons why a P2P connection was closed
|
| 287 |
+
*/
|
| 288 |
+
EOS_ENUM(EOS_EConnectionClosedReason,
|
| 289 |
+
/** The connection was closed for unknown reasons. This most notably happens during application shutdown. */
|
| 290 |
+
EOS_CCR_Unknown = 0,
|
| 291 |
+
/** The connection was at least locally accepted, but was closed by the local user via a call to EOS_P2P_CloseConnection / EOS_P2P_CloseConnections. */
|
| 292 |
+
EOS_CCR_ClosedByLocalUser = 1,
|
| 293 |
+
/** The connection was at least locally accepted, but was gracefully closed by the remote user via a call to EOS_P2P_CloseConnection / EOS_P2P_CloseConnections. */
|
| 294 |
+
EOS_CCR_ClosedByPeer = 2,
|
| 295 |
+
/** The connection was at least locally accepted, but was not remotely accepted in time. */
|
| 296 |
+
EOS_CCR_TimedOut = 3,
|
| 297 |
+
/** The connection was accepted, but the connection could not be created due to too many other existing connections */
|
| 298 |
+
EOS_CCR_TooManyConnections = 4,
|
| 299 |
+
/** The connection was accepted, The remote user sent an invalid message */
|
| 300 |
+
EOS_CCR_InvalidMessage = 5,
|
| 301 |
+
/** The connection was accepted, but the remote user sent us invalid data */
|
| 302 |
+
EOS_CCR_InvalidData = 6,
|
| 303 |
+
/** The connection was accepted, but we failed to ever establish a connection with the remote user due to connectivity issues. */
|
| 304 |
+
EOS_CCR_ConnectionFailed = 7,
|
| 305 |
+
/** The connection was accepted and established, but the peer silently went away. */
|
| 306 |
+
EOS_CCR_ConnectionClosed = 8,
|
| 307 |
+
/** The connection was locally accepted, but we failed to negotiate a connection with the remote user. This most commonly occurs if the local user goes offline or is logged-out during the connection process. */
|
| 308 |
+
EOS_CCR_NegotiationFailed = 9,
|
| 309 |
+
/** The connection was accepted, but an internal error occurred and the connection cannot be created or continue. */
|
| 310 |
+
EOS_CCR_UnexpectedError = 10,
|
| 311 |
+
/** The connection was ignored because no connection listeners were bound. */
|
| 312 |
+
EOS_CCR_ConnectionIgnored = 11
|
| 313 |
+
);
|
| 314 |
+
|
| 315 |
+
/**
|
| 316 |
+
* Structure containing information about a connection being closed.
|
| 317 |
+
*/
|
| 318 |
+
EOS_STRUCT(EOS_P2P_OnRemoteConnectionClosedInfo, (
|
| 319 |
+
/** Client-specified data passed into EOS_P2P_AddNotifyPeerConnectionClosed */
|
| 320 |
+
void* ClientData;
|
| 321 |
+
/** The local user who is being notified of a connection being closed */
|
| 322 |
+
EOS_ProductUserId LocalUserId;
|
| 323 |
+
/** The Product User ID of the remote user who this connection was with */
|
| 324 |
+
EOS_ProductUserId RemoteUserId;
|
| 325 |
+
/** The socket ID of the connection being closed */
|
| 326 |
+
const EOS_P2P_SocketId* SocketId;
|
| 327 |
+
/** The reason the connection was closed (if known) */
|
| 328 |
+
EOS_EConnectionClosedReason Reason;
|
| 329 |
+
));
|
| 330 |
+
|
| 331 |
+
/**
|
| 332 |
+
* Callback for information related to open connections being closed.
|
| 333 |
+
*/
|
| 334 |
+
EOS_DECLARE_CALLBACK(EOS_P2P_OnRemoteConnectionClosedCallback, const EOS_P2P_OnRemoteConnectionClosedInfo* Data);
|
| 335 |
+
|
| 336 |
+
/** The most recent version of the EOS_P2P_AcceptConnection API. */
|
| 337 |
+
#define EOS_P2P_ACCEPTCONNECTION_API_LATEST 1
|
| 338 |
+
|
| 339 |
+
/**
|
| 340 |
+
* Structure containing information about who would like to accept a connection, and which connection.
|
| 341 |
+
*/
|
| 342 |
+
EOS_STRUCT(EOS_P2P_AcceptConnectionOptions, (
|
| 343 |
+
/** API Version: Set this to EOS_P2P_ACCEPTCONNECTION_API_LATEST. */
|
| 344 |
+
int32_t ApiVersion;
|
| 345 |
+
/** The Product User ID of the local user who is accepting any pending or future connections with RemoteUserId */
|
| 346 |
+
EOS_ProductUserId LocalUserId;
|
| 347 |
+
/** The Product User ID of the remote user who has either sent a connection request or is expected to in the future */
|
| 348 |
+
EOS_ProductUserId RemoteUserId;
|
| 349 |
+
/** The socket ID of the connection to accept on */
|
| 350 |
+
const EOS_P2P_SocketId* SocketId;
|
| 351 |
+
));
|
| 352 |
+
|
| 353 |
+
/** The most recent version of the EOS_P2P_CloseConnection API. */
|
| 354 |
+
#define EOS_P2P_CLOSECONNECTION_API_LATEST 1
|
| 355 |
+
|
| 356 |
+
/**
|
| 357 |
+
* Structure containing information about who would like to close a connection, and which connection.
|
| 358 |
+
*/
|
| 359 |
+
EOS_STRUCT(EOS_P2P_CloseConnectionOptions, (
|
| 360 |
+
/** API Version: Set this to EOS_P2P_CLOSECONNECTION_API_LATEST. */
|
| 361 |
+
int32_t ApiVersion;
|
| 362 |
+
/** The Product User ID of the local user who would like to close a previously accepted connection (or decline a pending invite) */
|
| 363 |
+
EOS_ProductUserId LocalUserId;
|
| 364 |
+
/** The Product User ID of the remote user to disconnect from (or to reject a pending invite from) */
|
| 365 |
+
EOS_ProductUserId RemoteUserId;
|
| 366 |
+
/** The socket ID of the connection to close (or optionally NULL to not accept any connection requests from the Remote User) */
|
| 367 |
+
const EOS_P2P_SocketId* SocketId;
|
| 368 |
+
));
|
| 369 |
+
|
| 370 |
+
/** The most recent version of the EOS_P2P_CloseConnections API. */
|
| 371 |
+
#define EOS_P2P_CLOSECONNECTIONS_API_LATEST 1
|
| 372 |
+
|
| 373 |
+
/**
|
| 374 |
+
* Structure containing information about who would like to close connections, and by what socket ID
|
| 375 |
+
*/
|
| 376 |
+
EOS_STRUCT(EOS_P2P_CloseConnectionsOptions, (
|
| 377 |
+
/** API Version: Set this to EOS_P2P_CLOSECONNECTIONS_API_LATEST. */
|
| 378 |
+
int32_t ApiVersion;
|
| 379 |
+
/** The Product User ID of the local user who would like to close all connections that use a particular socket ID */
|
| 380 |
+
EOS_ProductUserId LocalUserId;
|
| 381 |
+
/** The socket ID of the connections to close */
|
| 382 |
+
const EOS_P2P_SocketId* SocketId;
|
| 383 |
+
));
|
| 384 |
+
|
| 385 |
+
/** The most recent version of the EOS_P2P_QueryNATType API. */
|
| 386 |
+
#define EOS_P2P_QUERYNATTYPE_API_LATEST 1
|
| 387 |
+
|
| 388 |
+
/**
|
| 389 |
+
* Structure containing information needed to query NAT-types
|
| 390 |
+
*/
|
| 391 |
+
EOS_STRUCT(EOS_P2P_QueryNATTypeOptions, (
|
| 392 |
+
/** API Version: Set this to EOS_P2P_QUERYNATTYPE_API_LATEST. */
|
| 393 |
+
int32_t ApiVersion;
|
| 394 |
+
));
|
| 395 |
+
|
| 396 |
+
/**
|
| 397 |
+
* Structure containing information about the local network NAT type
|
| 398 |
+
*/
|
| 399 |
+
EOS_STRUCT(EOS_P2P_OnQueryNATTypeCompleteInfo, (
|
| 400 |
+
/** Result code for the operation. EOS_Success is returned for a successful query, other codes indicate an error */
|
| 401 |
+
EOS_EResult ResultCode;
|
| 402 |
+
/** Client-specified data passed into EOS_P2P_QueryNATType */
|
| 403 |
+
void* ClientData;
|
| 404 |
+
/** The queried NAT type */
|
| 405 |
+
EOS_ENATType NATType;
|
| 406 |
+
));
|
| 407 |
+
|
| 408 |
+
/**
|
| 409 |
+
* Callback for information related to our NAT type query completing.
|
| 410 |
+
*/
|
| 411 |
+
EOS_DECLARE_CALLBACK(EOS_P2P_OnQueryNATTypeCompleteCallback, const EOS_P2P_OnQueryNATTypeCompleteInfo* Data);
|
| 412 |
+
|
| 413 |
+
/** The most recent version of the EOS_P2P_GetNATType API. */
|
| 414 |
+
#define EOS_P2P_GETNATTYPE_API_LATEST 1
|
| 415 |
+
|
| 416 |
+
/**
|
| 417 |
+
* Structure containing information needed to get previously queried NAT-types
|
| 418 |
+
*/
|
| 419 |
+
EOS_STRUCT(EOS_P2P_GetNATTypeOptions, (
|
| 420 |
+
/** API Version: Set this to EOS_P2P_GETNATTYPE_API_LATEST. */
|
| 421 |
+
int32_t ApiVersion;
|
| 422 |
+
));
|
| 423 |
+
|
| 424 |
+
/**
|
| 425 |
+
* Setting for controlling whether relay servers are used.
|
| 426 |
+
*
|
| 427 |
+
* Please see the following EOS_ERelayControl value compatibility-chart to better understand how changing this value
|
| 428 |
+
* can affect compatibility between clients with different settings. Connections between clients using
|
| 429 |
+
* Incompatible settings may succeed in limited scenarios but should be treated as though they will consistently fail.
|
| 430 |
+
*
|
| 431 |
+
* +------------------------------+---------------------+-------------------------------+---------------------+
|
| 432 |
+
* | | EOS_RC_NoRelays | EOS_RC_AllowRelays (Default) | EOS_RC_ForceRelays |
|
| 433 |
+
* +------------------------------+---------------------+-------------------------------+---------------------+
|
| 434 |
+
* | EOS_RC_NoRelays | Compatible | Compatible | Incompatible |
|
| 435 |
+
* | EOS_RC_AllowRelays (Default) | Compatible | Compatible | Compatible |
|
| 436 |
+
* | EOS_RC_ForceRelays | Incompatible | Compatible | Compatible |
|
| 437 |
+
* +------------------------------+---------------------+-------------------------------+---------------------+
|
| 438 |
+
*/
|
| 439 |
+
EOS_ENUM(EOS_ERelayControl,
|
| 440 |
+
/** Peer connections will never attempt to use relay servers. Clients with restrictive NATs may not be able to connect to peers. */
|
| 441 |
+
EOS_RC_NoRelays = 0,
|
| 442 |
+
/** Peer connections will attempt to use relay servers, but only after direct connection attempts fail. This is the default value if not changed. */
|
| 443 |
+
EOS_RC_AllowRelays = 1,
|
| 444 |
+
/** Peer connections will only ever use relay servers. This will add latency to all connections, but will hide IP Addresses from peers. */
|
| 445 |
+
EOS_RC_ForceRelays = 2
|
| 446 |
+
);
|
| 447 |
+
|
| 448 |
+
/** The most recent version of the EOS_P2P_SetRelayControl API. */
|
| 449 |
+
#define EOS_P2P_SETRELAYCONTROL_API_LATEST 1
|
| 450 |
+
|
| 451 |
+
/**
|
| 452 |
+
* Structure containing information about new relay configurations.
|
| 453 |
+
*/
|
| 454 |
+
EOS_STRUCT(EOS_P2P_SetRelayControlOptions, (
|
| 455 |
+
/** API Version: Set this to EOS_P2P_SETRELAYCONTROL_API_LATEST. */
|
| 456 |
+
int32_t ApiVersion;
|
| 457 |
+
/**
|
| 458 |
+
* The requested level of relay servers for P2P connections. This setting is only applied to new P2P connections, or when existing P2P connections
|
| 459 |
+
* reconnect during a temporary connectivity outage. Peers with an incompatible setting to the local setting will not be able to connect.
|
| 460 |
+
*/
|
| 461 |
+
EOS_ERelayControl RelayControl;
|
| 462 |
+
));
|
| 463 |
+
|
| 464 |
+
/** The most recent version of the EOS_P2P_GetRelayControl API. */
|
| 465 |
+
#define EOS_P2P_GETRELAYCONTROL_API_LATEST 1
|
| 466 |
+
|
| 467 |
+
/**
|
| 468 |
+
* Structure containing information about getting the relay control setting.
|
| 469 |
+
*/
|
| 470 |
+
EOS_STRUCT(EOS_P2P_GetRelayControlOptions, (
|
| 471 |
+
/** API Version: Set this to EOS_P2P_GETRELAYCONTROL_API_LATEST. */
|
| 472 |
+
int32_t ApiVersion;
|
| 473 |
+
));
|
| 474 |
+
|
| 475 |
+
/** The most recent version of the EOS_P2P_SetPortRange API. */
|
| 476 |
+
#define EOS_P2P_SETPORTRANGE_API_LATEST 1
|
| 477 |
+
|
| 478 |
+
/**
|
| 479 |
+
* Structure containing information about new port range settings.
|
| 480 |
+
*/
|
| 481 |
+
EOS_STRUCT(EOS_P2P_SetPortRangeOptions, (
|
| 482 |
+
/** API Version: Set this to EOS_P2P_SETPORTRANGE_API_LATEST. */
|
| 483 |
+
int32_t ApiVersion;
|
| 484 |
+
/** The ideal port to use for P2P traffic. The default value is 7777. If set to 0, the OS will choose a port. If set to 0, MaxAdditionalPortsToTry must be set to 0. */
|
| 485 |
+
uint16_t Port;
|
| 486 |
+
/**
|
| 487 |
+
* The maximum amount of additional ports to try if Port is unavailable. Ports will be tried from Port to Port + MaxAdditionalPortsToTry
|
| 488 |
+
* inclusive, until one is available or we run out of ports. If no ports are available, P2P connections will fail. The default value is 99.
|
| 489 |
+
*/
|
| 490 |
+
uint16_t MaxAdditionalPortsToTry;
|
| 491 |
+
));
|
| 492 |
+
|
| 493 |
+
/** The most recent version of the EOS_P2P_GetPortRange API. */
|
| 494 |
+
#define EOS_P2P_GETPORTRANGE_API_LATEST 1
|
| 495 |
+
|
| 496 |
+
/**
|
| 497 |
+
* Structure containing information about getting the configured port range settings.
|
| 498 |
+
*/
|
| 499 |
+
EOS_STRUCT(EOS_P2P_GetPortRangeOptions, (
|
| 500 |
+
/** API Version: Set this to EOS_P2P_GETPORTRANGE_API_LATEST. */
|
| 501 |
+
int32_t ApiVersion;
|
| 502 |
+
));
|
| 503 |
+
|
| 504 |
+
/** Helper constant to signify that the packet queue is allowed to grow indefinitely */
|
| 505 |
+
#define EOS_P2P_MAX_QUEUE_SIZE_UNLIMITED 0
|
| 506 |
+
|
| 507 |
+
/** The most recent version of the EOS_P2P_SetPacketQueueSize API. */
|
| 508 |
+
#define EOS_P2P_SETPACKETQUEUESIZE_API_LATEST 1
|
| 509 |
+
|
| 510 |
+
/**
|
| 511 |
+
* Structure containing information about new packet queue size settings.
|
| 512 |
+
*/
|
| 513 |
+
EOS_STRUCT(EOS_P2P_SetPacketQueueSizeOptions, (
|
| 514 |
+
/** API Version: Set this to EOS_P2P_SETPACKETQUEUESIZE_API_LATEST. */
|
| 515 |
+
int32_t ApiVersion;
|
| 516 |
+
/** The ideal maximum amount of bytes the Incoming packet queue can consume */
|
| 517 |
+
uint64_t IncomingPacketQueueMaxSizeBytes;
|
| 518 |
+
/** The ideal maximum amount of bytes the Outgoing packet queue can consume */
|
| 519 |
+
uint64_t OutgoingPacketQueueMaxSizeBytes;
|
| 520 |
+
));
|
| 521 |
+
|
| 522 |
+
/** The most recent version of the EOS_P2P_GetPacketQueueInfo API. */
|
| 523 |
+
#define EOS_P2P_GETPACKETQUEUEINFO_API_LATEST 1
|
| 524 |
+
|
| 525 |
+
/**
|
| 526 |
+
* Structure containing information needed to get the current packet queue information.
|
| 527 |
+
*/
|
| 528 |
+
EOS_STRUCT(EOS_P2P_GetPacketQueueInfoOptions, (
|
| 529 |
+
/** API Version: Set this to EOS_P2P_GETPACKETQUEUEINFO_API_LATEST. */
|
| 530 |
+
int32_t ApiVersion;
|
| 531 |
+
));
|
| 532 |
+
|
| 533 |
+
/**
|
| 534 |
+
* Information related to the current state of the packet queues. It is possible for the current size
|
| 535 |
+
* to be larger than the maximum size if the maximum size changes or if the maximum queue size is
|
| 536 |
+
* set to EOS_P2P_MAX_QUEUE_SIZE_UNLIMITED.
|
| 537 |
+
*/
|
| 538 |
+
EOS_STRUCT(EOS_P2P_PacketQueueInfo, (
|
| 539 |
+
/** The maximum size in bytes of the incoming packet queue */
|
| 540 |
+
uint64_t IncomingPacketQueueMaxSizeBytes;
|
| 541 |
+
/** The current size in bytes of the incoming packet queue */
|
| 542 |
+
uint64_t IncomingPacketQueueCurrentSizeBytes;
|
| 543 |
+
/** The current number of queued packets in the incoming packet queue */
|
| 544 |
+
uint64_t IncomingPacketQueueCurrentPacketCount;
|
| 545 |
+
/** The maximum size in bytes of the outgoing packet queue */
|
| 546 |
+
uint64_t OutgoingPacketQueueMaxSizeBytes;
|
| 547 |
+
/** The current size in bytes of the outgoing packet queue */
|
| 548 |
+
uint64_t OutgoingPacketQueueCurrentSizeBytes;
|
| 549 |
+
/** The current amount of queued packets in the outgoing packet queue */
|
| 550 |
+
uint64_t OutgoingPacketQueueCurrentPacketCount;
|
| 551 |
+
));
|
| 552 |
+
|
| 553 |
+
/** The most recent version of the EOS_P2P_AddNotifyIncomingPacketQueueFull API. */
|
| 554 |
+
#define EOS_P2P_ADDNOTIFYINCOMINGPACKETQUEUEFULL_API_LATEST 1
|
| 555 |
+
|
| 556 |
+
/**
|
| 557 |
+
* Structure containing information about what version of the EOS_P2P_AddNotifyIncomingPacketQueueFull function is supported.
|
| 558 |
+
*/
|
| 559 |
+
EOS_STRUCT(EOS_P2P_AddNotifyIncomingPacketQueueFullOptions, (
|
| 560 |
+
/** API Version: Set this to EOS_P2P_ADDNOTIFYINCOMINGPACKETQUEUEFULL_API_LATEST. */
|
| 561 |
+
int32_t ApiVersion;
|
| 562 |
+
));
|
| 563 |
+
|
| 564 |
+
/**
|
| 565 |
+
* Structure containing information about the packet queue's state and the incoming packet that would overflow the queue
|
| 566 |
+
*/
|
| 567 |
+
EOS_STRUCT(EOS_P2P_OnIncomingPacketQueueFullInfo, (
|
| 568 |
+
/** Client-specified data passed into AddNotifyIncomingPacketQueueFull */
|
| 569 |
+
void* ClientData;
|
| 570 |
+
/** The maximum size in bytes the incoming packet queue is allowed to use */
|
| 571 |
+
uint64_t PacketQueueMaxSizeBytes;
|
| 572 |
+
/** The current size in bytes the incoming packet queue is currently using */
|
| 573 |
+
uint64_t PacketQueueCurrentSizeBytes;
|
| 574 |
+
/** The Product User ID of the local user who is receiving the packet that would overflow the queue */
|
| 575 |
+
EOS_ProductUserId OverflowPacketLocalUserId;
|
| 576 |
+
/** The channel the incoming packet is for */
|
| 577 |
+
uint8_t OverflowPacketChannel;
|
| 578 |
+
/** The size in bytes of the incoming packet (and related metadata) that would overflow the queue */
|
| 579 |
+
uint32_t OverflowPacketSizeBytes;
|
| 580 |
+
));
|
| 581 |
+
|
| 582 |
+
/**
|
| 583 |
+
* Callback for information related to incoming connection requests.
|
| 584 |
+
*/
|
| 585 |
+
EOS_DECLARE_CALLBACK(EOS_P2P_OnIncomingPacketQueueFullCallback, const EOS_P2P_OnIncomingPacketQueueFullInfo* Data);
|
| 586 |
+
|
| 587 |
+
/** The most recent version of the EOS_P2P_ClearPacketQueue API. */
|
| 588 |
+
#define EOS_P2P_CLEARPACKETQUEUE_API_LATEST 1
|
| 589 |
+
|
| 590 |
+
/**
|
| 591 |
+
* Structure containing information about the packet queue to be cleared
|
| 592 |
+
*/
|
| 593 |
+
EOS_STRUCT(EOS_P2P_ClearPacketQueueOptions, (
|
| 594 |
+
/** API Version: Set this to EOS_P2P_CLEARPACKETQUEUE_API_LATEST. */
|
| 595 |
+
int32_t ApiVersion;
|
| 596 |
+
/** The Product User ID of the local user for whom we want to clear the queued packets */
|
| 597 |
+
EOS_ProductUserId LocalUserId;
|
| 598 |
+
/** The Product User ID to who (outgoing) or from who (incoming) packets are queued */
|
| 599 |
+
EOS_ProductUserId RemoteUserId;
|
| 600 |
+
/** The socket used for packets to be cleared */
|
| 601 |
+
const EOS_P2P_SocketId* SocketId;
|
| 602 |
+
));
|
| 603 |
+
|
| 604 |
+
#pragma pack(pop)
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_platform_prereqs.h
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
/******************************************************************************
|
| 6 |
+
*
|
| 7 |
+
* Please refer to https://dev.epicgames.com/docs/services for more details
|
| 8 |
+
* on platform specific development.
|
| 9 |
+
*
|
| 10 |
+
* Some platforms need additional setup before `eos_base.h` is called.
|
| 11 |
+
* The `eos_base.h` header is included by all EOS SDK headers. This header
|
| 12 |
+
* file provides one way of allowing cross platform development with minimal
|
| 13 |
+
* setup.
|
| 14 |
+
*
|
| 15 |
+
* To use this add the EOS_BUILD_PLATFORM_NAME define when building platforms
|
| 16 |
+
* which need to include a `<Platform>/eos_<Platform>_base.h`. The value of
|
| 17 |
+
* EOS_BUILD_PLATFORM_NAME will be placed in the `<Platform>` spot. Not all
|
| 18 |
+
* platforms need one of these base header files. Blank files are still provided
|
| 19 |
+
* for the platforms that do not require it.
|
| 20 |
+
*
|
| 21 |
+
* Alternatives to this header are to have the necessary file explicitly
|
| 22 |
+
* included. This is a good solution if only a single platform is needed.
|
| 23 |
+
* For example:
|
| 24 |
+
* #include "ThePlatform/eos_ThePlatform_base.h"
|
| 25 |
+
* #include "eos_sdk.h"
|
| 26 |
+
* #include "eos_friends_types.h"
|
| 27 |
+
*
|
| 28 |
+
* Another option is to use the macros provided by the custom compiler to
|
| 29 |
+
* determine which include to use.
|
| 30 |
+
* For example:
|
| 31 |
+
* #if defined(__THECOMPILER__)
|
| 32 |
+
* #include "ThePlatform/eos_ThePlatform_base.h"
|
| 33 |
+
* #elif defined(__SOMECOMPILER__)
|
| 34 |
+
* #include "SomePlatform/eos_SomePlatform_base.h"
|
| 35 |
+
* #endif
|
| 36 |
+
* #include "eos_sdk.h"
|
| 37 |
+
* #include "eos_friends_types.h"
|
| 38 |
+
*
|
| 39 |
+
******************************************************************************/
|
| 40 |
+
|
| 41 |
+
#if defined(EOS_BUILD_PLATFORM_NAME)
|
| 42 |
+
|
| 43 |
+
#if defined(EOS_USE_DLLEXPORT) || defined(USE_CALL) || defined(EOS_MEMORY_CALL)
|
| 44 |
+
#error \
|
| 45 |
+
The macros EOS_MEMORY_CALL, EOS_CALL, and EOS_USE_DLLEXPORT where unexpectedly partially defined. \
|
| 46 |
+
This can occur if `eos_platform_prereqs.h` is included after `eos_base.h` is included. \
|
| 47 |
+
Please refer to https://dev.epicgames.com/docs/services for more details.
|
| 48 |
+
#endif
|
| 49 |
+
|
| 50 |
+
#undef EOS_PREPROCESSOR_TO_STRING
|
| 51 |
+
#define EOS_PREPROCESSOR_TO_STRING(x) EOS_PREPROCESSOR_TO_STRING_INNER(x)
|
| 52 |
+
#undef EOS_PREPROCESSOR_TO_STRING_INNER
|
| 53 |
+
#define EOS_PREPROCESSOR_TO_STRING_INNER(x) #x
|
| 54 |
+
#undef EOS_PREPROCESSOR_JOIN
|
| 55 |
+
#define EOS_PREPROCESSOR_JOIN(x,y) EOS_PREPROCESSOR_JOIN_INNER(x,y)
|
| 56 |
+
#undef EOS_PREPROCESSOR_JOIN_INNER
|
| 57 |
+
#define EOS_PREPROCESSOR_JOIN_INNER(x,y) x##y
|
| 58 |
+
#define EOS_BUILD_PLATFORM_HEADER_BASE EOS_PREPROCESSOR_TO_STRING(EOS_PREPROCESSOR_JOIN(EOS_BUILD_PLATFORM_NAME/eos_,EOS_PREPROCESSOR_JOIN(EOS_BUILD_PLATFORM_NAME,_base.h)))
|
| 59 |
+
|
| 60 |
+
#include EOS_BUILD_PLATFORM_HEADER_BASE
|
| 61 |
+
|
| 62 |
+
#endif
|
| 63 |
+
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_playerdatastorage.h
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
#pragma once
|
| 3 |
+
|
| 4 |
+
#include "eos_playerdatastorage_types.h"
|
| 5 |
+
|
| 6 |
+
/**
|
| 7 |
+
* The following EOS_PlayerDataStorage_* functions allow you to query file metadata; create/upload files; and duplicate, read, and delete existing files
|
| 8 |
+
*/
|
| 9 |
+
|
| 10 |
+
/**
|
| 11 |
+
* Query a specific file's metadata, such as file names, size, and a MD5 hash of the data. This is not required before a file may be opened, saved, copied, or deleted. Once a file has
|
| 12 |
+
* been queried, its metadata will be available by the EOS_PlayerDataStorage_CopyFileMetadataAtIndex and EOS_PlayerDataStorage_CopyFileMetadataByFilename functions.
|
| 13 |
+
*
|
| 14 |
+
* @param QueryFileOptions Object containing properties related to which user is querying files, and what file is being queried
|
| 15 |
+
* @param ClientData Optional pointer to help clients track this request, that is returned in the completion callback
|
| 16 |
+
* @param CompletionCallback This function is called when the query operation completes
|
| 17 |
+
*
|
| 18 |
+
* @see EOS_PlayerDataStorage_QueryFileOptions
|
| 19 |
+
* @see EOS_PlayerDataStorage_OnQueryFileCompleteCallback
|
| 20 |
+
* @see EOS_PlayerDataStorage_GetFileMetadataCount
|
| 21 |
+
* @see EOS_PlayerDataStorage_CopyFileMetadataAtIndex
|
| 22 |
+
* @see EOS_PlayerDataStorage_CopyFileMetadataByFilename
|
| 23 |
+
*/
|
| 24 |
+
EOS_DECLARE_FUNC(void) EOS_PlayerDataStorage_QueryFile(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_QueryFileOptions* QueryFileOptions, void* ClientData, const EOS_PlayerDataStorage_OnQueryFileCompleteCallback CompletionCallback);
|
| 25 |
+
|
| 26 |
+
/**
|
| 27 |
+
* Query the file metadata, such as file names, size, and a MD5 hash of the data, for all files owned by this user for this application. This is not required before a file may be opened,
|
| 28 |
+
* saved, copied, or deleted.
|
| 29 |
+
*
|
| 30 |
+
* @param QueryFileListOptions Object containing properties related to which user is querying files
|
| 31 |
+
* @param ClientData Optional pointer to help clients track this request, that is returned in the completion callback
|
| 32 |
+
* @param CompletionCallback This function is called when the query operation completes
|
| 33 |
+
*
|
| 34 |
+
* @see EOS_PlayerDataStorage_QueryFileListOptions
|
| 35 |
+
* @see EOS_PlayerDataStorage_OnQueryFileListCompleteCallback
|
| 36 |
+
* @see EOS_PlayerDataStorage_GetFileMetadataCount
|
| 37 |
+
* @see EOS_PlayerDataStorage_CopyFileMetadataAtIndex
|
| 38 |
+
* @see EOS_PlayerDataStorage_CopyFileMetadataByFilename
|
| 39 |
+
*/
|
| 40 |
+
EOS_DECLARE_FUNC(void) EOS_PlayerDataStorage_QueryFileList(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_QueryFileListOptions* QueryFileListOptions, void* ClientData, const EOS_PlayerDataStorage_OnQueryFileListCompleteCallback CompletionCallback);
|
| 41 |
+
|
| 42 |
+
/**
|
| 43 |
+
* Create the cached copy of a file's metadata by filename. The metadata will be for the last retrieved or successfully saved version, and will not include any changes that have not
|
| 44 |
+
* completed writing. The returned pointer must be released by the user when no longer needed.
|
| 45 |
+
*
|
| 46 |
+
* @param CopyFileMetadataOptions Object containing properties related to which user is requesting metadata, and for which filename
|
| 47 |
+
* @param OutMetadata A copy of the FileMetadata structure will be set if successful. This data must be released by calling EOS_PlayerDataStorage_FileMetadata_Release.
|
| 48 |
+
* @return EOS_Success if the metadata is currently cached, otherwise an error result explaining what went wrong
|
| 49 |
+
*
|
| 50 |
+
* @see EOS_PlayerDataStorage_CopyFileMetadataByFilenameOptions
|
| 51 |
+
* @see EOS_PlayerDataStorage_FileMetadata
|
| 52 |
+
*/
|
| 53 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_PlayerDataStorage_CopyFileMetadataByFilename(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_CopyFileMetadataByFilenameOptions* CopyFileMetadataOptions, EOS_PlayerDataStorage_FileMetadata ** OutMetadata);
|
| 54 |
+
|
| 55 |
+
/**
|
| 56 |
+
* Get the count of files we have previously queried information for and files we have previously read from / written to.
|
| 57 |
+
*
|
| 58 |
+
* @param GetFileMetadataCountOptions Object containing properties related to which user is requesting the metadata count
|
| 59 |
+
* @param OutFileMetadataCount If successful, the count of metadata currently cached
|
| 60 |
+
* @return EOS_Success if the input was valid, otherwise an error result explaining what went wrong
|
| 61 |
+
*
|
| 62 |
+
* @see EOS_PlayerDataStorage_GetFileMetadataCountOptions
|
| 63 |
+
* @see EOS_PlayerDataStorage_CopyFileMetadataAtIndex
|
| 64 |
+
*/
|
| 65 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_PlayerDataStorage_GetFileMetadataCount(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_GetFileMetadataCountOptions* GetFileMetadataCountOptions, int32_t* OutFileMetadataCount);
|
| 66 |
+
|
| 67 |
+
/**
|
| 68 |
+
* Get the cached copy of a file's metadata by index. The metadata will be for the last retrieved or successfully saved version, and will not include any local changes that have not been
|
| 69 |
+
* committed by calling SaveFile. The returned pointer must be released by the user when no longer needed.
|
| 70 |
+
*
|
| 71 |
+
* @param CopyFileMetadataOptions Object containing properties related to which user is requesting metadata, and at what index
|
| 72 |
+
* @param OutMetadata A copy of the FileMetadata structure will be set if successful. This data must be released by calling EOS_PlayerDataStorage_FileMetadata_Release.
|
| 73 |
+
* @return EOS_Success if the requested metadata is currently cached, otherwise an error result explaining what went wrong
|
| 74 |
+
*
|
| 75 |
+
* @see EOS_PlayerDataStorage_CopyFileMetadataAtIndexOptions
|
| 76 |
+
* @see EOS_PlayerDataStorage_FileMetadata
|
| 77 |
+
* @see EOS_PlayerDataStorage_GetFileMetadataCount
|
| 78 |
+
* @see EOS_PlayerDataStorage_FileMetadata_Release
|
| 79 |
+
*/
|
| 80 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_PlayerDataStorage_CopyFileMetadataAtIndex(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_CopyFileMetadataAtIndexOptions* CopyFileMetadataOptions, EOS_PlayerDataStorage_FileMetadata ** OutMetadata);
|
| 81 |
+
|
| 82 |
+
/**
|
| 83 |
+
* Copies the data of an existing file to a new filename. This action happens entirely on the server and will not upload the contents of the source destination file from the host. This
|
| 84 |
+
* function paired with a subsequent EOS_PlayerDataStorage_DeleteFile can be used to rename a file. If successful, the destination file's metadata will be updated in our local cache.
|
| 85 |
+
*
|
| 86 |
+
* @param DuplicateOptions Object containing properties related to which user is duplicating the file, and what the source and destination file names are
|
| 87 |
+
* @param ClientData Optional pointer to help clients track this request, that is returned in the completion callback
|
| 88 |
+
* @param CompletionCallback This function is called when the duplicate operation completes
|
| 89 |
+
*
|
| 90 |
+
* @see EOS_PlayerDataStorage_DuplicateFileOptions
|
| 91 |
+
* @see EOS_PlayerDataStorage_OnDuplicateFileCompleteCallback
|
| 92 |
+
*/
|
| 93 |
+
EOS_DECLARE_FUNC(void) EOS_PlayerDataStorage_DuplicateFile(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_DuplicateFileOptions* DuplicateOptions, void* ClientData, const EOS_PlayerDataStorage_OnDuplicateFileCompleteCallback CompletionCallback);
|
| 94 |
+
|
| 95 |
+
/**
|
| 96 |
+
* Deletes an existing file in the cloud. If successful, the file's data will be removed from our local cache.
|
| 97 |
+
*
|
| 98 |
+
* @param DeleteOptions Object containing properties related to which user is deleting the file, and what file name is
|
| 99 |
+
* @param ClientData Optional pointer to help clients track this request, that is returned in the completion callback
|
| 100 |
+
* @param CompletionCallback This function is called when the delete operation completes
|
| 101 |
+
*
|
| 102 |
+
* @see EOS_PlayerDataStorage_DeleteFileOptions
|
| 103 |
+
* @see EOS_PlayerDataStorage_OnDeleteFileCompleteCallback
|
| 104 |
+
*/
|
| 105 |
+
EOS_DECLARE_FUNC(void) EOS_PlayerDataStorage_DeleteFile(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_DeleteFileOptions* DeleteOptions, void* ClientData, const EOS_PlayerDataStorage_OnDeleteFileCompleteCallback CompletionCallback);
|
| 106 |
+
|
| 107 |
+
/**
|
| 108 |
+
* Retrieve the contents of a specific file, potentially downloading the contents if we do not have a local copy, from the cloud. This request will occur asynchronously, potentially over
|
| 109 |
+
* multiple frames. All callbacks for this function will come from the same thread that the SDK is ticked from. If specified, the FileTransferProgressCallback will always be called at
|
| 110 |
+
* least once if the request is started successfully.
|
| 111 |
+
*
|
| 112 |
+
* @param ReadOptions Object containing properties related to which user is opening the file, what the file's name is, and related mechanisms for copying the data
|
| 113 |
+
* @param ClientData Optional pointer to help clients track this request, that is returned in associated callbacks
|
| 114 |
+
* @param CompletionCallback This function is called when the read operation completes
|
| 115 |
+
* @return A valid Player Data Storage File Request handle if successful, or NULL otherwise. Data contained in the completion callback will have more detailed information about issues with the request in failure cases. This handle must be released when it is no longer needed
|
| 116 |
+
*
|
| 117 |
+
* @return EOS_EResult containing the result of the operation.
|
| 118 |
+
* Possible result codes:
|
| 119 |
+
* - EOS_Success if the file is exists and the read operation completes successfully
|
| 120 |
+
* - EOS_NotFound if no file is found
|
| 121 |
+
*
|
| 122 |
+
* @see EOS_PlayerDataStorage_ReadFileOptions
|
| 123 |
+
* @see EOS_PlayerDataStorage_OnReadFileCompleteCallback
|
| 124 |
+
* @see EOS_PlayerDataStorageFileTransferRequest_Release
|
| 125 |
+
*/
|
| 126 |
+
EOS_DECLARE_FUNC(EOS_HPlayerDataStorageFileTransferRequest) EOS_PlayerDataStorage_ReadFile(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_ReadFileOptions* ReadOptions, void* ClientData, const EOS_PlayerDataStorage_OnReadFileCompleteCallback CompletionCallback);
|
| 127 |
+
|
| 128 |
+
/**
|
| 129 |
+
* Write new data to a specific file, potentially overwriting any existing file by the same name, to the cloud. This request will occur asynchronously, potentially over multiple frames.
|
| 130 |
+
* All callbacks for this function will come from the same thread that the SDK is ticked from. If specified, the FileTransferProgressCallback will always be called at least once if the
|
| 131 |
+
* request is started successfully.
|
| 132 |
+
*
|
| 133 |
+
* @param WriteOptions Object containing properties related to which user is writing the file, what the file's name is, and related mechanisms for writing the data
|
| 134 |
+
* @param ClientData Optional pointer to help clients track this request, that is returned in associated callbacks
|
| 135 |
+
* @param CompletionCallback This function is called when the write operation completes
|
| 136 |
+
* @return A valid Player Data Storage File Request handle if successful, or NULL otherwise. Data contained in the completion callback will have more detailed information about issues with the request in failure cases. This handle must be released when it is no longer needed
|
| 137 |
+
*
|
| 138 |
+
* @see EOS_PlayerDataStorage_WriteFileOptions
|
| 139 |
+
* @see EOS_PlayerDataStorage_OnWriteFileCompleteCallback
|
| 140 |
+
* @see EOS_PlayerDataStorageFileTransferRequest_Release
|
| 141 |
+
*/
|
| 142 |
+
EOS_DECLARE_FUNC(EOS_HPlayerDataStorageFileTransferRequest) EOS_PlayerDataStorage_WriteFile(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_WriteFileOptions* WriteOptions, void* ClientData, const EOS_PlayerDataStorage_OnWriteFileCompleteCallback CompletionCallback);
|
| 143 |
+
|
| 144 |
+
/**
|
| 145 |
+
* Clear previously cached file data. This operation will be done asynchronously. All cached files except those corresponding to the transfers in progress will be removed.
|
| 146 |
+
* Warning: Use this with care. Cache system generally tries to clear old and unused cached files from time to time. Unnecessarily clearing cache can degrade performance as SDK will have to re-download data.
|
| 147 |
+
*
|
| 148 |
+
* @param Options Object containing properties related to which user is deleting cache
|
| 149 |
+
* @param ClientData Optional pointer to help clients track this request, that is returned in associated callbacks
|
| 150 |
+
* @param CompletionCallback This function is called when the delete cache operation completes
|
| 151 |
+
* @return EOS_Success if the operation was started correctly, otherwise an error result explaining what went wrong
|
| 152 |
+
*
|
| 153 |
+
* @see EOS_PlayerDataStorage_DeleteCacheOptions
|
| 154 |
+
* @see EOS_PlayerDataStorage_OnDeleteCacheCompleteCallback
|
| 155 |
+
*/
|
| 156 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_PlayerDataStorage_DeleteCache(EOS_HPlayerDataStorage Handle, const EOS_PlayerDataStorage_DeleteCacheOptions* Options, void* ClientData, const EOS_PlayerDataStorage_OnDeleteCacheCompleteCallback CompletionCallback);
|
| 157 |
+
|
| 158 |
+
/**
|
| 159 |
+
* Below are helper functions to retrieve information about a file request handle, or to attempt to cancel a request in progress.
|
| 160 |
+
*/
|
| 161 |
+
|
| 162 |
+
/**
|
| 163 |
+
* Get the current state of a file request.
|
| 164 |
+
*
|
| 165 |
+
* @return EOS_Success if complete and successful, EOS_PlayerDataStorage_RequestInProgress if the request is still in progress, or another state for failure.
|
| 166 |
+
*/
|
| 167 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_PlayerDataStorageFileTransferRequest_GetFileRequestState(EOS_HPlayerDataStorageFileTransferRequest Handle);
|
| 168 |
+
|
| 169 |
+
/**
|
| 170 |
+
* Get the file name of the file this request is for. OutStringLength will always be set to the string length of the file name if it is not NULL.
|
| 171 |
+
*
|
| 172 |
+
* @param FilenameStringBufferSizeBytes The maximum number of bytes that can be written to OutStringBuffer
|
| 173 |
+
* @param OutStringBuffer The buffer to write the NULL-terminated utf8 file name into, if successful
|
| 174 |
+
* @param OutStringLength How long the file name is (not including null terminator)
|
| 175 |
+
* @return EOS_Success if the file name was successfully written to OutFilenameBuffer, a failure result otherwise
|
| 176 |
+
*
|
| 177 |
+
* @see EOS_PLAYERDATASTORAGE_FILENAME_MAX_LENGTH_BYTES
|
| 178 |
+
*/
|
| 179 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_PlayerDataStorageFileTransferRequest_GetFilename(EOS_HPlayerDataStorageFileTransferRequest Handle, uint32_t FilenameStringBufferSizeBytes, char* OutStringBuffer, int32_t* OutStringLength);
|
| 180 |
+
|
| 181 |
+
/**
|
| 182 |
+
* Attempt to cancel this file request in progress. This is a best-effort command and is not guaranteed to be successful if the request has completed before this function is called.
|
| 183 |
+
*
|
| 184 |
+
* @return EOS_EResult containing the result of the operation.
|
| 185 |
+
* Possible result codes:
|
| 186 |
+
* - EOS_Success if cancel is successful
|
| 187 |
+
* - EOS_NoChange if request had already completed (can't be canceled)
|
| 188 |
+
* - EOS_AlreadyPending if it's already been canceled before (this is a final state for canceled request and won't change over time).
|
| 189 |
+
*/
|
| 190 |
+
EOS_DECLARE_FUNC(EOS_EResult) EOS_PlayerDataStorageFileTransferRequest_CancelRequest(EOS_HPlayerDataStorageFileTransferRequest Handle);
|
Plugins/EOS-SDK-53289219-Release-v1.19.1.2/SDK/Include/eos_playerdatastorage_types.h
ADDED
|
@@ -0,0 +1,484 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Copyright Epic Games, Inc. All Rights Reserved.
|
| 2 |
+
|
| 3 |
+
#pragma once
|
| 4 |
+
|
| 5 |
+
#include "eos_common.h"
|
| 6 |
+
|
| 7 |
+
#pragma pack(push, 8)
|
| 8 |
+
|
| 9 |
+
/** Maximum File Name Length in bytes */
|
| 10 |
+
#define EOS_PLAYERDATASTORAGE_FILENAME_MAX_LENGTH_BYTES 64
|
| 11 |
+
|
| 12 |
+
EOS_EXTERN_C typedef struct EOS_PlayerDataStorageHandle* EOS_HPlayerDataStorage;
|
| 13 |
+
|
| 14 |
+
/** Timestamp value representing an undefined time for Player Data Storage. */
|
| 15 |
+
#define EOS_PLAYERDATASTORAGE_TIME_UNDEFINED -1
|
| 16 |
+
|
| 17 |
+
/** The most recent version of the EOS_PlayerDataStorage_FileMetadata API. */
|
| 18 |
+
#define EOS_PLAYERDATASTORAGE_FILEMETADATA_API_LATEST 3
|
| 19 |
+
|
| 20 |
+
/**
|
| 21 |
+
* Metadata information for a specific file
|
| 22 |
+
*/
|
| 23 |
+
EOS_STRUCT(EOS_PlayerDataStorage_FileMetadata, (
|
| 24 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_FILEMETADATA_API_LATEST. */
|
| 25 |
+
int32_t ApiVersion;
|
| 26 |
+
/** The total size of the file in bytes (Includes file header in addition to file contents) */
|
| 27 |
+
uint32_t FileSizeBytes;
|
| 28 |
+
/** The MD5 Hash of the entire file (including additional file header), in hex digits */
|
| 29 |
+
const char* MD5Hash;
|
| 30 |
+
/** The file's name */
|
| 31 |
+
const char* Filename;
|
| 32 |
+
/**
|
| 33 |
+
* The POSIX timestamp when the file was saved last time or EOS_PLAYERDATASTORAGE_TIME_UNDEFINED if the time is undefined.
|
| 34 |
+
* It will be undefined after a file is written and uploaded at first before a query operation is completed.
|
| 35 |
+
*/
|
| 36 |
+
int64_t LastModifiedTime;
|
| 37 |
+
/** The size of data (payload) in file in unencrypted (original) form. */
|
| 38 |
+
uint32_t UnencryptedDataSizeBytes;
|
| 39 |
+
));
|
| 40 |
+
|
| 41 |
+
/**
|
| 42 |
+
* Free the memory used by the file metadata
|
| 43 |
+
*/
|
| 44 |
+
EOS_DECLARE_FUNC(void) EOS_PlayerDataStorage_FileMetadata_Release(EOS_PlayerDataStorage_FileMetadata* FileMetadata);
|
| 45 |
+
|
| 46 |
+
/** The most recent version of the EOS_PlayerDataStorage_QueryFile API. */
|
| 47 |
+
#define EOS_PLAYERDATASTORAGE_QUERYFILE_API_LATEST 1
|
| 48 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_QUERYFILE_API_LATEST instead. */
|
| 49 |
+
#define EOS_PLAYERDATASTORAGE_QUERYFILEOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_QUERYFILE_API_LATEST
|
| 50 |
+
|
| 51 |
+
/**
|
| 52 |
+
* Input data for the EOS_PlayerDataStorage_QueryFile function
|
| 53 |
+
*/
|
| 54 |
+
EOS_STRUCT(EOS_PlayerDataStorage_QueryFileOptions, (
|
| 55 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_QUERYFILE_API_LATEST. */
|
| 56 |
+
int32_t ApiVersion;
|
| 57 |
+
/** The Product User ID of the local user requesting file metadata */
|
| 58 |
+
EOS_ProductUserId LocalUserId;
|
| 59 |
+
/** The name of the file being queried */
|
| 60 |
+
const char* Filename;
|
| 61 |
+
));
|
| 62 |
+
|
| 63 |
+
/**
|
| 64 |
+
* Data containing information about a query file request
|
| 65 |
+
*/
|
| 66 |
+
EOS_STRUCT(EOS_PlayerDataStorage_QueryFileCallbackInfo, (
|
| 67 |
+
/** Result code for the operation. EOS_Success is returned for a successful request, other codes indicate an error */
|
| 68 |
+
EOS_EResult ResultCode;
|
| 69 |
+
/** Client-specified data passed into the file query request */
|
| 70 |
+
void* ClientData;
|
| 71 |
+
/** The Product User ID of the local user who initiated this request */
|
| 72 |
+
EOS_ProductUserId LocalUserId;
|
| 73 |
+
));
|
| 74 |
+
/**
|
| 75 |
+
* Callback for when EOS_PlayerDataStorage_QueryFile completes
|
| 76 |
+
*/
|
| 77 |
+
EOS_DECLARE_CALLBACK(EOS_PlayerDataStorage_OnQueryFileCompleteCallback, const EOS_PlayerDataStorage_QueryFileCallbackInfo* Data);
|
| 78 |
+
|
| 79 |
+
/** The most recent version of the EOS_PlayerDataStorage_QueryFileList API. */
|
| 80 |
+
#define EOS_PLAYERDATASTORAGE_QUERYFILELIST_API_LATEST 2
|
| 81 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_QUERYFILELIST_API_LATEST instead. */
|
| 82 |
+
#define EOS_PLAYERDATASTORAGE_QUERYFILELISTOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_QUERYFILELIST_API_LATEST
|
| 83 |
+
|
| 84 |
+
/**
|
| 85 |
+
* Input data for the EOS_PlayerDataStorage_QueryFileList function
|
| 86 |
+
*/
|
| 87 |
+
EOS_STRUCT(EOS_PlayerDataStorage_QueryFileListOptions, (
|
| 88 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_QUERYFILELIST_API_LATEST. */
|
| 89 |
+
int32_t ApiVersion;
|
| 90 |
+
/** The Product User ID of the local user who requested file metadata */
|
| 91 |
+
EOS_ProductUserId LocalUserId;
|
| 92 |
+
));
|
| 93 |
+
|
| 94 |
+
/**
|
| 95 |
+
* Data containing information about a query file list request
|
| 96 |
+
*/
|
| 97 |
+
EOS_STRUCT(EOS_PlayerDataStorage_QueryFileListCallbackInfo, (
|
| 98 |
+
/** Result code for the operation. EOS_Success is returned for a successful request, other codes indicate an error */
|
| 99 |
+
EOS_EResult ResultCode;
|
| 100 |
+
/** Client-specified data passed into the file query request */
|
| 101 |
+
void* ClientData;
|
| 102 |
+
/** The Product User ID of the local user who initiated this request */
|
| 103 |
+
EOS_ProductUserId LocalUserId;
|
| 104 |
+
/** A count of files that were found, if successful */
|
| 105 |
+
uint32_t FileCount;
|
| 106 |
+
));
|
| 107 |
+
/**
|
| 108 |
+
* Callback for when EOS_PlayerDataStorage_QueryFileList completes
|
| 109 |
+
*/
|
| 110 |
+
EOS_DECLARE_CALLBACK(EOS_PlayerDataStorage_OnQueryFileListCompleteCallback, const EOS_PlayerDataStorage_QueryFileListCallbackInfo* Data);
|
| 111 |
+
|
| 112 |
+
/** The most recent version of the EOS_PlayerDataStorage_GetFileMetadataCount API. */
|
| 113 |
+
#define EOS_PLAYERDATASTORAGE_GETFILEMETADATACOUNT_API_LATEST 1
|
| 114 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_GETFILEMETADATACOUNT_API_LATEST instead. */
|
| 115 |
+
#define EOS_PLAYERDATASTORAGE_GETFILEMETADATACOUNTOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_GETFILEMETADATACOUNT_API_LATEST
|
| 116 |
+
|
| 117 |
+
/**
|
| 118 |
+
* Input data for the EOS_PlayerDataStorage_GetFileMetadataCount function
|
| 119 |
+
*/
|
| 120 |
+
EOS_STRUCT(EOS_PlayerDataStorage_GetFileMetadataCountOptions, (
|
| 121 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_GETFILEMETADATACOUNT_API_LATEST. */
|
| 122 |
+
int32_t ApiVersion;
|
| 123 |
+
/** The Product User ID of the local user who is requesting file metadata */
|
| 124 |
+
EOS_ProductUserId LocalUserId;
|
| 125 |
+
));
|
| 126 |
+
|
| 127 |
+
/** The most recent version of the EOS_PlayerDataStorage_CopyFileMetadataAtIndex API. */
|
| 128 |
+
#define EOS_PLAYERDATASTORAGE_COPYFILEMETADATAATINDEX_API_LATEST 1
|
| 129 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_COPYFILEMETADATAATINDEX_API_LATEST instead. */
|
| 130 |
+
#define EOS_PLAYERDATASTORAGE_COPYFILEMETADATAATINDEXOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_COPYFILEMETADATAATINDEX_API_LATEST
|
| 131 |
+
|
| 132 |
+
/**
|
| 133 |
+
* Input data for the CopyFileMetadataAtIndex function
|
| 134 |
+
*/
|
| 135 |
+
EOS_STRUCT(EOS_PlayerDataStorage_CopyFileMetadataAtIndexOptions, (
|
| 136 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_COPYFILEMETADATAATINDEX_API_LATEST. */
|
| 137 |
+
int32_t ApiVersion;
|
| 138 |
+
/** The Product User ID of the local user who is requesting file metadata */
|
| 139 |
+
EOS_ProductUserId LocalUserId;
|
| 140 |
+
/** The index to get data for */
|
| 141 |
+
uint32_t Index;
|
| 142 |
+
));
|
| 143 |
+
|
| 144 |
+
/** The most recent version of the EOS_PlayerDataStorage_CopyFileMetadataByFilename API. */
|
| 145 |
+
#define EOS_PLAYERDATASTORAGE_COPYFILEMETADATABYFILENAME_API_LATEST 1
|
| 146 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_COPYFILEMETADATABYFILENAME_API_LATEST instead. */
|
| 147 |
+
#define EOS_PLAYERDATASTORAGE_COPYFILEMETADATABYFILENAMEOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_COPYFILEMETADATABYFILENAME_API_LATEST
|
| 148 |
+
|
| 149 |
+
/**
|
| 150 |
+
* Input data for the CopyFileMetadataByFilename function
|
| 151 |
+
*/
|
| 152 |
+
EOS_STRUCT(EOS_PlayerDataStorage_CopyFileMetadataByFilenameOptions, (
|
| 153 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_COPYFILEMETADATABYFILENAME_API_LATEST. */
|
| 154 |
+
int32_t ApiVersion;
|
| 155 |
+
/** The Product User ID of the local user who is requesting file metadata */
|
| 156 |
+
EOS_ProductUserId LocalUserId;
|
| 157 |
+
/** The file's name to get data for */
|
| 158 |
+
const char* Filename;
|
| 159 |
+
));
|
| 160 |
+
|
| 161 |
+
/** The most recent version of the EOS_PlayerDataStorage_DuplicateFile API. */
|
| 162 |
+
#define EOS_PLAYERDATASTORAGE_DUPLICATEFILE_API_LATEST 1
|
| 163 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_DUPLICATEFILE_API_LATEST instead. */
|
| 164 |
+
#define EOS_PLAYERDATASTORAGE_DUPLICATEFILEOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_DUPLICATEFILE_API_LATEST
|
| 165 |
+
|
| 166 |
+
/**
|
| 167 |
+
* Input data for the EOS_PlayerDataStorage_DuplicateFile function
|
| 168 |
+
*/
|
| 169 |
+
EOS_STRUCT(EOS_PlayerDataStorage_DuplicateFileOptions, (
|
| 170 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_DUPLICATEFILE_API_LATEST. */
|
| 171 |
+
int32_t ApiVersion;
|
| 172 |
+
/** The Product User ID of the local user who authorized the duplication of the requested file; must be the original file's owner */
|
| 173 |
+
EOS_ProductUserId LocalUserId;
|
| 174 |
+
/** The name of the existing file to duplicate */
|
| 175 |
+
const char* SourceFilename;
|
| 176 |
+
/** The name of the new file */
|
| 177 |
+
const char* DestinationFilename;
|
| 178 |
+
));
|
| 179 |
+
|
| 180 |
+
/**
|
| 181 |
+
* Data containing the result information for a duplicate file request
|
| 182 |
+
*/
|
| 183 |
+
EOS_STRUCT(EOS_PlayerDataStorage_DuplicateFileCallbackInfo, (
|
| 184 |
+
/** Result code for the operation. EOS_Success is returned for a successful request, other codes indicate an error */
|
| 185 |
+
EOS_EResult ResultCode;
|
| 186 |
+
/** Client-specified data passed into the file duplicate request */
|
| 187 |
+
void* ClientData;
|
| 188 |
+
/** The Product User ID of the local user who initiated this request */
|
| 189 |
+
EOS_ProductUserId LocalUserId;
|
| 190 |
+
));
|
| 191 |
+
|
| 192 |
+
/**
|
| 193 |
+
* Callback for when EOS_PlayerDataStorage_DuplicateFile completes
|
| 194 |
+
*/
|
| 195 |
+
EOS_DECLARE_CALLBACK(EOS_PlayerDataStorage_OnDuplicateFileCompleteCallback, const EOS_PlayerDataStorage_DuplicateFileCallbackInfo* Data);
|
| 196 |
+
|
| 197 |
+
/** The most recent version of the EOS_PlayerDataStorage_DeleteFile API. */
|
| 198 |
+
#define EOS_PLAYERDATASTORAGE_DELETEFILE_API_LATEST 1
|
| 199 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_DELETEFILE_API_LATEST instead. */
|
| 200 |
+
#define EOS_PLAYERDATASTORAGE_DELETEFILEOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_DELETEFILE_API_LATEST
|
| 201 |
+
|
| 202 |
+
/**
|
| 203 |
+
* Input data for the EOS_PlayerDataStorage_DeleteFile function
|
| 204 |
+
*/
|
| 205 |
+
EOS_STRUCT(EOS_PlayerDataStorage_DeleteFileOptions, (
|
| 206 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_DELETEFILE_API_LATEST. */
|
| 207 |
+
int32_t ApiVersion;
|
| 208 |
+
/** The Product User ID of the local user who authorizes deletion of the file; must be the file's owner */
|
| 209 |
+
EOS_ProductUserId LocalUserId;
|
| 210 |
+
/** The name of the file to delete */
|
| 211 |
+
const char* Filename;
|
| 212 |
+
));
|
| 213 |
+
|
| 214 |
+
/**
|
| 215 |
+
* Data containing the result information for a delete file request
|
| 216 |
+
*/
|
| 217 |
+
EOS_STRUCT(EOS_PlayerDataStorage_DeleteFileCallbackInfo, (
|
| 218 |
+
/** Result code for the operation. EOS_Success is returned for a successful request, other codes indicate an error */
|
| 219 |
+
EOS_EResult ResultCode;
|
| 220 |
+
/** Client-specified data passed into the file deletion request */
|
| 221 |
+
void* ClientData;
|
| 222 |
+
/** The Product User ID of the local user who initiated this request */
|
| 223 |
+
EOS_ProductUserId LocalUserId;
|
| 224 |
+
));
|
| 225 |
+
|
| 226 |
+
/**
|
| 227 |
+
* Callback for when EOS_PlayerDataStorage_DeleteFile completes
|
| 228 |
+
*/
|
| 229 |
+
EOS_DECLARE_CALLBACK(EOS_PlayerDataStorage_OnDeleteFileCompleteCallback, const EOS_PlayerDataStorage_DeleteFileCallbackInfo* Data);
|
| 230 |
+
|
| 231 |
+
/**
|
| 232 |
+
* Handle type to a File Request
|
| 233 |
+
*/
|
| 234 |
+
EOS_EXTERN_C typedef struct EOS_PlayerDataStorageFileTransferRequestHandle* EOS_HPlayerDataStorageFileTransferRequest;
|
| 235 |
+
|
| 236 |
+
/**
|
| 237 |
+
* Free the memory used by a cloud-storage file request handle. This will not cancel a request in progress.
|
| 238 |
+
*/
|
| 239 |
+
EOS_DECLARE_FUNC(void) EOS_PlayerDataStorageFileTransferRequest_Release(EOS_HPlayerDataStorageFileTransferRequest PlayerDataStorageFileTransferHandle);
|
| 240 |
+
|
| 241 |
+
|
| 242 |
+
/**
|
| 243 |
+
* Data containing the information about a file transfer in progress (or one that has completed)
|
| 244 |
+
*/
|
| 245 |
+
EOS_STRUCT(EOS_PlayerDataStorage_FileTransferProgressCallbackInfo, (
|
| 246 |
+
/** Client-specified data passed into the file request */
|
| 247 |
+
void* ClientData;
|
| 248 |
+
/** The Product User ID of the local user who initiated this request */
|
| 249 |
+
EOS_ProductUserId LocalUserId;
|
| 250 |
+
/** The file name of the file being transferred */
|
| 251 |
+
const char* Filename;
|
| 252 |
+
/** Amount of bytes transferred so far in this request, out of TotalFileSizeBytes */
|
| 253 |
+
uint32_t BytesTransferred;
|
| 254 |
+
/** The total size of the file being transferred (Includes file header in addition to file contents, can be slightly more than expected) */
|
| 255 |
+
uint32_t TotalFileSizeBytes;
|
| 256 |
+
));
|
| 257 |
+
|
| 258 |
+
/**
|
| 259 |
+
* Callback for when there is a progress update for a file transfer in progress
|
| 260 |
+
*/
|
| 261 |
+
EOS_DECLARE_CALLBACK(EOS_PlayerDataStorage_OnFileTransferProgressCallback, const EOS_PlayerDataStorage_FileTransferProgressCallbackInfo* Data);
|
| 262 |
+
|
| 263 |
+
|
| 264 |
+
/**
|
| 265 |
+
* Return results for EOS_PlayerDataStorage_OnReadFileDataCallback callbacks to return
|
| 266 |
+
*/
|
| 267 |
+
EOS_ENUM(EOS_PlayerDataStorage_EReadResult,
|
| 268 |
+
/** Signifies the data was read successfully, and we should continue to the next chunk if possible */
|
| 269 |
+
EOS_RR_ContinueReading = 1,
|
| 270 |
+
/** Signifies there was a failure reading the data, and the request should end */
|
| 271 |
+
EOS_RR_FailRequest = 2,
|
| 272 |
+
/** Signifies the request should be canceled, but not due to an error */
|
| 273 |
+
EOS_RR_CancelRequest = 3
|
| 274 |
+
);
|
| 275 |
+
|
| 276 |
+
/**
|
| 277 |
+
* Data containing data for a chunk of a file being read
|
| 278 |
+
*/
|
| 279 |
+
EOS_STRUCT(EOS_PlayerDataStorage_ReadFileDataCallbackInfo, (
|
| 280 |
+
/** Client-specified data passed into the file request */
|
| 281 |
+
void* ClientData;
|
| 282 |
+
/** The Product User ID of the local user who initiated this request */
|
| 283 |
+
EOS_ProductUserId LocalUserId;
|
| 284 |
+
/** The file name being read */
|
| 285 |
+
const char* Filename;
|
| 286 |
+
/** The total file size of the file being read */
|
| 287 |
+
uint32_t TotalFileSizeBytes;
|
| 288 |
+
/** Is this chunk the last chunk of data? */
|
| 289 |
+
EOS_Bool bIsLastChunk;
|
| 290 |
+
/** The length of DataChunk in bytes that can be safely read */
|
| 291 |
+
uint32_t DataChunkLengthBytes;
|
| 292 |
+
/** Pointer to the start of data to be read */
|
| 293 |
+
const void* DataChunk;
|
| 294 |
+
));
|
| 295 |
+
|
| 296 |
+
/**
|
| 297 |
+
* Callback for when we have data ready to be read from the requested file. It is undefined how often this will be called during a single tick.
|
| 298 |
+
*
|
| 299 |
+
* @param Data Struct containing a chunk of data to read, as well as some metadata for the file being read
|
| 300 |
+
* @return The result of the read operation. If this value is not EOS_RR_ContinueReading, this callback will not be called again for the same request
|
| 301 |
+
*/
|
| 302 |
+
EOS_DECLARE_CALLBACK_RETVALUE(EOS_PlayerDataStorage_EReadResult, EOS_PlayerDataStorage_OnReadFileDataCallback, const EOS_PlayerDataStorage_ReadFileDataCallbackInfo* Data);
|
| 303 |
+
|
| 304 |
+
/** The most recent version of the EOS_PlayerDataStorage_ReadFile API. */
|
| 305 |
+
#define EOS_PLAYERDATASTORAGE_READFILE_API_LATEST 2
|
| 306 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_READFILE_API_LATEST instead. */
|
| 307 |
+
#define EOS_PLAYERDATASTORAGE_READFILEOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_READFILE_API_LATEST
|
| 308 |
+
|
| 309 |
+
/**
|
| 310 |
+
* Input data for the EOS_PlayerDataStorage_ReadFile function
|
| 311 |
+
*/
|
| 312 |
+
EOS_STRUCT(EOS_PlayerDataStorage_ReadFileOptions, (
|
| 313 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_READFILE_API_LATEST. */
|
| 314 |
+
int32_t ApiVersion;
|
| 315 |
+
/** The Product User ID of the local user who is reading the requested file */
|
| 316 |
+
EOS_ProductUserId LocalUserId;
|
| 317 |
+
/** The file name to read; this file must already exist */
|
| 318 |
+
const char* Filename;
|
| 319 |
+
/** The maximum amount of data in bytes should be available to read in a single EOS_PlayerDataStorage_OnReadFileDataCallback call */
|
| 320 |
+
uint32_t ReadChunkLengthBytes;
|
| 321 |
+
/** Callback function that handles data as it comes in, and can stop the transfer early */
|
| 322 |
+
EOS_PlayerDataStorage_OnReadFileDataCallback ReadFileDataCallback;
|
| 323 |
+
/** Optional callback function to be informed of download progress, if the file is not already locally cached; if provided, this will be called at least once before completion if the request is successfully started */
|
| 324 |
+
EOS_PlayerDataStorage_OnFileTransferProgressCallback FileTransferProgressCallback;
|
| 325 |
+
));
|
| 326 |
+
|
| 327 |
+
|
| 328 |
+
/**
|
| 329 |
+
* Data containing the result of a read file request
|
| 330 |
+
*/
|
| 331 |
+
EOS_STRUCT(EOS_PlayerDataStorage_ReadFileCallbackInfo, (
|
| 332 |
+
/** The result code for the operation.
|
| 333 |
+
* EOS_Success: The request was successful.
|
| 334 |
+
* EOS_Canceled: The request was canceled.
|
| 335 |
+
* EOS_TooManyRequests: There are too many requests in progress for the local user at this time.
|
| 336 |
+
* EOS_AlreadyPending: There is another requests in progress for the specified file by this user.
|
| 337 |
+
* EOS_CacheDirectoryMissing: The cache directory was not set when calling EOS_Platform_Create.
|
| 338 |
+
* EOS_CacheDirectoryInvalid: The cache directory provided when calling EOS_Platform_Create was invalid.
|
| 339 |
+
* EOS_PlayerDataStorage_UserThrottled: There were too many requests to the Data Storage service recently by the local user. The application must wait some time before trying again.
|
| 340 |
+
* EOS_PlayerDataStorage_EncryptionKeyNotSet: The encryption key value was not set when calling EOS_Platform_Create.
|
| 341 |
+
* EOS_PlayerDataStorage_FileCorrupted: The downloaded or cached file was corrupted or invalid in some way. What exactly is wrong with the file is returned in the logs (potentially retryable).
|
| 342 |
+
* EOS_InvalidState: The read operation is not allowed (e.g. when application is suspended).
|
| 343 |
+
* EOS_UnexpectedError: An unexpected error occurred either downloading, or reading the downloaded file. This most commonly means there were file IO issues such as: permission issues, disk is full, etc. (potentially retryable)
|
| 344 |
+
*/
|
| 345 |
+
EOS_EResult ResultCode;
|
| 346 |
+
/** Client-specified data passed into the file read request */
|
| 347 |
+
void* ClientData;
|
| 348 |
+
/** The Product User ID of the local user who initiated this request */
|
| 349 |
+
EOS_ProductUserId LocalUserId;
|
| 350 |
+
/** The filename of the file that has been finished reading */
|
| 351 |
+
const char* Filename;
|
| 352 |
+
));
|
| 353 |
+
|
| 354 |
+
/**
|
| 355 |
+
* Callback for when EOS_PlayerDataStorage_ReadFile completes
|
| 356 |
+
*/
|
| 357 |
+
EOS_DECLARE_CALLBACK(EOS_PlayerDataStorage_OnReadFileCompleteCallback, const EOS_PlayerDataStorage_ReadFileCallbackInfo* Data);
|
| 358 |
+
|
| 359 |
+
|
| 360 |
+
/**
|
| 361 |
+
* Return results for EOS_PlayerDataStorage_OnWriteFileDataCallback callbacks to return
|
| 362 |
+
*/
|
| 363 |
+
EOS_ENUM(EOS_PlayerDataStorage_EWriteResult,
|
| 364 |
+
/** Signifies the data was written successfully, and we should write the data the file */
|
| 365 |
+
EOS_WR_ContinueWriting = 1,
|
| 366 |
+
/** Signifies all data has now been written successfully, and we should upload the data to the cloud */
|
| 367 |
+
EOS_WR_CompleteRequest = 2,
|
| 368 |
+
/** Signifies there was a failure writing the data, and the request should end */
|
| 369 |
+
EOS_WR_FailRequest = 3,
|
| 370 |
+
/** Signifies the request should be canceled, but not due to an error */
|
| 371 |
+
EOS_WR_CancelRequest = 4
|
| 372 |
+
);
|
| 373 |
+
|
| 374 |
+
/**
|
| 375 |
+
* Data containing data for a chunk of a file being written
|
| 376 |
+
*/
|
| 377 |
+
EOS_STRUCT(EOS_PlayerDataStorage_WriteFileDataCallbackInfo, (
|
| 378 |
+
/** Client-specified data passed into the file write request */
|
| 379 |
+
void* ClientData;
|
| 380 |
+
/** The Product User ID of the local user who initiated this request */
|
| 381 |
+
EOS_ProductUserId LocalUserId;
|
| 382 |
+
/** The file name that is being written to */
|
| 383 |
+
const char* Filename;
|
| 384 |
+
/** The maximum amount of data in bytes that can be written safely to DataBuffer */
|
| 385 |
+
uint32_t DataBufferLengthBytes;
|
| 386 |
+
));
|
| 387 |
+
|
| 388 |
+
/**
|
| 389 |
+
* Callback for when we are ready to get more data to be written into the requested file. It is undefined how often this will be called during a single tick.
|
| 390 |
+
*
|
| 391 |
+
* @param Data Struct containing metadata for the file being written to, as well as the max length in bytes that can be safely written to DataBuffer
|
| 392 |
+
* @param OutDataBuffer A buffer to write data into, to be appended to the end of the file that is being written to. The maximum length of this value is provided in the Info parameter. The number of bytes written to this buffer should be set in OutDataWritten.
|
| 393 |
+
* @param OutDataWritten The length of the data written to OutDataBuffer. This must be less than or equal than the DataBufferLengthBytes provided in the Info parameter
|
| 394 |
+
* @return The result of the write operation. If this value is not EOS_WR_ContinueWriting, this callback will not be called again for the same request. If this is set to EOS_WR_FailRequest or EOS_WR_CancelRequest, all data written during the request will not be saved
|
| 395 |
+
*/
|
| 396 |
+
EOS_DECLARE_CALLBACK_RETVALUE(EOS_PlayerDataStorage_EWriteResult, EOS_PlayerDataStorage_OnWriteFileDataCallback, const EOS_PlayerDataStorage_WriteFileDataCallbackInfo* Data, void* OutDataBuffer, uint32_t* OutDataWritten);
|
| 397 |
+
|
| 398 |
+
/** The most recent version of the EOS_PlayerDataStorage_WriteFile API. */
|
| 399 |
+
#define EOS_PLAYERDATASTORAGE_WRITEFILE_API_LATEST 2
|
| 400 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_WRITEFILE_API_LATEST instead. */
|
| 401 |
+
#define EOS_PLAYERDATASTORAGE_WRITEFILEOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_WRITEFILE_API_LATEST
|
| 402 |
+
|
| 403 |
+
/**
|
| 404 |
+
* Input data for the EOS_PlayerDataStorage_WriteFile function
|
| 405 |
+
*/
|
| 406 |
+
EOS_STRUCT(EOS_PlayerDataStorage_WriteFileOptions, (
|
| 407 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_WRITEFILE_API_LATEST. */
|
| 408 |
+
int32_t ApiVersion;
|
| 409 |
+
/** The Product User ID of the local user who is writing the requested file to the cloud */
|
| 410 |
+
EOS_ProductUserId LocalUserId;
|
| 411 |
+
/** The name of the file to write; if this file already exists, the contents will be replaced if the write request completes successfully */
|
| 412 |
+
const char* Filename;
|
| 413 |
+
/** Requested maximum amount of data (in bytes) that can be written to the file per tick */
|
| 414 |
+
uint32_t ChunkLengthBytes;
|
| 415 |
+
/** Callback function that provides chunks of data to be written into the requested file */
|
| 416 |
+
EOS_PlayerDataStorage_OnWriteFileDataCallback WriteFileDataCallback;
|
| 417 |
+
/** Optional callback function to inform the application of upload progress; will be called at least once if set */
|
| 418 |
+
EOS_PlayerDataStorage_OnFileTransferProgressCallback FileTransferProgressCallback;
|
| 419 |
+
));
|
| 420 |
+
|
| 421 |
+
/**
|
| 422 |
+
* The result information for a request to write data to a file
|
| 423 |
+
*/
|
| 424 |
+
EOS_STRUCT(EOS_PlayerDataStorage_WriteFileCallbackInfo, (
|
| 425 |
+
/** The result code for the operation.
|
| 426 |
+
* EOS_Success: The request was successful.
|
| 427 |
+
* EOS_Canceled: The request was canceled.
|
| 428 |
+
* EOS_TooManyRequests: There are too many requests in progress for the local user at this time.
|
| 429 |
+
* EOS_AlreadyPending: There is another requests in progress for the specified file by this user.
|
| 430 |
+
* EOS_CacheDirectoryMissing: The cache directory was not set when calling EOS_Platform_Create.
|
| 431 |
+
* EOS_CacheDirectoryInvalid: The cache directory provided when calling EOS_Platform_Create was invalid.
|
| 432 |
+
* EOS_PlayerDataStorage_UserThrottled: There were too many requests to the Data Storage service recently by the local user. The application must wait some time before trying again.
|
| 433 |
+
* EOS_PlayerDataStorage_EncryptionKeyNotSet: The encryption key value was not set when calling EOS_Platform_Create.
|
| 434 |
+
* EOS_InvalidState: The read operation is not allowed (e.g. when application is suspended).
|
| 435 |
+
* EOS_UnexpectedError: An unexpected error occurred either downloading, or reading the downloaded file. This most commonly means there were file IO issues such as: permission issues, disk is full, etc. (potentially retryable)
|
| 436 |
+
*/
|
| 437 |
+
EOS_EResult ResultCode;
|
| 438 |
+
/** Client-specified data passed into the file write request */
|
| 439 |
+
void* ClientData;
|
| 440 |
+
/** The Product User ID of the local user who initiated this request */
|
| 441 |
+
EOS_ProductUserId LocalUserId;
|
| 442 |
+
/** The file name that is being written to */
|
| 443 |
+
const char* Filename;
|
| 444 |
+
));
|
| 445 |
+
|
| 446 |
+
/**
|
| 447 |
+
* Callback for when EOS_PlayerDataStorage_WriteFile completes
|
| 448 |
+
*/
|
| 449 |
+
EOS_DECLARE_CALLBACK(EOS_PlayerDataStorage_OnWriteFileCompleteCallback, const EOS_PlayerDataStorage_WriteFileCallbackInfo* Data);
|
| 450 |
+
|
| 451 |
+
/** The most recent version of the EOS_PlayerDataStorage_DeleteCache API. */
|
| 452 |
+
#define EOS_PLAYERDATASTORAGE_DELETECACHE_API_LATEST 1
|
| 453 |
+
/** DEPRECATED! Use EOS_PLAYERDATASTORAGE_DELETECACHE_API_LATEST instead. */
|
| 454 |
+
#define EOS_PLAYERDATASTORAGE_DELETECACHEOPTIONS_API_LATEST EOS_PLAYERDATASTORAGE_DELETECACHE_API_LATEST
|
| 455 |
+
|
| 456 |
+
/**
|
| 457 |
+
* Input data for the EOS_TitleStorage_DeleteCache function
|
| 458 |
+
*/
|
| 459 |
+
EOS_STRUCT(EOS_PlayerDataStorage_DeleteCacheOptions, (
|
| 460 |
+
/** API Version: Set this to EOS_PLAYERDATASTORAGE_DELETECACHE_API_LATEST. */
|
| 461 |
+
int32_t ApiVersion;
|
| 462 |
+
/** Product User ID of the local user who is deleting his cache */
|
| 463 |
+
EOS_ProductUserId LocalUserId;
|
| 464 |
+
));
|
| 465 |
+
|
| 466 |
+
/**
|
| 467 |
+
* Structure containing the result of a delete cache operation
|
| 468 |
+
*/
|
| 469 |
+
EOS_STRUCT(EOS_PlayerDataStorage_DeleteCacheCallbackInfo, (
|
| 470 |
+
/** Result code for the operation. EOS_Success is returned for a successful request, other codes indicate an error */
|
| 471 |
+
EOS_EResult ResultCode;
|
| 472 |
+
/** Client-specified data passed into the delete cache request */
|
| 473 |
+
void* ClientData;
|
| 474 |
+
/** Product User ID of the local user who initiated this request */
|
| 475 |
+
EOS_ProductUserId LocalUserId;
|
| 476 |
+
));
|
| 477 |
+
|
| 478 |
+
/**
|
| 479 |
+
* Callback for when EOS_PlayerDataStorage_DeleteCache completes
|
| 480 |
+
*/
|
| 481 |
+
EOS_DECLARE_CALLBACK(EOS_PlayerDataStorage_OnDeleteCacheCompleteCallback, const EOS_PlayerDataStorage_DeleteCacheCallbackInfo* Data);
|
| 482 |
+
|
| 483 |
+
|
| 484 |
+
#pragma pack(pop)
|