GS2-Inventory GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
acquireScript | ScriptSetting | アイテム入手したときに実行するスクリプト | |||
overflowScript | ScriptSetting | 入手上限に当たって入手できなかったときに実行するスクリプト | |||
consumeScript | ScriptSetting | アイテム消費するときに実行するスクリプト | |||
logSetting | LogSetting | ログの出力設定 |
GetAttr
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Inventory::Namespace
Properties:
Name: namespace1
Description: null
AcquireScript: null
OverflowScript: null
ConsumeScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, inventory
class SampleStack(Stack):
def __init__(self):
super().__init__()
inventory.Namespace(
stack=self,
name="namespace-0001",
options=inventory.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\Inventory\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Inventory\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.inventory.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.inventory.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 inventory from "@/gs2cdk/inventory";
class SampleStack extends core.Stack
{
public constructor() {
super();
new inventory.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.Gs2Inventory.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Inventory.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
CurrentItemModelMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
型 | 説明 | |
---|---|---|
Item | CurrentItemModelMaster | 更新した現在有効な所持品マスター |
実装例
Type: GS2::Inventory::CurrentItemModelMaster
Properties:
NamespaceName: namespace1
Settings: {"version": "2019-02-05", "inventoryModels": [{"name": "item", "metadata": "INVENTORY_ITEM", "initialCapacity": 100, "maxCapacity": 999, "itemModels": [{"name": "item-0001", "metadata": "ITEM_0001", "stackingLimit": 99, "allowMultipleStacks": false, "sortValue": 1}, {"name": "item-0002", "metadata": "ITEM_0002", "stackingLimit": 49, "allowMultipleStacks": true, "sortValue": 2}, {"name": "item-0003", "metadata": "ITEM_0003", "stackingLimit": 9, "allowMultipleStacks": false, "sortValue": 3}]}, {"name": "character", "metadata": "INVENTORY_CHARACTER", "initialCapacity": 50, "maxCapacity": 99, "itemModels": [{"name": "character-0001", "metadata": "CHARACTER_0001", "stackingLimit": 99, "allowMultipleStacks": false, "sortValue": 1}, {"name": "character-0002", "metadata": "CHARACTER_0002", "stackingLimit": 49, "allowMultipleStacks": true, "sortValue": 2}, {"name": "character-0003", "metadata": "CHARACTER_0003", "stackingLimit": 9, "allowMultipleStacks": false, "sortValue": 3}]}], "simpleInventoryModels": [{"name": "item", "metadata": "INVENTORY_ITEM", "simpleItemModels": [{"name": "item-0001", "metadata": "ITEM_0001"}, {"name": "item-0002", "metadata": "ITEM_0002"}, {"name": "item-0003", "metadata": "ITEM_0003"}]}], "bigInventoryModels": [{"name": "item", "metadata": "INVENTORY_ITEM", "bigItemModels": [{"name": "item-0001", "metadata": "ITEM_0001"}, {"name": "item-0002", "metadata": "ITEM_0002"}, {"name": "item-0003", "metadata": "ITEM_0003"}]}]}
from gs2_cdk import Stack, core, inventory
class SampleStack(Stack):
def __init__(self):
super().__init__()
inventory.Namespace(
stack=self,
# 省略
).master_data(
[
inventory.InventoryModel(
name='item',
initial_capacity=100,
max_capacity=999,
item_models=[ {'name': 'item-0001', 'metadata': 'ITEM_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'item-0002', 'metadata': 'ITEM_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'item-0003', 'metadata': 'ITEM_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3},
],
options=inventory.InventoryModelOptions(
metadata='INVENTORY_ITEM',
),
),
inventory.InventoryModel(
name='character',
initial_capacity=50,
max_capacity=99,
item_models=[ {'name': 'character-0001', 'metadata': 'CHARACTER_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'character-0002', 'metadata': 'CHARACTER_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'character-0003', 'metadata': 'CHARACTER_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3},
],
options=inventory.InventoryModelOptions(
metadata='INVENTORY_CHARACTER',
),
),
],
[
inventory.SimpleInventoryModel(
name='item',
simple_item_models=[ {'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'},
],
options=inventory.SimpleInventoryModelOptions(
metadata='INVENTORY_ITEM',
),
),
],
[
inventory.BigInventoryModel(
name='item',
big_item_models=[ {'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'},
],
options=inventory.BigInventoryModelOptions(
metadata='INVENTORY_ITEM',
),
),
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Inventory\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Inventory\Model\InventoryModel(
name:"item",
initialCapacity:100,
maxCapacity:999,
itemModels:[ {'name': 'item-0001', 'metadata': 'ITEM_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'item-0002', 'metadata': 'ITEM_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'item-0003', 'metadata': 'ITEM_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3},
],
options: new \Gs2Cdk\Inventory\Model\Options\InventoryModelOptions(
metadata:"INVENTORY_ITEM",
),
),
new \Gs2Cdk\Inventory\Model\InventoryModel(
name:"character",
initialCapacity:50,
maxCapacity:99,
itemModels:[ {'name': 'character-0001', 'metadata': 'CHARACTER_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'character-0002', 'metadata': 'CHARACTER_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'character-0003', 'metadata': 'CHARACTER_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3},
],
options: new \Gs2Cdk\Inventory\Model\Options\InventoryModelOptions(
metadata:"INVENTORY_CHARACTER",
),
),
],
[
new \Gs2Cdk\Inventory\Model\SimpleInventoryModel(
name:"item",
simpleItemModels:[ {'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'},
],
options: new \Gs2Cdk\Inventory\Model\Options\SimpleInventoryModelOptions(
metadata:"INVENTORY_ITEM",
),
),
],
[
new \Gs2Cdk\Inventory\Model\BigInventoryModel(
name:"item",
bigItemModels:[ {'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'},
],
options: new \Gs2Cdk\Inventory\Model\Options\BigInventoryModelOptions(
metadata:"INVENTORY_ITEM",
),
),
],
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.inventory.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.inventory.model.InventoryModel(
"item",
100,
999,
Arrays.asList(
{'name': 'item-0001', 'metadata': 'ITEM_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'item-0002', 'metadata': 'ITEM_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'item-0003', 'metadata': 'ITEM_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3}
),
new io.gs2.cdk.inventory.model.options.InventoryModelOptions() {
{
metadata: "INVENTORY_ITEM";
}
}
),
new io.gs2.cdk.inventory.model.InventoryModel(
"character",
50,
99,
Arrays.asList(
{'name': 'character-0001', 'metadata': 'CHARACTER_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'character-0002', 'metadata': 'CHARACTER_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'character-0003', 'metadata': 'CHARACTER_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3}
),
new io.gs2.cdk.inventory.model.options.InventoryModelOptions() {
{
metadata: "INVENTORY_CHARACTER";
}
}
)
),
Arrays.asList(
new io.gs2.cdk.inventory.model.SimpleInventoryModel(
"item",
Arrays.asList(
{'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'}
),
new io.gs2.cdk.inventory.model.options.SimpleInventoryModelOptions() {
{
metadata: "INVENTORY_ITEM";
}
}
)
),
Arrays.asList(
new io.gs2.cdk.inventory.model.BigInventoryModel(
"item",
Arrays.asList(
{'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'}
),
new io.gs2.cdk.inventory.model.options.BigInventoryModelOptions() {
{
metadata: "INVENTORY_ITEM";
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import inventory from "@/gs2cdk/inventory";
class SampleStack extends core.Stack
{
public constructor() {
super();
new inventory.model.Namespace(
this,
// 省略
).masterData(
[
new inventory.model.InventoryModel(
"item",
100,
999,
[
{'name': 'item-0001', 'metadata': 'ITEM_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'item-0002', 'metadata': 'ITEM_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'item-0003', 'metadata': 'ITEM_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3}
],
{
metadata: "INVENTORY_ITEM"
}
),
new inventory.model.InventoryModel(
"character",
50,
99,
[
{'name': 'character-0001', 'metadata': 'CHARACTER_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'character-0002', 'metadata': 'CHARACTER_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'character-0003', 'metadata': 'CHARACTER_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3}
],
{
metadata: "INVENTORY_CHARACTER"
}
)
],
[
new inventory.model.SimpleInventoryModel(
"item",
[
{'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'}
],
{
metadata: "INVENTORY_ITEM"
}
)
],
[
new inventory.model.BigInventoryModel(
"item",
[
{'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'}
],
{
metadata: "INVENTORY_ITEM"
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Inventory.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Inventory.Model.InventoryModel(
"item",
100,
999,
new Gs2Cdk.Gs2Inventory.Model.ItemModel[] {
{'name': 'item-0001', 'metadata': 'ITEM_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'item-0002', 'metadata': 'ITEM_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'item-0003', 'metadata': 'ITEM_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3}
},
new Gs2Cdk.Gs2Inventory.Model.Options.InventoryModelOptions {
metadata = "INVENTORY_ITEM",
}
),
new Gs2Cdk.Gs2Inventory.Model.InventoryModel(
"character",
50,
99,
new Gs2Cdk.Gs2Inventory.Model.ItemModel[] {
{'name': 'character-0001', 'metadata': 'CHARACTER_0001', 'stackingLimit': 99, 'allowMultipleStacks': False, 'sortValue': 1},
{'name': 'character-0002', 'metadata': 'CHARACTER_0002', 'stackingLimit': 49, 'allowMultipleStacks': True, 'sortValue': 2},
{'name': 'character-0003', 'metadata': 'CHARACTER_0003', 'stackingLimit': 9, 'allowMultipleStacks': False, 'sortValue': 3}
},
new Gs2Cdk.Gs2Inventory.Model.Options.InventoryModelOptions {
metadata = "INVENTORY_CHARACTER",
}
)
},
new [] {
new Gs2Cdk.Gs2Inventory.Model.SimpleInventoryModel(
"item",
new Gs2Cdk.Gs2Inventory.Model.SimpleItemModel[] {
{'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'}
},
new Gs2Cdk.Gs2Inventory.Model.Options.SimpleInventoryModelOptions {
metadata = "INVENTORY_ITEM",
}
)
},
new [] {
new Gs2Cdk.Gs2Inventory.Model.BigInventoryModel(
"item",
new Gs2Cdk.Gs2Inventory.Model.BigItemModel[] {
{'name': 'item-0001', 'metadata': 'ITEM_0001'},
{'name': 'item-0002', 'metadata': 'ITEM_0002'},
{'name': 'item-0003', 'metadata': 'ITEM_0003'}
},
new Gs2Cdk.Gs2Inventory.Model.Options.BigInventoryModelOptions {
metadata = "INVENTORY_ITEM",
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
GitHubCheckoutSetting
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
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文字 | タグ名 |
ScriptSetting
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
triggerScriptId | string | ~ 1024文字 | スクリプトGRN | ||
doneTriggerTargetType | enum [’none’, ‘gs2_script’, ‘aws’] | ✓ | “none” | ~ 128文字 | 完了通知の通知先 |
doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | スクリプトGRN | |
doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | ネームスペースGRN |
LogSetting
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
AcquireCount
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
itemName | string | ✓ | ~ 128文字 | シンプルアイテムモデルの名前 | |
count | long | ✓ | 1 ~ 9223372036854775805 | 入手する量 |
ConsumeCount
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
itemName | string | ✓ | ~ 128文字 | シンプルアイテムモデルの名前 | |
count | long | ✓ | 1 ~ 9223372036854775805 | 消費する量 |