Navigation
API > API/Plugins > API/Plugins/SceneState
Helper struct that can be passed over by copy in lambda captures, delegates while enabling functionality like safely accessing a Task, Task Instance, and Finishing a Task. It returns the Task and Task Instance only if the saved Instance Id matches the current Instance Id for the Task.
| Name | FTaskExecutionContext |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/SceneState/Source/SceneState/Public/Tasks/SceneStateTaskExecutionContext.h |
| Include Path | #include "Tasks/SceneStateTaskExecutionContext.h" |
Syntax
struct FTaskExecutionContext
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Tasks/SceneStateTaskExecutionContext.h | |||
FTaskExecutionContext
(
const FSceneStateTask& InTask, |
Tasks/SceneStateTaskExecutionContext.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ContextHandle | FExecutionContextHandle | Handle to the context within the saved registry | Tasks/SceneStateTaskExecutionContext.h | |
| ContextRegistryWeak | TWeakPtr< const FExecutionContextRegistry > | Registry used to find the context | Tasks/SceneStateTaskExecutionContext.h | |
| StateIndex | uint16 | Absolute index to the task's parent state | Tasks/SceneStateTaskExecutionContext.h | |
| StateInstanceId | uint16 | Id assigned to the state instance to distinguish it from a different instance (within the same context) with the same state index. | Tasks/SceneStateTaskExecutionContext.h | |
| TaskIndex | uint16 | Absolute index to the task | Tasks/SceneStateTaskExecutionContext.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void FinishTask() |
Helper function to Finish the Task / Task Instance for this context if these are still valid | Tasks/SceneStateTaskExecutionContext.h | |
const FSceneStateExecutionContext * GetExecutionContext() |
Resolves the execution context if it still exists | Tasks/SceneStateTaskExecutionContext.h | |
| Retrieves the FSceneStateTask view for this context, if the task instance this context got created for is still valid. | Tasks/SceneStateTaskExecutionContext.h | ||
| Retrieves the FSceneStateTaskInstance view for this context, if the task instance this context got created for is still valid. | Tasks/SceneStateTaskExecutionContext.h |