Navigation
API > API/Plugins > API/Plugins/RenderGrid
This class provides generic queue support, with built-in support for delays between actions.
| Name | FRenderGridGenericExecutionQueue |
| Type | class |
| Header File | /Engine/Plugins/Experimental/RenderGrid/Source/RenderGrid/Public/Utils/RenderGridGenericExecutionQueue.h |
| Include Path | #include "Utils/RenderGridGenericExecutionQueue.h" |
Syntax
class FRenderGridGenericExecutionQueue :
public TSharedFromThis< FRenderGridGenericExecutionQueue > ,
public FTickableGameObject
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FRenderGridGenericExecutionQueue
- FTickableObjectBase → FTickableGameObject → FRenderGridGenericExecutionQueue
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Add
(
const FRenderGridGenericExecutionQueueEntry& Entry |
Queues the given action. | Utils/RenderGridGenericExecutionQueue.h | |
void Delay
(
const FRenderGridGenericExecutionQueueDelay& Delay |
Queues the given delay. | Utils/RenderGridGenericExecutionQueue.h | |
void DelayFrames
(
const int64 Frames |
Queues the given delay, which will wait for the given number of frames. | Utils/RenderGridGenericExecutionQueue.h | |
void DelayFramesOrSeconds
(
const int64 Frames, |
Queues the given delay, which will wait for the given number of frames or seconds, whatever takes the longest. | Utils/RenderGridGenericExecutionQueue.h | |
void DelaySeconds
(
const double Seconds |
Queues the given delay, which will wait for the given number of seconds. | Utils/RenderGridGenericExecutionQueue.h | |
bool IsRunning() |
Returns true if Start() has been called and Stop() hasn't been called yet. | Utils/RenderGridGenericExecutionQueue.h | |
void Start() |
Starts the execution of this queue. | Utils/RenderGridGenericExecutionQueue.h | |
void Stop () |
Stops (pauses) the execution of this queue, this can be resumed by calling the Start function again. | Utils/RenderGridGenericExecutionQueue.h |
Overridden from FTickableGameObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsTickableInEditor() |
Utils/RenderGridGenericExecutionQueue.h | ||
virtual bool IsTickableWhenPaused() |
Utils/RenderGridGenericExecutionQueue.h |
Overridden from FTickableObjectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TStatId GetStatId() |
Utils/RenderGridGenericExecutionQueue.h | ||
virtual ETickableTickType GetTickableTickType() |
Utils/RenderGridGenericExecutionQueue.h | ||
virtual void Tick
(
float DeltaTime |
Utils/RenderGridGenericExecutionQueue.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExecuteNext() |
Executes the next delay (if there are any), otherwise it executes the next entry (action). | Utils/RenderGridGenericExecutionQueue.h | |
bool ExecuteNextDelay() |
Executes the next delay, returns true if it found any, returns false if there were no queued up delays. | Utils/RenderGridGenericExecutionQueue.h | |
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. | Utils/RenderGridGenericExecutionQueue.h | |
void QueueDelay
(
const FRenderGridGenericExecutionQueueDelay& Delay |
Adds the delay to the queued delays. | Utils/RenderGridGenericExecutionQueue.h |