Navigation
API > API/Plugins > API/Plugins/StateTreeModule
Inheritance Hierarchy
- UDataAsset
- UStateTree
- UAvaTransitionTree
References
| Module | StateTreeModule |
| Header | /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTree.h |
| Include | #include "StateTree.h" |
Syntax
UCLASS (BlueprintType)
class UStateTree : public UDataAsset
Remarks
StateTree asset. Contains the StateTree definition in both editor and runtime (baked) formats.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TObjectPtr< UObject > | EditorData | Edit time data for the StateTree, instance of UStateTreeEditorData | |
| uint32 | LastCompiledEditorDataHash | Hash of the editor data from last compile. | |
| FDelegateHandle | OnObjectsReinstancedHandle | ||
| FDelegateHandle | OnPreBeginPIEHandle | ||
| FDelegateHandle | OnUserDefinedStructReinstancedHandle |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddReferencedObjects
(
UObject* InThis, |
||
| void | BeginDestroy () |
||
| TArray< FStateTreeMemoryUsage > | Calculates runtime memory usage for different sections of the tree. | ||
| void | Compile the state trees if the editor hash data as changed since the last compilation. | ||
| FString | |||
| void | DeclareConstructClasses
(
TArray< FTopLevelAssetPath >& OutConstructClasses, |
||
| void | GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
||
| void | GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
||
| TConstArrayView< FStateTreeExternalDataDesc > | |||
| const FStateTreeInstanceData & | |||
| const FInstancedPropertyBag & | |||
| TConstArrayView< FStateTreeExternalDataDesc > | |||
| FConstStructView | |||
| FGuid | GetNodeIdFromIndex
(
const FStateTreeIndex16 NodeIndex |
||
| FStateTreeIndex16 | GetNodeIndexFromId
(
const FGuid Id |
||
| const FInstancedStructContainer & | GetNodes () |
||
| int32 | |||
| int32 | |||
| const FStateTreePropertyBindings & | |||
| const UStateTreeSchema * | GetSchema () |
||
| TSharedPtr< FStateTreeInstanceData > | |||
| const FCompactStateTreeState * | GetStateFromHandle
(
const FStateTreeStateHandle StateHandle |
||
| FStateTreeStateHandle | GetStateHandleFromId
(
const FGuid Id |
||
| FGuid | GetStateIdFromHandle
(
const FStateTreeStateHandle Handle |
||
| TConstArrayView< FCompactStateTreeState > | GetStates () |
||
| const FCompactStateTransition * | GetTransitionFromIndex
(
const FStateTreeIndex16 TransitionIndex |
||
| FGuid | GetTransitionIdFromIndex
(
const FStateTreeIndex16 Index |
||
| FStateTreeIndex16 | GetTransitionIndexFromId
(
const FGuid Id |
||
| bool | HasCompatibleContextData
(
const UStateTree& Other |
||
| EDataValidationResult | IsDataValid
(
FDataValidationContext& Context |
||
| bool | IsReadyToRun () |
||
| bool | Link () |
Resolves references between data in the StateTree. | |
| void | OnObjectsReinstanced
(
const FReplacementObjectMap& ObjectMap |
||
| void | OnPreBeginPIE
(
const bool bIsSimulating |
Called when the editor is preparing to start a pie session. | |
| void | OnUserDefinedStructReinstanced
(
const UUserDefinedStruct& UserDefinedStruct |
||
| void | |||
| void | PostLoad () |
||
| void | Resets the compiled data to empty. | ||
| void | Serialize
(
FStructuredArchiveRecord Record |
||
| void | ThreadedPostLoadAssetRegistryTagsOverride
(
FPostLoadAssetRegistryTagsContext& Context |
Typedefs
| Name | Description |
|---|---|
| FReplacementObjectMap |