1. Epic GamesDeveloper
  3. FStateTreePropertyPath

FStateTreePropertyPath

Representation of a property path used for property binding in StateTree.

API > API/Plugins > API/Plugins/StateTreeModule

References

   
Module StateTreeModule
Header /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreePropertyBindings.h
Include #include "StateTreePropertyBindings.h"

Syntax

USTRUCT ()  
struct FStateTreePropertyPath

Remarks

Representation of a property path used for property binding in StateTree.

Constructors

  Type Name Description
Public function    
Public function  

FStateTreePropertyPath ( const FGuid InStructID
)

  
Public function  

FStateTreePropertyPath ( const FGuid InStructID,
const FName PropertyName
)

  
Public function  

FStateTreePropertyPath ( const FGuid InStructID,
TConstArrayView< FStateTreePropertyPathSegment > InSegments
)

  

Functions

  Type Name Description
Public function void

AddPathSegment ( const FName InName,
const int32 InArrayIndex,
const UStruct* InInstanceType
)

 Adds a path segment to the path.
Public function void Adds a path segment to the path.
Public function bool

FromString ( const FString& InPath
)

 Parses path from string. The path should be in format: Foo.Bar[1].Baz
Public function TArrayView< FStateTreePropertyPathSegment >  
Public function Const const FStateTreePropertyPathSegment &

GetSegment ( const int32 Index
)

  
Public function Const TConstArrayView< FStateTreePropertyPathSegment >  
Public function Const const FGuid &  
Public function Const bool  
Public function Const bool
Includes

( const FStateTreePropertyPath& Other
)

 Test if this paths includes the provided path.
Public function Const bool  
Public function Const int32  
Public function void

Reset ()

 Reset the path to empty.
Public function Const bool

ResolveIndirections ( const UStruct* BaseStruct,
TArray< FStateTreePropertyPathIndirection >& OutIndirections,
FString* OutError,
bool bHandleRedirects
)

 Resolves the property path against base struct type.
Public function Const bool

ResolveIndirectionsWithValue ( const FStateTreeDataView BaseValueView,
TArray< FStateTreePropertyPathIndirection >& OutIndirections,
FString* OutError,
bool bHandleRedirects
)

 Resolves the property path against base value.
Public function void

SetStructID ( const FGuid NewStructID
)

  
Public function Const FString

ToString ( const int32 HighlightedSegment,
const TCHAR* HighlightPrefix,
const TCHAR* HighlightPostfix,
const bool bOutputInstances,
const int32 FirstSegment
)

 Returns the property path as a one string. Highlight allows to decorate a specific segment.
Public function bool

UpdateInstanceStructsFromValue ( const FStateTreeDataView BaseValueView,
FString* OutError
)

  
Public function bool

UpdateSegments ( const UStruct* BaseStruct,
FString* OutError
)

 Updates property segments from base struct type.
Public function bool

UpdateSegmentsFromValue ( const FStateTreeDataView BaseValueView,
FString* OutError
)

 Updates property segments from base value.

Operators

  Type Name Description
Public function Const bool Test if paths are equal.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page