Navigation
API > API/Plugins > API/Plugins/SceneState
Object instanced by USceneStateGeneratedClass. Holds the execution context (and instance data) that will be used to run the Scene State the USceneStateGeneratedClass holds.
| Name | USceneStateObject |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/SceneState/Source/SceneState/Public/SceneStateObject.h |
| Include Path | #include "SceneStateObject.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable)
class USceneStateObject : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USceneStateObject
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USceneStateObject() |
SceneStateObject.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ContextRegistry | TSharedPtr< UE::SceneState::FExecutionContextRegistry > | The registry containing all the execution contexts in this object | SceneStateObject.h | |
| EventStream | TObjectPtr< USceneStateEventStream > | Runtime Event System keeping track of Active Events that have been added | SceneStateObject.h |
|
| RootExecutionContext | FSceneStateExecutionContext | The top-level execution context of the Scene State | SceneStateObject.h |
|
| TemplateData | TObjectPtr< const USceneStateTemplateData > | Scene State template data to use for this object's execution. | SceneStateObject.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Enter() |
Called by the scene state player to start execution of the root state | SceneStateObject.h | |
void Exit() |
Called by the scene state player to stop the execution of the root state | SceneStateObject.h | |
FString GetContextName() |
Gets the context name of the scene state player | SceneStateObject.h | |
UObject * GetContextObject() |
Gets the context object of the scene state player | SceneStateObject.h |
|
TSharedRef< UE::SceneState::FExecutionContextRegistry > GetContextRegistry() |
Gets the context registry owned by this object | SceneStateObject.h | |
USceneStateEventStream * GetEventStream() |
SceneStateObject.h |
|
|
const USceneStateTemplateData * GetTemplateData() |
SceneStateObject.h | ||
virtual UWorld * GetWorld() |
SceneStateObject.h | ||
bool IsActive() |
Returns true if the object has an active root state | SceneStateObject.h |
|
void ReceiveEnter() |
SceneStateObject.h |
|
|
void ReceiveExit() |
SceneStateObject.h |
|
|
void ReceiveTick
(
float InDeltaSeconds |
SceneStateObject.h |
|
|
void Setup() |
Called by the scene state player to setup this object and the root execution context | SceneStateObject.h | |
void Tick
(
float InDeltaSeconds |
Called by the scene state player to start ticking the root state | SceneStateObject.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
SceneStateObject.h |