NAV
YAML TypeScript (CDK) Python (CDK) PHP (CDK) Java (CDK) C# (CDK)

GS2-Enhance

Reference to resource definitions available in GS2-Deploy templates

GS2-Deploy Reference

Entities

Namespace

Namespace

Type: GS2::Enhance::Namespace
Properties:
  Name: namespace1
  Description: null
  EnableDirectEnhance: true
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  EnhanceScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, enhance

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        enhance.Namespace(
            stack=self,
            name="namespace-0001",
            transaction_setting=core.TransactionSetting(
                enable_auto_run=False,
                options=core.TransactionSettingOptions(
                    distributor_namespace_id=,
                    key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                    queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                )
            ),
            options=enhance.NamespaceOptions(
                enable_direct_enhance=True,
                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\Enhance\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                enableAutoRun: False,
                options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                    distributorNamespaceId: ,
                    keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                )
            ),
            options: new \Gs2Cdk\Enhance\Model\Options\NamespaceOptions(
                enableDirectEnhance: True,
                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.core.model.TransactionSetting(
                false,
                new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                )
            ),
            new io.gs2.cdk.enhance.model.options.NamespaceOptions() {
                {
                    enableDirectEnhance = true;
                    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 enhance from "@/gs2cdk/enhance";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enhance.model.Namespace(
            this,
            "namespace-0001",
            new core.TransactionSetting(
                false,
                {
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                }
            ),
            {
                enableDirectEnhance: true,
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Enhance.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Core.Model.TransactionSetting(
                false,
                new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                    DistributorNamespaceId = ,
                    KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    QueueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                }
            ),
            new Gs2Cdk.Gs2Enhance.Model.Options.NamespaceOptions {
                enableDirectEnhance = true,
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

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
enableDirectEnhance bool false DirectEnhance is available
transactionSetting TransactionSetting Transaction settings
enhanceScript ScriptSetting Script to be executed at the time of reinforcement
logSetting LogSetting Log output settings

CurrentRateMaster

CurrentRateMaster

Type: GS2::Enhance::CurrentRateMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2020-08-22",
    "rateModels": [
      {
        "name": "character-level",
        "metadata": "CHARACTER_LEVEL",
        "targetInventoryModelId": "grn:inventory:character:character-0001",
        "materialInventoryModelId": "grn:inventory:material",
        "acquireExperienceSuffix": ":level",
        "acquireExperienceHierarchy": [
          "experience"
        ],
        "experienceModelId": "grn:experience:character:level",
        "bonusRates": [
          {
            "rate": 1.0,
            "weight": 90
          },
          {
            "rate": 1.5,
            "weight": 9
          },
          {
            "rate": 2.0,
            "weight": 1
          }
        ]
      },
      {
        "name": "character-friendly",
        "metadata": "CHARACTER_FRIENDLY",
        "targetInventoryModelId": "grn:inventory:character:character-0001",
        "materialInventoryModelId": "grn:inventory:material",
        "acquireExperienceSuffix": ":friendly",
        "experienceModelId": "grn:experience:character:friendly",
        "acquireExperienceHierarchy": [
          "taste"
        ],
        "bonusRates": [
          {
            "rate": 1.0,
            "weight": 1
          }
        ]
      }
    ]
  }
from gs2_cdk import Stack, core, enhance

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        enhance.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                enhance.RateModel(
                    name='character-level',
                    target_inventory_model_id='grn:inventory:character:character-0001',
                    acquire_experience_suffix=':level',
                    material_inventory_model_id='grn:inventory:material',
                    experience_model_id='grn:experience:character:level',
                    options=enhance.RateModelOptions(
                        metadata='CHARACTER_LEVEL',
                        acquire_experience_hierarchy=[    'experience',
                            ],
                        bonus_rates=[    {'rate': 1.0, 'weight': 90},
                            {'rate': 1.5, 'weight': 9},
                            {'rate': 2.0, 'weight': 1},
                            ],
                    ),
                ),
                enhance.RateModel(
                    name='character-friendly',
                    target_inventory_model_id='grn:inventory:character:character-0001',
                    acquire_experience_suffix=':friendly',
                    material_inventory_model_id='grn:inventory:material',
                    experience_model_id='grn:experience:character:friendly',
                    options=enhance.RateModelOptions(
                        metadata='CHARACTER_FRIENDLY',
                        acquire_experience_hierarchy=[    'taste',
                            ],
                        bonus_rates=[    {'rate': 1.0, 'weight': 1},
                            ],
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Enhance\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Enhance\Model\RateModel(
                    name:"character-level",
                    targetInventoryModelId:"grn:inventory:character:character-0001",
                    acquireExperienceSuffix:":level",
                    materialInventoryModelId:"grn:inventory:material",
                    experienceModelId:"grn:experience:character:level",
                    options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
                        metadata:"CHARACTER_LEVEL",
                        acquireExperienceHierarchy:[    "experience",
                        ],
                        bonusRates:[    {'rate': 1.0, 'weight': 90},
                        {'rate': 1.5, 'weight': 9},
                        {'rate': 2.0, 'weight': 1},
                        ],
                    ),
                ),
                new \Gs2Cdk\Enhance\Model\RateModel(
                    name:"character-friendly",
                    targetInventoryModelId:"grn:inventory:character:character-0001",
                    acquireExperienceSuffix:":friendly",
                    materialInventoryModelId:"grn:inventory:material",
                    experienceModelId:"grn:experience:character:friendly",
                    options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
                        metadata:"CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy:[    "taste",
                        ],
                        bonusRates:[    {'rate': 1.0, '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,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.enhance.model.RateModel(
                    "character-level",
                    "grn:inventory:character:character-0001",
                    ":level",
                    "grn:inventory:material",
                    "grn:experience:character:level",
                    new io.gs2.cdk.enhance.model.options.RateModelOptions() {
                        {
                            metadata: "CHARACTER_LEVEL";
                            acquireExperienceHierarchy: Arrays.asList(
                                "experience"
                            );
                            bonusRates: Arrays.asList(
                                {'rate': 1.0, 'weight': 90},
                            {'rate': 1.5, 'weight': 9},
                            {'rate': 2.0, 'weight': 1}
                            );
                        }
                    }
                ),
                new io.gs2.cdk.enhance.model.RateModel(
                    "character-friendly",
                    "grn:inventory:character:character-0001",
                    ":friendly",
                    "grn:inventory:material",
                    "grn:experience:character:friendly",
                    new io.gs2.cdk.enhance.model.options.RateModelOptions() {
                        {
                            metadata: "CHARACTER_FRIENDLY";
                            acquireExperienceHierarchy: Arrays.asList(
                                "taste"
                            );
                            bonusRates: Arrays.asList(
                                {'rate': 1.0, 'weight': 1}
                            );
                        }
                    }
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import enhance from "@/gs2cdk/enhance";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enhance.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new enhance.model.RateModel(
                    "character-level",
                    "grn:inventory:character:character-0001",
                    ":level",
                    "grn:inventory:material",
                    "grn:experience:character:level",
                    {
                        metadata: "CHARACTER_LEVEL",
                        acquireExperienceHierarchy: [
                                "experience"
                            ],
                        bonusRates: [
                                {'rate': 1.0, 'weight': 90},
                            {'rate': 1.5, 'weight': 9},
                            {'rate': 2.0, 'weight': 1}
                            ]
                    }
                ),
                new enhance.model.RateModel(
                    "character-friendly",
                    "grn:inventory:character:character-0001",
                    ":friendly",
                    "grn:inventory:material",
                    "grn:experience:character:friendly",
                    {
                        metadata: "CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy: [
                                "taste"
                            ],
                        bonusRates: [
                                {'rate': 1.0, 'weight': 1}
                            ]
                    }
                )
            ]
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Enhance.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Enhance.Model.RateModel(
                    "character-level",
                    "grn:inventory:character:character-0001",
                    ":level",
                    "grn:inventory:material",
                    "grn:experience:character:level",
                    new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions {
                        metadata = "CHARACTER_LEVEL",
                        acquireExperienceHierarchy = new string[] {
                            "experience"
                        },
                        bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[] {
                            {'rate': 1.0, 'weight': 90},
                        {'rate': 1.5, 'weight': 9},
                        {'rate': 2.0, 'weight': 1}
                        },
                    }
                ),
                new Gs2Cdk.Gs2Enhance.Model.RateModel(
                    "character-friendly",
                    "grn:inventory:character:character-0001",
                    ":friendly",
                    "grn:inventory:material",
                    "grn:experience:character:friendly",
                    new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions {
                        metadata = "CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy = new string[] {
                            "taste"
                        },
                        bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[] {
                            {'rate': 1.0, 'weight': 1}
                        },
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

Currently available enhanced rate masters

GS2 uses JSON format files for master data management.
By uploading the file, the settings can actually be reflected 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 your own 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