Enhanced Code Flow for Unreal Engine 4

This code plugin provides functions that drastically improve the quality of life during the implementation of game flow in C++.
It works very well with gameplay programming, UI programming with a lot of transitions or in any other situation.

Table of content

• Usage
• Extra Settings
• Instanced Actions
• Pausing and Resuming
• Stopping Actions
• Extending Plugin
• Special Thanks

Contact

If you have any question or suggestion regardles this plugin simply add an Issue to the github project or write an e-mail to me: zompi2@gmail.com I will try my best to answer it quickly :)

Changelog

The Changelog has been put into this file: Changelog.txt

IMPORTANT

Version 2.0.0 will probably break Blueprint nodes from previous versions. Update with caution!
Version 1.6.1 can be found on a separate branch here: Legacy-1.6

Example Project

The example project wich uses this plugin can be found in this repository. Example project is compatible with the newest version of the plugin only.

Usage

• Delay
• Add Ticker
• Wait And Execute
• While True Execute
• Add Timeline
• Add Custom Timeline
• Time Lock
• Do Once
• Do N Times

Run the following functions to use enhanced code flow!

Note that every function must receive a pointer to an owner that runs this function in it's first argument.
The owner must be able to return a World via GetWorld() function.

Delay

Execute specified action after some time. This can be useful in many various situations. Everytime when I was using a Delay node in blueprints I wish there was an equivalent of it in c++.

FFlow::Delay(this, 2.f, [this]()
{
  // Code to execute after 2 seconds.
});

An ECF-Delay BP node has few advantages over the built in Unreal's Delay node.
You can plan to execute delayed code without delaying the whole Blueprint, you can cancel the delayed code's execution or make the dilation game pause and time dilation independent.

Back to actions list
Back to top

Add Ticker

Creates a ticker. It can tick specified amount of time or until it won't be stopped or when owning object won't be destroyed.
Useful for actors and components that you don't want to be tickeable, but needs one tick to do something.

Run ticker for 10 seconds

FFlow::AddTicker(this, 10.f, [this](float DeltaTime)
{
  // Code to execute every tick
});

Run ticker for 10 seconds and run a callback when it finishes

FFlow::AddTicker(this, 10.f, [this](float DeltaTime)
{
  // Code to execute every tick
}, [this]()
{
  // Code to execute when ticker finishes ticking
});

Run ticker for infinite time and stop it when you want to

FFlow::AddTicker(this, [this](float DeltaTime, FECFHandle TickerHandle)
{
  // Code to execute in every tick.

  // Use this to stop the ticker
  FFlow::StopAction(this, TickerHandle);
});

Run ticker for infinite time and something else stops it

FECFHandle TickerHandle = FFlow::AddTicker(this, [this](float DeltaTime)
{
  // Code to execute in every tick.
});

// Use this to stop the ticker
FFlow::StopAction(this, TickerHandle);

Note 1: Tickers and every other plugin actions are impacted by global time dilation.
Note 2: You can check if the ticker (or any other action) is running using FFlow::IsActionRunning(TickerHandle)
Note 3: You can also run ticker infinitely by setting Ticking Time to -1

Back to actions list
Back to top

Wait and execute

Waits until specific conditions are met and then executes code.
The conditions are defined in a form of predicate.
Perfect solution if code needs a reference to an object, which spawn moment is not clearly defined, or if you can execute a specific code only when the game reaches a specific state.

FFlow::WaitAndExecute(this, [this]()
{
  // Write your own predicate. 
  // Return true when you want to execute the code below.
  return bIsReadyToUse;
},
[this]()
{
  // Implement code to execute when conditions are met.
});

BP version of this function uses a Predicate function which controls when the On Execution pin will execute.

Back to actions list
Back to top

While true execute

While the specified conditions are true tick the given code.
This one is useful when you want to write a loop that executes one run every tick until it finishes it's job.

FFlow::WhileTrueExecute(this, [this]()
{
  // Write your own predicate. 
  // Return true when you want this action to continue.
  return bIsRunning;
},
[this](float DeltaTime)
{
  // Implement code to tick when predicate returns true.
});

BP version of this function uses a Predicate function which controls when the On Execution pin with Delta Time will execute.

Back to actions list
Back to top

Add timeline

Easily launch the timeline and update your game based on them. Great solution for any kind of blends and transitions. The function requires the following parameters:

• StartValue - a value with which the timeline will begin;
• StopValue - a value with which the timeline will end. StopValue can be lesser than StartValue;
• Time - how long the timeline will work;
• TickFunc - a function that will tick with the timeline. It has the following arguments:
  • Value - a current value on this timeline;
  • Time - a time that passed on this timeline;
• CallbackFunc - a function that will run when the timeline comes to an end. Has the same arguments as TickFunc. This function is optional;
• BlendFunc - a function that describes a shape of the timeline:
  • Linear (default)
  • Cubic
  • EaseIn
  • EaseOut
  • EaseInOut
• BlendExp - an exponent defining a shape of EaseIn, EaseOut and EaseInOut function shapes. (default value: 1.f);

FFlow::AddTimeline(this, 0.f, 1.f, 2.f, [this](float Value, float Time)
{
  // Code to run every time the timeline tick
}, 
[this](float Value, float Time)
{
  // Code to run when timeline stops
}, 
EECFBlendFunc::ECFBlend_Linear, 2.f);

Back to actions list
Back to top

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.

FFlow::AddCustomTimeline(this, Curve, [this](float Value, float Time)
{
  // Code to run every time the timeline tick
}, 
[this](float Value, float Time)
{
  // Code to run when timeline stops
});

Back to actions list
Back to top

Time Lock

(Instanced)

Blocks execution of the block of code until the given time has passed.

static FECFInstanceId InstanceId = FECFInstanceId::NewId();
FFlow::TimeLock(this, 2.f, [this]()
{
  // This code will run now, and won't be able to execute for 2 seconds.
}, InstanceId);

BP version of this function requires InstanceId too. The best way to obtain it is to validate InstanceId handler. It will return a new InstanceId only if the one in the handler is not valid.

Back to actions list
Back to top

Do Once

(Instanced)

Allow to execute the given block of code only once.

static FECFInstanceId InstanceId = FECFInstanceId::NewId();
FFlow::DoOnce(this, [this]()
{
  // This code can be run only once.
}, InstanceId);

This function doesn't have a BP version, because Unreal has one already.

Back to actions list
Back to top

Do N Times

(Instanced)

Allow to execute the given block of code only given amount of times.

static FECFInstanceId InstanceId = FECFInstanceId::NewId();
FFlow::DoNTimes(this, 5, [this](int32 Counter)
{
  // This code can be run only 5 times.
}, InstanceId);

This function doesn't have a BP version, because Unreal has one already.

Back to actions list
Back to top

Extra settings

You can define extra settings at the end of each action launch. Currently the following actions are available:

• Time Intervals - defines the length of one tick.
• First Delay - defines when the first tick should be performed.
• Ignore Game Pause - it will ignore the game pause.
• Ignore Global Time Dilation - it will ignore global time dilation when ticking.
• Start Paused - the action will start in paused state and must be resumed manually.

FFlow::AddTicker(this, 10.f, [this](float DeltaTime)
{
  // Code to execute every 1 second for 10 seconds.
}, nullptr, FECFActionSettings(1.f, 0.f, false, false, false));

FFlow::AddTicker(this, 10.f, [this](float DeltaTime)
{
  // Code to execute every tick for 10 seconds 
  // while ignoring global time dilation.
}, nullptr, FECFActionSettings(0.f, 0.f, true, false, false));

FFlow::AddTicker(this, 10.f, [this](float DeltaTime)
{
  // Code to execute every 1 seconds for 10 seconds, 
  // after 5 seconds have passed, while ignoring 
  // global time dilation and pause.
}, nullptr, FECFActionSettings(1.f, 5.f, true, true, false));

To make defining these settings easier there are few macros that creates a settings structure with just one option:

• ECF_TICKINTERVAL(5.f) - settings which sets tick interval to 5 second
• ECF_DELAYFIRST(1.f) - settings which makes this action to run after 1 second delay
• ECF_IGNOREPAUSE - settings which makes this action ignore game pause
• ECF_IGNORETIMEDILATION - settings which makes this action ignore global time dilation
• ECF_IGNOREPAUSEDILATION - settings which makes this action ignore pause and global time dilation
• ECF_STARTPAUSED - settings which makes this action started in paused state

FFlow::Delay(this, 2.f, [this]()
{
  // Run this code after 2 seconds, while ignoring game pause.
}, ECF_IGNOREPAUSE);

Back to top

Instanced Actions

Some actions can be Instanced. Instanced action is an action that has valid FECFInstanceId. Such action can be executed only once.

As long as the action with given valid FECFInstanceId is running, no other action with the same FECFInstanceId can be executed.

Obtaining InstanceId

To get next valid InstanceId use the NewId() function

FECFInstanceId::NewId();

There is additional BP node which will validate an InstanceId if it is not valid.

Back to top

Pausing and Resuming

Actions

Every running action can be paused and resumed.

FFlow::PauseAction(GetWorld(), Handle); // Pause Action
FFlow::ResumeAction(GetWorld(), Handle); // Resume Action

// Checks if the Action is Running and if it is Paused or not
bool bIsPaused;
bool bIsRunning = FFlow::IsActionPaused(WorldContextObject, Handle, bIsPaused);

Subsystem

Whole Enhanced Code Subsystem can be paused and resumed as well.

FFlow::SetPause(GetWorld(), true); // Pauses the whole ECF Subsystem
FFlow::SetPause(GetWorld(), false); // Unpauses the whole ECF Subsystem
FFlow::GetPause(GetWorld()); // Check if the whole ECF Subsystem is paused or not

Back to top

Stopping actions

Every function described earlier can be checked if it's running and it can be stopped.

FFlow::IsActionRunning(GetWorld(), Handle); // <- is this action running?
FFlow::StopAction(GetWorld(), Handle); // <- stops this action!

You can also stop all of the actions from a specific owner or from everywhere.
Stopped actions can launch their completion callbacks or not, depending on the given argument:

FFlow::StopAllActions(GetWorld()); // <- stops all of the actions
FFlow::StopAllActions(GetWorld(), true); // <- stops all of the actions and launch their callbacks
FFlow::StopAllActions(GetWorld(), false, Owner); // <- stops all of the actions started from this specific owner

You can also stop a specific Instanced action with the FECFInstanceId:

FFlow::StopInstancedAction(GetWorld(), InstanceId); // <- stops all actions with this InstanceId
FFlow::StopInstancedAction(GetWorld(), InstanceId, true); // <- stops all actions with this InstanceId and launch their callbacks

You can also stop all of the specific actions. In this case you can also optionally specifiy an owner of this actions, or simply stop all of them. You can also specify if stopped actions should launch their completion callbacks or not.

FFlow::RemoveAllDelays(GetWorld());
FFlow::RemoveAllTickers(GetWorld());
FFlow::RemoveAllWaitAndExecutes(GetWorld());
FFlow::RemoveAllWhileTrueExecutes(GetWorld());
FFlow::RemoveAllTimelines(GetWorld());
FFlow::RemoveAllCustomTimelines(GetWorld());
FFlow::RemoveAllTimeLocks(GetWorld());

Back to top

Extending plugin

You have a source code of this plugin you can easily extend it's functionalities!

Check how other actions are made to easier understand how to extend the plugin.

1. Create a class that inherits from UECFActionBase
2. Implement Setup function, which accepts all parameters you want to pass to this action. Setup function must return true if the given parameters are valid.

bool Setup(int32 Param1, int32 Param2, TUniqueFunction<void()>&& Callback)
{
  CallbackFunc = MoveTemp(Callback);
  if (CallbackFunc) return true;
  return false;
}

Any callback must be passed as an r-value reference and be moved to the action's variable.

3. Override Init and Tick functions if needed.
4. If you want this action to be stopped while ticking - use MarkAsFinished() function.
5. If you want to launch a callback when this action is stopped by StopAction method with bComplete set to true - override Complete() function.
6. If this is an instanced action you can optionally override RetriggeredInstancedAction() function to add any logic that should be executed when the instanced action is called while already existing.
7. You can optionally run SetMaxActionTime in action's Init function to determine the maximum time in seconds this action should run.

IMMPORTANT! SetMaxActionTime is only to help ticker run ticks with proper delta times.
It will not stop the action itself!

8. In the FEnhancedCodeFlow class implement static function that launches the action using AddAction function. The function must receive a pointer to the launching UObject, FECFActionSettings, FECFInstanceId (use invalid one if the action shouldn't be instanced) and every other argument that is used in the action's Setup function in the same order. It must return FECFHandle.

FECFHandle FEnhancedCodeFlow::NewAction(UObject* InOwner, int32 Param1, int32 Param2, TUniqueFunction<void()>&& Call, const FECFActionSettings& Settings = {})
{
  if (UECFSubsystem* ECF = UECFSubsystem::Get(InOwner))
    return ECF->AddAction<UECFNewAction>(InOwner, Settings, FECFInstanceId(), Param1, Param2, MoveTemp(Call));
  else
    return FECFHandle();
}

It is done! Now you can run your own action:

FFlow::NewAction(this, 1, 2, [this]()
{
  // Callback code.
}, ECF_IGNOREPAUSE);

Back to top

Special thanks

I want to send special thanks to Monika, because she always supports me and believes in me, to Pawel, for allowing me to test this plugin on his project and to everyone that contributed to this project.
Also, I want to thank You for using this plugin! It is very important for me that my work is useful for someone!
Happy coding!

Back to top