本文へスキップ

カスタムプロパティアニメーション

説明​

このコンポーネントは、エンティティにアニメーションを作成します。

プロパティ​

プロパティタイプデフォルト説明
attributestring''Selected attribute to animate (e.g. position, scale, material)
propertystring''Individual property to animate (e.g. x, y, or z for a vector attribute)
targeteidundefinedThe target object to animate. If not specified, the animation is run on the object that the component is attached to.
fromnumber0The starting state of the animation
tonumber0The ending state of the animation
autoFrombooleanfalseIf enabled, ignore 'from' property and animate from the state of the object at the start of the animation
durationnumber1000Length of time that the animation runs in milliseconds
loopbooleantrueIf enabled, repeat the animation
reversebooleanfalseWhether to play in reverse, if loop set
easeInbooleanfalseIf enabled, easing function will be applied over time instead of straight interpolation
easeOutbooleanfalseIf enabled, easing function will be applied over time instead of straight interpolation
easingFunctionstring''Allowed values: 'Quadratic', 'Cubic', 'Quartic', 'Quintic', 'Sinusoidal', 'Exponential', 'Circular', 'Elastic', 'Back', 'Bounce'

機能​

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: 0,
  to: 0,
  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)