Package host.anzo.eossdk.eos.sdk

Class EOS

java.lang.Object
host.anzo.eossdk.eos.sdk.EOS
public class EOS extends Object
Epic Online Services SDK entry point
Since:
8/6/2023

  • Field Details

    • EOS_MAJOR_VERSION

      public static final int EOS_MAJOR_VERSION
      EOS SDK major version
      See Also:

    • EOS_MINOR_VERSION

      public static final int EOS_MINOR_VERSION
      EOS SDK minor version
      See Also:

    • EOS_PATCH_VERSION

      public static final int EOS_PATCH_VERSION
      EOS SDK patch version
      See Also:

    • EOS_PLATFORM_CHECKFORLAUNCHERANDRESTART_ENV_VAR

      public static final String EOS_PLATFORM_CHECKFORLAUNCHERANDRESTART_ENV_VAR
      The name of the env var used to determine if the game was launched by the Epic Games Launcher.

      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, this environment variable is set to 1.

      NOTE: You can force the EOS_Platform_CheckForLauncherAndRestart API to relaunch the title by explicitly unsetting this environment variable before calling EOS_Platform_CheckForLauncherAndRestart.

      See Also:

  • Constructor Details

    • EOS

      public EOS()

  • Method Details

    • EOS_Initialize

      public static EOS_EResult EOS_Initialize(EOS_InitializeOptions options)
      Initialize the Epic Online Services SDK.

      Before calling any other function in the SDK, clients must call this function.

      This function must only be called one time and must have a corresponding EOS_Shutdown call.

      Parameters:
      options - - The initialization options to use for the SDK.
      Returns:
      EOS_EResult.EOS_Success is returned if the SDK successfully initializes.
      EOS_EResult.EOS_AlreadyConfigured is returned if the function has already been called.
      EOS_EResult.EOS_InvalidParameters is returned if the provided options are invalid.

    • EOS_Shutdown

      public static EOS_EResult EOS_Shutdown()
      Tear 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 behavior.

      Returns:
      EOS_EResult.EOS_Success is returned if the SDK is successfully torn down.
      EOS_EResult.EOS_NotConfigured is returned if a successful call to EOS_Initialize has not been made.
      EOS_EResult.EOS_UnexpectedError is returned if EOS_Shutdown has already been called.

    • EOS_Platform_Create

      public static EOS_Platform_Interface EOS_Platform_Create(EOS_Platform_Options options)
      Create a single Epic Online Services Platform Instance.

      The platform instance is used to gain access to the various Epic Online Services.

      This function returns an opaque handle to the platform instance, and that handle must be passed to EOS_Platform_Release to release the instance.

      Parameters:
      options - platform create options
      Returns:
      An opaque handle to the platform instance.

    • EOS_ByteArray_ToString

      public EOS_EResult EOS_ByteArray_ToString(byte[] byteArray, int length, byte[] outBuffer, com.sun.jna.ptr.IntByReference inOutBufferLength)
      Encode a byte array into hex encoded string
      Parameters:
      byteArray - byte array
      length - byte count
      outBuffer - out buffer
      inOutBufferLength - exchange buffer
      Returns:
      EOS_EResult.EOS_Success if the encoding was successful and passed out in OutBuffer
      EOS_EResult.EOS_InvalidParameters if you pass a null pointer on invalid length for any of the parameters
      EOS_EResult.EOS_LimitExceeded - The outBuffer is not large enough to receive the encoding. inOutBufferLength contains the required minimum length to perform the operation successfully.