GS2-Buff GS2-Deploy/CDK リファレンス

エンティティ

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

必須デフォルト値の制限説明
namestring~ 32文字ネームスペース名
descriptionstring~ 1024文字説明文
applyBuffScriptScriptSettingバフを適用する際に実行するスクリプト
logSettingLogSettingログの出力設定

GetAttr

説明
ItemNamespace作成したネームスペース

実装例

Type: GS2::Buff::Namespace
Properties:
  Name: namespace1
  Description: null
  ApplyBuffScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, buff

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        buff.Namespace(
            stack=self,
            name="namespace-0001",
            options=buff.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Buff\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Buff\Model\Options\NamespaceOptions(
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
                ),
            ),
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.buff.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.buff.model.options.NamespaceOptions() {
                {
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import buff from "@/gs2cdk/buff";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new buff.model.Namespace(
            this,
            "namespace-0001",
            {
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Buff.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Buff.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

CurrentBuffMaster

現在有効なマスターデータ

GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

JSONファイルの形式についてはドキュメントを参照ください。

必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
settingsstring~ 5242880文字マスターデータ

GetAttr

説明
ItemCurrentBuffMaster更新した現在有効なバフ設定

実装例

Type: GS2::Buff::CurrentBuffMaster
Properties:
  NamespaceName: namespace1
  Settings: {"version": "2024-04-15", "buffEntryModels": [{"name": "buff-0001", "metadata": "BUFF_0001", "targetType": "model", "targetModel": {"targetModelName": "Gs2Experience:Status", "targetFieldName": "rankCapValue", "conditionGrns": [{"targetModelName": "Gs2Experience:ExperienceModel", "targetGrn": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"}, {"targetServiceName": "Gs2Experience:ExperienceModel", "targetModelName": "rateModel", "targetGrn": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002"}], "rate": 1.0}, "expression": "add", "priority": 1}, {"name": "buff-0002", "metadata": "BUFF_0002", "targetType": "action", "targetAction": {"targetActionName": "Gs2Experience:AddExperienceByUserId", "targetFieldName": "experienceValue", "conditionGrns": [{"targetModelName": "Gs2Experience:ExperienceModel", "targetGrn": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"}], "rate": 2.0}, "expression": "mul", "priority": 2}, {"name": "buff-0002", "metadata": "BUFF_0002", "targetType": "model", "targetModel": {"targetModelName": "Gs2Experience:Status", "targetFieldName": "rankCapValue", "conditionGrns": [{"targetModelName": "Gs2Experience:ExperienceModel", "targetGrn": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001"}], "rate": 3.0}, "expression": "mul", "priority": 3}]}
from gs2_cdk import Stack, core, buff

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        buff.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                buff.BuffEntryModel(
                    name='buff-0001',
                    expression='add',
                    target_type='model',
                    priority=1,
                    options=buff.BuffEntryModelOptions(
                        metadata='BUFF_0001',
                        target_model={'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}, {'targetServiceName': 'Gs2Experience:ExperienceModel', 'targetModelName': 'rateModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002'}], 'rate': 1.0},
                    ),
                ),
                buff.BuffEntryModel(
                    name='buff-0002',
                    expression='mul',
                    target_type='action',
                    priority=2,
                    options=buff.BuffEntryModelOptions(
                        metadata='BUFF_0002',
                        target_action={'targetActionName': 'Gs2Experience:AddExperienceByUserId', 'targetFieldName': 'experienceValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 2.0},
                    ),
                ),
                buff.BuffEntryModel(
                    name='buff-0002',
                    expression='mul',
                    target_type='model',
                    priority=3,
                    options=buff.BuffEntryModelOptions(
                        metadata='BUFF_0002',
                        target_model={'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 3.0},
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Buff\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Buff\Model\BuffEntryModel(
                    name:"buff-0001",
                    expression: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterExpression::ADD
                    targetType: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterTargetType::MODEL
                    priority:1,
                    options: new \Gs2Cdk\Buff\Model\Options\BuffEntryModelOptions(
                        metadata:"BUFF_0001",
                        targetModel:{'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}, {'targetServiceName': 'Gs2Experience:ExperienceModel', 'targetModelName': 'rateModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002'}], 'rate': 1.0},
                    ),
                ),
                new \Gs2Cdk\Buff\Model\BuffEntryModel(
                    name:"buff-0002",
                    expression: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterExpression::MUL
                    targetType: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterTargetType::ACTION
                    priority:2,
                    options: new \Gs2Cdk\Buff\Model\Options\BuffEntryModelOptions(
                        metadata:"BUFF_0002",
                        targetAction:{'targetActionName': 'Gs2Experience:AddExperienceByUserId', 'targetFieldName': 'experienceValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 2.0},
                    ),
                ),
                new \Gs2Cdk\Buff\Model\BuffEntryModel(
                    name:"buff-0002",
                    expression: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterExpression::MUL
                    targetType: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterTargetType::MODEL
                    priority:3,
                    options: new \Gs2Cdk\Buff\Model\Options\BuffEntryModelOptions(
                        metadata:"BUFF_0002",
                        targetModel:{'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 3.0},
                    ),
                ),
            ],
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.buff.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.buff.model.BuffEntryModel(
                    "buff-0001",
                    Add,
                    Model,
                    1,
                    new io.gs2.cdk.buff.model.options.BuffEntryModelOptions() {
                        {
                            metadata: "BUFF_0001";
                            targetModel: {'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}, {'targetServiceName': 'Gs2Experience:ExperienceModel', 'targetModelName': 'rateModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002'}], 'rate': 1.0};
                        }
                    }
                ),
                new io.gs2.cdk.buff.model.BuffEntryModel(
                    "buff-0002",
                    Mul,
                    Action,
                    2,
                    new io.gs2.cdk.buff.model.options.BuffEntryModelOptions() {
                        {
                            metadata: "BUFF_0002";
                            targetAction: {'targetActionName': 'Gs2Experience:AddExperienceByUserId', 'targetFieldName': 'experienceValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 2.0};
                        }
                    }
                ),
                new io.gs2.cdk.buff.model.BuffEntryModel(
                    "buff-0002",
                    Mul,
                    Model,
                    3,
                    new io.gs2.cdk.buff.model.options.BuffEntryModelOptions() {
                        {
                            metadata: "BUFF_0002";
                            targetModel: {'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 3.0};
                        }
                    }
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import buff from "@/gs2cdk/buff";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new buff.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new buff.model.BuffEntryModel(
                    "buff-0001",
                    buff.model.CurrentBuffMasterExpression.ADD,
                    buff.model.CurrentBuffMasterTargetType.MODEL,
                    1,
                    {
                        metadata: "BUFF_0001",
                        targetModel: {'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}, {'targetServiceName': 'Gs2Experience:ExperienceModel', 'targetModelName': 'rateModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002'}], 'rate': 1.0}
                    }
                ),
                new buff.model.BuffEntryModel(
                    "buff-0002",
                    buff.model.CurrentBuffMasterExpression.MUL,
                    buff.model.CurrentBuffMasterTargetType.ACTION,
                    2,
                    {
                        metadata: "BUFF_0002",
                        targetAction: {'targetActionName': 'Gs2Experience:AddExperienceByUserId', 'targetFieldName': 'experienceValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 2.0}
                    }
                ),
                new buff.model.BuffEntryModel(
                    "buff-0002",
                    buff.model.CurrentBuffMasterExpression.MUL,
                    buff.model.CurrentBuffMasterTargetType.MODEL,
                    3,
                    {
                        metadata: "BUFF_0002",
                        targetModel: {'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 3.0}
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Buff.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Buff.Model.BuffEntryModel(
                    "buff-0001",
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterExpression.Add,
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterTargetType.Model,
                    1,
                    new Gs2Cdk.Gs2Buff.Model.Options.BuffEntryModelOptions {
                        metadata = "BUFF_0001",
                        targetModel = {'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}, {'targetServiceName': 'Gs2Experience:ExperienceModel', 'targetModelName': 'rateModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0002'}], 'rate': 1.0},
                    }
                ),
                new Gs2Cdk.Gs2Buff.Model.BuffEntryModel(
                    "buff-0002",
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterExpression.Mul,
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterTargetType.Action,
                    2,
                    new Gs2Cdk.Gs2Buff.Model.Options.BuffEntryModelOptions {
                        metadata = "BUFF_0002",
                        targetAction = {'targetActionName': 'Gs2Experience:AddExperienceByUserId', 'targetFieldName': 'experienceValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 2.0},
                    }
                ),
                new Gs2Cdk.Gs2Buff.Model.BuffEntryModel(
                    "buff-0002",
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterExpression.Mul,
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterTargetType.Model,
                    3,
                    new Gs2Cdk.Gs2Buff.Model.Options.BuffEntryModelOptions {
                        metadata = "BUFF_0002",
                        targetModel = {'targetModelName': 'Gs2Experience:Status', 'targetFieldName': 'rankCapValue', 'conditionGrns': [{'targetModelName': 'Gs2Experience:ExperienceModel', 'targetGrn': 'grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001'}], 'rate': 3.0},
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

BuffTargetModel

モデルに適用するバフ

必須デフォルト値の制限説明
targetModelNameenum [
]
~ 128文字バフを適用するモデルの種類
targetFieldNamestring~ 64文字バフの適用対象フィールド名
conditionGrnsList<BuffTargetGrn>1 ~ 10 itemsバフの適用条件GRNのリスト
ratefloat~ 100レート

BuffTargetAction

アクションに適用するバフ

必須デフォルト値の制限説明
targetActionNameenum [
]
~ 128文字バフを適用するアクションの種類
targetFieldNamestring~ 64文字バフの適用対象フィールド名
conditionGrnsList<BuffTargetGrn>1 ~ 10 itemsバフの適用条件GRNのリスト
ratefloat~ 100レート

BuffTargetGrn

バフを適用するリソースのGRNパターン

必須デフォルト値の制限説明
targetModelNamestring~ 64文字バフの適用条件のモデル名
targetGrnstring~ 1024文字バフの適用条件GRN

OverrideBuffRate

バフの適用レート上書きモデル

必須デフォルト値の制限説明
namestring~ 128文字バフエンティティ名
ratefloat~ 100レート

ScriptSetting

スクリプト設定

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。 このモデルは、スクリプトの実行をトリガーするための設定を保持します。

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。 同期実行は、スクリプトの実行が完了するまで処理がブロックされます。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。

一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。 しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。 Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字スクリプトGRN
doneTriggerTargetTypeenum [
“none”,
“gs2_script”,
“aws”
]
“none”~ 128文字完了通知の通知先
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字スクリプトGRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字ネームスペースGRN

GitHubCheckoutSetting

GitHubからマスターデータをチェックアウトする設定

必須デフォルト値の制限説明
apiKeyIdstring~ 1024文字GitHub のAPIキーGRN
repositoryNamestring~ 1024文字リポジトリ名
sourcePathstring~ 1024文字ソースコードのファイルパス
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
~ 128文字コードの取得元
commitHashstring{referenceType} == “commit_hash”~ 1024文字コミットハッシュ
branchNamestring{referenceType} == “branch”~ 1024文字ブランチ名
tagNamestring{referenceType} == “tag”~ 1024文字タグ名

LogSetting

ログの書き出し設定

ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子(Namespace ID)を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

必須デフォルト値の制限説明
loggingNamespaceIdstring~ 1024文字ネームスペースGRN