PropertyTweener
Configure a PropertyTweener command within a Tween sequence.
Obtain PropertyTweener through a valid Tween TweenProperty(); direct construction is invalid. The command is already appended to the parent. Configure before processing; fluent methods return the same wrapper rather than an independent copy.
The default origin is sampled at start; FromCurrent retains the command-creation value and From supplies one explicitly. CustomInterpolator receives already eased progress. AsRelative with delay and a changed origin has a reproduced stale-final defect; see AsRelative/SetDelay for conditions.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
PropertyTweenerConstructor
public PropertyTweener();Do not call new PropertyTweener(): its native constructor emits an error. Create through Tween.TweenProperty on a valid Tween; this is a sequence command rather than a standalone timer/animation.
Methods7
AsRelativePropertyTweener
public PropertyTweener AsRelative();Treats the TweenProperty value as an offset from the origin rather than an absolute target. Origin 2 plus offset 3 finishes at 5. Current SetDelay with automatic resampling of a changed origin is defective: delayed start updates the origin but retains the previously calculated final value. If the target changes during delay, do not assume new-origin+offset; use From/FromCurrent for a fixed origin.
PropertyTweenerThe same command object for configuration, not an independent copy. From can yield null for an invalid state/type.
FromPropertyTweener
public PropertyTweener From(Variant value);Fixes an explicit initial value and disables automatic property resampling at start. The type must match the final value. Does not immediately write that value into the object: a step performs the change. Tested with a target edited between setup and start.
| Name | Type | Default |
|---|---|---|
value | Variant | — |
valueFixed origin of a compatible Variant type, not an offset.
PropertyTweenerThe same command object for configuration, not an independent copy. From can yield null for an invalid state/type.
FromCurrentPropertyTweener
public PropertyTweener FromCurrent();Keeps the origin captured when PropertyTweener was created and disables later resampling. In 1.0.0 this call itself does not read the property again. After a target changes following TweenProperty, FromCurrent does not mean take its new value now. Pass an explicitly read value to From or create the command at the intended moment.
PropertyTweenerThe same command object for configuration, not an independent copy. From can yield null for an invalid state/type.
SetCustomInterpolatorPropertyTweener
public PropertyTweener SetCustomInterpolator(Callable interpolatorMethod);Sets a Callable taking one numeric progress argument and returning float/double (Variant.Float). Progress already passed through Transition/Ease; avoid unintentionally applying the same curve twice. The result is an interpolation weight rather than a property value, and this method does not clamp it to 0…1. The endpoint calls the function at 1: returning 0.5 ends halfway rather than forcing finalVal. Invalid callback types were not executed here.
| Name | Type | Default |
|---|---|---|
interpolatorMethod | Callable | — |
interpolatorMethodCallable: one numeric progress → float/double weight; not void or an integer result.
PropertyTweenerThe same command object for configuration, not an independent copy. From can yield null for an invalid state/type.
SetDelayPropertyTweener
public PropertyTweener SetDelay(double delay);Sets a pre-property delay in Tween seconds; interpolation then runs for duration. Default resampling reads the origin when crossing the delay; From/FromCurrent fix it earlier. With AsRelative, a changed delayed origin does not update the previously calculated final value, a reproduced 1.0.0 defect. Configure before starting; not a sleep or a setting for every command.
| Name | Type | Default |
|---|---|---|
delay | double | — |
delayNonnegative finite delay in Tween seconds.
PropertyTweenerThe same command object for configuration, not an independent copy. From can yield null for an invalid state/type.
SetEasePropertyTweener
public PropertyTweener SetEase(Tween.EaseType ease);Sets this command easing, overriding the parent default. Configure after factory creation and before processing. Changes neither duration nor neighboring commands.
| Name | Type | Default |
|---|---|---|
ease | Tween.EaseType | — |
easeValid EaseType for this command.
PropertyTweenerThe same command object for configuration, not an independent copy. From can yield null for an invalid state/type.
SetTransPropertyTweener
public PropertyTweener SetTrans(Tween.TransitionType trans);Sets this command transition. Overrides captured parent defaults here without changing neighbors. Quad with Ease.In at half duration was tested.
| Name | Type | Default |
|---|---|---|
trans | Tween.TransitionType | — |
transValid TransitionType for this command.
PropertyTweenerThe same command object for configuration, not an independent copy. From can yield null for an invalid state/type.