Colisionador

Descripción

Este componente establece un colisionador de física en una entidad.

ColliderShape

Tipo	Descripción
Caja	Caja
Esfera	Esfera
Plano	Plano
Cápsula	Cápsula
Cono	Cono
Cilindro	Cilindro

Propiedades

Nombre	Tipo	Por defecto	Descripción
shape (Obligatorio)	ecs.ColliderShape	ecs.ColliderShape.Box	Los tipos admitidos están disponibles en ecs.ColliderShape
anchura	número	0	Anchura de las formas Caja o Plano.
altura	número	0	Altura de las formas Caja, Plano, Cápsula, Cono o Cilindro.
profundidad	número	0	Profundidad de la forma de la caja.
radio	número	0	Radio de las formas Esfera, Cápsula, Cono o Cilindro.
masa	número	0	Masa de la entidad. Deje 0 para hacer estática
eventOnly	booleano	falso	¿Debe el objeto sólo enviar eventos de colisión, y no responder físicamente
gravityFactory	número	1	Factor de escala Gravedad mundial
lockXAxis	booleano	falso	Desactiva la rotación en el eje X
lockYAxis	booleano	falso	Desactiva la rotación en el eje Y
lockZAxis	booleano	falso	Desactiva la rotación en el eje Z
fricción	número	0.5	La cantidad de fricción de contacto en la entidad
restitución	número	0	El rebote de la entidad
linearDamping	número	0	La resistencia del aire en movimiento
angularDamping	número	0	La resistencia del aire al girar
spinningFriction	número	0	La cantidad de fricción de la entidad al girar

Funciones

Get

Returns a read-only reference.

Example

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

Set

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

Example

ecs.Colisionador.set(world, component.eid, {
  shape: 'ecs.ColliderShape.Box',
  width: 0,
  height: 0,
  depth: 0,
  radius: 0,
  mass: 0,
  eventOnly: false,
  gravityFactory: 1,
  lockXAxis: false,
  lockYAxis: false,
  lockZAxis: false,
  friction: 0.5,
  restitution: 0,
  linearDamping: 0,
  angularDamping: 0,
  spinningFriction: 0
})

Mutate

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

Example

ecs.Colisionador.mutate(world, component.eid, (cursor) => {
  cursor.masa = 5;
  cursor.fricción = 0,8;
  return false;
})

Remove

Removes the component from the entity.

Example

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

Has

Returns true if the component is present on the entity.

Example

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

Reset

Adds, or resets the component to its default state.

Example

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

Acquire

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

Example

ecs.Colisionador.acquire(world, component.eid)

Commit

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

Example

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