Gamebase Unreal SDKを使用するには、初期化を行う必要があります。またアプリID、アプリバージョン情報がTOAST Consoleに登録されている必要があります。
Gamebase APIを使用するには、次のヘッダファイルをインクルードします。
#include "Gamebase.h"
初期化時に必要な設定は下記の通りです。
Setting value | Supported Platform | Mandatory(M) / Optional(O) |
---|---|---|
appID | ALL | M |
appVersion | ALL | M |
storeCode | ALL | M |
displayLanguageCode | ALL | O |
enablePopup | ALL | O |
enableLaunchingStatusPopup | ALL | O |
enableBanPopup | ALL | O |
enableKickoutPopup | ALL | O |
Gamebase Consoleに登録されたプロジェクトIDです。
Game > Gamebase > コンソール使用ガイド > アプリ > App
Gamebase Consoleに登録したクライアントバージョンです。
Game > Gamebase > コンソール使用ガイド > アプリ > Client
NHN Cloud統合アプリ内決済サービスであるIAP(In-App Purchase)を初期化するために必要なストア情報です。
Store | Code | Description |
---|---|---|
App Store | AS | only iOS |
Google Play | GG | only Android |
One Store | ONESTORE | only Android |
Galaxy Store | GALAXY | only Android |
Gamebaseで提供するUIおよびSystemDialogに表示される言語を、端末に設定された言語ではない別の言語に変更できます。
Game > Gamebase > Unreal SDK使用ガイド > ETC > Additional Features > Display Language
システムメンテナンス、利用制裁(ban)など、ゲームユーザーがゲームをプレイできない状況で、ポップアップなどで理由を表示する必要がある時があります。 Gamebaseで提供する基本ポップアップを使用するかの設定です。
LaunchingStatusがゲームをできない状態の場合、Gamebaseで提供する基本ポップアップを使用するかの設定です。 LaunchingStatusは、下記Launching項目下のState、Code部分を参照してください。
ログイン時、該当ゲームユーザーが利用停止状態の場合、Gamebaseで提供する基本ポップアップを使用するかどうかの設定です。
Gamebase ServerからKickoutイベントを受け取った場合、Gamebaseで提供する基本ポップアップを使用するかどうかの設定です。
[注意]
ゲームをリリースする時は、必ずソースコードからSetDebugModeの呼び出しを削除するか、パラメータをfalseに変更してビルドしてください。
デバッグ設定はConsoleでも行えます。Consoleで設定された値を優先視します。 Console設定方法は、以下のガイドを参考にしてください。
API
Supported Platforms ■ UNREAL_IOS ■ UNREAL_ANDROID ■ UNREAL_WINDOWS ■ UNREAL_EDITOR
void SetDebugMode(bool isDebugMode);
Example
void Sample::SetDebugMode(bool isDebugMode)
{
IGamebase::Get().SetDebugMode(isDebugMode);
}
SDKを初期化します。
API
Supported Platforms ■ UNREAL_IOS ■ UNREAL_ANDROID ■ UNREAL_WINDOWS ■ UNREAL_EDITOR
void Initialize(const FGamebaseConfiguration& configuration, const FGamebaseLaunchingInfoDelegate& onCallback);
Example
void Sample::Initialize(const FString& appID, const FString& appVersion)
{
FGamebaseConfiguration configuration{ "AppID", "AppVersion", "real", GamebaseDisplayLanguageCode.Korean, true, true, true, true, GamebaseStoreCode.Google, true };
IGamebase::Get().Initialize(configuration, FGamebaseLaunchingInfoDelegate::CreateLambda([=](const FGamebaseLaunchingInfo* launchingInfo, const FGamebaseError* error)
{
if (Gamebase::IsSuccess(error))
{
UE_LOG(GamebaseTestResults, Display, TEXT("Initialize succeeded."));
// Following notices are registered in the Gamebase Console
auto notice = launchingInfo->launching.notice;
if (notice != null)
{
if (string.IsNullOrEmpty(notice.message) == false)
{
UE_LOG(GamebaseTestResults, Display, TEXT("title: %s"), notice.title);
UE_LOG(GamebaseTestResults, Display, TEXT("message: %s"), notice.message);
UE_LOG(GamebaseTestResults, Display, TEXT("url: %s"), notice.url);
}
}
// Status information of game app version set in the Gamebase Unreal SDK initialization.
auto status = launchingInfo->launching.status;
// Game status code (e.g. Under maintenance, Update is required, Service has been terminated)
// refer to GamebaseLaunchingStatus
if (status.code == GamebaseLaunchingStatus::IN_SERVICE)
{
// Service is now normally provided.
}
else
{
switch (status.code)
{
case GamebaseLaunchingStatus::RECOMMEND_UPDATE:
{
// Update is recommended.
break;
}
// ...
case GamebaseLaunchingStatus::INTERNAL_SERVER_ERROR:
{
// Error in internal server.
break;
}
}
}
}
else
{
// Check the error code and handle the error appropriately.
UE_LOG(GamebaseTestResults, Display, TEXT("Initialize failed."));
}
}));
}
Initialize APIを使用してGamebase Unreal SDKを初期化すると、LaunchingInfoオブジェクトが結果値として伝達されます。 このLaunchingInfoオブジェクトにはGamebase Consoleに設定した値とゲーム状態などが含まれています。
Gamebaseローンチ情報です。
1.1 Status
Gamebase Unreal SDK初期化設定に入力したアプリバージョンのゲーム状態情報です。
ステータスコードは、下記の表を参照してください。
Status | Code | Description |
---|---|---|
IN_SERVICE | 200 | 正常サービス中 |
RECOMMEND_UPDATE | 201 | アップデート推奨 |
IN_SERVICE_BY_QA_WHITE_LIST | 202 | メンテナンス中はサービスを利用できませんが、QA端末に登録されている場合はメンテナンスに関係なくサービスに接続してテストできます。 |
IN_TEST | 203 | テスト中 |
IN_REVIEW | 204 | 審査中 |
IN_BETA | 205 | ベータサーバー環境 |
REQUIRE_UPDATE | 300 | アップデート必須 |
BLOCKED_USER | 301 | 接続遮断に登録された端末(デバイスキー)でサービスに接続した場合です。 |
TERMINATED_SERVICE | 302 | サービス終了 |
INSPECTING_SERVICE | 303 | サービスメンテナンス中 |
INSPECTING_ALL_SERVICES | 304 | 全サービスメンテナンス中 |
INTERNAL_SERVER_ERROR | 500 | 内部サーバーエラー |
Game > Gamebase > コンソール使用ガイド > アプリ > App
1.2 App
Gamebase Consoleに登録されたアプリ情報です。
Game > Gamebase > コンソール使用ガイド > アプリ > Client
1.3 Maintenance
Gamebase Consoleに登録されたメンテナンス情報です。
Game > Gamebase > コンソール使用ガイド > 運営 > Maintenance
1.4 Notice
Gamebase Consoleに登録された告知情報です。
Game > Gamebase > コンソール使用ガイド > 運営 > Notice
Gamebaseと連携されたTOASTサービスのappKeyです。
NHN Cloud Consoleに登録されたIAPストア情報です。
Game > Gamebase > コンソール使用ガイド > 決済
NHN Cloud Launchingコンソールでユーザーが入力した情報です。
Game > Gamebase > コンソール使用ガイド > 管理 > Config
GetLaunchingInformations APIを利用すると、Initialize後にもLaunchingInfoオブジェクトを取得できます。
[注意]
GetLaunchingInformations APIは、リアルタイムでサーバーから情報を取得する非同期APIではありません。 2分毎にアップデートされるキャッシュ情報を返すめ、リアルタイムで現在のメンテナンス状況を判断する用途には適していません。 このような場合にはLaunching Status Codeが変更されれ時にイベントが動作するGamebaseEventHandlerを活用してください。 Game > Gamebase > Unreal SDK使用ガイド > ETC > Additional Features > Gamebase Event Handler > Observer
API
Supported Platforms ■ UNREAL_IOS ■ UNREAL_ANDROID ■ UNREAL_EDITOR
const FGamebaseLaunchingInfoPtr GetLaunchingInformations() const;
Example
void Sample::GetLaunchingInformations()
{
auto launchingInformation = IGamebase::Get().GetLaunching().GetLaunchingInformations();
if (launchingInformation.IsValid() == false)
{
UE_LOG(GamebaseTestResults, Display, TEXT("Not found launching info."));
return;
}
}
Error | Error Code | Description |
---|---|---|
NOT_INITIALIZED | 1 | Gamebaseが初期化されていません。 |
NOT_LOGGED_IN | 2 | ログインが必要です。 |
INVALID_PARAMETER | 3 | 無効なパラメータです。 |
INVALID_JSON_FORMAT | 4 | JSONフォーマットエラーです。 |
USER_PERMISSION | 5 | 権限がありません。 |
NOT_SUPPORTED | 10 | サポートしない機能です。 |