Unreal 向け 6labs SDK

6labs SDK は Unreal Engine プラグインとして提供されます。

このモジュールを Unreal プロジェクトに追加します。

1. ダウンロード 6labs Unreal SDK の最新バージョン v2.3.5。
2. プラグインをプロジェクトの Plugins ディレクトリ（YourProject/Plugins/SixLabsSDK/）に展開します。
3. プラグインが有効になっていることを確認します。
   • Unreal Editor で Edit > Plugins を開きます。
   • 「6labs SDK」を検索し、有効になっていることを確認します。
4. モジュール依存関係を追加します。
   • ゲームモジュールの Build.cs に次を追加します： PublicDependencyModuleNames.Add("SixLabsSDK");

StartSession() メソッドを使用して、ゲームプレイの観察を開始します。以下の例を参照してください。

// MyGameInstance.h
UFUNCTION()
void OnStartSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage);

// MyGameInstance.cpp
#include "SixLabsSubsystem.h"
if (USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>())
{
    FSixLabsLifecycleComplete OnComplete;
    OnComplete.BindDynamic(this, &UMyGameInstance::OnStartSessionComplete);
    
    SixLabs->StartSession(TEXT("<player_in_game_id>"), TEXT("<developer_payload>"), OnComplete);
}

void UMyGameInstance::OnStartSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage)
{
    // Response == ESixLabsSdkResponse::SIXLABS_SUCCESS は StartSession() が正常に完了したことを意味します
    // 結果を処理する
    // SixLabs->GetSdkState() で SDK の現在の状態を取得できます
}

void StartSession(
    const FString& InGameId,
    const FString& DeveloperPayload,
    const FSixLabsLifecycleComplete& OnComplete);

SetInGameId() メソッドを使用して、プレイヤーのゲーム内 ID を既存の観察セッションに関連付けます。このメソッドは、ユーザーアカウントが作成される前に SDK が初期化された場合に、ログイン済みのユーザーを進行中のセッションに紐付けるためによく使用されます。

if (USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>())
{
    SixLabs->SetInGameId(TEXT("<player_in_game_id>"));
}

void SetInGameId(const FString& InGameId);

SendGameEvent() メソッドを使用すると、進行中の観察セッション中にカスタムのゲームプレイイベントを記録できます。イベントはセッションに紐付けられ、分析時に特定のゲームプレイの瞬間を関連付けるために利用できます。

const bool bAccepted = SixLabs->SendGameEvent(TEXT("<event_name>"), TEXT("<event_data_as_json>"));
if (!bAccepted)
{
    // イベントは送信されていません。理由は下記を参照
}

bool SendGameEvent(
    const FString& EventName,
    const FString& EventDataJson);

StartSession() は新しいセッションのゲームプレイ観察を開始します。その後は要件に応じて PauseSession()、 ResumeSession()、 StopSession() を使用してそのセッションを制御できます。

5.1 一時停止 (PauseSession)

PauseSession() メソッドを使用して、ゲームプレイの観察を一時停止します。

const ESixLabsSdkResponse Response = SixLabs->PauseSession();
if (Response != ESixLabsSdkResponse::SIXLABS_SUCCESS)
{
    // SDK は観察を行っていませんでした。下記のレスポンスを参照
}

ESixLabsSdkResponse PauseSession();

5.2 再開 (ResumeSession)

ResumeSession() メソッドを使用して、PauseSession() によって一時停止されていたセッションを再開します。

// MyGameInstance.h
UFUNCTION()
void OnResumeSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage);

// MyGameInstance.cpp
#include "SixLabsSubsystem.h"
if (USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>())
{
    FSixLabsLifecycleComplete OnComplete;
    OnComplete.BindDynamic(this, &UMyGameInstance::OnResumeSessionComplete);
    
    SixLabs->ResumeSession(OnComplete);
}

void UMyGameInstance::OnResumeSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage)
{
    // Response == ESixLabsSdkResponse::SIXLABS_SUCCESS は ResumeSession() が正常に完了したことを意味します
    // 結果を処理する
    // SixLabs->GetSdkState() で SDK の現在の状態を取得できます
}

void ResumeSession(const FSixLabsLifecycleComplete& OnComplete);

5.3 停止 (StopSession)

StopSession() メソッドを使用して、現在のセッションを完全に終了します。PauseSession() とは異なり、停止したセッションは ResumeSession() で再開することはできません — 新しいセッションを開始するには、再度 StartSession() を呼び出す必要があります。

// MyGameInstance.h
UFUNCTION()
void OnStopSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage);

// MyGameInstance.cpp
#include "SixLabsSubsystem.h"
if (USixLabsSubsystem* SixLabs = GetSubsystem<USixLabsSubsystem>())
{
    FSixLabsLifecycleComplete OnComplete;
    OnComplete.BindDynamic(this, &UMyGameInstance::OnStopSessionComplete);
    
    SixLabs->StopSession(OnComplete);
}

void UMyGameInstance::OnStopSessionComplete(ESixLabsSdkResponse Response, const FString& ErrorMessage)
{
    // Response == ESixLabsSdkResponse::SIXLABS_SUCCESS は StopSession() が正常に完了したことを意味します
    // 結果を処理する
    // SixLabs->GetSdkState() で SDK の現在の状態を取得できます
}

void StopSession(const FSixLabsLifecycleComplete& OnComplete);

SDK は以下の状態を遷移します。呼び出せるメソッドとその結果は、現在の状態によって決まります：

• GetSdkState() を使用すると、いつでも現在の SDK の状態を確認できます。戻り値は ESixLabsSdkState です。
• StartSession()、PauseSession()、ResumeSession()、StopSession() は、SDK が有効な状態にあるときにのみ呼び出すことができます。無効な状態から操作を呼び出すと、エラーが返されます。
• PauseSession() は ESixLabsSdkResponse を直接返します。StartSession()、ResumeSession()、StopSession() は、OnComplete コールバックを通じて結果を返します。
• OnComplete コールバックはゲームスレッド上で非同期に呼び出されます。

6.1 コールバック型

FSixLabsLifecycleComplete は、次の 2 つのパラメータを受け取るダイナミックデリゲートです：

6.2 状態

6.3 レスポンスコード