Navigation
API > API/Plugins > API/Plugins/SceneState
Instance data of a State
| Name | FSceneStateInstance |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/SceneState/Source/SceneState/Public/SceneStateInstance.h |
| Include Path | #include "SceneStateInstance.h" |
Syntax
USTRUCT ()
struct FSceneStateInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| SceneStateInstance.h | |||
FSceneStateInstance
(
const FSceneStateInstance& |
SceneStateInstance.h | ||
| SceneStateInstance.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ElapsedTime | float | SceneStateInstance.h | ||
| Status | UE::SceneState::EExecutionStatus | Current status of this state instance | SceneStateInstance.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InstanceId | uint16 | The id for this instance. | SceneStateInstance.h | |
| Parameters | FInstancedPropertyBag | Instanced state parameters | SceneStateInstance.h | |
| TaskInstances | FInstancedStructContainer | The task instances owned by this state | SceneStateInstance.h | |
| TaskStatuses | TArray< UE::SceneState::EExecutionStatus > | Execution status of the tasks | SceneStateInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint16 GetInstanceId() |
Get an identifier for this instance | SceneStateInstance.h | |
FInstancedPropertyBag & GetParameters() |
Returns the state parameters | SceneStateInstance.h | |
UE::SceneState::EExecutionStatus GetStatus() |
Gets the execution status of the state instance | SceneStateInstance.h | |
FInstancedStructContainer & GetTaskInstances() |
Returns the instance data of the tasks owned by this state | SceneStateInstance.h | |
UE::SceneState::EExecutionStatus GetTaskStatus
(
uint16 InTaskRelativeIndex |
Returns the status of the task at the given index | SceneStateInstance.h | |
void SetStatus
(
UE::SceneState::EExecutionStatus InStatus |
Sets the execution status of the state instance | SceneStateInstance.h | |
void SetTaskStatus
(
uint16 InTaskRelativeIndex, |
Sets the status of the task at the given index | SceneStateInstance.h | |
void Setup
(
const FSceneState& InState |
Called to setup the state instance for use | SceneStateInstance.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSceneStateInstance & operator=
(
const FSceneStateInstance& |
SceneStateInstance.h | ||
| SceneStateInstance.h |