NAV
GS2-Deploy

GS2-Limit

GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス

エンティティ

Namespace

Namespace

Type: GS2::Limit::Namespace
Properties:
  Name: namespace1
  Description: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

型 必須 デフォルト 値の制限 説明
name string ✓ ~ 32文字 ネームスペース名
description string ~ 1024文字 説明文
logSetting LogSetting ログの出力設定

LimitModelMaster

LimitModelMaster

Type: GS2::Limit::LimitModelMaster
Properties:
  NamespaceName: namespace1
  Name: limit-model-0001
  Description: null
  Metadata: null
  ResetType: monthly
  ResetDayOfMonth: 1
  ResetDayOfWeek: monday
  ResetHour: 5

回数制限の情報を定義するエンティティです。

回数制限にはリセット間隔を設定できます。 リセット間隔は 毎日・毎週・毎月・リセットしない の4種類から選択ができます。 全ての時間は協定世界時(UTC)で指定します。

回数制限の最大値はマスターデータでは設定しません。 なぜなら、ステップアップガチャのような仕組みで、購入回数カウンターが 3 回未満の場合に購入できる商品。 前述の商品を購入することが出来ず、購入回数カウンターが 5 回未満の場合に購入できる商品。というようにコンテキストによって最大値を変更できるようにするためです。

ここで定義した回数制限設定に紐づくカウンターは複数作成できます。 例えば、1回しか受け取れないクエスト報酬があるときに、クエストごとに回数制限を用意するのではなく 1つの回数制限を用意し、クエスト毎のカウンターを用意することで、設定の数を爆発させないことができます。

型 必須 デフォルト 値の制限 説明
namespaceName string ✓ ~ 32文字 ネームスペース名
name string ✓ ~ 128文字 回数制限の種類名
description string ~ 1024文字 説明文
metadata string ~ 2048文字 メタデータ
resetType string ✓ ~ 128文字 リセットタイミング
resetDayOfMonth int {resetType} == "monthly" 1 ~ 31 リセットをする日にち
resetDayOfWeek string {resetType} == "weekly" ~ 128文字 リセットする曜日
resetHour int {resetType} in ["monthly", "weekly", "daily"] ~ 23 リセット時刻

CurrentLimitMaster

CurrentLimitMaster

Type: GS2::Limit::CurrentLimitMaster
Properties:
  NamespaceName: namespace1
  Settings: {\n  "version": "2019-04-05",\n  "limitModels": [\n    {\n      "name": "daily",\n      "metadata": "DAILY",\n      "resetType": "daily",\n      "resetHour": 9\n    },\n    {\n      "name": "weekly",\n      "metadata": "WEEKLY",\n      "resetType": "weekly",\n      "resetDayOfWeek": "sunday",\n      "resetHour": 18\n    }\n  ]\n}

GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

JSONファイルの形式についてはドキュメントを参照ください。

型 必須 デフォルト 値の制限 説明
namespaceName string ✓ ~ 32文字 ネームスペース名
settings string ✓ ~ 5242880文字 マスターデータ
GS2-Deploy