FRenderGridGenericExecutionQueue | Unreal Engine 5.2 Documentation

Inheritance Hierarchy


Module	RenderGrid
Header	/Engine/Plugins/Experimental/RenderGrid/Source/RenderGrid/Public/Utils/RenderGridGenericExecutionQueue.h
Include	#include "Utils/RenderGridGenericExecutionQueue.h"

class FRenderGridGenericExecutionQueue :  
    public TSharedFromThis< FRenderGridGenericExecutionQueue >,  
    public FTickableGameObject

This class provides generic queue support, with built-in support for delays between actions.

Type	Name	Description
bool	bExecuting	Whether it's currently executing a delay or an entry (action).
bool	bRunning	Whether it has started (and hasn't been stopped/paused yet).
int64	DelayRemainingFrames	The number of frames the current delay has to wait for.
TSharedFuture< void >	DelayRemainingFuture	The TFuture it's waiting for (if any).
TSharedFuture< FRenderGridGenericExecutionQueueDelay >	DelayRemainingFutureReturningDelay	The TFuture it's waiting for (if any), that can return a delay.
double	DelayRemainingSeconds	The number of seconds the current delay has to wait for.
TDoubleLinkedList< FRenderGridGenericExecutionQueueDelay >	QueuedDelays	The queued up delays.
TDoubleLinkedList< FRenderGridGenericExecutionQueueEntry >	QueuedEntries	The queued up entries (actions).

Type	Name	Description
void	Add ( const FRenderGridGenericExecutionQueueEntry& Entry )	Queues the given action.
void	Delay ( const FRenderGridGenericExecutionQueueDelay& Delay )	Queues the given delay.
void	DelayFrames ( const int64 Frames )	Queues the given delay, which will wait for the given number of frames.
void	DelayFramesOrSeconds ( const int64 Frames, const double Seconds )	Queues the given delay, which will wait for the given number of frames or seconds, whatever takes the longest.
void	DelaySeconds ( const double Seconds )	Queues the given delay, which will wait for the given number of seconds.
void	ExecuteNext ()	Executes the next delay (if there are any), otherwise it executes the next entry (action).
bool	ExecuteNextDelay ()	Executes the next delay, returns true if it found any, returns false if there were no queued up delays.
bool	ExecuteNextEntry ()	Executes the next entry (action), returns true if it found and executed an entry, returns false if there were no queued up entries.
bool	IsRunning ()	Returns true if Start() has been called and Stop() hasn't been called yet.
void	QueueDelay ( const FRenderGridGenericExecutionQueueDelay& Delay )	Adds the delay to the queued delays.
void	Start ()	Starts the execution of this queue.
void	Stop ()	Stops (pauses) the execution of this queue, this can be resumed by calling the Start function again.

	Type	Name	Description
	bool	IsTickableInEditor ()	Used to determine whether the object should be ticked in the editor.
	bool	IsTickableWhenPaused ()	Used to determine if an object should be ticked when the game is paused.

Type	Name	Description
TStatId	GetStatId ()	Return the stat id to use for this tickable
ETickableTickType	GetTickableTickType ()	Virtual that can be overloaded by the inheriting class.
bool	IsAllowedToTick ()	Virtual that can be overloaded by the inheriting class.
bool	IsTickable ()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.