本文へスキップ

地図

説明​

このコンポーネントは全体的なマップ構成を表す。

名称タイプデフォルト説明
ラチチュード番号37.7955281地図の中心の緯度
経度番号-122.3934225地図の中心の経度
半径番号500地図ビューの半径（メートル単位
スポーンロケーションブーリアン擬似有効な場合、マップポイントはVPSが起動したすべての場所でスポーンする。
ユースGPSブーリアン真の有効にすると、マップはGPSをポーリングし、実行時に自動的に緯度と経度を更新します。

機能​

Get​

Returns a read-only reference.

Example

ecs.Map.get(world, component.eid)

Set​

Ensures the component exists on the entity, then assigns the (optional) data to the component.

Example

ecs.Map.set(world, component.eid, {
  latitude: 37.7955281,
  longitude: -122.3934225,
  radius: 500,
  spawnLocations: false,
  useGPS: true
})

Mutate​

Perform an update to the component within a callback function. Return true to indicate no changes made.

Example

ecs.Map.mutate(world, component.eid, (cursor) => {
  cursor.latitude = 37.4419;
  cursor.longitude = -122.1430;
  return false;
})

Remove​

Removes the component from the entity.

Example

ecs.Map.remove(world, component.eid)

Has​

Returns true if the component is present on the entity.

Example

ecs.Map.has(world, component.eid)

Reset​

Adds, or resets the component to its default state.

Example

ecs.Map.reset(world, component.eid)

Advanced Functions​

Cursor​

Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.

Example
ecs.Map.cursor(world, component.eid)

Acquire​

Same behavior as cursor, but commit must be called after the cursor is done being used.

Example
ecs.Map.acquire(world, component.eid)

Commit​

Called after acquire. An optional third argument determines whether the cursor was mutated or not.

Example
ecs.Map.commit(world, component.eid)
ecs.Map.commit(world, component.eid, false)

Dirty​

Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.

Example
ecs.Map.dirty(world, component.eid)