Passer au contenu principal

SuivreAnimation

Description

Ce composant crée une animation sur une entité.

Propriétés

PropriétéTypeDéfautDescription
cibleeidindéfiniL'objet cible à animer. Si elle n'est pas spécifiée, l'animation est exécutée sur l'objet auquel le composant est attaché.
minDistancenombre0Distance minimale à maintenir lors du suivi (en mètres).
maxDistancenombre0Distance maximale à maintenir lors du suivi (en mètres).
élasticiténombre1Proportion de la distance à parcourir (par seconde) lorsque la cible se trouve en dehors de la distance min/max (0 ne bouge jamais, 1 est instantané)

Fonctions

Get

Returns a read-only reference.

Example

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

Set

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

Example

ecs.FollowAnimation.set(world, component.eid, {
minDistance: 0,
maxDistance: 0,
elasticity: 1
})

Mutate

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

Example

ecs.FollowAnimation.mutate(world, component.eid, (cursor) => {
cursor.minDistance = 5;
cursor.elasticity = 0.5;
return false;
})

Remove

Removes the component from the entity.

Example

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

Has

Returns true if the component is present on the entity.

Example

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

Reset

Adds, or resets the component to its default state.

Example

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

Acquire

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

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

Commit

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

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