Navigation
API > API/Plugins > API/Plugins/SceneState
Runtime-immutable information of a state machine. Holds the range of states it will run, as well as the conduits found in the state machine, and other template data like template state machine parameters. These state machines are stored in the Scene State Generated Class.
| Name | FSceneStateMachine |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/SceneState/Source/SceneState/Public/SceneStateMachine.h |
| Include Path | #include "SceneStateMachine.h" |
Syntax
USTRUCT ()
struct FSceneStateMachine
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BindingsBatch | FPropertyBindingIndex16 | Bindings Batch where this State Machine is target | SceneStateMachine.h | |
| ConduitRange | FSceneStateRange | Index and count of the conduits that belong to this state machine. | SceneStateMachine.h | |
| EntryIndex | uint16 | Relative Index of the entry state that the State Machine will start in AbsoluteEntryIndex = StateRange.Index (absolute) + EntryIndex (relative) | SceneStateMachine.h | |
| Parameters | FInstancedPropertyBag | Template Parameters to use to Instance the Scene State Machine Instance | SceneStateMachine.h | |
| StateRange | FSceneStateRange | Index and count of the states that belong to this state machine. | SceneStateMachine.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSceneStateRange GetConduitRange() |
SceneStateMachine.h | ||
uint16 GetEntryIndex() |
SceneStateMachine.h | ||
const UStruct * GetParametersStruct() |
SceneStateMachine.h | ||
FSceneStateRange GetStateRange() |
SceneStateMachine.h | ||
bool IsValid() |
SceneStateMachine.h | ||
void Setup
(
const FSceneStateExecutionContext& InContext |
SceneStateMachine.h | ||
void Start
(
const FSceneStateExecutionContext& InContext |
SceneStateMachine.h | ||
void Stop
(
const FSceneStateExecutionContext& InContext |
SceneStateMachine.h | ||
void Tick
(
const FSceneStateExecutionContext& InContext, |
SceneStateMachine.h |