Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
zompi2 committed Dec 15, 2024
1 parent 5fa32c2 commit e248e1f
Showing 1 changed file with 80 additions and 0 deletions.
80 changes: 80 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,11 @@ Check out the **[Example Project](https://github.com/zompi2/UE4EnhancedCodeFlowE
- [While True Execute](#while-true-execute)
- [Run Async Then](#run-async-then)
- [Add Timeline](#add-timeline)
- [Add Timeline Vector](#add-timeline-vector)
- [Add Timeline Linear Color](#add-timeline-linear-color)
- [Add Custom Timeline](#add-custom-timeline)
- [Add Custom Timeline Vector](#add-custom-timeline-vector)
- [Add Custom Timeline Linear Color](#add-custom-timeline-linear-color)
- [Time Lock](#time-lock)
- [Do Once](#do-once)
- [Do N Times](#do-n-times)
Expand Down Expand Up @@ -355,9 +359,45 @@ EECFBlendFunc::ECFBlend_Linear, 2.f);

![Timeline](https://user-images.githubusercontent.com/7863125/218276147-80928cc9-5455-4edd-bd7c-2f50ae819ca3.png)

#### Add timeline vector

The same as `Add timeline`, but with a Vector instead of float

``` cpp
FFlow::AddTimelineVector(this, FVector(0.f, 0.f, 0.f), FVector(1.f, 1.f, 1.f), 2.f, [this](FVector Value, float Time)
{
// Code to run every time the timeline tick
},
[this](FVector Value, float Time, bool bStopped)
{
// Code to run when timeline stops
},
EECFBlendFunc::ECFBlend_Linear, 2.f);
```
![tlvec](https://github.com/user-attachments/assets/a98d8352-1fab-43fb-a15d-2cd9b1fbe0bd)
[Back to actions list](#usage)
[Back to top](#table-of-content)
#### Add timeline linear color
The same as `Add timeline`, but with a LinearColor instead of float
``` cpp
FFlow::AddTimelineLinearColor(this, FLinearColor(0.f, 0.f, 0.f, 1.f), FLinearColor(1.f, 1.f, 1.f, 1.f), 2.f, [this](FLinearColor Value, float Time)
{
// Code to run every time the timeline tick
},
[this](FLinearColor Value, float Time, bool bStopped)
{
// Code to run when timeline stops
},
EECFBlendFunc::ECFBlend_Linear, 2.f);
```

![tllc](https://github.com/user-attachments/assets/9555d519-8894-4c7e-a207-e58278abf97e)

#### Add custom timeline

Creates a discrete timeline which shape is based on a **UCurveFloat**. Works like the previously described timeline, but an asset with a curve must be given.
Expand All @@ -378,6 +418,46 @@ FFlow::AddCustomTimeline(this, Curve, [this](float Value, float Time)
[Back to actions list](#usage)
[Back to top](#table-of-content)
#### Add custom timeline vector
The same as `Add custom timeline` but with **UCurveVector** instead of **UCurveFloat**.
``` cpp
FFlow::AddCustomTimelineVector(this, Curve, [this](FVector Value, float Time)
{
// Code to run every time the timeline tick
},
[this](FVector Value, float Time, bool bStopped)
{
// Code to run when timeline stops. bStopped argument is optional.
});
```

![ctlc](https://github.com/user-attachments/assets/08109d0f-112e-4664-ae4f-c5a7c59dedd4)

[Back to actions list](#usage)
[Back to top](#table-of-content)

#### Add custom timeline linear color

The same as `Add custom timeline` but with **UCurveLinearColor** instead of **UCurveFloat**.

``` cpp
FFlow::AddCustomTimelineLinearColor(this, Curve, [this](FLinearColor Value, float Time)
{
// Code to run every time the timeline tick
},
[this](FLinearColor Value, float Time, bool bStopped)
{
// Code to run when timeline stops. bStopped argument is optional.
});
```
![ctv](https://github.com/user-attachments/assets/e4b88d37-d3ee-4f5a-9b37-4f3ea83fe523)
[Back to actions list](#usage)
[Back to top](#table-of-content)
#### Time Lock
**(Instanced)**
Expand Down

0 comments on commit e248e1f

Please sign in to comment.