适用于 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 是一个动态委托，会接收以下两个参数：

6.2 状态

6.3 响应代码