Navigation
API > API/Plugins > API/Plugins/SceneState
Object Class for the Scene State Object Holds all the data about States, State Machines, Tasks, etc. All this data is immutable in execution, and as such, it is not instanced to the Scene State Object instances.
| Name | USceneStateGeneratedClass |
| Type | class |
| Header File | /Engine/Plugins/Experimental/SceneState/Source/SceneState/Public/SceneStateGeneratedClass.h |
| Include Path | #include "SceneStateGeneratedClass.h" |
Syntax
UCLASS (MinimalAPI)
class USceneStateGeneratedClass : public UBlueprintGeneratedClass
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UField → UStruct → UClass → UBlueprintGeneratedClass → USceneStateGeneratedClass
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USceneStateGeneratedClass() |
SceneStateGeneratedClass.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BindingCollection | FSceneStateBindingCollection | SceneStateGeneratedClass.h | ||
| ConduitLinks | TArray< FSceneStateConduitLink > | Compiled conduit information used only in Link time | SceneStateGeneratedClass.h | |
| Conduits | TArray< FSceneStateConduit > | All the compiled conduits | SceneStateGeneratedClass.h | |
| EventHandlers | TArray< FSceneStateEventHandler > | SceneStateGeneratedClass.h | ||
| OnObjectsReinstancedHandle | FDelegateHandle | SceneStateGeneratedClass.h | ||
| OnStructsReinstancedHandle | FDelegateHandle | SceneStateGeneratedClass.h | ||
| RootStateIndex | uint16 | SceneStateGeneratedClass.h | ||
| StateMachineGraphToIndex | TMap< FObjectKey, uint16 > | Map of a State Machine Graph to its State Machine Index | SceneStateGeneratedClass.h | |
| StateMachineIdToIndex | TMap< FGuid, uint16 > | Map of the Top-Level State machine Parameters id to the index in the state machine array | SceneStateGeneratedClass.h | |
| StateMachines | TArray< FSceneStateMachine > | SceneStateGeneratedClass.h | ||
| StateMetadata | TArray< FSceneStateMetadata > | SceneStateGeneratedClass.h | ||
| StateNodeToIndex | TMap< FObjectKey, uint16 > | Map of a State Node to its State Index | SceneStateGeneratedClass.h | |
| States | TArray< FSceneState > | SceneStateGeneratedClass.h | ||
| TaskInstances | FInstancedStructContainer | Templates used to instantiate the Task Instances | SceneStateGeneratedClass.h | |
| TaskMetadata | TArray< FSceneStateTaskMetadata > | SceneStateGeneratedClass.h | ||
| TaskNodeToIndex | TMap< FObjectKey, uint16 > | Map of a Task Node to its Task Index | SceneStateGeneratedClass.h | |
| TaskPrerequisites | TArray< uint16 > | Array of the task prerequisites in their relative index. | SceneStateGeneratedClass.h | |
| Tasks | FInstancedStructContainer | SceneStateGeneratedClass.h | ||
| TransitionLinks | TArray< FSceneStateTransitionLink > | Compiled transition information only used in Link time | SceneStateGeneratedClass.h | |
| TransitionMetadata | TArray< FSceneStateTransitionMetadata > | SceneStateGeneratedClass.h | ||
| TransitionParameters | TMap< uint16, FInstancedPropertyBag > | Map of the Transition Index (absolute) to the template transition parameters map for evaluation function call. | SceneStateGeneratedClass.h | |
| Transitions | TArray< FSceneStateTransition > | SceneStateGeneratedClass.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FSceneState * FindStateFromNode
(
FObjectKey InStateNode |
Finds the mapped compiled state for a given state node | SceneStateGeneratedClass.h | |
const FSceneStateMachine * FindStateMachine
(
const FGuid& InStateMachineId |
Finds the Top-Level State Machine that is linked to the given Guid | SceneStateGeneratedClass.h | |
const FSceneStateTask * FindTaskFromNode
(
FObjectKey InTaskNode |
Finds the mapped compiled task for a given task node | SceneStateGeneratedClass.h | |
void ForEachStateInstance
(
USceneStateObject& InRootState, |
For a given root state and state node retrieves the mapped state instances | SceneStateGeneratedClass.h | |
void ForEachTaskInstance
(
USceneStateObject& InRootState, |
For a given root state and task node retrieves the mapped task instances | SceneStateGeneratedClass.h | |
const FSceneStateBindingCollection & GetBindingCollection() |
SceneStateGeneratedClass.h | ||
TConstArrayView< FSceneStateConduit > GetConduits() |
SceneStateGeneratedClass.h | ||
TConstArrayView< FSceneStateEventHandler > GetEventHandlers() |
SceneStateGeneratedClass.h | ||
const FSceneState * GetRootState() |
SceneStateGeneratedClass.h | ||
TConstArrayView< FSceneStateMachine > GetStateMachines() |
SceneStateGeneratedClass.h | ||
TConstArrayView< FSceneStateMetadata > GetStateMetadata() |
SceneStateGeneratedClass.h | ||
TConstArrayView< FSceneState > GetStates() |
SceneStateGeneratedClass.h | ||
const FInstancedStructContainer & GetTaskInstances() |
SceneStateGeneratedClass.h | ||
TConstArrayView< FSceneStateTaskMetadata > GetTaskMetadata() |
SceneStateGeneratedClass.h | ||
TConstArrayView< uint16 > GetTaskPrerequisites() |
SceneStateGeneratedClass.h | ||
const FInstancedStructContainer & GetTasks() |
SceneStateGeneratedClass.h | ||
FInstancedPropertyBag GetTransitionParameter
(
uint16 InAbsoluteIndex |
SceneStateGeneratedClass.h | ||
TConstArrayView< FSceneStateTransition > GetTransitions() |
SceneStateGeneratedClass.h |
Overridden from UStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Link
(
FArchive& Ar, |
SceneStateGeneratedClass.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
SceneStateGeneratedClass.h | ||
virtual void PostLoad() |
SceneStateGeneratedClass.h |