Component:Tween: Difference between revisions

From Resonite Wiki
imported>AshtonSparx
 
Add most info
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=TweenComponent.png
|Image=TweenComponent.png
|Name=Tween<t>
|Name=Tween<t>
}}
}}
The '''Tween''' component is usually auto generated by [[ProtoFlux]] or by holding an object and hitting primary to align the object. The purpose of this component is to handle transitions in a value to value manner and only exists temporarily. This is not used for animations, only for a transition from one value to another. For animations, see either [[Component:ValueGradientDriver]] or [[Component:Animator]]


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|User|User|
|User|User| The user handling the processing for this component.
|Target|User|
|Target|'''[[Type:IField`1|IField`1]]&lt;T&gt;'''|TypeAdv1=true| The field to drive and Tween.
|OnlyUnderParent|Slot|
|OnlyUnderParent|Slot|
|StartTime|Float|
|From|'''T'''|TypeAdv3=true| The value to start at
|Duration|Float|
|To|'''T'''|TypeAdv4=true| The value to end at.
|Curve|CurvePreset|
|StartTime|Double| The world time this Tween should start. Usually is creation time.
|LocalCallback|Bool|
|Duration|Float| How long from <code>StartTime</code> the Tween should go for.
|OnDone|Delegate|
|Curve|CurvePreset| How <code>Target</code> should transition from <code>From</code> to <code>To</code>. See [[Type:CurvePreset|CurvePreset]]
|LocalCallback|Bool| Whether the Callback should be executed by <code>User</code>
|OnDone|{{RootFieldType|SyncDelegate`1|[[Type:Action|Action]]}}|TypeAdv9=true| The Sync Method to call when this is done tweening.
}}
}}


== Usage ==
== Usage ==
Users should not use this directly, and instead use [[ProtoFlux]] to Invoke this component's behavior.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Simple Keyboard Movement]]
[[Category:Components{{#translation:}}|Tween`1]]
[[Category:Components:Input:Controls{{#translation:}}|Simple Keyboard Movement]]
[[Category:Components:Uncategorized{{#translation:}}|Tween`1]]
[[Category:Generic Components{{#translation:}}|Tween`1]]

Latest revision as of 23:19, 10 November 2024

Component image 
Tween<t> component as seen in the Scene Inspector

The Tween component is usually auto generated by ProtoFlux or by holding an object and hitting primary to align the object. The purpose of this component is to handle transitions in a value to value manner and only exists temporarily. This is not used for animations, only for a transition from one value to another. For animations, see either Component:ValueGradientDriver or Component:Animator

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
User User The user handling the processing for this component.
Target IField`1<T> The field to drive and Tween.
OnlyUnderParent Slot
From T The value to start at
To T The value to end at.
StartTime Double The world time this Tween should start. Usually is creation time.
Duration Float How long from StartTime the Tween should go for.
Curve CurvePreset How Target should transition from From to To. See CurvePreset
LocalCallback Bool Whether the Callback should be executed by User
OnDone Action The Sync Method to call when this is done tweening.

Usage

Users should not use this directly, and instead use ProtoFlux to Invoke this component's behavior.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


See Also