NAV
Unity Unreal Engine 4

GS2-Stamina

GS2-SDK for Game Engine のリファレンス

ゲームエンジン向けモデル

EzStaminaModel

スタミナマスターはスタミナの種類を定義するエンティティです。 スタミナの最大値や、回復間隔、回復量といったパラメータを定義できます。 GS2-Experience と連動させて、最大値や回復量をコントロールすることもできます。

説明
name string スタミナの種類名
metadata string メタデータ
recoverIntervalMinutes int スタミナを回復する速度(分)
recoverValue int 時間経過後に回復する量
initialCapacity int スタミナの最大値の初期値
isOverflow bool 最大値を超えて回復するか
maxCapacity int 溢れた状況での最大値
maxStaminaTable MaxStaminaTable GS2-Experience と連携する際に使用するスタミナ最大値テーブル
recoverIntervalTable RecoverIntervalTable GS2-Experience と連携する際に使用する回復間隔テーブル
recoverValueTable RecoverValueTable GS2-Experience と連携する際に使用する回復量テーブル

EzMaxStaminaTable

GS2-Experience のランクごとにスタミナの最大値を定義するエンティティです。

説明
name string 最大スタミナ値テーブル名
metadata string メタデータ
experienceModelId string 経験値・ランクアップ閾値モデルGRN
values int[] ランク毎のスタミナの最大値テーブル

EzRecoverIntervalTable

GS2-Experience のランクごとにスタミナの回復間隔を定義するエンティティです。

説明
name string スタミナ回復間隔テーブル名
metadata string メタデータ
experienceModelId string 経験値・ランクアップ閾値モデルGRN
values int[] ランク毎のスタミナ回復間隔テーブル

EzRecoverValueTable

GS2-Experience のランクごとにスタミナの回復量を定義するエンティティです。

説明
name string スタミナ回復量テーブル名
metadata string メタデータ
experienceModelId string 経験値・ランクアップ閾値モデルGRN
values int[] ランク毎のスタミナ回復量テーブル

EzStamina

ゲームプレイヤー毎に現在のスタミナ値を保持するエンティティです。

説明
staminaName string スタミナモデルの名前
value int 最終更新時におけるスタミナ値
maxValue int スタミナの最大値
recoverIntervalMinutes int スタミナの回復間隔(分)
recoverValue int スタミナの回復量
nextRecoverAt long 次回スタミナが回復する時間

ゲームエンジン向けメソッド

getStaminaModel

getStaminaModel

using Gs2.Core.AsyncResult;
using Gs2.Gs2Account.Unity.Result;
using Gs2.Unity.Util;

var profile = new Profile(
    clientId: "your client id",
    clientSecret: "your client secret",
    reopener: new Gs2BasicReopener()
);

{
    AsyncResult<object> asyncResult = null;

    var current = profile.Initialize(
        r => { asyncResult = r; }
    );

    yield return current;

    if (asyncResult.Error != null)
    {
        OnError(asyncResult.Error);
        yield break;
    }
}

// Up to this line is the initialization process.

var gs2 = new Gs2.Unity.Client(profile);

{
    AsyncResult<EzGetStaminaModelResult> asyncResult = null;
    var current = gs2.Stamina.GetStaminaModel(
        callback: r => { asyncResult = r; },
        namespaceName: "namespace2",
        staminaName: "stamina-0001"
    );

    yield return current;
    if (asyncResult.Error != null)
    {
        OnError(asyncResult.Error);
        yield break;
    }

    var result = asyncResult.Result;
    var item = result.Item;
}
ProfilePtr = std::make_shared<gs2::ez::Profile>(
    TCHAR_TO_ANSI(*ClientId),
    TCHAR_TO_ANSI(*ClientSecret),
    gs2::ez::Gs2BasicReopener()
);

ClientPtr = std::make_shared<gs2::ez::Client>(
    *ProfilePtr
);

ProfilePtr->initialize(
    [this](gs2::ez::Profile::AsyncInitializeResult r)
    {
        if (r.getError())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, "profile.initialize failed.");
        }
        else
        {
            AccountCreate();
        }
    }
);

// Up to this line is the initialization process.

ClientPtr->stamina.getStaminaModel(
    [](gs2::ez::account::AsyncEzGetStaminaModelResult r)
    {
        if (r.getError())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, "stamina.getStaminaModel failed.");
        }
        else
        {
            Item = r.getResult()->getItem();
        }
    },
    TCHAR_TO_ANSI("namespace2"), // namespaceName
    TCHAR_TO_ANSI("stamina-0001") // staminaName
);

スタミナモデルを認証

Request

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
staminaName string ~ 128文字 スタミナの種類名

Result

説明
item EzStaminaModel スタミナモデル

listStaminaModels

listStaminaModels

using Gs2.Core.AsyncResult;
using Gs2.Gs2Account.Unity.Result;
using Gs2.Unity.Util;

var profile = new Profile(
    clientId: "your client id",
    clientSecret: "your client secret",
    reopener: new Gs2BasicReopener()
);

{
    AsyncResult<object> asyncResult = null;

    var current = profile.Initialize(
        r => { asyncResult = r; }
    );

    yield return current;

    if (asyncResult.Error != null)
    {
        OnError(asyncResult.Error);
        yield break;
    }
}

// Up to this line is the initialization process.

var gs2 = new Gs2.Unity.Client(profile);

{
    AsyncResult<EzDescribeStaminaModelsResult> asyncResult = null;
    var current = gs2.Stamina.DescribeStaminaModels(
        callback: r => { asyncResult = r; },
        namespaceName: "namespace2"
    );

    yield return current;
    if (asyncResult.Error != null)
    {
        OnError(asyncResult.Error);
        yield break;
    }

    var result = asyncResult.Result;
    var items = result.Items;
}
ProfilePtr = std::make_shared<gs2::ez::Profile>(
    TCHAR_TO_ANSI(*ClientId),
    TCHAR_TO_ANSI(*ClientSecret),
    gs2::ez::Gs2BasicReopener()
);

ClientPtr = std::make_shared<gs2::ez::Client>(
    *ProfilePtr
);

ProfilePtr->initialize(
    [this](gs2::ez::Profile::AsyncInitializeResult r)
    {
        if (r.getError())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, "profile.initialize failed.");
        }
        else
        {
            AccountCreate();
        }
    }
);

// Up to this line is the initialization process.

ClientPtr->stamina.describeStaminaModels(
    [](gs2::ez::account::AsyncEzDescribeStaminaModelsResult r)
    {
        if (r.getError())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, "stamina.describeStaminaModels failed.");
        }
        else
        {
            Items = r.getResult()->getItems();
        }
    },
    TCHAR_TO_ANSI("namespace2") // namespaceName
);

スタミナモデルを認証

Request

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名

Result

説明
items EzStaminaModel[] スタミナモデルのリスト

consume

consume

using Gs2.Core.AsyncResult;
using Gs2.Gs2Account.Unity.Result;
using Gs2.Unity.Util;

var profile = new Profile(
    clientId: "your client id",
    clientSecret: "your client secret",
    reopener: new Gs2BasicReopener()
);

{
    AsyncResult<object> asyncResult = null;

    var current = profile.Initialize(
        r => { asyncResult = r; }
    );

    yield return current;

    if (asyncResult.Error != null)
    {
        OnError(asyncResult.Error);
        yield break;
    }
}

// Up to this line is the initialization process.

var gs2 = new Gs2.Unity.Client(profile);

{
    AsyncResult<EzConsumeStaminaResult> asyncResult = null;
    var current = gs2.Stamina.ConsumeStamina(
        callback: r => { asyncResult = r; },
        session: session,
        namespaceName: "namespace2",
        staminaName: "stamina-0001",
        consumeValue: 50
    );

    yield return current;
    if (asyncResult.Error != null)
    {
        OnError(asyncResult.Error);
        yield break;
    }

    var result = asyncResult.Result;
    var item = result.Item;
    var staminaModel = result.StaminaModel;
}
ProfilePtr = std::make_shared<gs2::ez::Profile>(
    TCHAR_TO_ANSI(*ClientId),
    TCHAR_TO_ANSI(*ClientSecret),
    gs2::ez::Gs2BasicReopener()
);

ClientPtr = std::make_shared<gs2::ez::Client>(
    *ProfilePtr
);

ProfilePtr->initialize(
    [this](gs2::ez::Profile::AsyncInitializeResult r)
    {
        if (r.getError())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, "profile.initialize failed.");
        }
        else
        {
            AccountCreate();
        }
    }
);

// Up to this line is the initialization process.

ClientPtr->stamina.consumeStamina(
    [](gs2::ez::account::AsyncEzConsumeStaminaResult r)
    {
        if (r.getError())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, "stamina.consumeStamina failed.");
        }
        else
        {
            Item = r.getResult()->getItem();
            StaminaModel = r.getResult()->getStaminaModel();
        }
    },
    ProfilePtr->getGs2Session(),
    TCHAR_TO_ANSI("namespace2"), // namespaceName
    TCHAR_TO_ANSI("stamina-0001"), // staminaName
    50 // consumeValue
);

スタミナを消費

Request

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
staminaName string ~ 128文字 スタミナモデルの名前
accessToken string ~ 128文字 ユーザーID
consumeValue int 1 ~ 9223372036854775807 消費するスタミナ量

Result

説明
item EzStamina スタミナ
staminaModel EzStaminaModel スタミナモデル

getStamina

getStamina

using Gs2.Core.AsyncResult;
using Gs2.Gs2Account.Unity.Result;
using Gs2.Unity.Util;

var profile = new Profile(
    clientId: "your client id",
    clientSecret: "your client secret",
    reopener: new Gs2BasicReopener()
);

{
    AsyncResult<object> asyncResult = null;

    var current = profile.Initialize(
        r => { asyncResult = r; }
    );

    yield return current;

    if (asyncResult.Error != null)
    {
        OnError(asyncResult.Error);
        yield break;
    }
}

// Up to this line is the initialization process.

var gs2 = new Gs2.Unity.Client(profile);

{
    AsyncResult<EzGetStaminaResult> asyncResult = null;
    var current = gs2.Stamina.GetStamina(
        callback: r => { asyncResult = r; },
        session: session,
        namespaceName: "namespace1",
        staminaName: "stamina-0001"
    );

    yield return current;
    if (asyncResult.Error != null)
    {
        OnError(asyncResult.Error);
        yield break;
    }

    var result = asyncResult.Result;
    var item = result.Item;
    var staminaModel = result.StaminaModel;
}
ProfilePtr = std::make_shared<gs2::ez::Profile>(
    TCHAR_TO_ANSI(*ClientId),
    TCHAR_TO_ANSI(*ClientSecret),
    gs2::ez::Gs2BasicReopener()
);

ClientPtr = std::make_shared<gs2::ez::Client>(
    *ProfilePtr
);

ProfilePtr->initialize(
    [this](gs2::ez::Profile::AsyncInitializeResult r)
    {
        if (r.getError())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, "profile.initialize failed.");
        }
        else
        {
            AccountCreate();
        }
    }
);

// Up to this line is the initialization process.

ClientPtr->stamina.getStamina(
    [](gs2::ez::account::AsyncEzGetStaminaResult r)
    {
        if (r.getError())
        {
            GEngine->AddOnScreenDebugMessage(-1, 5.f, FColor::Red, "stamina.getStamina failed.");
        }
        else
        {
            Item = r.getResult()->getItem();
            StaminaModel = r.getResult()->getStaminaModel();
        }
    },
    ProfilePtr->getGs2Session(),
    TCHAR_TO_ANSI("namespace1"), // namespaceName
    TCHAR_TO_ANSI("stamina-0001") // staminaName
);

現在のスタミナを取得

Request

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
staminaName string ~ 128文字 スタミナモデルの名前
accessToken string ~ 128文字 ユーザーID

Result

説明
item EzStamina スタミナ
staminaModel EzStaminaModel スタミナモデル