Animation tweening with 30+ easing functions
Repository: github.com/dekiengine/deki-tween · Latest release: 0.19.0 · Needs engine 0.19.0+
Install with DekiEditor --packages-add deki-tween <project>, or from the Package Manager. The engine's own components and C++ API are in the Deki docs.
Shown in the editor as Tween.
Components
| Component | Category | Description |
|---|---|---|
| TweenComponent | Animation | Animates the object's position, scale or rotation along an easing curve. |
Feature flags
Parts you can leave out of a build. A feature with a define is switched there; the rest are stripped with their components.
| Feature | Define | Default |
|---|---|---|
| Tween | DEKI_FEATURE_TWEEN | on |
Component reference
TweenComponent
Animates the object's position, scale or rotation along an easing curve.
Inspector name: Tween Component · Category: Animation · Type: DekiTween::TweenComponent
| Property | Type | Default | Constraints | Description |
|---|---|---|---|---|
| targetType | enum | "Position" | Position, Scale, Rotation | Which property of the object is animated: position, scale, rotation or colour. |
| endValue | Vector3 | [0.0, 0.0, 0.0] | The value to arrive at. Which parts are used depends on the target above. | |
| duration | float | 1 | 0.1 to 10 (slider) | How long one pass takes, in seconds. |
| delay | float | 0 | 0 to 5 (slider) | Wait this long, in seconds, before starting. |
| 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 | The shape of the motion. Linear is mechanical; ease-in-out starts and ends gently, which reads as natural for almost everything. |
| loops | int32 | 0 | -1 to 100 | How many times to run. 0 runs once, -1 repeats forever. |
| pingPong | bool | false | Run the tween backwards on alternate passes instead of jumping back to the start. | |
| autoPlay | bool | true | Start as soon as the object comes alive. Off, something has to start it. | |
| relative | bool | false | Treat the end value as an offset from where the object already is, rather than an absolute destination. |
Changelog
0.19.0
Changed
- minEngine 0.19.0: built against engine 0.19.0, whose component metadata records the package each class is in. A build of this package from before does not load and is rebuilt.
Added
- Japanese, Simplified Chinese and Korean: editor/lang/ja.json, zh.json and ko.json translate the names, tooltips and enum values this package's components show in the Inspector.
- The package's editor text goes through the editor's translation (Tr), so it shows in the editor's language. Needs the editor release that adds Localization.h; raise minEngine to it when releasing.
0.18.0
Changed
- minEngine 0.18.0. Reflection ABI 21: the package must be rebuilt.
- Names follow the code style (deki-engine/docs/codestyle): types, functions and enum values are PascalCase, constants kPascalCase, members m_PascalCase, locals and parameters camelCase. The code is formatted with clang-format 22.
- The functions the editor finds by name are PascalCase: DekiTweenRegisterComponents, DekiTweenGetAutoComponentCount, DekiTweenEnsureRegistered and the rest. Built against engine ABI 21; a build of this package from before does not load and is rebuilt.
- Renamed: on_complete and on_update are onComplete and onUpdate; EaseType::COUNT is Count.
Removed
- The former names from before 0.16.0 (bare class names, and deki-gpio's DekiEsp32::ESP32PinSetup). A scene that old is upgraded with 0.17 first.
Earlier releases: CHANGELOG.md.
Generated from the package's reflection data (engine 0.19.0). Property names are the keys used in scene files. Renames keep an alias (compatibility).
