Target: target component.
If true, destroys the tweening entity (not the target entity) when the tweening operation ends.
Duration of tween, in seconds.
True if the tween has stopped playing (t>duration). Never true if looping is continuous. You can use the Watcher module to watch this, and trigger a calback when the tween is finished playing.
The tweening function to use, as defined in the TweenFunc enum.
The looping behavior to use.
Number of times the tween has looped. You can use the Watcher module to watch this, and trigger a calback every loop.
Target: offset in the component. This is the field offset into the component memory, in bytes. This offset is set automatically when using JS or TS generic addTween functions. Internally, it is retrieved from the ComponentType.FieldName.$o prototype value. For example TransformLocalPosition.position.y.$o has an offset of 4: The second float value inside the TransformLocalPosition component.
True if the tween has started playing (t>0) This can be watched using the Watcher module.
Current time of tween, in seconds. Negative if the tween has not started.
Target: target entity.
Generated using TypeDoc
An active tween. The addTween functions on TweenService create an entity with the TweenComponent on it. Once the tween is created, you can use callbacks in the Watcher module to watch for the current state of the tweening operation.
Most of this component's fields are copied from TweenDesc when you use TweenService::addTween to add a new tween.
You can dynamically change values inside the TweenComponent at any time.