Ir al contenido principal

Mapa

Descripción​

Este componente representa la configuración general del mapa.

NombreTipoPor defectoDescripción
latitudnúmero37.7955281La latitud del centro del mapa
longitudnúmero-122.3934225Longitud del centro del mapa
radionúmero500El radio de la vista del mapa, en metros
spawnLocationsbooleanofalsoSi se activa, los puntos de mapa aparecerán en cada ubicación activada por VPS.
useGPSbooleanoverdaderoSi se activa, el mapa sondeará el GPS y actualizará la latitud y longitud automáticamente en tiempo de ejecución.

Funciones​

Get​

Returns a read-only reference.

Example

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

Set​

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

Example

ecs.Mapa.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.Mapa.mutate(world, component.eid, (cursor) => {
  cursor.latitud = 37,4419;
  cursor.longitud = -122,1430;
  return false;
})

Remove​

Removes the component from the entity.

Example

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

Has​

Returns true if the component is present on the entity.

Example

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

Reset​

Adds, or resets the component to its default state.

Example

ecs.Mapa.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.Mapa.cursor(world, component.eid)

Acquire​

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

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

Commit​

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

Example
ecs.Mapa.commit(world, component.eid)
ecs.Mapa.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.Mapa.dirty(world, component.eid)