Step 1: Prepare Elixir

The first step to integrating Elixir is to assign your SDK public key by running:

UElixirSubsystem::GetInstance()->PrepareElixir(ElixirApiKey);

It is highly recommended to manage API keys through some sort of persisted settings system, such as the built in Unreal Engine UDeveloperSettings class, as you will find yourself having to frequently switch between development API keys for testing and production API keys for building a release.

Step 2: Initialize Elixir

The second step of Elixir integration is calling the InitElixir function. The function receives a UElixirSubsystem::FCallback.

UElixirSubsystem::FCallback CompleteCallback;
CompleteCallback.BindDynamic(this, &UMyClass::OnElixirInitComplete);
UElixirSubsystem::GetInstance()->InitElixir(CompleteCallback);

The completion callback can execute any logic that should happen after initializing the SDK:

void UMyClass::OnElixirInitComplete(const bool bSuccess)
{
    // this code will run after the SDK has either been successfully initialized
    // or an error has been encountered
}

The initialization process will take care of the following:

• Log in the user automatically via provided context from Elixir Launcher (in production) or a freshly generated token (in development).

• Initialize connection to the Elixir Overlay event buffer

• Set up a timer to refresh the authentication token automatically in the background

You are now ready to use the Elixir SDK!

Prepare & Init Elixir

To integrate the Elixir SDK into your blueprint project you must execute the "Prepare Elixir" node, which will connect your public API key to the SDK and the "Init Elixir" node.

You would normally want to do this in either your game state or your level blueprint, as they get initialized early and only get destroyed once the level is unloaded.

The initialization process will take care of the following:

• Log in the user automatically via provided context from Elixir Launcher (in production) or a freshly generated token (in development).

• Initialize connection to the Elixir Overlay event buffer

• Set up a timer to refresh the authentication token automatically in the background

On Complete Event

The "Init Elixir" node will provide a delegate for a completion event. You can bind a custom event to that delegate using the "Create Event" node, and execute the logic of your choice upon either a successful or failed initialization.

You are now ready to use the Elixir SDK!

Using Elixir Functions

You can easily find all the relevant Elixir functionality by looking for the "Get Elixir Subsystem" node.

Once found, extend a connection from its' pin and type "Elixir" to see a list of all available nodes to interact with the SDK.