GS2-MegaField GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
logSetting | LogSetting | ログの出力設定 |
GetAttr
型 | 説明 | |
---|---|---|
Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::MegaField::Namespace
Properties:
Name: namespace1
Description: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
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
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() {
{
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 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
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2MegaField.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2MegaField.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
CurrentFieldMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
型 | 説明 | |
---|---|---|
Item | CurrentFieldMaster | 更新した現在有効な所持品マスター |
実装例
Type: GS2::MegaField::CurrentFieldMaster
Properties:
NamespaceName: namespace1
Settings: {"version": "2022-08-28", "areaModels": [{"name": "area-0001", "metadata": "AREA_0001", "layerModels": [{"name": "layer-0001", "metadata": "LAYER_0001"}]}]}
from gs2_cdk import Stack, core, mega_field
class SampleStack(Stack):
def __init__(self):
super().__init__()
mega_field.Namespace(
stack=self,
# 省略
).master_data(
[
mega_field.AreaModel(
name='area-0001',
options=mega_field.AreaModelOptions(
metadata='AREA_0001',
layer_models=[ {'name': 'layer-0001', 'metadata': 'LAYER_0001'},
],
),
),
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\MegaField\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\MegaField\Model\AreaModel(
name:"area-0001",
options: new \Gs2Cdk\MegaField\Model\Options\AreaModelOptions(
metadata:"AREA_0001",
layerModels:[ {'name': 'layer-0001', '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,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.megaField.model.AreaModel(
"area-0001",
new io.gs2.cdk.megaField.model.options.AreaModelOptions() {
{
metadata: "AREA_0001";
layerModels: Arrays.asList(
{'name': 'layer-0001', 'metadata': 'LAYER_0001'}
);
}
}
)
)
);
}
}
System.out.println(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,
// 省略
).masterData(
[
new megaField.model.AreaModel(
"area-0001",
{
metadata: "AREA_0001",
layerModels: [
{'name': 'layer-0001', 'metadata': 'LAYER_0001'}
]
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2MegaField.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2MegaField.Model.AreaModel(
"area-0001",
new Gs2Cdk.Gs2MegaField.Model.Options.AreaModelOptions {
metadata = "AREA_0001",
layerModels = new Gs2Cdk.Gs2MegaField.Model.LayerModel[] {
{'name': 'layer-0001', 'metadata': 'LAYER_0001'}
},
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
Position
座標
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
x | float | ✓ | ~ 1048574 | X座標 | |
y | float | ✓ | ~ 1048574 | Y座標 | |
z | float | ✓ | ~ 1048574 | Z座標 |
MyPosition
自分の位置情報
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
position | Position | ✓ | 座標 | ||
vector | Vector | ✓ | 向き | ||
r | float | ✓ | 1 | ~ 10000 | 半径 |
Scope
取得する周囲の状況
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
layerName | string | ✓ | ~ 128文字 | レイヤーモデル名 | |
r | float | ✓ | 1 ~ 16777214 | 半径 | |
limit | int | ✓ | 1 ~ 100 | 最大数 |
Vector
座標
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
x | float | ✓ | ~ 1048574 | X座標 | |
y | float | ✓ | ~ 1048574 | Y座標 | |
z | float | ✓ | ~ 1048574 | Z座標 |
LogSetting
ログの書き出し設定
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
GitHubCheckoutSetting
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
apiKeyId | string | ✓ | ~ 1024文字 | GitHub のAPIキーGRN | |
repositoryName | string | ✓ | ~ 1024文字 | リポジトリ名 | |
sourcePath | string | ✓ | ~ 1024文字 | ソースコードのファイルパス | |
referenceType | enum [‘commit_hash’, ‘branch’, ’tag’] | ✓ | ~ 128文字 | コードの取得元 | |
commitHash | string | {referenceType} == “commit_hash” | ~ 1024文字 | コミットハッシュ | |
branchName | string | {referenceType} == “branch” | ~ 1024文字 | ブランチ名 | |
tagName | string | {referenceType} == “tag” | ~ 1024文字 | タグ名 |