|
deki-tween 1.3.0
Deki package reference
|
Animation tweening with 30+ easing functions
Repository: github.com/dekiengine/deki-tween · Latest release: 1.1.0 · Needs engine 1.2.0+
Install: DekiEditor --packages-add deki-tween <project>, or add it in the Package Manager. Part of Deki; the engine's own components and the C++ API are documented there.
Shown in the editor as Tween.
| Component | Category | Description |
|---|---|---|
| TweenComponent | Animation | Animates the object's position, scale or rotation along an easing curve. |
Compile-time features the package exposes (package.json):
| Feature | Define | Default |
|---|---|---|
| Tween | DEKI_FEATURE_TWEEN | on |
Animates the object's position, scale or rotation along an easing curve.
Inspector name: Tween Component · Category: Animation · Type GUID: 9e113121-59df-4786-9752-0099935f1378
| Property | Type | Default | Constraints | Description |
|---|---|---|---|---|
| targetType | enum | Position | Position, Scale, Rotation | |
| endValue | Vector3 | [0.0, 0.0, 0.0] | ||
| duration | float | 1 | 0.1 to 10 (slider) | |
| delay | float | 0 | 0 to 5 (slider) | |
| easeType | enum | Linear | Linear, SineIn, SineOut, SineInOut, QuadIn, QuadOut, QuadInOut, CubicIn, CubicOut, CubicInOut, QuartIn, QuartOut, QuartInOut, QuintIn, QuintOut, QuintInOut, ExpoIn, ExpoOut, ExpoInOut, CircIn, CircOut, CircInOut, BackIn, BackOut, BackInOut, ElasticIn, ElasticOut, ElasticInOut, BounceIn, BounceOut, BounceInOut | |
| loops | int32 | 0 | -1 to 100 | |
| pingPong | bool | false | ||
| autoPlay | bool | true | ||
| relative | bool | false |
Generated from the package's reflection metadata by the Deki documentation build (engine 1.3.0). Reflected property names are the keys scene files use; a rename ships with an alias, see COMPATIBILITY.md.