Skip to content

Kiln API / kiln / TweenOptions

Interface: TweenOptions ​

Properties ​

PropertyTypeDescription
duration?numberSeconds per run. Default 0.3.
ease?EasingAn ease name or a function of 0..1. Default 'outQuad'.
delay?numberSeconds before it starts. Start values are read when it starts. Default 0.
repeat?numberExtra runs after the first; -1 repeats forever. Default 0.
yoyo?booleanAlternate direction on each repeat (there and back). Default false.
from?Record<string, number>Start values instead of the current ones, written when the tween starts.
tag?stringA label carried by TweenDone so readers can tell tweens apart. Default ''.
despawn?booleanDespawn the entity when the tween (and anything chained with .then) finishes. Default false.