Play Tween Animation Action: Difference between revisions

From Pummel Party Mod Documentation
Jump to navigation Jump to search
(Initial content)
 
(Aded image)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
An action to move a gameobject using a simple, eased motion. This action is best used for one-time motions between two points, or rotations/scales between two values.
An action to move a gameobject using a simple, eased motion. This action is best used for one-time motions between two points, or rotations/scales between two values.


== Component Settings ==
== Action Settings ==
[[File:PlayTweenAnimationAction.png|thumb|600px|right|The Play Tween Animation action in the [[Action Editor]]. This example will move a cube up by 1 unit over 4 seconds with easing.]]
{| class="wikitable"
{| class="wikitable"
|-
|-
! Property !! Description
! Property !! Description
|-
| '''Target''' || The gameobject(s) that should be affected by this action.
|-
|-
| '''Type''' || The attribute of the gameobject to be animated. Can choose from ''Position'', ''Rotation'' and ''Scale''.
| '''Type''' || The attribute of the gameobject to be animated. Can choose from ''Position'', ''Rotation'' and ''Scale''.
Line 12: Line 15:
| '''Time''' || How long should the animation take, in seconds.
| '''Time''' || How long should the animation take, in seconds.
|-
|-
| '''Start Type''' || The position/rotation/scale at the start of the animation. ''Current'' uses the object's current value. ''Specific'' allows a specific value to be entered and used. ''Offset'' uses the current value with an offset applied.  
| '''Start Type''' || The position/rotation/scale at the start of the animation.  
''Current'' uses the object's current value.  
''Specific'' allows a specific value to be entered and used.  
''Offset'' uses the current value with an offset applied.  
|-
|-
| '''End Type''' || The position/rotation/scale at the end of the animation.
| '''End Type''' || The position/rotation/scale at the end of the animation.
''Current'' uses the object's current value.
''Specific'' allows a specific value to be entered and used.
''Offset'' uses the current value with an offset applied.  
|-
|-
|}
|}


[[Category:Actions]]
[[Category:Actions]]

Latest revision as of 00:26, 7 December 2022

An action to move a gameobject using a simple, eased motion. This action is best used for one-time motions between two points, or rotations/scales between two values.

Action Settings

The Play Tween Animation action in the Action Editor. This example will move a cube up by 1 unit over 4 seconds with easing.
Property Description
Target The gameobject(s) that should be affected by this action.
Type The attribute of the gameobject to be animated. Can choose from Position, Rotation and Scale.
Ease Type What type of easing should the motion use. This affects the speed of the motion over time. Linear appears rigid with constant animation while the ease in/out options will slow the animation at the start/end of the animation.
Time How long should the animation take, in seconds.
Start Type The position/rotation/scale at the start of the animation.

Current uses the object's current value. Specific allows a specific value to be entered and used. Offset uses the current value with an offset applied.

End Type The position/rotation/scale at the end of the animation.

Current uses the object's current value. Specific allows a specific value to be entered and used. Offset uses the current value with an offset applied.