GS2-Deploy/CDK Reference of GS2-Buff

Entities

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

	Type	Require	Limitation	Description
name	string	✓	~ 32 chars	Namespace name
description	string		~ 1024 chars	Description
logSetting	LogSetting			Log output settings

GetAttr

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Buff::Namespace
Properties:
  Name: namespace1
  Description: 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

Currently available master data

GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Please refer to the documentation for the format of the JSON file.

	Type	Require	Default	Limitation	Description
namespaceName	string	✓		~ 32 chars	Namespace name
settings	string	✓		~ 5242880 chars	Master data

GetAttr

	Type	Description
Item	CurrentBuffMaster	Updated currently available buff rate settings

Implementation Example

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,
            # omission
        ).master_data(
            [
                buff.BuffEntryModel(
                    name='buff-0001',
                    target_type='model',
                    expression='add',
                    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',
                    target_type='action',
                    expression='mul',
                    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',
                    target_type='model',
                    expression='mul',
                    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,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Buff\Model\BuffEntryModel(
                    name:"buff-0001",
                    targetType: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterTargetType::MODEL
                    expression: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterExpression::ADD
                    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",
                    targetType: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterTargetType::ACTION
                    expression: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterExpression::MUL
                    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",
                    targetType: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterTargetType::MODEL
                    expression: \Gs2Cdk\Buff\Model\Enums\CurrentBuffMasterExpression::MUL
                    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,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.buff.model.BuffEntryModel(
                    "buff-0001",
                    Model,
                    Add,
                    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",
                    Action,
                    Mul,
                    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",
                    Model,
                    Mul,
                    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,
            // omission
        ).masterData(
            [
                new buff.model.BuffEntryModel(
                    "buff-0001",
                    buff.model.CurrentBuffMasterTargetType.MODEL,
                    buff.model.CurrentBuffMasterExpression.ADD,
                    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.CurrentBuffMasterTargetType.ACTION,
                    buff.model.CurrentBuffMasterExpression.MUL,
                    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.CurrentBuffMasterTargetType.MODEL,
                    buff.model.CurrentBuffMasterExpression.MUL,
                    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,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Buff.Model.BuffEntryModel(
                    "buff-0001",
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterTargetType.Model,
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterExpression.Add,
                    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.CurrentBuffMasterTargetType.Action,
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterExpression.Mul,
                    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.CurrentBuffMasterTargetType.Model,
                    Gs2Cdk.Gs2Buff.Model.Enums.CurrentBuffMasterExpression.Mul,
                    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

Buff Target Model

	Type	Require	Limitation	Description
targetModelName	enum [ ]	✓	~ 128 chars	Types of model to apply buffs
targetFieldName	string	✓	~ 64 chars	Field name to which the buff is applied
conditionGrns	List<BuffTargetGrn>	✓	1 ~ 10 items	List of buff application condition GRNs
rate	float	✓	~ 100	Rate

BuffTargetAction

Buff Target Action

	Type	Require	Limitation	Description
targetActionName	enum [ ]	✓	~ 128 chars	Types of action to apply buffs
targetFieldName	string	✓	~ 64 chars	Field name to which the buff is applied
conditionGrns	List<BuffTargetGrn>	✓	1 ~ 10 items	List of buff application condition GRNs
rate	float	✓	~ 100	Rate

BuffTargetGrn

Buff Target GRN pattern

	Type	Require	Default	Limitation	Description
targetModelName	string	✓		~ 64 chars	Buff application condition model name
targetGrn	string	✓		~ 1024 chars	Buff application condition GRN

GitHubCheckoutSetting

Setup to check out master data from GitHub

	Type	Require	Limitation	Description
apiKeyId	string	✓	~ 1024 chars	GitHub API key GRN
repositoryName	string	✓	~ 1024 chars	Repository Name
sourcePath	string	✓	~ 1024 chars	Source code file path
referenceType	enum [ “commit_hash”, “branch”, “tag” ]	✓	~ 128 chars	Source of code
commitHash	string	{referenceType} == “commit_hash”	~ 1024 chars	Commit hash
branchName	string	{referenceType} == “branch”	~ 1024 chars	Branch Name
tagName	string	{referenceType} == “tag”	~ 1024 chars	Tag Name

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

	Type	Require	Default	Limitation	Description
loggingNamespaceId	string	✓		~ 1024 chars	Namespace GRN