GS2-Enhance Deploy/CDK 레퍼런스
GS2-Deploy의 스택을 생성할 때 사용하는 템플릿 포맷과, CDK를 이용한 각종 언어의 템플릿 출력 구현 예제
엔티티
Deploy 처리에서 조작 대상이 되는 리소스
Namespace
네임스페이스
네임스페이스는 하나의 프로젝트 내에서 동일한 서비스를 서로 다른 용도로 여러 개 이용하기 위한 엔티티입니다.
GS2의 각 서비스는 네임스페이스 단위로 관리됩니다. 네임스페이스가 다르면 동일한 서비스라도 완전히 독립된 데이터 공간으로 취급됩니다.
따라서 각 서비스의 이용을 시작하려면 먼저 네임스페이스를 생성해야 합니다.
Request
리소스 생성·갱신 요청
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128자 | 네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||
| description | string | ~ 1024자 | 설명문 | |||
| transactionSetting | TransactionSetting | ✓ | 트랜잭션 설정 강화 조작 시 분산 트랜잭션의 실행 방법을 제어하는 설정입니다. 자동 실행, 원자적 커밋, 비동기 처리 등의 옵션을 지원합니다. | |||
| enhanceScript | ScriptSetting | 강화 시 실행할 스크립트 설정 Script 트리거 레퍼런스 - enhance | ||||
| logSetting | LogSetting | 로그 출력 설정 강화 조작의 로그 데이터를 GS2-Log에 출력하기 위한 설정입니다. GS2-Log의 네임스페이스를 지정하면 강화 및 한계 돌파 조작의 API 요청·응답 로그를 수집할 수 있습니다. |
GetAttr
!GetAttr 태그로 취득 가능한 리소스 생성 결과
| 타입 | 설명 | |
|---|---|---|
| Item | Namespace | 생성한 네임스페이스 |
구현 예제
Type: GS2::Enhance::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting:
EnableAutoRun: true
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
EnhanceScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/enhance"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
enhance.NewNamespace(
&SampleStack,
"namespace-0001",
enhance.NamespaceOptions{
TransactionSetting: core.NewTransactionSetting(
core.TransactionSettingOptions{
QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
},
),
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(SampleStack.Yaml()) // Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Enhance\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Enhance\Model\Options\NamespaceOptions(
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
new \Gs2Cdk\Core\Model\TransactionSettingOptions(
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
)
),
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.enhance.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.enhance.model.options.NamespaceOptions()
.withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
new io.gs2.cdk.core.model.options.TransactionSettingOptions()
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
))
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Enhance.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Enhance.Model.Options.NamespaceOptions
{
transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
options: new Gs2Cdk.Core.Model.TransactionSettingOptions
{
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import enhance from "@/gs2cdk/enhance";
class SampleStack extends core.Stack
{
public constructor() {
super();
new enhance.model.Namespace(
this,
"namespace-0001",
{
transactionSetting: new core.TransactionSetting(
{
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, enhance
class SampleStack(Stack):
def __init__(self):
super().__init__()
enhance.Namespace(
stack=self,
name='namespace-0001',
options=enhance.NamespaceOptions(
transaction_setting=core.TransactionSetting(
options=core.TransactionSettingOptions(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
)
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate TemplateTransactionSetting
트랜잭션 설정
트랜잭션 설정은 트랜잭션의 실행 방법·정합성·비동기 처리·충돌 회피 메커니즘을 제어하는 설정입니다.
자동 실행(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)” 중에서 선택할 수 있습니다.
| |||||||||||
| 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로 지정해야 합니다. |
CurrentRateMaster
현재 활성화된 레이트 모델의 마스터 데이터
현재 네임스페이스 내에서 유효한 레이트 모델의 정의를 기술한 마스터 데이터입니다.
GS2에서는 마스터 데이터 관리에 JSON 형식의 파일을 사용합니다.
파일을 업로드하면 실제로 서버에 설정을 반영할 수 있습니다.
JSON 파일을 작성하는 방법으로, 관리 콘솔 내에 마스터 데이터 에디터를 제공하고 있습니다.
또한 게임 운영에 더 적합한 도구를 직접 제작하여 적절한 포맷의 JSON 파일을 출력하는 방식으로도 서비스를 이용할 수 있습니다.
Note
JSON 파일 형식에 대해서는 GS2-Enhance 마스터 데이터 레퍼런스를 참조해 주세요.
Request
리소스 생성·갱신 요청
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128자 | 네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||||||||
| mode | 문자열 열거형 enum { “direct”, “preUpload” } | “direct” | 업데이트 모드
| |||||||||
| settings | string | {mode} == “direct” | ✓※ | ~ 5242880 바이트 (5MB) | 마스터 데이터 ※ mode이(가) “direct” 이면 필수 | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓※ | ~ 1024자 | 사전 업로드로 획득한 토큰 업로드한 마스터 데이터를 적용하기 위해 사용됩니다. ※ mode이(가) “preUpload” 이면 필수 |
GetAttr
!GetAttr 태그로 취득 가능한 리소스 생성 결과
| 타입 | 설명 | |
|---|---|---|
| Item | CurrentRateMaster | 갱신된 현재 활성화된 레이트 모델의 마스터 데이터 |
구현 예제
Type: GS2::Enhance::CurrentRateMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2020-08-22",
"rateModels": [
{
"name": "character-friendly",
"targetInventoryModelId": "grn:inventory:character",
"acquireExperienceSuffix": ":friendly",
"materialInventoryModelId": "grn:inventory:sweet",
"experienceModelId": "grn:experience:friendly",
"metadata": "CHARACTER_FRIENDLY",
"acquireExperienceHierarchy": [
"taste"
],
"bonusRates": [
{
"rate": 1,
"weight": 90
}
]
},
{
"name": "character-level",
"targetInventoryModelId": "grn:inventory:character",
"acquireExperienceSuffix": ":level",
"materialInventoryModelId": "grn:inventory:material",
"experienceModelId": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
"metadata": "CHARACTER_LEVEL",
"acquireExperienceHierarchy": [
"experience"
],
"bonusRates": [
{
"rate": 1,
"weight": 90
},
{
"rate": 1.5,
"weight": 9
},
{
"rate": 2,
"weight": 1
}
]
}
],
"unleashRateModels": [
]
}
UploadToken: nullimport (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/enhance"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
enhance.NewNamespace(
&SampleStack,
"namespace-0001",
enhance.NamespaceOptions{},
).MasterData(
[]enhance.RateModel{
enhance.NewRateModel(
"character-friendly",
"grn:inventory:character",
":friendly",
"grn:inventory:sweet",
"grn:experience:friendly",
enhance.RateModelOptions{
Metadata: pointy.String("CHARACTER_FRIENDLY"),
AcquireExperienceHierarchy: []string{
"taste",
},
BonusRates: []enhance.BonusRate{
enhance.NewBonusRate(
1,
90,
enhance.BonusRateOptions{},
),
},
},
),
enhance.NewRateModel(
"character-level",
"grn:inventory:character",
":level",
"grn:inventory:material",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
enhance.RateModelOptions{
Metadata: pointy.String("CHARACTER_LEVEL"),
AcquireExperienceHierarchy: []string{
"experience",
},
BonusRates: []enhance.BonusRate{
enhance.NewBonusRate(
1,
90,
enhance.BonusRateOptions{},
),
enhance.NewBonusRate(
1.5,
9,
enhance.BonusRateOptions{},
),
enhance.NewBonusRate(
2,
1,
enhance.BonusRateOptions{},
),
},
},
),
},
[]enhance.UnleashRateModel{
},
)
println(SampleStack.Yaml()) // Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Enhance\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\Enhance\Model\RateModel(
name:"character-friendly",
targetInventoryModelId:"grn:inventory:character",
acquireExperienceSuffix:":friendly",
materialInventoryModelId:"grn:inventory:sweet",
experienceModelId:"grn:experience:friendly",
options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
metadata:"CHARACTER_FRIENDLY",
acquireExperienceHierarchy:[
"taste",
],
bonusRates:[
new \Gs2Cdk\Enhance\Model\BonusRate(
rate: 1,
weight: 90,
),
]
)
),
new \Gs2Cdk\Enhance\Model\RateModel(
name:"character-level",
targetInventoryModelId:"grn:inventory:character",
acquireExperienceSuffix:":level",
materialInventoryModelId:"grn:inventory:material",
experienceModelId:"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
metadata:"CHARACTER_LEVEL",
acquireExperienceHierarchy:[
"experience",
],
bonusRates:[
new \Gs2Cdk\Enhance\Model\BonusRate(
rate: 1,
weight: 90,
),
new \Gs2Cdk\Enhance\Model\BonusRate(
rate: 1.5,
weight: 9,
),
new \Gs2Cdk\Enhance\Model\BonusRate(
rate: 2,
weight: 1,
),
]
)
)
],
[
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.enhance.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.enhance.model.RateModel(
"character-friendly",
"grn:inventory:character",
":friendly",
"grn:inventory:sweet",
"grn:experience:friendly",
new io.gs2.cdk.enhance.model.options.RateModelOptions()
.withMetadata("CHARACTER_FRIENDLY")
.withAcquireExperienceHierarchy(Arrays.asList(
"taste"
))
.withBonusRates(Arrays.asList(
new io.gs2.cdk.enhance.model.BonusRate(
1f,
90
)
))
),
new io.gs2.cdk.enhance.model.RateModel(
"character-level",
"grn:inventory:character",
":level",
"grn:inventory:material",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
new io.gs2.cdk.enhance.model.options.RateModelOptions()
.withMetadata("CHARACTER_LEVEL")
.withAcquireExperienceHierarchy(Arrays.asList(
"experience"
))
.withBonusRates(Arrays.asList(
new io.gs2.cdk.enhance.model.BonusRate(
1f,
90
),
new io.gs2.cdk.enhance.model.BonusRate(
1.5f,
9
),
new io.gs2.cdk.enhance.model.BonusRate(
2f,
1
)
))
)
),
Arrays.asList(
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Enhance.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Enhance.Model.RateModel[] {
new Gs2Cdk.Gs2Enhance.Model.RateModel(
name: "character-friendly",
targetInventoryModelId: "grn:inventory:character",
acquireExperienceSuffix: ":friendly",
materialInventoryModelId: "grn:inventory:sweet",
experienceModelId: "grn:experience:friendly",
options: new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions
{
metadata = "CHARACTER_FRIENDLY",
acquireExperienceHierarchy = new string[]
{
"taste"
},
bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[]
{
new Gs2Cdk.Gs2Enhance.Model.BonusRate(
rate: 1f,
weight: 90
)
}
}
),
new Gs2Cdk.Gs2Enhance.Model.RateModel(
name: "character-level",
targetInventoryModelId: "grn:inventory:character",
acquireExperienceSuffix: ":level",
materialInventoryModelId: "grn:inventory:material",
experienceModelId: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
options: new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions
{
metadata = "CHARACTER_LEVEL",
acquireExperienceHierarchy = new string[]
{
"experience"
},
bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[]
{
new Gs2Cdk.Gs2Enhance.Model.BonusRate(
rate: 1f,
weight: 90
),
new Gs2Cdk.Gs2Enhance.Model.BonusRate(
rate: 1.5f,
weight: 9
),
new Gs2Cdk.Gs2Enhance.Model.BonusRate(
rate: 2f,
weight: 1
)
}
}
)
},
new Gs2Cdk.Gs2Enhance.Model.UnleashRateModel[] {
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import enhance from "@/gs2cdk/enhance";
class SampleStack extends core.Stack
{
public constructor() {
super();
new enhance.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new enhance.model.RateModel(
"character-friendly",
"grn:inventory:character",
":friendly",
"grn:inventory:sweet",
"grn:experience:friendly",
{
metadata: "CHARACTER_FRIENDLY",
acquireExperienceHierarchy: [
"taste",
],
bonusRates: [
new enhance.model.BonusRate(
1,
90
),
]
}
),
new enhance.model.RateModel(
"character-level",
"grn:inventory:character",
":level",
"grn:inventory:material",
"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
{
metadata: "CHARACTER_LEVEL",
acquireExperienceHierarchy: [
"experience",
],
bonusRates: [
new enhance.model.BonusRate(
1,
90
),
new enhance.model.BonusRate(
1.5,
9
),
new enhance.model.BonusRate(
2,
1
),
]
}
)
],
[
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, enhance
class SampleStack(Stack):
def __init__(self):
super().__init__()
enhance.Namespace(
stack=self,
name="namespace-0001",
).master_data(
rate_models=[
enhance.RateModel(
name='character-friendly',
target_inventory_model_id='grn:inventory:character',
acquire_experience_suffix=':friendly',
material_inventory_model_id='grn:inventory:sweet',
experience_model_id='grn:experience:friendly',
options=enhance.RateModelOptions(
metadata = 'CHARACTER_FRIENDLY',
acquire_experience_hierarchy = [
'taste',
],
bonus_rates = [
enhance.BonusRate(
rate=1,
weight=90,
),
]
),
),
enhance.RateModel(
name='character-level',
target_inventory_model_id='grn:inventory:character',
acquire_experience_suffix=':level',
material_inventory_model_id='grn:inventory:material',
experience_model_id='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level',
options=enhance.RateModelOptions(
metadata = 'CHARACTER_LEVEL',
acquire_experience_hierarchy = [
'experience',
],
bonus_rates = [
enhance.BonusRate(
rate=1,
weight=90,
),
enhance.BonusRate(
rate=1.5,
weight=9,
),
enhance.BonusRate(
rate=2,
weight=1,
),
]
),
),
],
unleash_rate_models=[
],
)
print(SampleStack().yaml()) # Generate TemplateRateModel
강화 레이트 모델
강화 레이트는 강화에 사용하는 소재와 강화 대상을 정의한 데이터입니다.
소재 데이터와 강화 대상 데이터는 모두 GS2-Inventory에서 관리되고 있어야 합니다.
강화로 얻는 경험치는 GS2-Inventory의 메타데이터에 JSON 형식으로 기록됩니다.
여기서는 메타데이터의 어느 계층에 경험치 값이 저장되어 있는지를 기재해야 합니다.
강화 시 일정 확률로 대성공과 같은 형태로 입수할 수 있는 경험치량에 보정값을 적용할 수 있습니다.
그 추첨 확률도 이 엔티티에서 정의합니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| rateModelId | string | ※ | ~ 1024자 | 강화 레이트 모델 GRN
※ 서버가 자동으로 설정 | ||
| name | string | ✓ | ~ 128자 | 강화 레이트 모델 이름 강화 레이트 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(밑줄) .(마침표)로 지정합니다. | ||
| description | string | ~ 1024자 | 설명문 | |||
| metadata | string | ~ 2048자 | 메타데이터 메타데이터에는 임의의 값을 설정할 수 있습니다. 이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. | |||
| targetInventoryModelId | string | ✓ | ~ 1024자 | 강화 대상으로 사용할 수 있는 GS2-Inventory 인벤토리 모델의 GRN
강화 대상이 되는 아이템을 보유하는 GS2-Inventory의 인벤토리 모델을 지정합니다. 강화되는 아이템은 이 인벤토리 모델에 속해 있어야 합니다. | ||
| acquireExperienceSuffix | string | ✓ | ~ 1024자 | GS2-Experience에서 획득한 경험치를 저장하는 프로퍼티 ID에 부여하는 서픽스 아이템의 프로퍼티 ID 끝에 추가되어, 경험치가 저장되는 GS2-Experience의 프로퍼티 ID를 구성하는 문자열입니다. 같은 아이템에 여러 경험치 종류를 부여할 수 있습니다(예: 캐릭터 레벨의 “level”, 호감도의 “like”). | ||
| materialInventoryModelId | string | ✓ | ~ 1024자 | 강화 소재로 사용할 수 있는 GS2-Inventory 인벤토리 모델 GRN
강화 소재로 사용할 수 있는 아이템을 보유하는 GS2-Inventory의 인벤토리 모델을 지정합니다. 각 소재가 제공하는 경험치는 acquireExperienceHierarchy로 지정된 JSON 계층을 사용하여 아이템 모델의 메타데이터에 정의됩니다. | ||
| acquireExperienceHierarchy | List<string> | 0 ~ 10 items | ItemModel의 메타데이터에 저장할, 획득 경험치를 정의하는 JSON 데이터의 계층 구조 정의 GS2-Enhance에는 GS2-Inventory와 연동하여 강화를 수행하는 기능이 있으며, ItemModel의 메타데이터에 JSON 형식으로 강화 소재로 사용했을 때의 경험치량을 설정합니다. 예를 들어, { “aaa”: { “bbb”: { “experienceValue”: 100 } } }와 같은 구조의 데이터 정의로 메타데이터에 설정하고 싶은 경우에는 [ “aaa”, “bbb”, “experienceValue” ]와 같이 지정합니다. 자세한 내용은 마이크로서비스 소개 / GS2-Enhance 항목에서 설명합니다. | |||
| experienceModelId | string | ✓ | ~ 1024자 | 강화 결과로 얻는 GS2-Experience 경험치 모델 GRN
강화로 얻은 경험치가 기록되는 GS2-Experience의 경험치 모델을 지정합니다. 경험치는 대상 아이템의 프로퍼티 ID와 acquireExperienceSuffix를 조합하여 식별되는 프로퍼티에 가산됩니다. | ||
| bonusRates | List<BonusRate> | 0 ~ 1000 items | 경험치 획득량 보너스 강화 시 보너스 경험치 배율의 가중치 추첨을 정의합니다. 각 항목은 배율(예: 1.5로 150%)과 추첨 가중치를 지정합니다. 강화 실행 시 가중치 추첨으로 하나의 항목이 선택되어, 획득 경험치에 “대성공” 보너스가 적용되는지 여부가 결정됩니다. |
BonusRate
경험치 획득량 보너스
강화 시 경험치 보너스 배율을 결정하는 가중치 추첨의 단일 항목을 정의합니다. 서로 다른 배율과 가중치를 가진 여러 항목을 설정함으로써, 제어된 확률에 따른 “대성공"이나 “초성공” 같은 시스템을 구현할 수 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| rate | float | 1.0 | 0 ~ 10000 | 경험치 보너스 배율 (1.0 = 보너스 없음) 이 항목이 추첨되었을 때 기본 경험치에 적용되는 배율입니다. 1.0은 보너스 없는 일반 강화, 1.5는 경험치 150%(대성공), 2.0은 경험치 200%(초성공) 등을 의미합니다. | ||
| weight | int | 1 | 0 ~ 2147483645 | 추첨 가중치 보너스 레이트를 선택하는 가중치 추첨에서 사용되는 상대적인 가중치입니다. 값이 클수록 이 보너스 레이트가 선택될 확률이 높아집니다. 실제 확률은 이 가중치를 보너스 레이트 목록 내 모든 가중치의 합계로 나눈 값이 됩니다. |
UnleashRateModel
한계돌파 레이트 모델
아이템의 한계돌파(해방) 조건을 정의합니다. GS2-Inventory에서 관리되는 아이템과 GS2-Grade의 그레이드 모델을 연결하여 그레이드 진행을 가능하게 합니다. 각 그레이드 레벨에서 소비하는 동일 종류 아이템의 수를 개별적으로 설정할 수 있어, 각 한계돌파 단계의 비용을 세밀하게 제어할 수 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| unleashRateModelId | string | ※ | ~ 1024자 | 한계돌파 레이트 모델 GRN
※ 서버가 자동으로 설정 | ||
| name | string | ✓ | ~ 128자 | 한계돌파 레이트 모델명 한계돌파 레이트 모델 고유의 이름. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||
| description | string | ~ 1024자 | 설명문 | |||
| metadata | string | ~ 2048자 | 메타데이터 메타데이터에는 임의의 값을 설정할 수 있습니다. 이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. | |||
| targetInventoryModelId | string | ✓ | ~ 1024자 | 한계돌파 대상에 사용할 수 있는 GS2-Inventory 인벤토리 모델 GRN
한계돌파 대상이 되는 아이템을 보유하는 GS2-Inventory의 인벤토리 모델을 지정합니다. 한계돌파하는 아이템과 소재로 소비되는 동일 종류 아이템 모두 이 인벤토리 모델에 속해 있어야 합니다. | ||
| gradeModelId | string | ✓ | ~ 1024자 | 그레이드 모델 GRN
대상 아이템의 한계돌파 레벨을 추적하는 GS2-Grade의 그레이드 모델을 지정합니다. 한계돌파가 성공하면, 이 그레이드 모델 내에서 아이템의 그레이드가 가산됩니다. | ||
| gradeEntries | List<UnleashRateEntryModel> | ✓ | 1 ~ 1000 items | 그레이드 엔트리 목록 한계돌파의 각 그레이드 레벨에 대한 소재 비용을 정의합니다. 각 엔트리는 그레이드 값과, 해당 그레이드에 도달하기 위해 소비해야 하는 동일 종류 아이템 수를 매핑합니다. 예를 들어, 그레이드 1은 복제품 1개, 그레이드 2는 복제품 3개와 같이 설정할 수 있습니다. |
UnleashRateEntryModel
한계돌파 레이트 엔트리 모델
한계돌파 진행에서 단일 그레이드 레벨의 소재 비용을 정의합니다. 각 엔트리는 대상이 되는 그레이드 값과, 해당 그레이드를 달성하기 위해 소비해야 하는 동일 종류 아이템의 수를 지정합니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| gradeValue | long | ✓ | 1 ~ 1000 | 대상 그레이드 이 엔트리가 비용을 정의하는 그레이드 값입니다. 이 그레이드 레벨로의 한계돌파를 실행할 때, needCount로 지정된 수의 아이템이 소비됩니다. | ||
| needCount | int | ✓ | 1 ~ 1000 | 동일 종류의 아이템을 몇 개 소비할지 대상 그레이드로의 한계돌파를 실행하기 위해 소비해야 하는 동일 종류 아이템의 수입니다. 이 아이템들은 한계돌파되는 아이템과 동일한 아이템 모델의 것입니다. |