> For the complete documentation index, see [llms.txt](/llms.txt)
# GS2-Inventory Deploy/CDK 레퍼런스
GS2-Deploy의 스택을 생성할 때 사용하는 템플릿 포맷과, CDK를 이용한 각종 언어의 템플릿 출력 구현 예제
## 엔티티
Deploy 처리에서 조작 대상이 되는 리소스
### Namespace
네임스페이스
네임스페이스는 하나의 프로젝트 내에서 동일한 서비스를 서로 다른 용도로 여러 개 이용하기 위한 엔티티입니다.
GS2의 각 서비스는 네임스페이스 단위로 관리됩니다. 네임스페이스가 다르면 동일한 서비스라도 완전히 독립된 데이터 공간으로 취급됩니다.
따라서 각 서비스의 이용을 시작하려면 먼저 네임스페이스를 생성해야 합니다.
#### Request
리소스 생성・갱신 요청
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string | | ✓| | ~ 128자 | 네임스페이스 이름
네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| description | string | | | | ~ 1024자 | 설명문 |
| transactionSetting | [TransactionSetting](#transactionsetting) | | | | | 트랜잭션 설정
아이템 획득 및 소비 등의 인벤토리 조작에 대한 분산 트랜잭션 처리를 설정합니다. 원활한 실행을 위한 자동 실행 모드, 여러 리소스에 대한 일관된 조작을 위한 원자적 커밋(atomic commit), 대규모 보상 배포를 위한 비동기 처리를 지원합니다. |
| acquireScript | [ScriptSetting](#scriptsetting) | | | | | 아이템을 입수했을 때 실행할 스크립트 설정
Script 트리거 레퍼런스 - [`acquire`](../script/#acquire) |
| overflowScript | [ScriptSetting](#scriptsetting) | | | | | 입수 상한에 도달하여 입수할 수 없었을 때 실행할 스크립트 설정
Script 트리거 레퍼런스 - [`overflowDone`](../script/#overflowdone) |
| consumeScript | [ScriptSetting](#scriptsetting) | | | | | 아이템을 소비할 때 실행할 스크립트 설정
Script 트리거 레퍼런스 - [`consume`](../script/#consume) |
| simpleItemAcquireScript | [ScriptSetting](#scriptsetting) | | | | | 심플 아이템을 입수했을 때 실행할 스크립트 설정
Script 트리거 레퍼런스 - [`simpleItemAcquire`](../script/#simpleitemacquire) |
| simpleItemConsumeScript | [ScriptSetting](#scriptsetting) | | | | | 심플 아이템을 소비할 때 실행할 스크립트 설정
Script 트리거 레퍼런스 - [`simpleItemConsume`](../script/#simpleitemconsume) |
| bigItemAcquireScript | [ScriptSetting](#scriptsetting) | | | | | 거대 아이템을 입수했을 때 실행할 스크립트 설정
Script 트리거 레퍼런스 - [`bigItemAcquire`](../script/#bigitemacquire) |
| bigItemConsumeScript | [ScriptSetting](#scriptsetting) | | | | | 거대 아이템을 소비할 때 실행할 스크립트 설정
Script 트리거 레퍼런스 - [`bigItemConsume`](../script/#bigitemconsume) |
| logSetting | [LogSetting](#logsetting) | | | | | 로그 출력 설정
인벤토리 조작의 API 요청·응답 로그를 출력하기 위한 GS2-Log 네임스페이스를 지정합니다. 디버그 및 분석을 위해 아이템의 입수, 소비, 용량 변경을 추적하는 데 유용합니다. |
#### GetAttr
[!GetAttr](/articles/tech/deploy/#getattr) 태그로 취득 가능한 리소스 생성 결과
| | 타입 | 설명 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 생성한 네임스페이스
#### 구현 예제
**GS2-Deploy(YAML)**
```yaml
Type: GS2::Inventory::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting: null
AcquireScript: null
OverflowScript: null
ConsumeScript: null
SimpleItemAcquireScript: null
SimpleItemConsumeScript: null
BigItemAcquireScript: null
BigItemConsumeScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
```
**Go**
```go
import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/inventory"
)
SampleStack := core.NewStack()
inventory.NewNamespace(
&SampleStack,
"namespace-0001",
inventory.NamespaceOptions{
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(SampleStack.Yaml()) // Generate Template
```
**PHP**
```php
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
```
**Java**
```java
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()
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
```
**C#**
```csharp
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Inventory.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Inventory.Model.Options.NamespaceOptions
{
logSetting = new Gs2Cdk.Core.Model.LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
```
**TypeScript**
```typescript
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
```
**Python**
```python
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
```
#### TransactionSetting
트랜잭션 설정
트랜잭션 설정은 트랜잭션의 실행 방법·정합성·비동기 처리·충돌 회피 메커니즘을 제어하는 설정입니다.
자동 실행(AutoRun), 원자적 실행(AtomicCommit), GS2-Distributor를 이용한 비동기 실행, 스크립트 결과의 일괄 적용, GS2-JobQueue를 통한 입수 액션의 비동기화 등을 조합하여 게임 로직에 맞는 견고한 트랜잭션 관리를 가능하게 합니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool | | | false | | 발행한 트랜잭션을 서버 사이드에서 자동으로 실행할지 여부 |
| enableAtomicCommit | bool | {enableAutoRun} == true | | false | | 트랜잭션의 실행을 원자적으로 커밋할지 여부
※ enableAutoRun이(가) true 이면 활성화 |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | | false | | 트랜잭션을 비동기 처리로 실행할지 여부
※ enableAtomicCommit이(가) true 이면 활성화 |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | | false | | 스크립트의 결과 커밋 처리를 비동기 처리로 실행할지 여부
※ transactionUseDistributor이(가) true 이면 활성화 |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | | false | | 입수 액션을 실행할 때 GS2-JobQueue를 사용할지 여부
※ enableAtomicCommit이(가) true 이면 활성화 |
| distributorNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:distributor:default" | ~ 1024자 | 트랜잭션 실행에 사용하는 GS2-Distributor 네임스페이스GRN |
| queueNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:queue:default" | ~ 1024자 | 트랜잭션 실행에 사용하는 GS2-JobQueue의 네임스페이스GRN |
#### ScriptSetting
스크립트 설정
GS2에서는 마이크로서비스의 이벤트에 연결하여 커스텀 스크립트를 실행할 수 있습니다.
이 모델은 스크립트 실행을 트리거하기 위한 설정을 보유합니다.
스크립트 실행 방식은 크게 두 가지로, 바로 "동기 실행"과 "비동기 실행"입니다.
동기 실행은 스크립트 실행이 완료될 때까지 처리가 블록됩니다.
대신 스크립트 실행 결과를 이용하여 API 실행을 중단시키거나 API 응답 내용을 제어할 수 있습니다.
한편, 비동기 실행에서는 스크립트 완료를 기다리기 위해 처리가 블록되는 일이 없습니다.
다만 스크립트 실행 결과를 이용하여 API 실행을 중단하거나 API 응답 내용을 변경할 수는 없습니다.
비동기 실행은 API의 응답 흐름에 영향을 주지 않으므로 원칙적으로 비동기 실행을 권장합니다.
비동기 실행에는 실행 방식이 두 가지 있으며, GS2-Script와 Amazon EventBridge가 있습니다.
Amazon EventBridge를 사용함으로써 Lua 이외의 언어로 처리를 작성할 수 있습니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string | | | | ~ 1024자 | API 실행 시 동기적으로 실행되는 GS2-Script의 스크립트GRN
"grn:gs2:"로 시작하는 GRN 형식의 ID로 지정해야 합니다. |
| doneTriggerTargetType | 문자열 열거형
enum {
"none",
"gs2_script",
"aws"
}
| | | "none" | | 비동기 스크립트의 실행 방법
비동기 실행에서 사용할 스크립트의 종류를 지정합니다.
"비동기 실행의 스크립트를 사용하지 않음(none)", "GS2-Script를 사용함(gs2_script)", "Amazon EventBridge를 사용함(aws)" 중에서 선택할 수 있습니다.none: 없음 / gs2_script: GS2-Script / aws: Amazon EventBridge / |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024자 | 비동기 실행할 GS2-Script 스크립트GRN
"grn:gs2:"로 시작하는 GRN 형식의 ID로 지정해야 합니다.
※ doneTriggerTargetType이(가) "gs2_script" 이면 활성화 |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024자 | 비동기 실행 스크립트를 실행하는 GS2-JobQueue 네임스페이스GRN
비동기 실행 스크립트를 직접 실행하지 않고 GS2-JobQueue를 경유하는 경우 GS2-JobQueue의 네임스페이스GRN을 지정합니다.
GS2-JobQueue를 이용해야 할 이유는 많지 않으므로, 특별한 이유가 없다면 지정할 필요는 없습니다.
※ doneTriggerTargetType이(가) "gs2_script" 이면 활성화 |
#### LogSetting
로그 출력 설정
로그 데이터의 출력 설정을 관리합니다. 이 타입은 로그 데이터를 출력하기 위해 사용되는 GS2-Log 네임스페이스의 식별자(Namespace ID)를 보관합니다.
로그 네임스페이스ID(loggingNamespaceId)에는 로그 데이터를 수집하여 저장하는 GS2-Log의 네임스페이스를 GRN 형식으로 지정합니다.
이 설정을 하면 설정된 네임스페이스 내에서 발생한 API 요청·응답 로그 데이터가 대상 GS2-Log 네임스페이스 쪽으로 출력됩니다.
GS2-Log에서는 실시간으로 로그가 제공되어 시스템 모니터링, 분석, 디버깅 등에 활용할 수 있습니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string | | ✓ | | ~ 1024자 | 로그를 출력할 GS2-Log의 네임스페이스GRN
"grn:gs2:"로 시작하는 GRN 형식의 ID로 지정해야 합니다. |
---
### CurrentItemModelMaster
현재 활성화된 아이템 모델의 마스터 데이터
현재 네임스페이스 내에서 유효한 아이템 모델의 정의를 기술한 마스터 데이터입니다.
GS2는 마스터 데이터 관리에 JSON 형식의 파일을 사용합니다.
파일을 업로드함으로써 실제로 서버에 설정을 반영할 수 있습니다.
JSON 파일을 작성하는 방법으로, 매니지먼트 콘솔 내에 마스터 데이터 에디터를 제공하고 있습니다.
또한 게임 운영에 더 적합한 도구를 직접 만들어 적절한 포맷의 JSON 파일을 작성함으로써도 서비스를 이용할 수 있습니다.
**ℹ️ Note**
JSON 파일 형식에 대해서는 [GS2-Inventory 마스터 데이터 레퍼런스](api_reference/inventory/master_data/)를 참조해 주세요.
#### Request
리소스 생성・갱신 요청
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128자 | 네임스페이스 이름
네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| mode | 문자열 열거형
enum {
"direct",
"preUpload"
}
| | | "direct" | | 업데이트 모드direct: 마스터 데이터를 직접 업데이트 / preUpload: 마스터 데이터를 업로드한 후 업데이트 / |
| settings | string | {mode} == "direct" | ✓※| | ~ 5242880 바이트 (5MB) | 마스터 데이터
※ mode이(가) "direct" 이면 필수 |
| uploadToken | string | {mode} == "preUpload" | ✓※| | ~ 1024자 | 사전 업로드로 획득한 토큰
업로드한 마스터 데이터를 적용하기 위해 사용됩니다.
※ mode이(가) "preUpload" 이면 필수 |
#### GetAttr
[!GetAttr](/articles/tech/deploy/#getattr) 태그로 취득 가능한 리소스 생성 결과
| | 타입 | 설명 |
| --- | --- | --- |
| Item | [CurrentItemModelMaster](../sdk#currentitemmodelmaster) | 갱신된 현재 활성화된 아이템 모델의 마스터 데이터
#### 구현 예제
**GS2-Deploy(YAML)**
```yaml
Type: GS2::Inventory::CurrentItemModelMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2019-02-05",
"inventoryModels": [
{
"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
}
],
"metadata": "INVENTORY_ITEM"
},
{
"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
}
],
"metadata": "INVENTORY_CHARACTER"
}
],
"simpleInventoryModels": [
{
"name": "item",
"simpleItemModels": [
{
"name": "item-0001",
"metadata": "ITEM_0001"
},
{
"name": "item-0002",
"metadata": "ITEM_0002"
},
{
"name": "item-0003",
"metadata": "ITEM_0003"
}
],
"metadata": "INVENTORY_ITEM"
}
],
"bigInventoryModels": [
{
"name": "item",
"bigItemModels": [
{
"name": "item-0001",
"metadata": "ITEM_0001"
},
{
"name": "item-0002",
"metadata": "ITEM_0002"
},
{
"name": "item-0003",
"metadata": "ITEM_0003"
}
],
"metadata": "INVENTORY_ITEM"
}
]
}
UploadToken: null
```
**Go**
```go
import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/inventory"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
inventory.NewNamespace(
&SampleStack,
"namespace-0001",
inventory.NamespaceOptions{},
).MasterData(
[]inventory.InventoryModel{
inventory.NewInventoryModel(
"item",
100,
999,
[]inventory.ItemModel{
inventory.NewItemModel(
"item-0001",
99,
false,
1,
inventory.ItemModelOptions{
Metadata: pointy.String("ITEM_0001"),
},
),
inventory.NewItemModel(
"item-0002",
49,
true,
2,
inventory.ItemModelOptions{
Metadata: pointy.String("ITEM_0002"),
},
),
inventory.NewItemModel(
"item-0003",
9,
false,
3,
inventory.ItemModelOptions{
Metadata: pointy.String("ITEM_0003"),
},
),
},
inventory.InventoryModelOptions{
Metadata: pointy.String("INVENTORY_ITEM"),
},
),
inventory.NewInventoryModel(
"character",
50,
99,
[]inventory.ItemModel{
inventory.NewItemModel(
"character-0001",
99,
false,
1,
inventory.ItemModelOptions{
Metadata: pointy.String("CHARACTER_0001"),
},
),
inventory.NewItemModel(
"character-0002",
49,
true,
2,
inventory.ItemModelOptions{
Metadata: pointy.String("CHARACTER_0002"),
},
),
inventory.NewItemModel(
"character-0003",
9,
false,
3,
inventory.ItemModelOptions{
Metadata: pointy.String("CHARACTER_0003"),
},
),
},
inventory.InventoryModelOptions{
Metadata: pointy.String("INVENTORY_CHARACTER"),
},
),
},
[]inventory.SimpleInventoryModel{
inventory.NewSimpleInventoryModel(
"item",
[]inventory.SimpleItemModel{
inventory.NewSimpleItemModel(
"item-0001",
inventory.SimpleItemModelOptions{
Metadata: pointy.String("ITEM_0001"),
},
),
inventory.NewSimpleItemModel(
"item-0002",
inventory.SimpleItemModelOptions{
Metadata: pointy.String("ITEM_0002"),
},
),
inventory.NewSimpleItemModel(
"item-0003",
inventory.SimpleItemModelOptions{
Metadata: pointy.String("ITEM_0003"),
},
),
},
inventory.SimpleInventoryModelOptions{
Metadata: pointy.String("INVENTORY_ITEM"),
},
),
},
[]inventory.BigInventoryModel{
inventory.NewBigInventoryModel(
"item",
[]inventory.BigItemModel{
inventory.NewBigItemModel(
"item-0001",
inventory.BigItemModelOptions{
Metadata: pointy.String("ITEM_0001"),
},
),
inventory.NewBigItemModel(
"item-0002",
inventory.BigItemModelOptions{
Metadata: pointy.String("ITEM_0002"),
},
),
inventory.NewBigItemModel(
"item-0003",
inventory.BigItemModelOptions{
Metadata: pointy.String("ITEM_0003"),
},
),
},
inventory.BigInventoryModelOptions{
Metadata: pointy.String("INVENTORY_ITEM"),
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
```
**PHP**
```php
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Inventory\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\Inventory\Model\InventoryModel(
name:"item",
initialCapacity:100,
maxCapacity:999,
itemModels:[
new \Gs2Cdk\Inventory\Model\ItemModel(
name: "item-0001",
stackingLimit: 99,
allowMultipleStacks: false,
sortValue: 1,
options: new \Gs2Cdk\Inventory\Model\Options\ItemModelOptions(
metadata: "ITEM_0001",
),
),
new \Gs2Cdk\Inventory\Model\ItemModel(
name: "item-0002",
stackingLimit: 49,
allowMultipleStacks: true,
sortValue: 2,
options: new \Gs2Cdk\Inventory\Model\Options\ItemModelOptions(
metadata: "ITEM_0002",
),
),
new \Gs2Cdk\Inventory\Model\ItemModel(
name: "item-0003",
stackingLimit: 9,
allowMultipleStacks: false,
sortValue: 3,
options: new \Gs2Cdk\Inventory\Model\Options\ItemModelOptions(
metadata: "ITEM_0003",
),
),
],
options: new \Gs2Cdk\Inventory\Model\Options\InventoryModelOptions(
metadata:"INVENTORY_ITEM"
)
),
new \Gs2Cdk\Inventory\Model\InventoryModel(
name:"character",
initialCapacity:50,
maxCapacity:99,
itemModels:[
new \Gs2Cdk\Inventory\Model\ItemModel(
name: "character-0001",
stackingLimit: 99,
allowMultipleStacks: false,
sortValue: 1,
options: new \Gs2Cdk\Inventory\Model\Options\ItemModelOptions(
metadata: "CHARACTER_0001",
),
),
new \Gs2Cdk\Inventory\Model\ItemModel(
name: "character-0002",
stackingLimit: 49,
allowMultipleStacks: true,
sortValue: 2,
options: new \Gs2Cdk\Inventory\Model\Options\ItemModelOptions(
metadata: "CHARACTER_0002",
),
),
new \Gs2Cdk\Inventory\Model\ItemModel(
name: "character-0003",
stackingLimit: 9,
allowMultipleStacks: false,
sortValue: 3,
options: new \Gs2Cdk\Inventory\Model\Options\ItemModelOptions(
metadata: "CHARACTER_0003",
),
),
],
options: new \Gs2Cdk\Inventory\Model\Options\InventoryModelOptions(
metadata:"INVENTORY_CHARACTER"
)
)
],
[
new \Gs2Cdk\Inventory\Model\SimpleInventoryModel(
name:"item",
simpleItemModels:[
new \Gs2Cdk\Inventory\Model\SimpleItemModel(
name: "item-0001",
options: new \Gs2Cdk\Inventory\Model\Options\SimpleItemModelOptions(
metadata: "ITEM_0001",
),
),
new \Gs2Cdk\Inventory\Model\SimpleItemModel(
name: "item-0002",
options: new \Gs2Cdk\Inventory\Model\Options\SimpleItemModelOptions(
metadata: "ITEM_0002",
),
),
new \Gs2Cdk\Inventory\Model\SimpleItemModel(
name: "item-0003",
options: new \Gs2Cdk\Inventory\Model\Options\SimpleItemModelOptions(
metadata: "ITEM_0003",
),
),
],
options: new \Gs2Cdk\Inventory\Model\Options\SimpleInventoryModelOptions(
metadata:"INVENTORY_ITEM"
)
)
],
[
new \Gs2Cdk\Inventory\Model\BigInventoryModel(
name:"item",
bigItemModels:[
new \Gs2Cdk\Inventory\Model\BigItemModel(
name: "item-0001",
options: new \Gs2Cdk\Inventory\Model\Options\BigItemModelOptions(
metadata: "ITEM_0001",
),
),
new \Gs2Cdk\Inventory\Model\BigItemModel(
name: "item-0002",
options: new \Gs2Cdk\Inventory\Model\Options\BigItemModelOptions(
metadata: "ITEM_0002",
),
),
new \Gs2Cdk\Inventory\Model\BigItemModel(
name: "item-0003",
options: new \Gs2Cdk\Inventory\Model\Options\BigItemModelOptions(
metadata: "ITEM_0003",
),
),
],
options: new \Gs2Cdk\Inventory\Model\Options\BigInventoryModelOptions(
metadata:"INVENTORY_ITEM"
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
```
**Java**
```java
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.inventory.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.inventory.model.InventoryModel(
"item",
100,
999,
Arrays.asList(
new io.gs2.cdk.inventory.model.ItemModel(
"item-0001",
99L,
false,
1,
new io.gs2.cdk.inventory.model.options.ItemModelOptions()
.withMetadata("ITEM_0001")
),
new io.gs2.cdk.inventory.model.ItemModel(
"item-0002",
49L,
true,
2,
new io.gs2.cdk.inventory.model.options.ItemModelOptions()
.withMetadata("ITEM_0002")
),
new io.gs2.cdk.inventory.model.ItemModel(
"item-0003",
9L,
false,
3,
new io.gs2.cdk.inventory.model.options.ItemModelOptions()
.withMetadata("ITEM_0003")
)
),
new io.gs2.cdk.inventory.model.options.InventoryModelOptions()
.withMetadata("INVENTORY_ITEM")
),
new io.gs2.cdk.inventory.model.InventoryModel(
"character",
50,
99,
Arrays.asList(
new io.gs2.cdk.inventory.model.ItemModel(
"character-0001",
99L,
false,
1,
new io.gs2.cdk.inventory.model.options.ItemModelOptions()
.withMetadata("CHARACTER_0001")
),
new io.gs2.cdk.inventory.model.ItemModel(
"character-0002",
49L,
true,
2,
new io.gs2.cdk.inventory.model.options.ItemModelOptions()
.withMetadata("CHARACTER_0002")
),
new io.gs2.cdk.inventory.model.ItemModel(
"character-0003",
9L,
false,
3,
new io.gs2.cdk.inventory.model.options.ItemModelOptions()
.withMetadata("CHARACTER_0003")
)
),
new io.gs2.cdk.inventory.model.options.InventoryModelOptions()
.withMetadata("INVENTORY_CHARACTER")
)
),
Arrays.asList(
new io.gs2.cdk.inventory.model.SimpleInventoryModel(
"item",
Arrays.asList(
new io.gs2.cdk.inventory.model.SimpleItemModel(
"item-0001",
new io.gs2.cdk.inventory.model.options.SimpleItemModelOptions()
.withMetadata("ITEM_0001")
),
new io.gs2.cdk.inventory.model.SimpleItemModel(
"item-0002",
new io.gs2.cdk.inventory.model.options.SimpleItemModelOptions()
.withMetadata("ITEM_0002")
),
new io.gs2.cdk.inventory.model.SimpleItemModel(
"item-0003",
new io.gs2.cdk.inventory.model.options.SimpleItemModelOptions()
.withMetadata("ITEM_0003")
)
),
new io.gs2.cdk.inventory.model.options.SimpleInventoryModelOptions()
.withMetadata("INVENTORY_ITEM")
)
),
Arrays.asList(
new io.gs2.cdk.inventory.model.BigInventoryModel(
"item",
Arrays.asList(
new io.gs2.cdk.inventory.model.BigItemModel(
"item-0001",
new io.gs2.cdk.inventory.model.options.BigItemModelOptions()
.withMetadata("ITEM_0001")
),
new io.gs2.cdk.inventory.model.BigItemModel(
"item-0002",
new io.gs2.cdk.inventory.model.options.BigItemModelOptions()
.withMetadata("ITEM_0002")
),
new io.gs2.cdk.inventory.model.BigItemModel(
"item-0003",
new io.gs2.cdk.inventory.model.options.BigItemModelOptions()
.withMetadata("ITEM_0003")
)
),
new io.gs2.cdk.inventory.model.options.BigInventoryModelOptions()
.withMetadata("INVENTORY_ITEM")
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
```
**C#**
```csharp
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Inventory.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Inventory.Model.InventoryModel[] {
new Gs2Cdk.Gs2Inventory.Model.InventoryModel(
name: "item",
initialCapacity: 100,
maxCapacity: 999,
itemModels: new Gs2Cdk.Gs2Inventory.Model.ItemModel[]
{
new Gs2Cdk.Gs2Inventory.Model.ItemModel(
name: "item-0001",
stackingLimit: 99L,
allowMultipleStacks: false,
sortValue: 1,
options: new Gs2Cdk.Gs2Inventory.Model.Options.ItemModelOptions
{
metadata = "ITEM_0001"
}
),
new Gs2Cdk.Gs2Inventory.Model.ItemModel(
name: "item-0002",
stackingLimit: 49L,
allowMultipleStacks: true,
sortValue: 2,
options: new Gs2Cdk.Gs2Inventory.Model.Options.ItemModelOptions
{
metadata = "ITEM_0002"
}
),
new Gs2Cdk.Gs2Inventory.Model.ItemModel(
name: "item-0003",
stackingLimit: 9L,
allowMultipleStacks: false,
sortValue: 3,
options: new Gs2Cdk.Gs2Inventory.Model.Options.ItemModelOptions
{
metadata = "ITEM_0003"
}
)
},
options: new Gs2Cdk.Gs2Inventory.Model.Options.InventoryModelOptions
{
metadata = "INVENTORY_ITEM"
}
),
new Gs2Cdk.Gs2Inventory.Model.InventoryModel(
name: "character",
initialCapacity: 50,
maxCapacity: 99,
itemModels: new Gs2Cdk.Gs2Inventory.Model.ItemModel[]
{
new Gs2Cdk.Gs2Inventory.Model.ItemModel(
name: "character-0001",
stackingLimit: 99L,
allowMultipleStacks: false,
sortValue: 1,
options: new Gs2Cdk.Gs2Inventory.Model.Options.ItemModelOptions
{
metadata = "CHARACTER_0001"
}
),
new Gs2Cdk.Gs2Inventory.Model.ItemModel(
name: "character-0002",
stackingLimit: 49L,
allowMultipleStacks: true,
sortValue: 2,
options: new Gs2Cdk.Gs2Inventory.Model.Options.ItemModelOptions
{
metadata = "CHARACTER_0002"
}
),
new Gs2Cdk.Gs2Inventory.Model.ItemModel(
name: "character-0003",
stackingLimit: 9L,
allowMultipleStacks: false,
sortValue: 3,
options: new Gs2Cdk.Gs2Inventory.Model.Options.ItemModelOptions
{
metadata = "CHARACTER_0003"
}
)
},
options: new Gs2Cdk.Gs2Inventory.Model.Options.InventoryModelOptions
{
metadata = "INVENTORY_CHARACTER"
}
)
},
new Gs2Cdk.Gs2Inventory.Model.SimpleInventoryModel[] {
new Gs2Cdk.Gs2Inventory.Model.SimpleInventoryModel(
name: "item",
simpleItemModels: new Gs2Cdk.Gs2Inventory.Model.SimpleItemModel[]
{
new Gs2Cdk.Gs2Inventory.Model.SimpleItemModel(
name: "item-0001",
options: new Gs2Cdk.Gs2Inventory.Model.Options.SimpleItemModelOptions
{
metadata = "ITEM_0001"
}
),
new Gs2Cdk.Gs2Inventory.Model.SimpleItemModel(
name: "item-0002",
options: new Gs2Cdk.Gs2Inventory.Model.Options.SimpleItemModelOptions
{
metadata = "ITEM_0002"
}
),
new Gs2Cdk.Gs2Inventory.Model.SimpleItemModel(
name: "item-0003",
options: new Gs2Cdk.Gs2Inventory.Model.Options.SimpleItemModelOptions
{
metadata = "ITEM_0003"
}
)
},
options: new Gs2Cdk.Gs2Inventory.Model.Options.SimpleInventoryModelOptions
{
metadata = "INVENTORY_ITEM"
}
)
},
new Gs2Cdk.Gs2Inventory.Model.BigInventoryModel[] {
new Gs2Cdk.Gs2Inventory.Model.BigInventoryModel(
name: "item",
bigItemModels: new Gs2Cdk.Gs2Inventory.Model.BigItemModel[]
{
new Gs2Cdk.Gs2Inventory.Model.BigItemModel(
name: "item-0001",
options: new Gs2Cdk.Gs2Inventory.Model.Options.BigItemModelOptions
{
metadata = "ITEM_0001"
}
),
new Gs2Cdk.Gs2Inventory.Model.BigItemModel(
name: "item-0002",
options: new Gs2Cdk.Gs2Inventory.Model.Options.BigItemModelOptions
{
metadata = "ITEM_0002"
}
),
new Gs2Cdk.Gs2Inventory.Model.BigItemModel(
name: "item-0003",
options: new Gs2Cdk.Gs2Inventory.Model.Options.BigItemModelOptions
{
metadata = "ITEM_0003"
}
)
},
options: new Gs2Cdk.Gs2Inventory.Model.Options.BigInventoryModelOptions
{
metadata = "INVENTORY_ITEM"
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
```
**TypeScript**
```typescript
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",
).masterData(
[
new inventory.model.InventoryModel(
"item",
100,
999,
[
new inventory.model.ItemModel(
"item-0001",
99,
false,
1,
{
metadata: "ITEM_0001"
}
),
new inventory.model.ItemModel(
"item-0002",
49,
true,
2,
{
metadata: "ITEM_0002"
}
),
new inventory.model.ItemModel(
"item-0003",
9,
false,
3,
{
metadata: "ITEM_0003"
}
),
],
{
metadata: "INVENTORY_ITEM"
}
),
new inventory.model.InventoryModel(
"character",
50,
99,
[
new inventory.model.ItemModel(
"character-0001",
99,
false,
1,
{
metadata: "CHARACTER_0001"
}
),
new inventory.model.ItemModel(
"character-0002",
49,
true,
2,
{
metadata: "CHARACTER_0002"
}
),
new inventory.model.ItemModel(
"character-0003",
9,
false,
3,
{
metadata: "CHARACTER_0003"
}
),
],
{
metadata: "INVENTORY_CHARACTER"
}
)
],
[
new inventory.model.SimpleInventoryModel(
"item",
[
new inventory.model.SimpleItemModel(
"item-0001",
{
metadata: "ITEM_0001"
}
),
new inventory.model.SimpleItemModel(
"item-0002",
{
metadata: "ITEM_0002"
}
),
new inventory.model.SimpleItemModel(
"item-0003",
{
metadata: "ITEM_0003"
}
),
],
{
metadata: "INVENTORY_ITEM"
}
)
],
[
new inventory.model.BigInventoryModel(
"item",
[
new inventory.model.BigItemModel(
"item-0001",
{
metadata: "ITEM_0001"
}
),
new inventory.model.BigItemModel(
"item-0002",
{
metadata: "ITEM_0002"
}
),
new inventory.model.BigItemModel(
"item-0003",
{
metadata: "ITEM_0003"
}
),
],
{
metadata: "INVENTORY_ITEM"
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
```
**Python**
```python
from gs2_cdk import Stack, core, inventory
class SampleStack(Stack):
def __init__(self):
super().__init__()
inventory.Namespace(
stack=self,
name="namespace-0001",
).master_data(
inventory_models=[
inventory.InventoryModel(
name='item',
initial_capacity=100,
max_capacity=999,
item_models=[
inventory.ItemModel(
name='item-0001',
stacking_limit=99,
allow_multiple_stacks=False,
sort_value=1,
options=inventory.ItemModelOptions(
metadata='ITEM_0001',
),
),
inventory.ItemModel(
name='item-0002',
stacking_limit=49,
allow_multiple_stacks=True,
sort_value=2,
options=inventory.ItemModelOptions(
metadata='ITEM_0002',
),
),
inventory.ItemModel(
name='item-0003',
stacking_limit=9,
allow_multiple_stacks=False,
sort_value=3,
options=inventory.ItemModelOptions(
metadata='ITEM_0003',
),
),
],
options=inventory.InventoryModelOptions(
metadata = 'INVENTORY_ITEM'
),
),
inventory.InventoryModel(
name='character',
initial_capacity=50,
max_capacity=99,
item_models=[
inventory.ItemModel(
name='character-0001',
stacking_limit=99,
allow_multiple_stacks=False,
sort_value=1,
options=inventory.ItemModelOptions(
metadata='CHARACTER_0001',
),
),
inventory.ItemModel(
name='character-0002',
stacking_limit=49,
allow_multiple_stacks=True,
sort_value=2,
options=inventory.ItemModelOptions(
metadata='CHARACTER_0002',
),
),
inventory.ItemModel(
name='character-0003',
stacking_limit=9,
allow_multiple_stacks=False,
sort_value=3,
options=inventory.ItemModelOptions(
metadata='CHARACTER_0003',
),
),
],
options=inventory.InventoryModelOptions(
metadata = 'INVENTORY_CHARACTER'
),
),
],
simple_inventory_models=[
inventory.SimpleInventoryModel(
name='item',
simple_item_models=[
inventory.SimpleItemModel(
name='item-0001',
options=inventory.SimpleItemModelOptions(
metadata='ITEM_0001',
),
),
inventory.SimpleItemModel(
name='item-0002',
options=inventory.SimpleItemModelOptions(
metadata='ITEM_0002',
),
),
inventory.SimpleItemModel(
name='item-0003',
options=inventory.SimpleItemModelOptions(
metadata='ITEM_0003',
),
),
],
options=inventory.SimpleInventoryModelOptions(
metadata = 'INVENTORY_ITEM'
),
),
],
big_inventory_models=[
inventory.BigInventoryModel(
name='item',
big_item_models=[
inventory.BigItemModel(
name='item-0001',
options=inventory.BigItemModelOptions(
metadata='ITEM_0001',
),
),
inventory.BigItemModel(
name='item-0002',
options=inventory.BigItemModelOptions(
metadata='ITEM_0002',
),
),
inventory.BigItemModel(
name='item-0003',
options=inventory.BigItemModelOptions(
metadata='ITEM_0003',
),
),
],
options=inventory.BigInventoryModelOptions(
metadata = 'INVENTORY_ITEM'
),
),
],
)
print(SampleStack().yaml()) # Generate Template
```
#### InventoryModel
인벤토리 모델
인벤토리는 게임 플레이어가 소유한 아이템을 담는 가방과 같은 것입니다.
인벤토리에는 용량을 설정할 수 있으며, 용량을 초과하여 소유할 수 없습니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| inventoryModelId | string | | ※ | | ~ 1024자 | 인벤토리 모델 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | | ~ 128자 | 인벤토리 모델 이름
인벤토리 모델 고유 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. |
| metadata | string | | | | ~ 2048자 | 메타데이터
메타데이터에는 임의의 값을 설정할 수 있습니다.
이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |
| initialCapacity | int | | ✓ | | 0 ~ 2147483646 | 초기 크기
인벤토리가 처음 생성될 때 사용자에게 제공되는 인벤토리 칸의 수입니다. 각 칸에는 하나의 아이템 스택을 저장할 수 있습니다. 사용자는 게임 플레이 액션을 통해 maxCapacity까지 용량을 확장할 수 있습니다. |
| maxCapacity | int | | ✓ | | 0 ~ 2147483646 | 최대 크기
사용자가 확장할 수 있는 인벤토리 칸의 상한값입니다. 이 값을 초과하여 용량을 늘릴 수 없습니다. 모든 칸이 사용 중이고 아이템을 더 이상 스택할 수 없는 경우, 오버플로우 스크립트가 초과분을 처리하지 않는 한 입수는 실패합니다. |
| protectReferencedItem | bool? | | | false | | 참조된 아이템 보호
활성화하면 (referenceOf 메커니즘을 통해) 참조가 등록된 아이템 세트는 소비하거나 삭제할 수 없게 됩니다. 다른 시스템에서 사용 중인 아이템(예: 장착 중인 장비, 편성에 연결된 아이템)이 실수로 삭제되는 것을 방지합니다. |
| itemModels | [List<ItemModel>](#itemmodel) | | | [] | 1 ~ 1000 items | 아이템 모델 목록
이 인벤토리에 저장할 수 있는 아이템의 종류입니다. 각 아이템 모델은 한 종류의 아이템에 대한 스택 및 입수 동작을 정의합니다. 인벤토리 모델당 최대 1000개의 아이템 모델까지 설정할 수 있습니다. |
#### ItemModel
아이템 모델
아이템은 포션 ×99 처럼, 하나의 인벤토리 칸에 여러 개를 모아서 소지할 수 있습니다.
이렇게 한 칸에 여러 개를 모으는 것을 "스택"이라고 하며, 아이템마다 스택 가능한 상한 수를 설정할 수 있습니다.
스택 상한에 도달했을 때의 동작도 아이템마다 설정할 수 있습니다.
구체적으로는 다음 중 하나를 선택할 수 있습니다:
- 새로운 인벤토리 칸을 추가하여 추가로 소지할 수 있도록 한다
- 상한에 도달했으므로 더 이상 입수할 수 없도록 한다
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| itemModelId | string | | ※ | | ~ 1024자 | 아이템 모델 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | | ~ 128자 | 아이템 모델 이름
아이템 모델 고유 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. |
| metadata | string | | | | ~ 2048자 | 메타데이터
GS2-Enhance에는 GS2-Inventory와 연동하여 강화를 수행하는 메커니즘이 있으며, ItemModel의 메타데이터에 JSON 형식으로 강화 소재로 사용했을 때의 경험치량을 설정합니다.
자세한 내용은 [마이크로서비스 소개 / GS2-Enhance](/microservices/enhance/#강화-레이트) 항목에서 설명합니다. |
| stackingLimit | long | | ✓ | | 1 ~ 9223372036854775805 | 스택 가능한 최대 수량
하나의 인벤토리 칸(스택)에 보관할 수 있는 이 아이템의 최대 수입니다. 이 상한에 도달하면 allowMultipleStacks 설정에 따라 새로운 칸이 할당되거나 추가 입수가 차단됩니다. |
| allowMultipleStacks | bool | | ✓ | | | 복수 스택 허용
활성화하면 스택 상한에 도달했을 때 새로운 인벤토리 칸이 자동으로 할당되어 이 아이템의 추가 수량을 저장합니다(추가 용량을 소비합니다). 비활성화하면 기존 칸에서 스택 상한에 도달한 시점에 입수가 차단됩니다. |
| sortValue | int | | ✓ | | 0 ~ 2147483646 | 표시 순서
인벤토리 내 아이템을 표시용으로 정렬하기 위한 수치입니다. 값이 작을수록 먼저 표시됩니다. 이 값은 ItemSet 레코드에도 복사되어 소지 아이템의 일관된 정렬을 가능하게 합니다. |
#### SimpleInventoryModel
심플 인벤토리 모델
일반적인 InventoryModel에서는 인벤토리 안에 저장할 수 있는 아이템의 용량 제한을 설정할 수 있었습니다.
하지만 심플 인벤토리에는 그러한 기능이 없으며, 단순히 아이템의 소지 수량을 보유할 뿐입니다.
다만 심플 인벤토리에서는 여러 아이템의 증감 처리를 한 번의 처리로 실행할 수 있는 API를 사용할 수 있습니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| inventoryModelId | string | | ※ | | ~ 1024자 | 심플 인벤토리 모델 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | | ~ 128자 | 심플 인벤토리 모델 이름
심플 인벤토리 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| metadata | string | | | | ~ 2048자 | 메타데이터
메타데이터에는 임의의 값을 설정할 수 있습니다.
이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |
| simpleItemModels | [List<SimpleItemModel>](#simpleitemmodel) | | | [] | 1 ~ 1000 items | 심플 아이템 모델 목록
이 심플 인벤토리에 저장할 수 있는 아이템의 종류입니다. 일반적인 인벤토리와 달리 심플 아이템에는 스택 상한이나 용량 제약이 없습니다. 심플 인벤토리 모델당 최대 1000개의 아이템 모델을 사용할 수 있습니다. |
#### SimpleItemModel
심플 아이템 모델
ItemModel에서는 스택할 수 있는 수량의 최댓값을 설정할 수 있어, 일정 수를 초과하는 경우 여러 스택으로 나누는 구현이 가능했습니다.
심플 아이템에는 그러한 기능이 없으며, 단순히 아이템의 소지 수량만을 보관합니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| itemModelId | string | | ※ | | ~ 1024자 | 심플 아이템 모델 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | | ~ 128자 | 심플 아이템 모델 이름
심플 아이템 모델 고유 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. |
| metadata | string | | | | ~ 2048자 | 메타데이터
메타데이터에는 임의의 값을 설정할 수 있습니다.
이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |
#### BigInventoryModel
거대 인벤토리 모델
일반적인 InventoryModel이나 SimpleInventoryModel에서는 인벤토리에 저장할 수 있는 아이템의 수가 int64 범위로 제한되었습니다.
인플레이션 계열 게임에서는 더 넓은 범위의 값이 필요한 경우가 있습니다.
거대 인벤토리 모델에서는 인벤토리에 저장할 수 있는 아이템의 수가 최대 1024자리의 정수값을 가질 수 있습니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| inventoryModelId | string | | ※ | | ~ 1024자 | 거대 인벤토리 모델 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | | ~ 128자 | 거대 인벤토리 모델 이름
거대 인벤토리 모델 고유 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. |
| metadata | string | | | | ~ 2048자 | 메타데이터
메타데이터에는 임의의 값을 설정할 수 있습니다.
이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |
| bigItemModels | [List<BigItemModel>](#bigitemmodel) | | | [] | 1 ~ 1000 items | 거대 아이템 모델 목록
이 거대 인벤토리에 저장할 수 있는 아이템의 종류입니다. 각 거대 아이템 모델은 최대 1024자리의 정수 문자열로 표현되는 수량을 보유할 수 있습니다. 거대 인벤토리 모델당 최대 1000개의 아이템 모델까지 설정할 수 있습니다. |
#### BigItemModel
거대 아이템 모델
거대 아이템 모델은 거대 인벤토리 모델에 저장되는 거대 아이템을 정의하는 모델입니다.
거대 아이템은 소지 수량을 int64 범위를 초과하여 보유할 수 있습니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| itemModelId | string | | ※ | | ~ 1024자 | 거대 아이템 모델 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | | ~ 128자 | 거대 아이템 모델 이름
거대 아이템 모델 고유 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. |
| metadata | string | | | | ~ 2048자 | 메타데이터
메타데이터에는 임의의 값을 설정할 수 있습니다.
이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |
---