1. Epic GamesDeveloper
  3. FStateTreePropertyBindings

FStateTreePropertyBindings

Runtime storage and execution of property bindings.

API > API/Plugins > API/Plugins/StateTreeModule

Runtime storage and execution of property bindings.

   
Name FStateTreePropertyBindings
Type struct
Header File /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreePropertyBindings.h
Include Path #include "StateTreePropertyBindings.h"

Syntax

USTRUCT ()  
struct FStateTreePropertyBindings : public FPropertyBindingBindingCollection

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FStateTreePropertyBindings()

   StateTreePropertyBindings.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
FStateTreePropertyBindingCompiler friend   StateTreePropertyBindings.h  
PropertyAccesses TArray< FStateTreePropertyAccess > Array of individually accessed properties StateTreePropertyBindings.h  
PropertyPathBindings TArray< FStateTreePropertyPathBinding > Array of property bindings, resolved into arrays of copies before use. StateTreePropertyBindings.h  
PropertyReferencePaths TArray< FStateTreePropertyRefPath > Array of referenced property paths StateTreePropertyBindings.h  
SourceStructs TArray< FStateTreeBindableStructDesc > Array of expected source structs. StateTreePropertyBindings.h  
UStateTree friend   StateTreePropertyBindings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CopyProperty ( const FStateTreePropertyCopy& Copy,
FStateTreeDataView SourceStructView,
FStateTreeDataView TargetStructView
) const

 Copies a property from Source to Target based on the provided Copy. StateTreePropertyBindings.h  

const FStateTreePropertyCopyBatch & GetBatch ( const FStateTreeIndex16 TargetBatchIndex
) const

   StateTreePropertyBindings.h  

TConstArrayView< FStateTreePropertyCopy > GetBatchCopies ( const FStateTreeIndex16 TargetBatchIndex
) const

   StateTreePropertyBindings.h  

TConstArrayView< FStateTreePropertyCopy > GetBatchCopies ( const FStateTreePropertyCopyBatch& Batch
) const

   StateTreePropertyBindings.h  

T * GetMutablePropertyPtr ( FStateTreeDataView SourceView,
const FStateTreePropertyAccess& PropertyAccess
) const

 Pointer to referenced property StateTreePropertyBindings.h  

const FStateTreePropertyAccess * GetPropertyAccess ( const FStateTreePropertyRef& Reference
) const

   StateTreePropertyBindings.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSint32 GetSourceStructNum()

   StateTreePropertyBindings.h  

Overridden from FPropertyBindingBindingCollection

Name Remarks Include Path Unreal Specifiers
  StateTreePropertyBindings.h  

virtual int32 GetNumBindableStructDescriptors()

   StateTreePropertyBindings.h  

virtual void OnReset()

 Clears all bindings. StateTreePropertyBindings.h  

virtual bool ResolveBindingCopyInfo ( const FPropertyBindingBinding& InResolvedBinding,
const FPropertyBindingPathIndirection& InBindingSourceLeafIndirection,
const FPropertyBindingPathIndirection& InBindingTargetLeafIndirection,
FPropertyBindingCopyInfo& OutCopyInfo
)

   StateTreePropertyBindings.h  

virtual void VisitSourceStructDescriptorInternal ( TFunctionRef< EVisitResult(const FPropertyBindingBindableStructDescriptor&Descriptor)> InFunction
) const

   StateTreePropertyBindings.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ForEachBinding ( const FPropertyBindingIndex16 InBegin,
const FPropertyBindingIndex16 InEnd,
const TFunctionRef< void(const FPropertyBindingBinding&Binding, const int32 BindingIndex)> InFuncti...
) const

   StateTreePropertyBindings.h  
  StateTreePropertyBindings.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSbool ResetObjects ( const FStateTreeIndex16 TargetBatchIndex,
FStateTreeDataView TargetStructView
) const

   StateTreePropertyBindings.h  

Overridden from FPropertyBindingBindingCollection

Name Remarks Include Path Unreal Specifiers

virtual FPropertyBindingBinding * AddBindingInternal ( const FPropertyBindingPath& InSourcePath,
const FPropertyBindingPath& InTargetPath
)

   StateTreePropertyBindings.h  

virtual const FPropertyBindingBinding * FindBindingInternal ( TFunctionRef< bool(const FPropertyBindingBinding&)> InPredicate
) const

   StateTreePropertyBindings.h  

virtual void ForEachBinding ( TFunctionRef< void(const FPropertyBindingBinding&Binding)> InFunction
) const

   StateTreePropertyBindings.h  

virtual void ForEachMutableBinding ( TFunctionRef< void(FPropertyBindingBinding&Binding)> InFunction
)

   StateTreePropertyBindings.h  

virtual int32 GetNumBindings()

   StateTreePropertyBindings.h  

virtual bool HasBindingInternal ( TFunctionRef< bool(const FPropertyBindingBinding&)> InPredicate
) const

   StateTreePropertyBindings.h  

virtual bool OnResolvingPaths()

   StateTreePropertyBindings.h  

virtual void RemoveBindingsInternal ( TFunctionRef< bool(FPropertyBindingBinding&)> InPredicate
)

   StateTreePropertyBindings.h  

virtual void VisitBindings ( TFunctionRef< EVisitResult(const FPropertyBindingBinding&Binding)> InFunction
) const

   StateTreePropertyBindings.h  

virtual void VisitMutableBindings ( TFunctionRef< EVisitResult(FPropertyBindingBinding&Binding)> InFunction
)

   StateTreePropertyBindings.h  

Static

Name Remarks Include Path Unreal Specifiers

static EStateTreePropertyAccessCompatibility GetPropertyCompatibility ( const FProperty* FromProperty,
const FProperty* ToProperty
)

   StateTreePropertyBindings.h  

static bool ResolveCopyType ( const FPropertyBindingPathIndirection& SourceIndirection,
const FPropertyBindingPathIndirection& TargetIndirection,
FStateTreePropertyCopy& OutCopy
)

 Resolves what kind of copy type to use between specified property indirections. StateTreePropertyBindings.h  

static bool ResolveCopyType ( const FStateTreePropertyPathIndirection& SourceIndirection,
const FStateTreePropertyPathIndirection& TargetIndirection,
FStateTreePropertyCopy& OutCopy
)

   StateTreePropertyBindings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page