GS2-LoginReward Deploy/CDK Reference
The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
Entities
Resources targeted by the Deploy operation
Namespace
Namespace
A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. 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.
Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| description | string | ~ 1024 chars | Description | |||
| transactionSetting | TransactionSetting | ✓ | Transaction Settings Configuration for how reward transactions are executed within this namespace. | |||
| receiveScript | ScriptSetting | Script to run when receiving rewards Script Trigger Reference - receive | ||||
| logSetting | LogSetting | Log Output Settings Configuration for outputting API request/response logs to GS2-Log. When configured, login bonus operations (receive, missed recovery, etc.) are logged for monitoring and analysis. |
GetAttr
Resource creation results that can be retrieved using 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/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 Templateclass 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 Templateclass 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 Templatefrom 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 TemplateTransactionSetting
Transaction Settings
Transaction Settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous Acquire Actions via GS2-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 * Applicable only if enableAutoRun is true | ||
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | Whether to execute transactions asynchronously * Applicable only if enableAtomicCommit is true | ||
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | false | Whether to execute the commit processing of the script result asynchronously * Applicable only if transactionUseDistributor is true | ||
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | Whether to use GS2-JobQueue to execute the acquire action * Applicable only if enableAtomicCommit is true | ||
| distributorNamespaceId | string | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor Namespace GRN used to execute transactions | ||
| queueNamespaceId | string | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute transactions |
ScriptSetting
Script Setting
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’s execution results to halt API execution or control the API’s response content.
In contrast, asynchronous execution does not block processing until the script has finished executing. However, because the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API response flow and 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 | GS2-Script script GRN
executed synchronously when the API is executed Must be specified in GRN format starting with “grn:gs2:”. | |||||||||||
| doneTriggerTargetType | String Enum enum { “none”, “gs2_script”, “aws” } | “none” | How to execute asynchronous scripts Specifies the type of script to use for asynchronous execution. You can choose from “Do not use asynchronous execution (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
| |||||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-Script script GRN
for asynchronous execution Must be specified in GRN format starting with “grn:gs2:”. * Applicable only 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 are not many cases where GS2-JobQueue is required, so you generally do not need to specify it unless you have a specific reason. * Applicable only if doneTriggerTargetType is “gs2_script” |
LogSetting
Log Output Settings
Log Output Settings define how log data is exported. 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, debugging, and other operational purposes.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | GS2-Log namespace GRN
to output logs Must be specified in GRN format starting with “grn:gs2:”. |
CurrentBonusMaster
Currently active Login Bonus Model master data
This master data describes the definitions of Login Bonus Models currently active within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on the server.
To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for game operations and export JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-LoginReward for the JSON file format.Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| mode | String Enum enum { “direct”, “preUpload” } | “direct” | Update mode
| |||||||||
| settings | string | {mode} == “direct” | ✓* | ~ 5242880 chars | Master Data * Required if mode is “direct” | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓* | ~ 1024 chars | Token obtained by pre-upload Used to apply the uploaded master data. * Required if mode is “preUpload” |
GetAttr
Resource creation results that can be retrieved using the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentBonusMaster | Updated master data of the currently active Login Bonus Models |
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 Templateclass 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 Templateclass 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";
import money from "@/gs2cdk/money";
import stamina from "@/gs2cdk/stamina";
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 Templatefrom gs2_cdk import Stack, core, login_reward, money, stamina
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
Login Bonus Model
Login 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 * Set automatically by the server | ||||||||
| name | string | ✓ | ~ 128 chars | Login Bonus Model name Login Bonus Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| metadata | string | ~ 2048 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||||||||
| mode | String Enum enum { “schedule”, “streaming” } | ✓ | Mode Specifies the distribution schedule type for the login bonus. In “schedule” mode, rewards are tied to elapsed days since a GS2-Schedule event start date. In “streaming” mode, rewards are distributed sequentially from the beginning each day regardless of calendar date.
| |||||||||
| periodEventId | string | ~ 1024 chars | Period Event GRN GS2-Schedule Event GRN that represents the period during which to enable login bonuses. In Schedule Mode, this field is required and determines the start date from which elapsed days are counted for reward distribution. In Streaming Mode, this field is optional; when specified, users cannot receive bonuses beyond the elapsed days since the event start. | |||||||||
| resetHour | int | {periodEventId} == "" | ✓* | 0 ~ 23 | Reset Hour (UTC) The hour of day (0-23, UTC) at which the daily receive flag resets. This determines when a new day begins for login bonus purposes. Only required when periodEventId is not specified; when an event is set, the reset timing follows the event’s schedule. * Required if periodEventId is “" | |||||||
| repeat | String Enum enum { “enabled”, “disabled” } | {mode} == “streaming” | ✓* | Repeat Whether to restart distribution from the beginning after all rewards have been distributed. Only applicable in Streaming Mode. When enabled, the reward list loops back to the first entry after the last one is distributed. Note: the missed-bonus recovery feature cannot be used when repeat is enabled.
* Required if mode is “streaming” | ||||||||
| rewards | List<Reward> | 0 ~ 100 items | Rewards The ordered list of daily rewards. Each entry corresponds to one day’s login bonus, distributed sequentially from index 0. In Schedule Mode, the index maps to the number of elapsed days since the event start date. In Streaming Mode, the index maps to the number of login days. Up to 100 entries can be configured. | |||||||||
| missedReceiveRelief | String Enum enum { “enabled”, “disabled” } | “disabled” | Missed Receive Relief Whether to enable the missed-bonus recovery feature. When enabled, users can retroactively receive bonuses they missed by paying a specified cost (consume actions). Optionally, verify actions can be configured to check conditions before allowing recovery. This feature cannot be used when Streaming Mode with repeat enabled is active. Defaults to “disabled”.
| |||||||||
| missedReceiveReliefVerifyActions | List<VerifyAction> | {missedReceiveRelief} == “enabled” | [] | 0 ~ 10 items | Missed Receive Relief Verify Actions List of verify actions to execute before allowing missed-bonus recovery. These actions check preconditions (e.g., user eligibility) before the recovery is processed. Up to 10 actions can be configured. Only applicable when missedReceiveRelief is enabled. * Applicable only if missedReceiveRelief is “enabled” | |||||||
| missedReceiveReliefConsumeActions | List<ConsumeAction> | {missedReceiveRelief} == “enabled” | [] | 0 ~ 10 items | Missed Receive Relief Consume Actions List of consume actions that define the cost a user must pay to recover a missed bonus. For example, this can be configured to consume in-game currency or items as the recovery cost. Up to 10 actions can be configured. Only applicable when missedReceiveRelief is enabled. * Applicable only if missedReceiveRelief is “enabled” |
Reward
Reward
Represents a single day’s reward configuration for a login bonus. Each Reward contains a list of acquire actions that define what the user receives (e.g., items, currency, experience). The rewards array in BonusModel holds one Reward per day, distributed in order. Reward values can be modified at runtime through the buff system (BonusModelBuff) to apply rate multipliers to acquire actions.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| acquireActions | List<AcquireAction> | ✓ | 1 ~ 10 items | Acquire Actions List of acquire actions that define the resources granted to the user for this day’s reward. Each action specifies a acquire action (e.g., add items, grant currency) and its request parameters. At least 1 and up to 10 actions can be configured per reward. |
ConsumeAction
Consume Action
Defines an action for consuming resources from a user via the transaction mechanism. Used in missed-bonus recovery to specify the cost users must pay (e.g., deducting currency, consuming items). The action field specifies the type of consume action, and the request field contains the corresponding request parameters.
VerifyAction
Verify Action
Defines an action for verifying conditions before proceeding with an operation. Used in missed-bonus recovery to check preconditions (e.g., user eligibility, resource availability) before allowing the recovery. The action field specifies the type of verify action, and the request field contains the corresponding request parameters.
AcquireAction
Acquire Action
Defines an action for granting resources to a user via the transaction mechanism. Used within rewards to specify what the user receives (e.g., adding items to inventory, granting currency, awarding experience points). The action field specifies the type of acquire action, and the request field contains the corresponding request parameters.