GS2-MegaField GS2-Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例

エンティティ

Deploy処理で操作する対象リソース

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。

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

	型	必須	デフォルト	値の制限	説明
namespaceId	string	✓		~ 1024文字	ネームスペース GRN
name	string	✓		~ 128文字	ネームスペース名
description	string			~ 1024文字	説明文
logSetting	LogSetting				ログの出力設定
createdAt	long	✓	現在時刻		作成日時 UNIX 時間・ミリ秒サーバー側で自動的に設定
updatedAt	long	✓	現在時刻		最終更新日時 UNIX 時間・ミリ秒サーバー側で自動的に設定
revision	long		0	0 ~ 9223372036854775805	リビジョン

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

	型	説明
Item	Namespace	作成したネームスペース

実装例

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

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/megaField"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
megaField.NewNamespace(
    &SampleStack,
    "namespace-0001",
    megaField.NamespaceOptions{
        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\MegaField\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\MegaField\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.megaField.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.megaField.model.options.NamespaceOptions()
                        .withLogSetting(new io.gs2.cdk.core.model.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.Gs2MegaField.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2MegaField.Model.Options.NamespaceOptions
            {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import megaField from "@/gs2cdk/megaField";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new megaField.model.Namespace(
            this,
            "namespace-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, mega_field

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        mega_field.Namespace(
            stack=self,
            name='namespace-0001',
            options=mega_field.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

LogSetting

ログの書き出し設定

ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。
ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。
この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。
GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

	型	有効化条件	必須	デフォルト	値の制限	説明
loggingNamespaceId	string		✓		~ 1024文字	ログを出力する GS2-Log のネームスペース GRN

CurrentFieldMaster

現在有効なマスターデータ

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

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

Note

JSONファイルの形式については GS2-MegaField マスターデータリファレンスをご参照ください。

	型	有効化条件	必須	デフォルト	値の制限	説明
namespaceId	string		✓		~ 1024文字	ネームスペース GRN
settings	string		✓		~ 5242880 バイト (5MB)	マスターデータ

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

	型	説明
Item	CurrentFieldMaster	更新した現在有効な所持品マスター

実装例

Type: GS2::MegaField::CurrentFieldMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2022-08-28",
    "areaModels": [
      {
        "name": "area-0001",
        "metadata": "AREA_0001",
        "layerModels": [
          {
            "name": "layer-0001",
            "metadata": "LAYER_0001"
          }
        ]
      }
    ]
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/megaField"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
megaField.NewNamespace(
    &SampleStack,
    "namespace-0001",
    megaField.NamespaceOptions{},
).MasterData(
    []megaField.AreaModel{
        megaField.NewAreaModel(
            "area-0001",
            megaField.AreaModelOptions{
                Metadata: pointy.String("AREA_0001"),
                LayerModels: []megaField.LayerModel{
                    megaField.NewLayerModel(
                        "layer-0001",
                        megaField.LayerModelOptions{
                            Metadata: pointy.String("LAYER_0001"),
                        },
                    ),
                },
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\MegaField\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\MegaField\Model\AreaModel(
                    name:"area-0001",
                    options: new \Gs2Cdk\MegaField\Model\Options\AreaModelOptions(
                        metadata:"AREA_0001",
                        layerModels:[
                            new \Gs2Cdk\MegaField\Model\LayerModel(
                                name: "layer-0001",
                                options: new \Gs2Cdk\MegaField\Model\Options\LayerModelOptions(
                                    metadata: "LAYER_0001",
                                )
                            ),
                        ]
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.megaField.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.megaField.model.AreaModel(
                    "area-0001",
                    new io.gs2.cdk.megaField.model.options.AreaModelOptions()
                        .withMetadata("AREA_0001")
                        .withLayerModels(Arrays.asList(
                            new io.gs2.cdk.megaField.model.LayerModel(
                                "layer-0001",
                                new io.gs2.cdk.megaField.model.options.LayerModelOptions()
                                    .withMetadata("LAYER_0001")
                            )
                        ))
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2MegaField.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2MegaField.Model.AreaModel[] {
                new Gs2Cdk.Gs2MegaField.Model.AreaModel(
                    name: "area-0001",
                    options: new Gs2Cdk.Gs2MegaField.Model.Options.AreaModelOptions
                    {
                        metadata = "AREA_0001",
                        layerModels = new Gs2Cdk.Gs2MegaField.Model.LayerModel[]
                        {
                            new Gs2Cdk.Gs2MegaField.Model.LayerModel(
                                name: "layer-0001",
                                options: new Gs2Cdk.Gs2MegaField.Model.Options.LayerModelOptions
                                {
                                    metadata = "LAYER_0001"
                                }
                            )
                        }
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import megaField from "@/gs2cdk/megaField";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new megaField.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new megaField.model.AreaModel(
                    "area-0001",
                    {
                        metadata: "AREA_0001",
                        layerModels: [
                            new megaField.model.LayerModel(
                                "layer-0001",
                                {
                                    metadata: "LAYER_0001"
                                }
                            ),
                        ]
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, mega_field

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        mega_field.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            area_models=[
                mega_field.AreaModel(
                    name='area-0001',
                    options=mega_field.AreaModelOptions(
                        metadata = 'AREA_0001',
                        layer_models = [
                            mega_field.LayerModel(
                                name='layer-0001',
                                options=mega_field.LayerModelOptions(
                                    metadata='LAYER_0001',
                                ),
                            ),
                        ]
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

AreaModel

エリアは空間を分割するもので、同じ座標でもエリアが異なれば別空間として扱うことができます。

	型	必須	デフォルト	値の制限	説明
areaModelId	string	✓		~ 1024文字	エリアモデル GRN
name	string	✓		~ 128文字	エリアモデル名
metadata	string			~ 2048文字	メタデータ
layerModels	List<LayerModel>		[]	0 ~ 1000 items	レイヤーモデル一覧

LayerModel

レイヤーは1つの空間内で複数の論理階層を実現します。
たとえば、キャラクターが大量に存在する空間で、エネミーが見えなくなってしまう問題を解決します。
レイヤー1 にはキャラクターを配置。レイヤー2にはエネミーを配置した場合、レイヤーごとに指定した距離内での取得数量を指定できるため、見えなくなる心配はありません。

	型	必須	値の制限	説明
layerModelId	string	✓	~ 1024文字	レイヤーモデル GRN
name	string	✓	~ 128文字	レイヤーモデル名
metadata	string		~ 2048文字	メタデータ

LayerModel

	型	必須	値の制限	説明
layerModelId	string	✓	~ 1024文字	レイヤーモデル GRN
name	string	✓	~ 128文字	レイヤーモデル名
metadata	string		~ 2048文字	メタデータ