Collider

Description

Ce composant établit un collisionneur physique sur une entité.

ColliderShape

Type	Description
Boîte	Boîte
Sphère	Sphère
Avion	Avion
Capsule	Capsule
Cône	Cône
Cylindre	Cylindre

Propriétés

Nom	Type	Défaut	Description
forme (obligatoire)	ecs.ColliderShape	ecs.ColliderShape.Box	Les types pris en charge sont disponibles dans ecs.ColliderShape
largeur	nombre	0	Largeur de la boîte ou du plan.
hauteur	nombre	0	Hauteur d'une boîte, d'un plan, d'une capsule, d'un cône ou d'un cylindre.
profondeur	nombre	0	Profondeur de la forme de la boîte.
rayon	nombre	0	Rayon des sphères, des capsules, des cônes ou des cylindres.
masse	nombre	0	Masse de l'entité. Laisser 0 pour rendre statique
eventOnly	booléen	faux	L'objet doit-il uniquement envoyer des événements de collision et ne pas réagir physiquement ?
gravityFactory	nombre	1	Facteur de mise à l'échelle Gravité mondiale
lockXAxis	booléen	faux	Désactive la rotation sur l'axe X
lockYAxis	booléen	faux	Désactive la rotation sur l'axe Y
verrouZAxis	booléen	faux	Désactive la rotation sur l'axe Z
friction	nombre	0.5	L'importance du frottement de contact sur l'entité
restitution	nombre	0	Le dynamisme de l'entité
amortissement linéaire	nombre	0	La résistance de l'air lors d'un déplacement
amortissement angulaire	nombre	0	La résistance de l'air lors de la rotation
friction d'essorage	nombre	0	L'importance de la friction sur l'entité pendant la rotation

Fonctions

Get

Returns a read-only reference.

Example

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

Set

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

Example

ecs.Collider.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.Collider.mutate(world, component.eid, (cursor) => {
  cursor.mass = 5;
  cursor.friction = 0.8;
  return false;
})

Remove

Removes the component from the entity.

Example

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

Has

Returns true if the component is present on the entity.

Example

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

Reset

Adds, or resets the component to its default state.

Example

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

Acquire

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

Example

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

Commit

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

Example

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