Skip to content
This repository was archived by the owner on May 25, 2025. It is now read-only.

Commit cc15780

Browse files
committed
Update README.md
1 parent cf357ae commit cc15780

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,32 @@
22

33
A collection of blueprint function libraries.
44

5+
## Installation
6+
7+
The plugin can be used in both C++ and Blueprint projects.
8+
9+
### Blueprint projects
10+
11+
**At the moment, the package is compatible only with Unreal Engine 4.**
12+
13+
1. Download [**package file**](https://github.com/TrickyFatCat/TrickyFunctionLibrary/releases/tag/v1.0);
14+
2. Unzip the package to the Plugins folder in engine folder, e.g. `C:\Program Files\Epic Games\UE_4.27\Engine\Plugins`;
15+
3. Restart the project;
16+
17+
In this case the plugin can be used for any blueprint project.
18+
19+
### C++ projects
20+
21+
1. Create the Plugins folder in the project directory;
22+
2. Create the TrickyAnimationComponents folder in the Plugins folder;
23+
3. Download the plugin source code into that folder;
24+
4. Rebuild the project;
25+
26+
## Functions
27+
28+
1. `ConvertTimeSeconds` - converts given time in seconds to different time formats;
29+
2. `SetTimelineRateToTime` - sets timeline play rate to play as long as target time;
30+
3. `GetPlayerCharacterViewPoint` - returns player characters viewpoint location and rotation;
31+
4. `ApproachInt32` - changes the given int32 variable by a given delta value up to a target value.
32+
5. `ApproachFloat` - changes the given float variable by a given delta value up to a target value.
33+
4. `ApproachInt32` - changes the given vector variable by a given delta value up to a target value.

0 commit comments

Comments
 (0)