GS2-Deploy/CDK Reference of GS2-Inventory
Entities
Namespace
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 | Default | Limitation | Description | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 32 chars | Namespace name | |
| description | string | ~ 1024 chars | description of Namespace | ||
| acquireScript | ScriptSetting | Script to be executed when an item is obtained | |||
| overflowScript | ScriptSetting | Script to be executed when the maximum acquisition limit is reached and the script cannot be obtained. | |||
| consumeScript | ScriptSetting | Script to run when consuming items | |||
| logSetting | LogSetting | Log output settings |
GetAttr
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Inventory::Namespace
Properties:
Name: namespace1
Description: null
AcquireScript: null
OverflowScript: null
ConsumeScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1from 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 Templateclass 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 TemplateCurrentItemModelMaster
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 | CurrentItemModelMaster | Updated and currently available possession master |
Implementation Example
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,
# omission
).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 Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Inventory\Model\Namespace_(
stack: $this,
// omission
))->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,
// omission
).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,
// omission
).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,
// omission
).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 TemplateGitHubCheckoutSetting
| Type | Require | Default | 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 |
ScriptSetting
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024 chars | Script GRN | ||
| doneTriggerTargetType | enum [’none’, ‘gs2_script’, ‘aws’] | ✓ | “none” | ~ 128 chars | Notification of Completion |
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN | |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Namespace GRN |
LogSetting
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | Namespace GRN |
AcquireCount
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| itemName | string | ✓ | ~ 128 chars | Simple Item Model Name | |
| count | long | ✓ | 1 ~ 9223372036854775805 | Quantity to be obtained |
ConsumeCount
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| itemName | string | ✓ | ~ 128 chars | Simple Item Model Name | |
| count | long | ✓ | 1 ~ 9223372036854775805 | Quantity to be consumed |