GS2-Limit
GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス
GS2-Deploy リファレンス
エンティティ
Namespace
Namespace
Type: GS2::Limit::Namespace
Properties:
Name: namespace1
Description: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
from gs2_cdk import Stack, core, limit
class SampleStack(Stack):
def __init__(self):
super().__init__()
limit.Namespace(
stack=self,
name="namespace-0001",
options=limit.NamespaceOptions(
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\Limit\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Limit\Model\Options\NamespaceOptions(
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
),
),
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.limit.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.limit.model.options.NamespaceOptions() {
{
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 limit from "@/gs2cdk/limit";
class SampleStack extends core.Stack
{
public constructor() {
super();
new limit.model.Namespace(
this,
"namespace-0001",
{
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.Gs2Limit.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Limit.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 32文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| logSetting | LogSetting | ログの出力設定 |
CurrentLimitMaster
CurrentLimitMaster
Type: GS2::Limit::CurrentLimitMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-04-05",
"limitModels": [
{
"name": "daily",
"metadata": "DAILY",
"resetType": "daily",
"resetHour": 9
},
{
"name": "weekly",
"metadata": "WEEKLY",
"resetType": "weekly",
"resetDayOfWeek": "sunday",
"resetHour": 18
}
]
}
from gs2_cdk import Stack, core, limit
class SampleStack(Stack):
def __init__(self):
super().__init__()
limit.Namespace(
stack=self,
# 省略
).master_data(
[
limit.LimitModel(
name='daily',
reset_type='daily',
options=limit.LimitModelOptions(
metadata='DAILY',
reset_hour=9,
),
),
limit.LimitModel(
name='weekly',
reset_type='weekly',
options=limit.LimitModelOptions(
metadata='WEEKLY',
reset_day_of_week='sunday',
reset_hour=18,
),
),
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Limit\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Limit\Model\LimitModel(
name:"daily",
resetType:"daily",
options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
metadata:"DAILY",
resetHour:9,
),
),
new \Gs2Cdk\Limit\Model\LimitModel(
name:"weekly",
resetType:"weekly",
options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
metadata:"WEEKLY",
resetDayOfWeek:"sunday",
resetHour:18,
),
),
],
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.limit.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.limit.model.LimitModel(
"daily",
"daily",
new io.gs2.cdk.limit.model.options.LimitModelOptions() {
{
metadata: "DAILY";
resetHour: 9;
}
}
),
new io.gs2.cdk.limit.model.LimitModel(
"weekly",
"weekly",
new io.gs2.cdk.limit.model.options.LimitModelOptions() {
{
metadata: "WEEKLY";
resetDayOfWeek: "sunday";
resetHour: 18;
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import limit from "@/gs2cdk/limit";
class SampleStack extends core.Stack
{
public constructor() {
super();
new limit.model.Namespace(
this,
// 省略
).masterData(
[
new limit.model.LimitModel(
"daily",
"daily",
{
metadata: "DAILY",
resetHour: 9
}
),
new limit.model.LimitModel(
"weekly",
"weekly",
{
metadata: "WEEKLY",
resetDayOfWeek: "sunday",
resetHour: 18
}
)
]
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Limit.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Limit.Model.LimitModel(
"daily",
"daily",
new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions {
metadata = "DAILY",
resetHour = 9,
}
),
new Gs2Cdk.Gs2Limit.Model.LimitModel(
"weekly",
"weekly",
new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions {
metadata = "WEEKLY",
resetDayOfWeek = "sunday",
resetHour = 18,
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |