Navigation
API > API/Plugins > API/Plugins/SceneState
Scene State Players is the layer between the Context Object and the rest of Scene State It instances a Scene State Object from a given class. These players exist to keep shared logic re-usable across multiple possible implementers
| Name | USceneStatePlayer |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/SceneState/Source/SceneState/Public/SceneStatePlayer.h |
| Include Path | #include "SceneStatePlayer.h" |
Syntax
UCLASS (MinimalAPI)
class USceneStatePlayer : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USceneStatePlayer
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Begin() |
Should be called to start the execution of the scene state object | SceneStatePlayer.h | |
void End() |
Should be called to end the execution of the scene state object | SceneStatePlayer.h | |
FString GetContextName() |
Returns the context name for this player, for debugging purposes | SceneStatePlayer.h | |
UObject * GetContextObject() |
Returns the context object for this player | SceneStatePlayer.h | |
USceneStateObject * GetSceneState() |
SceneStatePlayer.h | ||
TSubclassOf< USceneStateObject > GetSceneStateClass() |
SceneStatePlayer.h | ||
void SetSceneStateClass
(
TSubclassOf< USceneStateObject > InSceneStateClass |
Sets the class of the root state object. Destroying the existing one | SceneStatePlayer.h | |
void Setup() |
Should be called prior to the start of the execution | SceneStatePlayer.h | |
void Tick
(
float InDeltaTime |
Should be called every tick during the execution of the scene state object | SceneStatePlayer.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& InPropertyChangedEvent |
SceneStatePlayer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool OnGetContextName
(
FString& OutContextName |
Returns the context name for this player | SceneStatePlayer.h | |
virtual bool OnGetContextObject
(
UObject*& OutContextObject |
Returns the context object for this player | SceneStatePlayer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetRootStateName() |
SceneStatePlayer.h | ||
static FName GetSceneStateClassName() |
SceneStatePlayer.h |