GS2-Buff GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
logSetting | LogSetting | ログの出力設定 |
GetAttr
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
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
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
型 | 説明 | |
---|---|---|
Item | CurrentBuffMaster | 更新した現在有効なバフ設定 |
実装例
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',
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,
// 省略
))->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,
// 省略
).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,
// 省略
).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,
// 省略
).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
モデルに適用するバフ
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
targetModelName | enum [ ] | ✓ | ~ 128文字 | バフを適用するモデルの種類 | |
targetFieldName | string | ✓ | ~ 64文字 | バフの適用対象フィールド名 | |
conditionGrns | List<BuffTargetGrn> | ✓ | 1 ~ 10 items | バフの適用条件GRNのリスト | |
rate | float | ✓ | ~ 100 | レート |
BuffTargetAction
アクションに適用するバフ
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
targetActionName | enum [ ] | ✓ | ~ 128文字 | バフを適用するアクションの種類 | |
targetFieldName | string | ✓ | ~ 64文字 | バフの適用対象フィールド名 | |
conditionGrns | List<BuffTargetGrn> | ✓ | 1 ~ 10 items | バフの適用条件GRNのリスト | |
rate | float | ✓ | ~ 100 | レート |
BuffTargetGrn
バフを適用するリソースのGRNパターン
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
targetModelName | string | ✓ | ~ 64文字 | バフの適用条件のモデル名 | |
targetGrn | string | ✓ | ~ 1024文字 | バフの適用条件GRN |
GitHubCheckoutSetting
GitHubからマスターデータをチェックアウトする設定
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
apiKeyId | string | ✓ | ~ 1024文字 | GitHub のAPIキーGRN | |
repositoryName | string | ✓ | ~ 1024文字 | リポジトリ名 | |
sourcePath | string | ✓ | ~ 1024文字 | ソースコードのファイルパス | |
referenceType | enum [ “commit_hash”, “branch”, “tag” ] | ✓ | ~ 128文字 | コードの取得元 | |
commitHash | string | {referenceType} == “commit_hash” | ~ 1024文字 | コミットハッシュ | |
branchName | string | {referenceType} == “branch” | ~ 1024文字 | ブランチ名 | |
tagName | string | {referenceType} == “tag” | ~ 1024文字 | タグ名 |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子(Namespace ID)を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |