Component:ScaleTransition: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Scale Transition
|Name=Scale Transition
}}
}}
{{stub}}
The '''ScaleTransition''' component makes a slot scale from one scale state to another, disabling when fully reaching its disabled scale point. The component's scale transition state is controlled via <code>ShowField</code>.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ShowField|Bool|
|ShowField|Bool| Whether to be transitioning to hidden (false) or shown (true)
|TransitionTimeField|Float|
|TransitionTimeField|Float| How long the transition to shown or hidden should take.
|ShowScaleField|Float3|
|ShowScaleField|Float3| What scale the object should transition to from <code>HiddenScaleField</code> when <code>ShowField</code> is true.
|HiddenScaleField|Float3|
|HiddenScaleField|Float3| What scale the object should transition to from <code>ShowScaleField</code> when <code>ShowField</code> is false.
|CurveField|CurvePreset|
|CurveField|CurvePreset| How the object should transition scale over time.
|_scaleDrive|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv5=true|
|_scaleDrive|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv5=true| The field to drive to make this slot scale up and down. Usually the slot's scale field.
|_enabledDrive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv6=true|
|_enabledDrive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv6=true| The field to drive to false when the object is done scaling to hidden and drive to true when transitioning away from hidden.
}}
}}


== Behavior ==
== Usage ==
Attach to a slot and provide values to the proper fields. When <code>ShowField</code> is toggled, the scale and enabled fields of the component will do a little animation.


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
* [[Component:Tween]]


[[Category:Components:Transform:Drivers{{#translation:}}|Scale Transition]]
[[Category:Components:Transform:Drivers{{#translation:}}|Scale Transition]]
[[Category:Components{{#translation:}}|Scale Transition]]
[[Category:Components{{#translation:}}|Scale Transition]]
[[Category:ComponentStubs]]

Latest revision as of 17:39, 2 February 2025

Component image 
Scale Transition component as seen in the Scene Inspector

The ScaleTransition component makes a slot scale from one scale state to another, disabling when fully reaching its disabled scale point. The component's scale transition state is controlled via ShowField.

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. Some components stop their functionality when this field is disabled, but some don't.
ShowField Bool Whether to be transitioning to hidden (false) or shown (true)
TransitionTimeField Float How long the transition to shown or hidden should take.
ShowScaleField Float3 What scale the object should transition to from HiddenScaleField when ShowField is true.
HiddenScaleField Float3 What scale the object should transition to from ShowScaleField when ShowField is false.
CurveField CurvePreset How the object should transition scale over time.
_scaleDrive field drive of Float3 The field to drive to make this slot scale up and down. Usually the slot's scale field.
_enabledDrive field drive of Bool The field to drive to false when the object is done scaling to hidden and drive to true when transitioning away from hidden.

Usage

Attach to a slot and provide values to the proper fields. When ShowField is toggled, the scale and enabled fields of the component will do a little animation.

Examples

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


See Also