NAV
GS2-Deploy

GS2-Schedule

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

エンティティ

Namespace

Namespace

Type: GS2::Schedule::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 ログの出力設定

EventMaster

EventMaster

Type: GS2::Schedule::EventMaster
Properties:
  NamespaceName: namespace1
  Name: event-0001
  Description: null
  Metadata: null
  ScheduleType: absolute
  AbsoluteBegin: 10000
  AbsoluteEnd: 20000
  RepeatType: null
  RepeatBeginDayOfMonth: 1
  RepeatEndDayOfMonth: 2
  RepeatBeginDayOfWeek: monday
  RepeatEndDayOfWeek: sunday
  RepeatBeginHour: 5
  RepeatEndHour: 6
  RelativeTriggerName: trigger-0001
  RelativeDuration: 10000

ゲーム内のイベント情報を保持するエンティティです。

イベントの期間は絶対期間と相対期間の2種類存在します。 絶対期間は 2021年1月1日 00:00(UTC) ～ 2021年1月7日 23:59(UTC) のような固定の期間で、 相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。

イベントには開催期間だけでなく、繰り返しが設定できるようになっており イベント期間のうち、月曜日の 10:00 ～ 11:00 だけをイベント期間とするような設定も可能です。

型 必須 デフォルト 値の制限 説明
namespaceName string ✓ ~ 32文字 ネームスペース名
name string ✓ ~ 128文字 イベントの種類名
description string ~ 1024文字 説明文
metadata string ~ 2048文字 メタデータ
scheduleType string ✓ ~ 128文字 イベント期間の種類
absoluteBegin long {scheduleType} == "absolute" イベントの開始日時
absoluteEnd long {scheduleType} == "absolute" イベントの終了日時
repeatType string {scheduleType} == "absolute" "always" ~ 128文字 繰り返しの種類
repeatBeginDayOfMonth int {repeatType} == "monthly" 1 ~ 31 イベントの繰り返し開始日
repeatEndDayOfMonth int {repeatType} == "monthly" 1 ~ 31 イベントの繰り返し終了日
repeatBeginDayOfWeek string {repeatType} == "weekly" ~ 128文字 イベントの繰り返し開始曜日
repeatEndDayOfWeek string {repeatType} == "weekly" ~ 128文字 イベントの繰り返し終了曜日
repeatBeginHour int {repeatType} in ["daily", "weekly", "monthly"] ~ 23 イベントの繰り返し開始時間
repeatEndHour int {repeatType} in ["daily", "weekly", "monthly"] ~ 23 イベントの繰り返し終了時間
relativeTriggerName string {scheduleType} == "relative" ~ 128文字 イベントの開始トリガー名
relativeDuration int {scheduleType} == "relative" ~ 9223372036854775807 イベントの開催期間(秒)

CurrentEventMaster

CurrentEventMaster

Type: GS2::Schedule::CurrentEventMaster
Properties:
  NamespaceName: namespace1
  Settings: {\n  "version": "2019-03-31",\n  "events": [\n    {\n      "name": "event-0001",\n      "metadata": "EVENT_0001",\n      "scheduleType": "absolute",\n      "absoluteBegin": 10000,\n      "absoluteEnd": 20000\n    },\n    {\n      "name": "event-0002",\n      "metadata": "EVENT_0002",\n      "scheduleType": "relative",\n      "relativeTriggerName": "trigger-0001",\n      "relativeDuration": 30000\n    },\n    {\n      "name": "daily-0001",\n      "metadata": "EVENT_0003",\n      "scheduleType": "absolute",\n      "absoluteBegin": 1569369600000,\n      "absoluteEnd": 1569456000000,\n      "repeatType": "daily",\n      "repeatBeginHour": 1,\n      "repeatEndHour": 2\n    },\n    {\n      "name": "daily-0002",\n      "metadata": "EVENT_0004",\n      "scheduleType": "absolute",\n      "absoluteBegin": 1569369600000,\n      "absoluteEnd": 1569456000000,\n      "repeatType": "daily",\n      "repeatBeginHour": 3,\n      "repeatEndHour": 1\n    },\n    {\n      "name": "weekly-0001",\n      "metadata": "EVENT_0005",\n      "scheduleType": "absolute",\n      "absoluteBegin": 1569888000000,\n      "absoluteEnd": 1570406400000,\n      "repeatType": "weekly",\n      "repeatBeginDayOfWeek": "tuesday",\n      "repeatEndDayOfWeek": "wednesday",\n      "repeatBeginHour": 1,\n      "repeatEndHour": 2\n    },\n    {\n      "name": "weekly-0002",\n      "metadata": "EVENT_0006",\n      "scheduleType": "absolute",\n      "absoluteBegin": 1569888000000,\n      "absoluteEnd": 1570406400000,\n      "repeatType": "weekly",\n      "repeatBeginDayOfWeek": "wednesday",\n      "repeatEndDayOfWeek": "tuesday",\n      "repeatBeginHour": 3,\n      "repeatEndHour": 1\n    },\n    {\n      "name": "monthly-0001",\n      "metadata": "EVENT_0007",\n      "scheduleType": "absolute",\n      "absoluteBegin": 1570406400000,\n      "absoluteEnd": 1575158400000,\n      "repeatType": "monthly",\n      "repeatBeginDayOfMonth": 10,\n      "repeatEndDayOfMonth": 15,\n      "repeatBeginHour": 1,\n      "repeatEndHour": 2\n    },\n    {\n      "name": "monthly-0002",\n      "metadata": "EVENT_0008",\n      "scheduleType": "absolute",\n      "absoluteBegin": 1570406400000,\n      "absoluteEnd": 1575158400000,\n      "repeatType": "monthly",\n      "repeatBeginDayOfMonth": 16,\n      "repeatEndDayOfMonth": 9,\n      "repeatBeginHour": 3,\n      "repeatEndHour": 0\n    }\n  ]\n}

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

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

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

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