1. Epic GamesDeveloper
  3. SceneState

SceneState

API > API/Plugins

   
Name SceneState
Type Plugin
Location /Engine/Plugins/VirtualProduction/SceneState/Source/SceneState/
Module Build Rules SceneState.Build.cs

Classes

Name Remarks
FExecutionContextHandle Holds a unique number mapping a context in a registry
FExecutionScope Adds the given State Machine to the Execution Stack on scope enter / constructor and removes it on scope exit / destructor.
FReentryHandle  
USceneStateBlueprintableTask Base class for Blueprint Tasks.
USceneStateGeneratedClass Object Class for the Scene State Object Holds the template data for scene state objects.
USceneStateObject Object instanced by USceneStateGeneratedClass.
USceneStatePlayer 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.
USceneStateTaskGeneratedClass Generated class for Scene State Blueprintable Tasks
USceneStateTemplateData Holds all the data about States, State Machines, Tasks, etc.

Structs

Name Remarks
FApplyBatchParams  
FReentryGuard Ensures no reentry in a given scope
FResolvePropertyResult  
FSceneState Runtime-immutable information of a state.
FSceneStateBlueprintableTaskInstance  
FSceneStateBlueprintableTaskWrapper Task Wrapper for Blueprint Tasks.
FSceneStateConduit Defines a conduit, a transition indirection
FSceneStateConduitInstance Instance data of a conduit
FSceneStateConduitLink Holds information about the conduit that is only used in conduit link time
FSceneStateExecutionContext Struct representing an execution.
FSceneStateFunction Base struct for all scene state functions.
FSceneStateFunctionInstanceBatch Holds all the function instances for a given batch
FSceneStateFunctionMetadata Metadata information about the function.
FSceneStateInstance Instance data of a State
FSceneStateMachine Runtime-immutable information of a state machine.
FSceneStateMachineInstance Instance data of a State Machine
FSceneStateMachineTask Task that runs a local state machine
FSceneStateMachineTaskBinding Binding Extension for the State Machine Task.
FSceneStateMachineTaskInstance  
FSceneStateMetadata Metadata information about the State. Available only in editor
FSceneStatePlayerTask Task that runs a Scene State Object through a Player
FSceneStatePlayerTaskInstance  
FSceneStateRange  
FSceneStateTask Base class for Tasks.
FSceneStateTaskBindingExtension Extension to allow custom bindings for a task.
FSceneStateTaskInstance Represents the Instance Data of a Task
FSceneStateTaskMetadata Metadata information about the Task. Available only in editor
FSceneStateTransition Holds the exit transition conditions and information from its owner state to a target.
FSceneStateTransitionInstance Instance data of a transition
FSceneStateTransitionLink Holds information about the transition that is only used in transition link time
FSceneStateTransitionMetadata Metadata information about the Transition. Available only in editor
FSceneStateTransitionResult The result output of a transition graph evaluation
FSceneStateTransitionTarget Describes a transition's target via its type (e.g. State) and an index if required (e.g. the index of the State)
FTaskBindingDesc  
FTaskEditChange Describes an Edit change for a task or task instance
FTaskExecutionContext Helper struct that can be passed over by copy in lambda captures, delegates while enabling functionality like safely accessing a Task, Task Instance, and Finishing a Task.
FTransitionEvaluationParams The parameters required for transition evaluation

Enums

Public

Name Remarks
ESceneStateMachineRunMode Defines the possible ways a state machine will run
ESceneStateTaskFlags Defines common task behaviors: whether it should tick, whether it handles custom bindings, etc.
ESceneStateTaskStopReason Defines the reasons why a task has stopped
ESceneStateTransitionEvaluationFlags Defines how a transition evaluation should take place
ESceneStateTransitionTargetType Types of object a transition can lead to

Functions

Public

Name Remarks Include Path Unreal Specifiers
  SceneStateEnums.h  
  SceneStateEnums.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page