GS2-MegaField SDK for Game Engine API リファレンス
モデル
EzAreaModel
エリアは空間を分割するもので、同じ座標でもエリアが異なれば別空間として扱うことができます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
name | string | ✓ | | ~ 128文字 | エリアモデル名 |
metadata | string | | | ~ 2048文字 | メタデータ |
layerModels | List<EzLayerModel> | | | | レイヤーモデル一覧 |
EzLayerModel
レイヤーは1つの空間内で複数の論理階層を実現します。
たとえば、キャラクターが大量に存在する空間で、エネミーが見えなくなってしまう問題を解決します。
レイヤー1 にはキャラクターを配置。レイヤー2にはエネミーを配置した場合、レイヤーごとに指定した距離内での取得数量を指定できるため、見えなくなる心配はありません。
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
name | string | ✓ | | ~ 128文字 | レイヤーモデル名 |
metadata | string | | | ~ 2048文字 | メタデータ |
EzMyPosition
自分の位置情報
EzPosition
座標
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
x | float | ✓ | | ~ 9223372036854775807 | X座標 |
y | float | ✓ | | ~ 9223372036854775807 | Y座標 |
z | float | ✓ | | ~ 9223372036854775807 | Z座標 |
EzScope
取得する周囲の状況
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
r | float | ✓ | | 1 ~ 9223372036854775807 | 半径 |
limit | int | ✓ | | 1 ~ 100 | 最大数 |
EzSpatial
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
userId | string | ✓ | | ~ 128文字 | ユーザーID |
areaModelName | string | ✓ | | ~ 128文字 | エリア名 |
layerModelName | string | ✓ | | ~ 128文字 | レイヤー名 |
position | EzPosition | ✓ | | | 座標 |
vector | EzVector | ✓ | | | 向き |
EzVector
座標
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
x | float | ✓ | | ~ 9223372036854775807 | X座標 |
y | float | ✓ | | ~ 9223372036854775807 | Y座標 |
z | float | ✓ | | ~ 9223372036854775807 | Z座標 |
メソッド
describeAreaModels
エリアモデル一覧を取得
Request
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | ✓ | | ~ 32文字 | ネームスペース名 |
Result
実装例
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
);
var items = await domain.AreaModelsAsync(
).ToListAsync();
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
);
var it = domain.AreaModels(
);
List<EzAreaModel> items = new List<EzAreaModel>();
while (it.HasNext())
{
yield return it.Next();
if (it.Error != null)
{
onError.Invoke(it.Error, null);
break;
}
if (it.Current != null)
{
items.Add(it.Current);
}
else
{
break;
}
}
const auto Domain = Gs2->MegaField->Namespace(
"namespace-0001" // namespaceName
);
const auto It = Domain->AreaModels(
);
for (auto Item : *It)
{
}
getAreaModel
エリアモデルを取得
Request
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | ✓ | | ~ 32文字 | ネームスペース名 |
areaModelName | string | ✓ | | ~ 128文字 | エリアモデル名 |
Result
実装例
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
).AreaModel(
areaModelName: "area-0001"
);
var item = await domain.ModelAsync();
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
).AreaModel(
areaModelName: "area-0001"
);
var future = domain.Model();
yield return future;
var item = future.Result;
const auto Domain = Gs2->MegaField->Namespace(
"namespace-0001" // namespaceName
)->AreaModel(
"area-0001" // areaModelName
);
const auto item = Domain.Model();
describeLayerModels
エリアモデル一覧を取得
Request
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | ✓ | | ~ 32文字 | ネームスペース名 |
areaModelName | string | ✓ | | ~ 128文字 | エリアモデル名 |
Result
実装例
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
).AreaModel(
areaModelName: "area-0001"
);
var items = await domain.LayerModelsAsync(
).ToListAsync();
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
).AreaModel(
areaModelName: "area-0001"
);
var it = domain.LayerModels(
);
List<EzLayerModel> items = new List<EzLayerModel>();
while (it.HasNext())
{
yield return it.Next();
if (it.Error != null)
{
onError.Invoke(it.Error, null);
break;
}
if (it.Current != null)
{
items.Add(it.Current);
}
else
{
break;
}
}
const auto Domain = Gs2->MegaField->Namespace(
"namespace-0001" // namespaceName
)->AreaModel(
"area-0001" // areaModelName
);
const auto It = Domain->LayerModels(
);
for (auto Item : *It)
{
}
getLayerModel
エリアモデルを取得
Request
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | ✓ | | ~ 32文字 | ネームスペース名 |
areaModelName | string | ✓ | | ~ 128文字 | エリアモデル名 |
layerModelName | string | ✓ | | ~ 128文字 | レイヤーモデル名 |
Result
実装例
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
).AreaModel(
areaModelName: "area-0001"
).LayerModel(
layerModelName: "layer-0001"
);
var item = await domain.ModelAsync();
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
).AreaModel(
areaModelName: "area-0001"
).LayerModel(
layerModelName: "layer-0001"
);
var future = domain.Model();
yield return future;
var item = future.Result;
const auto Domain = Gs2->MegaField->Namespace(
"namespace-0001" // namespaceName
)->AreaModel(
"area-0001" // areaModelName
)->LayerModel(
"layer-0001" // layerModelName
);
const auto item = Domain.Model();
update
座標を送信
Request
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | ✓ | | ~ 32文字 | ネームスペース名 |
areaModelName | string | ✓ | | ~ 128文字 | エリア名 |
layerModelName | string | ✓ | | ~ 128文字 | レイヤー名 |
position | EzMyPosition | ✓ | | | 自分の位置情報 |
scopes | List<EzScope> | | | | 他プレイヤーの取得範囲リスト |
accessToken | string | ✓ | | ~ 128文字 | ユーザーID |
Result
実装例
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
).Me(
gameSession: GameSession
).Spatial(
areaModelName: "area-0001",
layerModelName: "layer-0001"
);
var result = await domain.UpdateAsync(
position: ,
scopes: null
);
var item = await result.ModelAsync();
var domain = gs2.MegaField.Namespace(
namespaceName: "namespace-0001"
).Me(
gameSession: GameSession
).Spatial(
areaModelName: "area-0001",
layerModelName: "layer-0001"
);
var future = domain.Update(
position: ,
scopes: null
);
yield return future;
if (future.Error != null)
{
onError.Invoke(future.Error, null);
yield break;
}
var future2 = future.Result.Model();
yield return future2;
if (future2.Error != null)
{
onError.Invoke(future2.Error, null);
yield break;
}
var result = future2.Result;
const auto Domain = Gs2->MegaField->Namespace(
"namespace-0001" // namespaceName
)->Me(
AccessToken
)->Spatial(
"area-0001", // areaModelName
"layer-0001" // layerModelName
);
const auto Future = Domain->Update(
,
nullptr // scopes
);
Future->StartSynchronousTask();
if (Future->GetTask().IsError())
{
return false;
}
// obtain changed values / result values
const auto Future2 = Future->GetTask().Result()->Model();
Future2->StartSynchronousTask();
if (!TestFalse(WHAT, Future2->GetTask().IsError())) return false;
const auto Result = Future2->GetTask().Result();