public class EOS_Platform_Interface
extends com.sun.jna.PointerType
EOS.EOS_Initialize(EOS_InitializeOptions),
EOS.EOS_Platform_Create(EOS_Platform_Options),
release(),
EOS.EOS_Shutdown()| Constructor and Description |
|---|
EOS_Platform_Interface() |
EOS_Platform_Interface(com.sun.jna.Pointer address) |
| Modifier and Type | Method and Description |
|---|---|
EOS_EResult |
checkForLauncherAndRestart()
Checks if the app was launched through the Epic Games Launcher, and relaunches it through the Epic Games Launcher if it wasn't.
|
EOS_Achievements_Interface |
getAchievementsInterface()
Get a handle to the Achievements Interface.
|
java.lang.String |
getActiveCountryCode(EOS_EpicAccountId localUserId)
This only will return the value set as the override otherwise EOS_NotFound is returned.
|
java.lang.String |
getActiveLocaleCode(EOS_EpicAccountId localUserId)
Get the active locale code that the SDK will send to services which require it.
|
EOS_AntiCheatClient_Interface |
getAntiCheatClientInterface()
Get a handle to the Anti-Cheat Client Interface.
|
EOS_AntiCheatServer_Interface |
getAntiCheatServerInterface()
Get a handle to the Anti-Cheat Server Interface.
|
EOS_EApplicationStatus |
getApplicationStatus()
Retrieves the current application state as told to the SDK by the application.
|
EOS_Auth_Interface |
getAuthInterface()
Get a handle to the Auth Interface.
|
EOS_Connect_Interface |
getConnectInterface()
Get a handle to the Connect Interface.
|
EOS_CustomInvites_Interface |
getCustomInvitesInterface()
Get a handle to the Custom Invites Interface.
|
EOS_EResult |
getDesktopCrossplayStatus(EOS_Platform_GetDesktopCrossplayStatusOptions options,
EOS_Platform_DesktopCrossplayStatusInfo outDesktopCrossplayStatusInfo)
Windows only.
|
EOS_Ecom_Interface |
getEcomInterface()
Get a handle to the Ecom Interface.
|
EOS_Friends_Interface |
getFriendsInterface()
Get a handle to the Friends Interface.
|
EOS_IntegratedPlatform_Interface |
getIntegratedPlatformInterface()
Get a handle to the Integrated Platform Interface.
|
EOS_KWS_Interface |
getKWSInterface()
Get a handle to the Kids Web Service Interface.
|
EOS_Leaderboards_Interface |
getLeaderboardsInterface()
Get a handle to the Leaderboards Interface.
|
EOS_Lobby_Interface |
getLobbyInterface()
Get a handle to the Lobby Interface.
|
EOS_Metrics_Interface |
getMetricsInterface()
Get a handle to the Metrics Interface.
|
EOS_Mods_Interface |
getModsInterface()
Get a handle to the Mods Interface.
|
EOS_ENetworkStatus |
getNetworkStatus()
Retrieves the current network state as told to the SDK by the application.
|
java.lang.String |
getOverrideCountryCode()
Get the override country code that the SDK will send to services which require it.
|
java.lang.String |
getOverrideLocaleCode()
Get the override locale code that the SDK will send to services which require it.
|
EOS_P2P_Interface |
getP2PInterface()
Get a handle to the Peer-to-Peer Networking Interface.
|
EOS_PlayerDataStorage_Interface |
getPlayerDataStorageInterface()
Get a handle to the PlayerDataStorage Interface.
|
EOS_Presence_Interface |
getPresenceInterface()
Get a handle to the Presence Interface.
|
EOS_ProgressionSnapshot_Interface |
getProgressionSnapshotInterface()
Get the active country code that the SDK will send to services which require it.
|
EOS_Reports_Interface |
getReportsInterface()
Get a handle to the Reports Interface.
|
EOS_RTC_Admin_Interface |
getRTCAdminInterface()
Get a handle to the RTC Admin Interface.
|
EOS_RTC_Interface |
getRTCInterface()
Get a handle to the RTC Interface.
|
EOS_Sanctions_Interface |
getSanctionsInterface()
Get a handle to the Sanctions Interface.
|
EOS_Sessions_Interface |
getSessionsInterface()
Get a handle to the Sessions Interface.
|
EOS_Stats_Interface |
getStatsInterface()
Get a handle to the Stats Interface.
|
EOS_TitleStorage_Interface |
getTitleStorageInterface()
Get a handle to the TitleStorage Interface.
|
EOS_UI_Interface |
getUIInterface()
Get a handle to the UI Interface.
|
EOS_UserInfo_Interface |
getUserInfoInterface()
Get a handle to the UserInfo Interface.
|
void |
release()
Release an Epic Online Services platform instance previously returned from EOS_Platform_Create.
|
EOS_EResult |
setApplicationStatus(EOS_EApplicationStatus newStatus)
Notify a change in application state.
|
EOS_EResult |
setNetworkStatus(EOS_ENetworkStatus newStatus)
Notify a change in network state.
|
EOS_EResult |
setOverrideCountryCode(java.lang.String newCountryCode)
Set the override country code that the SDK will send to services which require it.
|
EOS_EResult |
setOverrideLocaleCode(java.lang.String newLocaleCode)
Set the override locale code that the SDK will send to services which require it.
|
void |
tick()
Notify the platform instance to do work.
|
public EOS_Platform_Interface(com.sun.jna.Pointer address)
public EOS_Platform_Interface()
public void release()
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. Typically only a single platform instance needs to be created during the lifetime of a game. You should release each platform instance before calling the EOS_Shutdown function.
public void tick()
public EOS_Connect_Interface getConnectInterface()
public EOS_Auth_Interface getAuthInterface()
public EOS_AntiCheatServer_Interface getAntiCheatServerInterface()
public EOS_AntiCheatClient_Interface getAntiCheatClientInterface()
public EOS_Mods_Interface getModsInterface()
public EOS_Lobby_Interface getLobbyInterface()
public EOS_Reports_Interface getReportsInterface()
public EOS_Sanctions_Interface getSanctionsInterface()
public EOS_Achievements_Interface getAchievementsInterface()
public EOS_CustomInvites_Interface getCustomInvitesInterface()
public EOS_Ecom_Interface getEcomInterface()
public EOS_Friends_Interface getFriendsInterface()
public EOS_IntegratedPlatform_Interface getIntegratedPlatformInterface()
public EOS_KWS_Interface getKWSInterface()
public EOS_Leaderboards_Interface getLeaderboardsInterface()
public EOS_Metrics_Interface getMetricsInterface()
public EOS_P2P_Interface getP2PInterface()
public EOS_PlayerDataStorage_Interface getPlayerDataStorageInterface()
public EOS_Presence_Interface getPresenceInterface()
public EOS_ProgressionSnapshot_Interface getProgressionSnapshotInterface()
public EOS_Stats_Interface getStatsInterface()
public EOS_TitleStorage_Interface getTitleStorageInterface()
public EOS_UserInfo_Interface getUserInfoInterface()
public EOS_Sessions_Interface getSessionsInterface()
public EOS_UI_Interface getUIInterface()
public EOS_RTC_Interface getRTCInterface()
public EOS_RTC_Admin_Interface getRTCAdminInterface()
public java.lang.String getActiveCountryCode(EOS_EpicAccountId localUserId) throws EOSException
localUserId - The account to use for lookup if no override exists.EOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if there is not an override country code for the userEOSLimitExceededException - The OutBuffer is not large enough to receive the country code string. InOutBufferLength contains the required minimum length to perform the operation successfully.EOSExceptionEOS_Defines.EOS_COUNTRYCODE_MAX_LENGTHpublic java.lang.String getActiveLocaleCode(EOS_EpicAccountId localUserId) throws EOSException
localUserId - The account to use for lookup if no override exists.EOSInvalidParametersException - if you pass a null pointer for the out parameterEOSNotFoundException - if there is neither an override nor an available locale code for the userEOSLimitExceededException - if there is neither an override nor an available locale code for the userEOSExceptionEOS_Defines.EOS_LOCALECODE_MAX_LENGTHpublic java.lang.String getOverrideCountryCode()
throws EOSException
EOSInvalidParametersException - if you pass a null pointer for the out parameterEOSLimitExceededException - The OutBuffer is not large enough to receive the country code string. InOutBufferLength contains the required minimum length to perform the operation successfully.EOSExceptionEOS_Defines.EOS_COUNTRYCODE_MAX_LENGTHpublic java.lang.String getOverrideLocaleCode()
throws EOSException
EOSInvalidParametersException - override locale code stringEOSLimitExceededException - The OutBuffer is not large enough to receive the locale code string. InOutBufferLength contains the required minimum length to perform the operation successfully.EOSExceptionEOS_Defines.EOS_LOCALECODE_MAX_LENGTHpublic EOS_EResult setOverrideCountryCode(java.lang.String newCountryCode)
newCountryCode - country code to overrideEOS_EResult.EOS_Success if the country code was overriddenEOS_EResult.EOS_InvalidParameters if you pass an invalid country codeEOS_Defines.EOS_COUNTRYCODE_MAX_LENGTHpublic EOS_EResult setOverrideLocaleCode(java.lang.String newLocaleCode)
newLocaleCode - locale code to overrideEOS_EResult.EOS_Success if the locale code was overriddenEOS_EResult.EOS_InvalidParameters if you pass an invalid locale codeEOS_Defines.EOS_LOCALECODE_MAX_LENGTHpublic EOS_EResult checkForLauncherAndRestart()
NOTE: During the call to EOS_Platform_Create, the command line that was used to launch the app is inspected, and if it is recognized as coming from the Epic Games Launcher, an environment variable is set to 1. The name of the environment variable is defined by EOS_PLATFORM_CHECKFORLAUNCHERANDRESTART_ENV_VAR.
You can force the EOS_Platform_CheckForLauncherAndRestart API to relaunch the title by explicitly unsetting this environment variable before calling EOS_Platform_CheckForLauncherAndRestart.
EOS_EResult.EOS_Success is returned if the app is being restarted. You should quit your process as soon as possible.
EOS_EResult.EOS_NoChange is returned if the app was already launched through the Epic Launcher, and no action needs to be taken.
EOS_EResult.EOS_UnexpectedError is returned if the LauncherCheck module failed to initialize, or the module tried and failed to restart the app.
public EOS_EResult getDesktopCrossplayStatus(EOS_Platform_GetDesktopCrossplayStatusOptions options, EOS_Platform_DesktopCrossplayStatusInfo outDesktopCrossplayStatusInfo)
This function verifies that the application was launched through the Bootstrapper application, the redistributable service has been installed and is running in the background, and that the overlay has been loaded successfully.
On Windows, the desktop crossplay functionality is required to use Epic accounts login with applications that are distributed outside the Epic Games Store.
options - input structure that specifies the API version.outDesktopCrossplayStatusInfo - output structure to receive the desktop crossplay status information.EOS_EResult.EOS_NotImplemented is returned on non-Windows platforms.public EOS_EResult setApplicationStatus(EOS_EApplicationStatus newStatus)
newStatus - The new status for the application.EOS_EResult.EOS_Success if the application was changed successfully.EOS_EResult.EOS_InvalidParameters if the value of NewStatus is invalid.v
EOS_EResult.EOS_NotImplemented if EOS_AS_BackgroundConstrained or EOS_AS_BackgroundUnconstrained are attempted to be set on platforms that do not have such application states.public EOS_EApplicationStatus getApplicationStatus()
public EOS_EResult setNetworkStatus(EOS_ENetworkStatus newStatus)
newStatus - The new network status.EOS_EResult.EOS_Success if the network was changed successfully.EOS_EResult.EOS_InvalidParameters if the value of NewStatus is invalid.public EOS_ENetworkStatus getNetworkStatus()