GS2-Deploy/CDK Reference of GS2-LoginReward
The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
Entity
Resources operated in Deloy process
Namespace
Namespace
A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.
Therefore, you must create a namespace before you can start using each service.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Namespace name | ||
| description | string | ~ 1024 chars | Description | |||
| transactionSetting | TransactionSetting | ✓ | Transaction settings | |||
| receiveScript | ScriptSetting | Script to run when receiving rewards | ||||
| logSetting | LogSetting | Log output settings |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::LoginReward::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting:
EnableAutoRun: true
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
ReceiveScript: 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/loginReward"
"github.com/gs2io/gs2-golang-cdk/money"
"github.com/gs2io/gs2-golang-cdk/stamina"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
loginReward.NewNamespace(
&SampleStack,
"namespace-0001",
loginReward.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 Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\LoginReward\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\LoginReward\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.loginReward.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.loginReward.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.Gs2LoginReward.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2LoginReward.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 loginReward from "@/gs2cdk/loginReward";
class SampleStack extends core.Stack
{
public constructor() {
super();
new loginReward.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, login_reward
class SampleStack(Stack):
def __init__(self):
super().__init__()
login_reward.Namespace(
stack=self,
name='namespace-0001',
options=login_reward.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 TemplateLogSetting
Log Export Settings
Manages log data export settings. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, and debugging.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | GS2-Log namespace GRN to output logs |
TransactionSetting
Transaction settings
Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, Distributor, batch application of script results, and asynchronous acquisition actions via JobQueue enables robust transaction management tailored to game logic.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | Whether to automatically execute issued transactions on the server side | ||
| enableAtomicCommit | bool | {enableAutoRun} == true | ✓* | false | Whether to commit the execution of transactions atomically * Required if enableAutoRun is true | |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | ✓* | false | Whether to execute transactions asynchronously * Required if enableAtomicCommit is true | |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | ✓* | false | Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true | |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | ✓* | false | Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor namespace used for transaction execution | |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | Namespace in GS2-JobQueue used to run the transaction |
ScriptSetting
Script settings
In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.
There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API.
In contrast, asynchronous execution does not block processing until the script has finished executing. Since the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API’s response flow. For this reason, asynchronous execution is generally recommended.
There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024 chars | Script GRN of synchronous execution script Must be specified in GRN format starting with “grn:gs2:”. | |||||||||||
| doneTriggerTargetType | String Enum enum { “none”, “gs2_script”, “aws” } | ✓ | “none” | ~ 128 chars | How to execute asynchronous scripts Specifies the type of script to use for asynchronous execution. You can choose from “Do not use asynchronous execution scripts (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
| |||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN of asynchronous execution script Must be specified in GRN format starting with “grn:gs2:”. * Enabled if doneTriggerTargetType is “gs2_script” | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-JobQueue namespace GRN to execute asynchronous execution scripts If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN. There is little reason to use GS2-JobQueue, so you don’t need to specify it unless you have a specific reason. * Enabled if doneTriggerTargetType is “gs2_script” |
CurrentBonusMaster
Currently Available Master Data
GS2 uses JSON format files for managing master data. By uploading these files, the settings are applied to the server.
To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for operating your game and export JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-LoginReward for the JSON file format.| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name | ||||||||
| mode | String Enum enum { “direct”, “preUpload” } | ✓ | “direct” | ~ 128 chars | Update mode
| |||||||
| settings | string | {mode} == “direct” | ✓* | ~ 5242880 bytes (5MB) | Master Data * Required if mode is “direct” | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓* | ~ 1024 chars | Token used to reflect results after upload * Required if mode is “preUpload” |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentBonusMaster | Updated and currently available bonus model master |
Implementation Example
Type: GS2::LoginReward::CurrentBonusMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2023-07-11",
"bonusModels": [
{
"name": "schedule",
"mode": "schedule",
"missedReceiveRelief": "disabled",
"periodEventId": "grn:gs2:schedule:grn-0001",
"rewards": [
{
"acquireActions": [
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "stamina-0001",
"staminaName": "quest",
"userId": "#{userId}",
"recoverValue": 100
}
}
]
},
{
"acquireActions": [
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "stamina-0001",
"staminaName": "quest",
"userId": "#{userId}",
"recoverValue": 100
}
}
]
},
{
"acquireActions": [
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "stamina-0001",
"staminaName": "quest",
"userId": "#{userId}",
"recoverValue": 100
}
}
]
}
]
},
{
"name": "streaming",
"mode": "streaming",
"missedReceiveRelief": "enabled",
"resetHour": 15,
"repeat": "enabled",
"rewards": [
{
"acquireActions": [
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "stamina-0001",
"staminaName": "quest",
"userId": "#{userId}",
"recoverValue": 100
}
}
]
},
{
"acquireActions": [
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "stamina-0001",
"staminaName": "quest",
"userId": "#{userId}",
"recoverValue": 100
}
}
]
},
{
"acquireActions": [
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "stamina-0001",
"staminaName": "quest",
"userId": "#{userId}",
"recoverValue": 100
}
}
]
}
],
"missedReceiveReliefConsumeActions": [
{
"action": "Gs2Money:WithdrawByUserId",
"request": {
"namespaceName": "money-0001",
"userId": "#{userId}",
"slot": 0,
"count": 200,
"paidOnly": false
}
}
]
}
]
}
UploadToken: nullimport (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/loginReward"
"github.com/gs2io/gs2-golang-cdk/money"
"github.com/gs2io/gs2-golang-cdk/stamina"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
loginReward.NewNamespace(
&SampleStack,
"namespace-0001",
loginReward.NamespaceOptions{},
).MasterData(
[]loginReward.BonusModel{
loginReward.NewBonusModel(
"schedule",
loginReward.BonusModelModeSchedule,
loginReward.BonusModelMissedReceiveReliefDisabled,
loginReward.BonusModelOptions{
PeriodEventId: pointy.String("grn:gs2:schedule:grn-0001"),
Rewards: []loginReward.Reward{
loginReward.NewReward(
[]core.AcquireAction{
stamina.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
loginReward.RewardOptions{},
),
loginReward.NewReward(
[]core.AcquireAction{
stamina.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
loginReward.RewardOptions{},
),
loginReward.NewReward(
[]core.AcquireAction{
stamina.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
loginReward.RewardOptions{},
),
},
},
),
loginReward.NewBonusModel(
"streaming",
loginReward.BonusModelModeStreaming,
loginReward.BonusModelMissedReceiveReliefEnabled,
loginReward.BonusModelOptions{
ResetHour: pointy.Int32(15),
Repeat: loginReward.BonusModelRepeatEnabled.Pointer(),
Rewards: []loginReward.Reward{
loginReward.NewReward(
[]core.AcquireAction{
stamina.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
loginReward.RewardOptions{},
),
loginReward.NewReward(
[]core.AcquireAction{
stamina.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
loginReward.RewardOptions{},
),
loginReward.NewReward(
[]core.AcquireAction{
stamina.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
loginReward.RewardOptions{},
),
},
MissedReceiveReliefConsumeActions: []core.ConsumeAction{
money.WithdrawByUserId(
"namespace-0001",
0,
1,
pointy.Bool(false),
),
},
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\LoginReward\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\LoginReward\Model\BonusModel(
name:"schedule",
mode: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMode::SCHEDULE,
missedReceiveRelief: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMissedReceiveRelief::DISABLED,
options: new \Gs2Cdk\LoginReward\Model\Options\BonusModelOptions(
periodEventId:"grn:gs2:schedule:grn-0001",
rewards:[
new \Gs2Cdk\LoginReward\Model\Reward(
acquireActions: [
new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100,
),
],
),
new \Gs2Cdk\LoginReward\Model\Reward(
acquireActions: [
new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100,
),
],
),
new \Gs2Cdk\LoginReward\Model\Reward(
acquireActions: [
new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100,
),
],
),
]
)
),
new \Gs2Cdk\LoginReward\Model\BonusModel(
name:"streaming",
mode: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMode::STREAMING,
missedReceiveRelief: \Gs2Cdk\LoginReward\Model\Enums\BonusModelMissedReceiveRelief::ENABLED,
options: new \Gs2Cdk\LoginReward\Model\Options\BonusModelOptions(
resetHour:15,
repeat:Gs2Cdk\LoginReward\Model\Enums\BonusModelRepeat::ENABLED,
rewards:[
new \Gs2Cdk\LoginReward\Model\Reward(
acquireActions: [
new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100,
),
],
),
new \Gs2Cdk\LoginReward\Model\Reward(
acquireActions: [
new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100,
),
],
),
new \Gs2Cdk\LoginReward\Model\Reward(
acquireActions: [
new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100,
),
],
),
],
missedReceiveReliefConsumeActions:[
new \Gs2Cdk\Money\StampSheet\WithdrawByUserId(
namespaceName: "money-0001",
userId: "#{userId}",
slot: 0,
count: 200,
paidOnly: False,
),
]
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.loginReward.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.loginReward.model.BonusModel(
"schedule",
io.gs2.cdk.loginReward.model.enums.BonusModelMode.SCHEDULE,
io.gs2.cdk.loginReward.model.enums.BonusModelMissedReceiveRelief.DISABLED,
new io.gs2.cdk.loginReward.model.options.BonusModelOptions()
.withPeriodEventId("grn:gs2:schedule:grn-0001")
.withRewards(Arrays.asList(
new io.gs2.cdk.loginReward.model.Reward(
Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}")
)
),
new io.gs2.cdk.loginReward.model.Reward(
Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}")
)
),
new io.gs2.cdk.loginReward.model.Reward(
Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}")
)
)
))
),
new io.gs2.cdk.loginReward.model.BonusModel(
"streaming",
io.gs2.cdk.loginReward.model.enums.BonusModelMode.STREAMING,
io.gs2.cdk.loginReward.model.enums.BonusModelMissedReceiveRelief.ENABLED,
new io.gs2.cdk.loginReward.model.options.BonusModelOptions()
.withResetHour(15)
.withRepeat(io.gs2.cdk.loginReward.model.enums.BonusModelRepeat.ENABLED)
.withRewards(Arrays.asList(
new io.gs2.cdk.loginReward.model.Reward(
Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}")
)
),
new io.gs2.cdk.loginReward.model.Reward(
Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}")
)
),
new io.gs2.cdk.loginReward.model.Reward(
Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}")
)
)
))
.withMissedReceiveReliefConsumeActions(Arrays.asList(
new io.gs2.cdk.money.stampSheet.WithdrawByUserId(
"namespace-0001",
0,
1,
false,
"#{userId}")
))
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2LoginReward.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2LoginReward.Model.BonusModel[] {
new Gs2Cdk.Gs2LoginReward.Model.BonusModel(
name: "schedule",
mode: Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMode.Schedule,
missedReceiveRelief: Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMissedReceiveRelief.Disabled,
options: new Gs2Cdk.Gs2LoginReward.Model.Options.BonusModelOptions
{
periodEventId = "grn:gs2:schedule:grn-0001",
rewards = new Gs2Cdk.Gs2LoginReward.Model.Reward[]
{
new Gs2Cdk.Gs2LoginReward.Model.Reward(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100
)
}
),
new Gs2Cdk.Gs2LoginReward.Model.Reward(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100
)
}
),
new Gs2Cdk.Gs2LoginReward.Model.Reward(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100
)
}
)
}
}
),
new Gs2Cdk.Gs2LoginReward.Model.BonusModel(
name: "streaming",
mode: Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMode.Streaming,
missedReceiveRelief: Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelMissedReceiveRelief.Enabled,
options: new Gs2Cdk.Gs2LoginReward.Model.Options.BonusModelOptions
{
resetHour = 15,
repeat = Gs2Cdk.Gs2LoginReward.Model.Enums.BonusModelRepeat.Enabled,
rewards = new Gs2Cdk.Gs2LoginReward.Model.Reward[]
{
new Gs2Cdk.Gs2LoginReward.Model.Reward(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100
)
}
),
new Gs2Cdk.Gs2LoginReward.Model.Reward(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100
)
}
),
new Gs2Cdk.Gs2LoginReward.Model.Reward(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
namespaceName: "stamina-0001",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 100
)
}
)
},
missedReceiveReliefConsumeActions = new Gs2Cdk.Core.Model.ConsumeAction[]
{
new Gs2Cdk.Gs2Money.StampSheet.WithdrawByUserId(
namespaceName: "money-0001",
userId: "#{userId}",
slot: 0,
count: 200,
paidOnly: false
)
}
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import loginReward from "@/gs2cdk/loginReward";
class SampleStack extends core.Stack
{
public constructor() {
super();
new loginReward.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new loginReward.model.BonusModel(
"schedule",
loginReward.model.BonusModelMode.SCHEDULE,
loginReward.model.BonusModelMissedReceiveRelief.DISABLED,
{
periodEventId: "grn:gs2:schedule:grn-0001",
rewards: [
new loginReward.model.Reward(
[
new stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
]
),
new loginReward.model.Reward(
[
new stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
]
),
new loginReward.model.Reward(
[
new stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
]
),
]
}
),
new loginReward.model.BonusModel(
"streaming",
loginReward.model.BonusModelMode.STREAMING,
loginReward.model.BonusModelMissedReceiveRelief.ENABLED,
{
resetHour: 15,
repeat: loginReward.model.BonusModelRepeat.ENABLED,
rewards: [
new loginReward.model.Reward(
[
new stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
]
),
new loginReward.model.Reward(
[
new stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
]
),
new loginReward.model.Reward(
[
new stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
]
),
],
missedReceiveReliefConsumeActions: [
new money.stampSheet.WithdrawByUserId(
"namespace-0001",
0,
1,
false,
"#{userId}"
),
]
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, login_reward
class SampleStack(Stack):
def __init__(self):
super().__init__()
login_reward.Namespace(
stack=self,
name="namespace-0001",
).master_data(
bonus_models=[
login_reward.BonusModel(
name='schedule',
mode=login_reward.BonusModelMode.SCHEDULE,
missed_receive_relief=login_reward.BonusModelMissedReceiveRelief.DISABLED,
options=login_reward.BonusModelOptions(
period_event_id = 'grn:gs2:schedule:grn-0001',
rewards = [
login_reward.Reward(
acquire_actions=[
stamina.RecoverStaminaByUserId(
namespace_name='stamina-0001',
stamina_name='quest',
user_id='#{userId}',
recover_value=100
),
],
),
login_reward.Reward(
acquire_actions=[
stamina.RecoverStaminaByUserId(
namespace_name='stamina-0001',
stamina_name='quest',
user_id='#{userId}',
recover_value=100
),
],
),
login_reward.Reward(
acquire_actions=[
stamina.RecoverStaminaByUserId(
namespace_name='stamina-0001',
stamina_name='quest',
user_id='#{userId}',
recover_value=100
),
],
),
]
),
),
login_reward.BonusModel(
name='streaming',
mode=login_reward.BonusModelMode.STREAMING,
missed_receive_relief=login_reward.BonusModelMissedReceiveRelief.ENABLED,
options=login_reward.BonusModelOptions(
reset_hour = 15,
repeat = login_reward.BonusModelRepeat.ENABLED,
rewards = [
login_reward.Reward(
acquire_actions=[
stamina.RecoverStaminaByUserId(
namespace_name='stamina-0001',
stamina_name='quest',
user_id='#{userId}',
recover_value=100
),
],
),
login_reward.Reward(
acquire_actions=[
stamina.RecoverStaminaByUserId(
namespace_name='stamina-0001',
stamina_name='quest',
user_id='#{userId}',
recover_value=100
),
],
),
login_reward.Reward(
acquire_actions=[
stamina.RecoverStaminaByUserId(
namespace_name='stamina-0001',
stamina_name='quest',
user_id='#{userId}',
recover_value=100
),
],
),
],
missed_receive_relief_consume_actions = [
money.WithdrawByUserId(
namespace_name='money-0001',
user_id='#{userId}',
slot=0,
count=200,
paid_only=False
),
]
),
),
],
)
print(SampleStack().yaml()) # Generate TemplateBonusModel
Bonus Model
A bonus model defines the distribution schedule for login bonuses. There are two schedule types: 《Schedule Mode》 and 《Streaming Mode》.
In Schedule Mode, a GS2-Schedule event must be specified, and bonuses are distributed based on the number of days elapsed since the event’s start date. If the user misses a day partway through, the bonus for that day will not be granted.
In Streaming Mode, the rewards configured for the bonus are distributed sequentially from the beginning each day. Streaming Mode also supports repetition; when enabled, the distribution restarts from the first reward after reaching the end of the stream.
Both Schedule Mode and Streaming Mode provide a missed-bonus recovery feature. By paying a certain cost, users can receive bonuses they previously missed. However, if a GS2-Schedule event is associated, users cannot receive bonuses beyond the number of days elapsed since the event’s start date. Additionally, the recovery feature cannot be used when using Streaming Mode with repetition enabled.
In both Schedule Mode and Streaming Mode, the maximum number of days that can be configured for bonuses is 100 days.
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bonusModelId | string | ✓ | ~ 1024 chars | Login Bonus Model GRN | ||||||||
| name | string | ✓ | ~ 128 chars | Bonus Model Name | ||||||||
| metadata | string | ~ 2048 chars | Metadata | |||||||||
| mode | String Enum enum { “schedule”, “streaming” } | ✓ | ~ 128 chars | mode
| ||||||||
| periodEventId | string | ~ 1024 chars | GS2-Schedule Event GRN that represents the period during which to enable login bonuses | |||||||||
| resetHour | int | {periodEventId} == "" | ✓* | 0 ~ 23 | Reset time of the receive flag (UTC) * Required if periodEventId is “" | |||||||
| repeat | String Enum enum { “enabled”, “disabled” } | {mode} == “streaming” | ✓* | ~ 128 chars | Whether to repeat after reaching the end * Required if mode is “streaming” | |||||||
| rewards | List<Reward> | 0 ~ 100 items | List of rewards | |||||||||
| missedReceiveRelief | String Enum enum { “enabled”, “disabled” } | ✓ | “disabled” | ~ 128 chars | Missed Rescue Function
| |||||||
| missedReceiveReliefVerifyActions | List<VerifyAction> | {missedReceiveRelief} == “enabled” | [] | 0 ~ 10 items | List of verify actions for missed receive relief * Enabled if missedReceiveRelief is “enabled” | |||||||
| missedReceiveReliefConsumeActions | List<ConsumeAction> | {missedReceiveRelief} == “enabled” | [] | 0 ~ 10 items | List of consume actions for missed receive relief * Enabled if missedReceiveRelief is “enabled” |
Reward
Reward
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| acquireActions | List<AcquireAction> | ✓ | 1 ~ 10 items | List of Acquire Action |
ConsumeAction
Consume Action
VerifyAction
Verify Action
AcquireAction
Acquire Action