Navigation
API > API/Plugins > API/Plugins/SceneState
Base struct for all scene state functions. Binding Functions are a layer of logic that execute prior to evaluating owner's bindings.
The function's instance data is expected to have its output properties with meta "Output", and these will be hidden in the UI. This property is used to find which bindings the function can be used for.
Example:
USTRUCT() struct FTextToStringFunctionInstance {
FText Text;
FString Result; };
| Name | FSceneStateFunction |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/SceneState/Source/SceneState/Public/Functions/SceneStateFunction.h |
| Include Path | #include "Functions/SceneStateFunction.h" |
Syntax
USTRUCT (Meta=(Hidden))
struct FSceneStateFunction
Derived Classes
FSceneStateFunction derived class hierarchy
- FSceneStateDoubleFunction
- FSceneStateIntegerFunction
- FSceneStateBooleanFunction
- FSceneStateConcatenateStringFunction
- FSceneStateDoubleToStringFunction
- FSceneStateIntegerToStringFunction
- FSceneStateNameFromStringFunction
- FSceneStateNameToStringFunction
- FSceneStateTextFromStringFunction
- FSceneStateTextToStringFunction
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BindingsBatch | FPropertyBindingIndex16 | Bindings Batch where this function is target | Functions/SceneStateFunction.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Cleanup
(
const FSceneStateExecutionContext& InContext |
Called when binding owners are cleaning up their allocated instance data | Functions/SceneStateFunction.h | |
void Execute
(
const FSceneStateExecutionContext& InContext, |
Called right before evaluating bindings for the owner. | Functions/SceneStateFunction.h | |
const UScriptStruct * GetFunctionDataType() |
Called in-editor to get the function data type | Functions/SceneStateFunction.h | |
void Setup
(
const FSceneStateExecutionContext& InContext |
Called when binding owners are setting up and allocating instance data | Functions/SceneStateFunction.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnExecute
(
const FSceneStateExecutionContext& InContext, |
Called right before evaluating bindings for the owner. | Functions/SceneStateFunction.h | |
virtual const UScriptStruct * OnGetFunctionDataType() |
Called to retrieve the data type that this function expects | Functions/SceneStateFunction.h |