general - YoYoGames/GMEXT-EpicOnlineServices GitHub Wiki

General

This module provides miscellaneous/debug functions.

Functions

Provided functions:

Constants

These are the constants used by this API:

Structs

These are the structs used this API:



Back To Top

eos_get_version

Epic Online Services Function: EOS_Friends_AcceptInvite

This function gets the version of the EOSSDK binary.


Syntax:

eos_get_version()



Returns:

String


Example:

show_debug_message($"EpicOnlineServices Version: {eos_get_version()}");

The above code shows an example of how the function should be used. The function eos_get_version will return the current version of the SDK.




Back To Top

eos_logging_set_log_level

Epic Online Services Function: EOS_Logging_SetLogLevel

This function sets the logging level for the specified logging category.

Note

By default all log categories will callback for Warnings, Errors, and Fatals.


Syntax:

eos_logging_set_log_level(category, log_level)
Argument Type Description
category EOS_LOG_CATEGORY The specific log category to configure. Use EOS_LOG_CATEGORY.ALL_CATEGORIES to configure all categories simultaneously to the same log level. Check the constants under EOS_LOG_CATEGORY.
log_level EOS_LOG_LEVEL the log level to use for the log category. Check the constants under EOS_LOG_LEVEL.



Returns:

N/A


Example:

eos_logging_set_log_level(EOS_LC_ALL_CATEGORIES, EOS_LOG_OFF);

The above code shows an example of how the function should be used. This will turn off logging for all categories.




Back To Top

eos_result_to_string

This function returns a text representation of the status code passed to it.


Syntax:

eos_result_to_string(result)
Argument Type Description
result EOS_RESULT The result code for which to get the text representation



Returns:

String




Back To Top

eos_shutdown

Epic Online Services Function: EOS_Shutdown

This function shuts down the Epic Online Services SDK. Once this function has been called, no more SDK calls are permitted. Calling anything after eos_shutdown will result in undefined behaviour.

  1. EOS_RESULT.SUCCESS is the returned status if the SDK is successfully torn down.
  2. EOS_RESULT.NOT_CONFIGURED is returned status if the extension didn't initialise correctly.
  3. EOS_RESULT.UNEXPECTED_ERROR is returned status if eos_shutdown has already been called.

Warning

This should be called at the end of your game.


Syntax:

eos_shutdown()



Returns:

EpicResult


Example:

var _struct = eos_shutdown();
if(_struct.status == EOS_RESULT.SUCCESS)
{
     show_debug_message("Shutdown Success");
}
else
{
     show_debug_message("Shutdown Failed");
}

The above code shows an example of how the function should be used. This should be called at the end of your game.




Back To Top

EOS_RESULT

Epic Online Services Enum: EOS_EResult

This enum holds the available constants used as task results, for the entire API.

These constants are referenced by the following functions:

These constants are referenced by the following structs:


Member Description
SUCCESS Successful result. no further error processing needed
NO_CONNECTION Failed due to no connection
INVALID_CREDENTIALS Failed login due to invalid credentials
INVALID_USER Failed due to invalid or missing user
INVALID_AUTH Failed due to invalid or missing authentication token for user (e.g. not logged in)
ACCESS_DENIED Failed due to invalid access
MISSING_PERMISSIONS If the client does not possess the permission required
TOKEN_NOT_ACCOUNT If the token provided does not represent an account
TOO_MANY_REQUESTS Throttled due to too many requests
ALREADY_PENDING Async request was already pending
INVALID_PARAMETERS Invalid parameters specified for request
INVALID_REQUEST Invalid request
UNRECOGNIZED_RESPONSE Failed due to unable to parse or recognize a backend response
INCOMPATIBLE_VERSION Incompatible client for backend version
NOT_CONFIGURED Not configured correctly for use
ALREADY_CONFIGURED Already configured for use.
NOT_IMPLEMENTED Feature not available on this implementation
CANCELED Operation was canceled (likely by user)
NOT_FOUND The requested information was not found
OPERATION_WILL_RETRY An error occurred during an asynchronous operation, and it will be retried. Callbacks receiving this result will be called again in the future.
NO_CHANGE The request had no effect
VERSION_MISMATCH The request attempted to use multiple or inconsistent API versions
LIMIT_EXCEEDED A maximum limit was exceeded on the client, different from TOO_MANY_REQUESTS
DISABLED Feature or client ID performing the operation has been disabled.
DUPLICATE_NOT_ALLOWED Duplicate entry not allowed
INVALID_SANDBOX_ID Sandbox ID is invalid
TIMED_OUT Request timed out
PARTIAL_RESULT A query returned some but not all of the requested results.
MISSING_ROLE Client is missing the white-listed role
MISSING_FEATURE Client is missing the white-listed feature
INVALID_SANDBOX The sandbox given to the backend is invalid
INVALID_DEPLOYMENT The deployment given to the backend is invalid
INVALID_PRODUCT The product ID specified to the backend is invalid
INVALID_PRODUCT_USER_ID The product user ID specified to the backend is invalid
SERVICE_FAILURE There was a failure with the backend service
CACHE_DIRECTORY_MISSING Cache directory is not set in platform options.
CACHE_DIRECTORY_INVALID Cache directory is not accessible.
INVALID_STATE The request failed because resource was in an invalid state
REQUEST_IN_PROGRESS Request is in progress
APPLICATION_SUSPENDED Application is suspended
NETWORK_DISCONNECTED Network is disconnected
AUTH_ACCOUNT_LOCKED Account locked due to login failures
AUTH_ACCOUNT_LOCKED_FOR_UPDATE Account locked by update operation.
AUTH_INVALID_REFRESH_TOKEN Refresh token used was invalid
AUTH_INVALID_TOKEN Invalid access token, typically when switching between backend environments
AUTH_AUTHENTICATION_FAILURE Invalid bearer token
AUTH_INVALID_PLATFORM_TOKEN Invalid platform token
AUTH_WRONG_ACCOUNT Auth parameters are not associated with this account
AUTH_WRONG_CLIENT Auth parameters are not associated with this client
AUTH_FULL_ACCOUNT_REQUIRED Full account is required
AUTH_HEADLESS_ACCOUNT_REQUIRED Headless account is required
AUTH_PASSWORD_RESET_REQUIRED Password reset is required
AUTH_PASSWORD_CANNOT_BE_REUSED Password was previously used and cannot be reused
AUTH_EXPIRED Authorization code/exchange code has expired
AUTH_SCOPE_CONSENT_REQUIRED Consent has not been given by the user
AUTH_APPLICATION_NOT_FOUND The application has no profile on the backend
AUTH_SCOPE_NOT_FOUND The requested consent wasn't found on the backend
AUTH_ACCOUNT_FEATURE_RESTRICTED This account has been denied access to login
AUTH_PIN_GRANT_CODE Pin grant code initiated
AUTH_PIN_GRANT_EXPIRED Pin grant code attempt expired
AUTH_PIN_GRANT_PENDING Pin grant code attempt pending
AUTH_EXTERNALAUTHNOTLINKED External auth source did not yield an account
AUTH_EXTERNAL_AUTH_REVOKED External auth access revoked
AUTH_EXTERNAL_AUTH_INVALID External auth token cannot be interpreted
AUTH_EXTERNAL_AUTH_RESTRICTED External auth cannot be linked to his account due to restrictions
AUTH_EXTERNAL_AUTH_CANNOT_LOGIN External auth cannot be used for login
AUTH_EXTERNAL_AUTH_EXPIRED External auth is expired
AUTH_EXTERNAL_AUTH_IS_LAST_LOGIN_TYPE External auth cannot be removed since it's the last possible way to login
AUTH_EXCHANGE_CODE_NOT_FOUND Exchange code not found
AUTH_ORIGINATING_EXCHANGE_CODE_SESSION_EXPIRED Originating exchange code session has expired
AUTH_ACCOUNT_NOT_ACTIVE The account has been disabled and cannot be used for authentication
AUTH_MFA_REQUIRED MFA challenge required
AUTH_PARENTAL_CONTROLS Parental locks are in place
AUTH_NO_REAL_ID Korea real ID association required but missing
FRIENDS_INVITE_AWAITING_ACCEPTANCE An outgoing friend invitation is waiting acceptance; sending another invite to the same user is erroneous
FRIENDS_NO_INVITATION There is no friend invitation to accept/reject
FRIENDS_ALREADY_FRIENDS Users are already friends, so sending another invite is erroneous
FRIENDS_NOT_FRIENDS Users are not friends, so deleting the friend is erroneous
FRIENDS_TARGET_USER_TOO_MANY_INVITES Remote user has too many invites to receive new invites
FRIENDS_LOCAL_USER_TOO_MANY_INVITES Local user has too many invites to send new invites
FRIENDS_TARGET_USER_FRIEND_LIMIT_EXCEEDED Remote user has too many friends to make a new friendship
FRIENDS_LOCAL_USER_FRIEND_LIMIT_EXCEEDED Local user has too many friends to make a new friendship
PRESENCE_DATA_INVALID Request data was null or invalid
PRESENCE_DATALENGTHINVALID Request contained too many or too few unique data items, or the request would overflow the maximum amount of data allowed
PRESENCE_DATA_KEY_INVALID Request contained data with an invalid key
PRESENCE_DATA_KEY_LENGTH_INVALID Request contained data with a key too long or too short
PRESENCE_DATA_VALUE_INVALID Request contained data with an invalid value
PRESENCE_DATA_VALUE_LENGTH_INVALID Request contained data with a value too long
PRESENCE_RICH_TEXT_INVALID Request contained an invalid rich text string
PRESENCE_RICH_TEXT_LENGTH_INVALID Request contained a rich text string that was too long
PRESENCE_STATUS_INVALID Request contained an invalid status state
ECOM_ENTITLEMENT_STALE The entitlement retrieved is stale, re-query for updated information
ECOM_CATALOG_OFFER_STALE The offer retrieved is stale, re-query for updated information
ECOM_CATALOG_ITEM_STALE The item or associated structure retrieved is stale, re-query for updated information
ECOM_CATALOG_OFFER_PRICE_INVALID The one or more offers has an invalid price. This may be caused by the price setup.
ECOM_CHECKOUT_LOAD_ERROR The checkout page failed to load
ECOM_PURCHASE_PROCESSING The player closed the purchase flow overlay after clicking the purchase button. The purchase may still go through = and the game needs to query unredeemed entitlements for a short time.
SESSIONS_SESSION_IN_PROGRESS Session is already in progress
SESSIONS_TOO_MANY_PLAYERS Too many players to register with this session
SESSIONS_NO_PERMISSION Client has no permissions to access this session
SESSIONS_SESSION_ALREADY_EXISTS Session already exists in the system
SESSIONS_INVALID_LOCK Session lock required for operation
SESSIONS_INVALID_SESSION Invalid session reference
SESSIONS_SANDBOX_NOT_ALLOWED Sandbox ID associated with auth didn't match
SESSIONS_INVITE_FAILED Invite failed to send
SESSIONS_INVITE_NOT_FOUND Invite was not found with the service
SESSIONS_UPSERT_NOT_ALLOWED This client may not modify the session
SESSIONS_AGGREGATION_FAILED Backend nodes unavailable to process request
SESSIONS_HOST_AT_CAPACITY Individual backend node is as capacity
SESSIONS_SANDBOX_AT_CAPACITY Sandbox on node is at capacity
SESSIONS_SESSION_NOT_ANONYMOUS An anonymous operation was attempted on a non anonymous session
SESSIONS_OUT_OF_SYNC Session is currently out of sync with the backend, data is saved locally but needs to sync with backend
SESSIONS_TOO_MANY_INVITES User has received too many invites
SESSIONS_PRESENCE_SESSION_EXISTS Presence session already exists for the client
SESSIONS_DEPLOYMENT_AT_CAPACITY Deployment on node is at capacity
SESSIONS_NOT_ALLOWED Session operation not allowed
SESSIONS_PLAYER_SANCTIONED Session operation not allowed
PLAYER_DATA_STORAGE_FILENAME_INVALID Request filename was invalid
PLAYER_DATA_STORAGE_FILENAME_LENGTH_INVALID Request filename was too long
PLAYER_DATA_STORAGE_FILENAME_INVALID_CHARS Request filename contained invalid characters
PLAYER_DATA_STORAGE_FILESIZE_TOO_LARGE Request operation would grow file too large
PLAYER_DATA_STORAGE_FILE_SIZE_INVALID Request file length is not valid
PLAYER_DATA_STORAGE_FILE_HANDLE_INVALID Request file handle is not valid
PLAYER_DATA_STORAGE_DATA_INVALID Request data is invalid
PLAYER_DATA_STORAGE_DATA_LENGTH_INVALID Request data length was invalid
PLAYER_DATA_STORAGE_START_INDEX_INVALID Request start index was invalid
PLAYER_DATA_STORAGE_REQUEST_IN_PROGRESS Request is in progress
PLAYER_DATA_STORAGE_USER_THROTTLED User is marked as throttled which means he can't perform some operations because limits are exceeded.
PLAYER_DATA_STORAGE_ENCRYPTION_KEY_NOT_SET Encryption key is not set during SDK init.
PLAYER_DATA_STORAGE_USER_ERROR_FROM_DATA_CALLBACK User data callback returned error
PLAYER_DATA_STORAGE_FILE_HEADER_HAS_NEWER_VERSION User is trying to read file that has header from newer version of SDK. Game/SDK needs to be updated.
PLAYER_DATA_STORAGE_FILE_CORRUPTED The file is corrupted. In some cases retry can fix the issue.
CONNECT_EXTERNAL_TOKEN_VALIDATION_FAILED EOS Auth service deemed the external token invalid
CONNECT_USER_ALREADY_EXISTS EOS Auth user already exists
CONNECT_AUTH_EXPIRED EOS Auth expired
CONNECT_INVALID_TOKEN EOS Auth invalid token
CONNECT_UNSUPPORTED_TOKEN_TYPE EOS Auth doesn't support this token type
CONNECT_LINK_ACCOUNT_FAILED EOS Auth Account link failure
CONNECT_EXTERNAL_SERVICE_UNAVAILABLE EOS Auth External service for validation was unavailable
CONNECT_EXTERNAL_SERVICE_CONFIGURATION_FAILURE EOS Auth External Service configuration failure with Dev Portal
UI_SOCIAL_OVERLAY_LOAD_ERROR The social overlay page failed to load
UI_INCONSISTENT_VIRTUAL_MEMORY_FUNCTIONS Virtual Memory Functions are an inconsistent mix of functions and nullptrs
LOBBY_NOT_OWNER Client has no permissions to modify this lobby
LOBBY_INVALID_LOCK Lobby lock required for operation
LOBBY_LOBBY_ALREADY_EXISTS Lobby already exists in the system
LOBBY_SESSION_IN_PROGRESS Lobby is already in progress
LOBBY_TOO_MANY_PLAYERS Too many players to register with this lobby
LOBBY_NO_PERMISSION Client has no permissions to access this lobby
LOBBY_INVALID_SESSION Invalid lobby session reference
LOBBY_SANDBOX_NOT_ALLOWED Sandbox ID associated with auth didn't match
LOBBY_INVITE_FAILED Invite failed to send
LOBBY_INVITE_NOT_FOUND Invite was not found with the service
LOBBY_UPSERT_NOT_ALLOWED This client may not modify the lobby
LOBBY_AGGREGATION_FAILED Backend nodes unavailable to process request
LOBBY_HOST_AT_CAPACITY Individual backend node is at capacity
LOBBY_SANDBOX_AT_CAPACITY Sandbox on node is at capacity
LOBBY_TOO_MANY_INVITES User has received too many invites
LOBBY_DEPLOYMENT_AT_CAPACITY Deployment on node is at capacity
LOBBY_NOT_ALLOWED Lobby operation not allowed
LOBBY_MEMBER_UPDATE_ONLY While restoring a lost connection lobby ownership changed and only local member data was updated
LOBBY_PRESENCE_LOBBY_EXISTS Presence lobby already exists for the client
LOBBY_VOICE_NOT_ENABLED Operation requires lobby with voice enabled
LOBBY_PLATFORM_NOT_ALLOWED The client platform does not match the allowed platform list for the lobby.
TITLE_STORAGE_USER_ERROR_FROM_DATA_CALLBACK User callback that receives data from storage returned error.
TITLE_STORAGE_ENCRYPTION_KEY_NOT_SET User forgot to set Encryption key during platform init. Title Storage can't work without it.
TITLE_STORAGE_FILE_CORRUPTED Downloaded file is corrupted.
TITLE_STORAGE_FILE_HEADER_HAS_NEWER_VERSION Downloaded file's format is newer than client SDK version.
MODS_MOD_SDK_PROCESS_IS_ALREADY_RUNNING ModSdk process is already running. This error comes from the EOSSDK.
MODS_MOD_SDK_COMMAND_IS_EMPTY ModSdk command is empty. Either the ModSdk configuration file is missing or the manifest location is empty.
MODS_MOD_SDK_PROCESS_CREATION_FAILED Creation of the ModSdk process failed. This error comes from the SDK.
MODS_CRITICAL_ERROR A critical error occurred in the external ModSdk process that we were unable to resolve.
MODS_TOOL_INTERNAL_ERROR A internal error occurred in the external ModSdk process that we were unable to resolve.
MODS_IPC_FAILURE A IPC failure occurred in the external ModSdk process.
MODS_INVALID_IPC_RESPONSE A invalid IPC response received in the external ModSdk process.
MODS_URI_LAUNCH_FAILURE A URI Launch failure occurred in the external ModSdk process.
MODS_MOD_IS_NOT_INSTALLED Attempting to perform an action with a mod that is not installed. This error comes from the external ModSdk process.
MODS_USER_DOES_NOT_OWN_THEGAME Attempting to perform an action on a game that the user doesn't own. This error comes from the external ModSdk process.
MODS_OFFER_REQUEST_BY_ID_INVALID_RESULT Invalid result of the request to get the offer for the mod. This error comes from the external ModSdk process.
MODS_COULD_NOT_FIND_OFFER Could not find the offer for the mod. This error comes from the external ModSdk process.
MODS_OFFER_REQUEST_BY_ID_FAILURE Request to get the offer for the mod failed. This error comes from the external ModSdk process.
MODS_PURCHASE_FAILURE Request to purchase the mod failed. This error comes from the external ModSdk process.
MODS_INVALID_GAME_INSTALL_INFO Attempting to perform an action on a game that is not installed or is partially installed. This error comes from the external ModSdk process.
MODS_CANNOT_GET_MANIFEST_LOCATION Failed to get manifest location. Either the ModSdk configuration file is missing or the manifest location is empty
MODS_UNSUPPORTED_OS Attempting to perform an action with a mod that does not support the current operating system.
ANTICHEAT_CLIENT_PROTECTION_NOT_AVAILABLE The anti-cheat client protection is not available. Check that the game was started using the anti-cheat bootstrapper.
ANTICHEAT_INVALID_MODE The current anti-cheat mode is incorrect for using this API
ANTICHEAT_CLIENT_PRODUCTID_MISMATCH The ProductId provided to the anti-cheat client helper executable does not match what was used to initialize the EOS SDK
ANTICHEAT_CLIENT_SANDBOX_ID_MISMATCH The SandboxId provided to the anti-cheat client helper executable does not match what was used to initialize the EOS SDK
ANTICHEAT_PROTECT_MESSAGE_SESSION_KEY_REQUIRED (ProtectMessage/UnprotectMessage) No session key is available, but it is required to complete this operation
ANTICHEAT_PROTECT_MESSAGE_VALIDATION_FAILED (ProtectMessage/UnprotectMessage) Message integrity is invalid
ANTICHEAT_PROTECT_MESSAGE_INITIALIZATION_FAILED (ProtectMessage/UnprotectMessage) Initialization failed
ANTICHEAT_PEER_ALREADY_REGISTERED (RegisterPeer) Peer is already registered
ANTICHEAT_PEER_NOT_FOUND (UnregisterPeer) Peer does not exist
ANTICHEAT_PEER_NOT_PROTECTED (ReceiveMessageFromPeer) Invalid call: Peer is not protected
ANTICHEAT_CLIENT_DEPLOYMENT_ID_MISMATCH The DeploymentId provided to the anti-cheat client helper executable does not match what was used to initialize the EOS SDK
ANTICHEAT_DEVICE_ID_AUTH_IS_NOT_SUPPORTED EOS Connect DeviceID auth method is not supported for anti-cheat
RTC_TOO_MANY_PARTICIPANTS EOS RTC room cannot accept more participants
RTC_ROOM_ALREADY_EXISTS EOS RTC room already exists
RTC_USER_KICKED The user kicked out from the room
RTC_USER_BANNED The user is banned
RTC_ROOM_WAS_LEFT EOS RTC room was left successfully
RTC_RECONNECTION_TIME_GATE_EXPIRED Connection dropped due to long timeout
RTC_SHUTDOWN_INVOKED EOS RTC room was left due to platform release
RTC_USERIS_IN_BLOCKLIST EOS RTC operation failed because the user is in the local user's block list
PROGRESSION_SNAPSHOT_SNAPSHOT_ID_UNAVAILABLE The number of available Snapshot IDs have all been exhausted.
KWS__PARENT_EMAIL_MISSING The KWS user does not have a parental email associated with the account. The parent account was unlinked or deleted
KWS_USER_GRADUATED The KWS user is no longer a minor and trying to update the parent email
ANDROID__JAVA_VM_NOT_STORED EOS Android VM not stored
ANDROID_RESERVED_MUST_REFERENCE_LOCAL_VM EOS Android if Reserved is set it must reference stored VM
ANDROID_RESERVED_MUST_BE_NULL EOS Android Reserved must not be provided
PERMISSION_REQUIRED_PATCH_AVAILABLE Patch required before the user can use the privilege
PERMISSION_REQUIRED_SYSTEM_UPDATE System update required before the user can use the privilege
PERMISSION_AGE_RESTRICTION_FAILURE Parental control failure usually
PERMISSION_ACCOUNT_TYPE_FAILURE Premium Account Subscription required but not available
PERMISSION_CHAT_RESTRICTION User restricted from chat
PERMISSION_UGC_RESTRICTION User restricted from User Generated Content
PERMISSION_ONLINE_PLAY_RESTRICTED Online play is restricted
DESKTOP_CROSSPLAY_APPLICATION_NOT_BOOTSTRAPPED The application was not launched through the Bootstrapper. Desktop crossplay functionality is unavailable.
DESKTOP_CROSSPLAY_SERVICE_NOT_INSTALLED The redistributable service is not installed.
DESKTOP_CROSSPLAY_SERVICE_START_FAILED The desktop crossplay service failed to start.
DESKTOP_CROSSPLAY_SERVICE_NOT_RUNNING The desktop crossplay service is no longer running for an unknown reason.
CUSTOM_INVITES_INVITE_FAILED When sending the custom invite failed.
USER_INFO_BEST_DISPLAY_NAME_INDETERMINATE The best display name could not be safely determined.
CONSOLE_INIT_CACHE_STORAGE_SIZE_KB_NOT_MULTIPLE_OF_16 CacheStorageSizeKB must be a multiple of 16
CONSOLE_INIT_CACHE_STORAGE_SIZE_KB_BELOW_MINIMUM_SIZE CacheStorageSizeKB is less than the minimum allowed
CONSOLE_INIT_CACHE_STORAGE_SIZE_KB_EXCEEDS_MAXIMUM_SIZE CacheStorageSizeKB is greater than the maximum allowed (4000 MB)
CONSOLE_INIT_CACHE_STORAGE_INDEX_OUT_OF_RANGE CacheStorageIndex is out of its allowed range
UNEXPECTED_ERROR An unexpected error that we cannot identify has occurred


Back To Top

EOS_COMPARISON_OP

Epic Online Services Enum: EOS_EComparisonOp

These constants are referenced by the following functions:


Member Description
EQUAL Value must equal the one stored on the lobby/session
NOT_EQUAL Value must not equal the one stored on the lobby/session
GREATER_THAN Value must be strictly greater than the one stored on the lobby/session
GREATER_THAN_OR_EQUAL Value must be greater than or equal to the one stored on the lobby/session
LESS_THAN Value must be strictly less than the one stored on the lobby/session
LESS_THAN_OR_EQUAL Value must be less than or equal to the one stored on the lobby/session
DISTANCE Prefer values nearest the one specified i.e. abs(SearchValue-SessionValue) closest to 0
ANY_OF Value stored on the lobby/session may be any from a specified list
NOT_ANY_OF Value stored on the lobby/session may NOT be any from a specified list
ONE_OF This one value is a part of a collection
NOT_ONE_OF This one value is NOT part of a collection
CONTAINS This value is a CASE SENSITIVE substring of an attribute stored on the lobby/session


Back To Top

EOS_LOG_CATEGORY

Epic Online Services Enum: EOS_ELogCategory

These constants represent the available logging categories.

These constants are referenced by the following functions:


Member Description
CORE Low level logs unrelated to specific services
AUTH Logs related to the Auth service
FRIENDS Logs related to the Friends service
PRESENCE Logs related to the Presence service
USER_INFO Logs related to the UserInfo service
HTTP_SERIALIZATION Logs related to HTTP serialization
ECOM Logs related to the Ecommerce service
P2P Logs related to the P2P service
SESSIONS Logs related to the Sessions service
RATE_LIMITER Logs related to rate limiting
PLAYER_DATA_STORAGE Logs related to the PlayerDataStorage service
ANALYTICS Logs related to sdk analytics
MESSAGING Logs related to the messaging service
CONNECT Logs related to the Connect service
OVERLAY Logs related to the Overlay
ACHIEVEMENTS Logs related to the Achievements service
STATS Logs related to the Stats service
UI Logs related to the UI service
LOBBY Logs related to the lobby service
LEADERBOARDS Logs related to the Leaderboards service
KEYCHAIN Logs related to an internal Keychain feature that the authentication interfaces use
IDENTITY_PROVIDER Logs related to external identity providers
TITLE_STORAGE Logs related to Title Storage
MODS Logs related to the Mods service
ANTI_CHEAT Logs related to the Anti-Cheat service
REPORTS Logs related to reports client
SANCTIONS Logs related to the Sanctions service
PROGRESSION_SNAPSHOTS Logs related to the Progression Snapshot service
KWS Logs related to the Kids Web Services integration
RTC Logs related to the RTC API
RTC_ADMIN Logs related to the RTC Admin API
INVENTORY Logs related to the Inventory service
RECEIPT_VALIDATOR Logs related to the Receipt Validator API
CUSTOM_INVITES Logs related to the Custom Invites API
ALL_CATEGORIES Not a real log category. Used by eos_logging_set_log_level to set the log level for all categories at the same time


Back To Top

EOS_LOG_LEVEL

Epic Online Services Enum: EOS_ELogLevel

These constants represent the available logging levels. When a log message is output, it has an associated log level. Messages will only be sent to the callback function if the message is associated log level is less than or equal to the configured log level for that category.

These constants are referenced by the following functions:


Member Description
EOS_LOG_OFF
EOS_LOG_FATAL
EOS_LOG_ERROR
EOS_LOG_WARNING
EOS_LOG_INFO
EOS_LOG_VERBOSE
EOS_LOG_VERY_VERBOSE


Back To Top

EOS_INVALID_NOTIFICATIONID

This macro represents an invalid notification ID.


Member Description
EOS_INVALID_NOTIFICATIONID


Back To Top

EpicResult

A struct containing a result's status code and its representation in text.

This struct is referenced by the following functions:


Member Type Description
status EOS_RESULT The status code for the operation. EOS_RESULT.SUCCESS indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code.

⚠️ **GitHub.com Fallback** ⚠️