Navigation
API > API/Plugins > API/Plugins/SceneState
Task that runs a local state machine
| Name | FSceneStateMachineTask |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/SceneState/Source/SceneState/Public/Tasks/SceneStateMachineTask.h |
| Include Path | #include "Tasks/SceneStateMachineTask.h" |
Syntax
USTRUCT (DisplayName="Run State Machine", Category="Core")
struct FSceneStateMachineTask : public FSceneStateTask
Inheritance Hierarchy
- FSceneStateTask → FSceneStateMachineTask
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSceneStateMachineTask() |
Tasks/SceneStateMachineTask.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FInstanceDataType | FSceneStateMachineTaskInstance | Tasks/SceneStateMachineTask.h |
Functions
Public
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsStateMachineFinished
(
const FSceneStateExecutionContext& InContext, |
Tasks/SceneStateMachineTask.h |
Overridden from FSceneStateTask
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnBuildTaskInstance
(
UObject* InOuter, |
Called to init properties (e.g. Guids) or instances objects within the task instance | Tasks/SceneStateMachineTask.h | |
virtual const FSceneStateTaskBindingExtension * OnGetBindingExtension () |
Called to get the optional Binding Extension for a Task | Tasks/SceneStateMachineTask.h | |
virtual const UScriptStruct * OnGetTaskInstanceType () |
Called in-editor to get the task instance type | Tasks/SceneStateMachineTask.h | |
virtual void OnStart
(
const FSceneStateExecutionContext& InContext, |
Called once the State processes that the Task has all its prerequisites met. | Tasks/SceneStateMachineTask.h | |
virtual void OnStop
(
const FSceneStateExecutionContext& InContext, |
Called when the Task has finished or forcibly stopped by the state | Tasks/SceneStateMachineTask.h | |
virtual void OnTick
(
const FSceneStateExecutionContext& InContext, |
Called by the State each Tick if the Task is set to Tick via its TaskFlags | Tasks/SceneStateMachineTask.h |