Skip to content

Commit ae2a626

Browse files
committed
Update README.md
1 parent 7d76728 commit ae2a626

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The plugin contains:
3737

3838
A scene component which rotates along the chosen axis.
3939

40-
#### Parameters
40+
#### Variables
4141

4242
1. `RotateX` - toggle rotation along the X axis;
4343
2. `RotateY` - toggle rotation along the Y axis;
@@ -52,7 +52,7 @@ A scene component which rotates along the chosen axis.
5252

5353
A scene component which create oscillation animation for location, rotation and scale.
5454

55-
#### Parameters
55+
#### Variables
5656

5757
1. `IsEnable` - toggles all the animations;
5858
2. For location, rotation, scale:
@@ -70,7 +70,7 @@ A scene component which create oscillation animation for location, rotation and
7070

7171
An actor component which moves the actor towards a target using interpolation functions.
7272

73-
#### Parameters
73+
#### Variables
7474

7575
1. `IsEnabled` - toggles the easing animation;
7676
2. `FollowActor` - switches between using location from a target actor or a specific world location.
@@ -97,12 +97,13 @@ An actor component which animates transforms of the chosen scene components of a
9797
4. Create or use the existing curve float object for the `AnimationCurve` variable;
9898
5. Setup animation behavior in blueprints;
9999

100-
#### Parameters
100+
#### Variables
101101

102102
1. `InitialState` - the initial state of the animation on begin play;
103103
2. `AnimationTime` - the length of the animation;
104104
3. `AnimationCurve` - a float curve object used by the timeline component for the animation. It's better to use a curve with length equal 1.f;
105-
4. `TransformOffsets` - an array with transform offsets for each scene component in the AnimatedComponents array. The number of offsets must be equal to the number of animated components;
105+
4. `AnimateWholeActor` - if true, the whole actor will be animated. Doesn't require call of `SetAnimatedComponents`;
106+
5. `TransformOffsets` - an array with transform offsets for each scene component in the AnimatedComponents array. The number of offsets must be equal to the number of animated components;
106107

107108
#### Functions
108109

@@ -112,6 +113,7 @@ An actor component which animates transforms of the chosen scene components of a
112113
4. `Resume` - resumes the animation;
113114
5. `SetAnimatedComponents` - fills the Animated components array with the chosen scene components. It'll omit nullptr entries;
114115
6. `CanPlayAnimation` - returns if the animation can be played or not;
116+
7. `GetAnimationProgress` - returns progress of the animation;
115117

116118
### SplineAnimationComponent
117119

@@ -125,7 +127,7 @@ An actor component which moves an actor along a spline component using a timelin
125127
4. Choose an actor with a spline component as `TargetActor`;
126128
5. Setup animation behavior in blueprints if needed;
127129

128-
#### Parameters
130+
#### Variables
129131

130132
1. `AnimationMode` - a mode which determines how the animation will work;
131133
2. `SplineActor` - an actor which contains a spline component;

0 commit comments

Comments
 (0)