CustomPropertyAnimation

Description

This component creates an animation on an entity.

Properties

Property	Type	Default	Description
attribute	string	''	Selected attribute to animate (e.g. position, scale, material)
property	string	''	Individual property to animate (e.g. x, y, or z for a vector attribute)
target	eid	undefined	The target object to animate. If not specified, the animation is run on the object that the component is attached to.
from	object	undefined	The starting state of the animation
to	object	undefined	The ending state of the animation
autoFrom	boolean	false	If enabled, ignore 'from' property and animate from the state of the object at the start of the animation.
duration	number	0	Length of time that the animation runs in milliseconds.
loop	boolean	false	If enabled, repeat the animation.
reverse	boolean	false	Whether to play in reverse, if loop set.
easeIn	boolean	false	If enabled, easing function will be applied over time instead of straight interpolation
easeOut	boolean	false	If enabled, easing function will be applied over time instead of straight interpolation
easingFunction	string	''	Choose from Quadratic (default), Cubic, Quartic, Quintic, Sinusoidal, Exponential, Circular, Elastic, Back, and Bounce

Functions

Get

Returns a read-only reference.

Example

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

Set

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

Example

ecs.CustomPropertyAnimation.set(world, component.eid, {
  attribute: 'attribute',
  property: 'property',
  from: {
    x: 0,
    y: 0,
    z: 0
 },
  to: {
    x: 10,
    y: 10,
    z: 10
 },
  autoFrom: false,
  duration: 1000,
  loop: false,
  reverse: false,
  easeIn: false,
  easeOut: false,
  easingFunction: 'Cubic'
})

Mutate

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

Example

ecs.CustomPropertyAnimation.mutate(world, component.eid, (cursor) => {
  cursor.duration = 1000;
  cursor.loop = true;
  return false;
})

Remove

Removes the component from the entity.

Example

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

Has

Returns true if the component is present on the entity.

Example

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

Reset

Adds, or resets the component to its default state.

Example

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

Acquire

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

Example

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

Commit

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

Example

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