1. Epic GamesDeveloper
  3. FTrait

FTrait

[FTrait](API\Plugins\AnimNext\TraitCore\FTrait)

API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/TraitCore

Inheritance Hierarchy

References

   
Module AnimNext
Header /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/TraitCore/Trait.h
Include #include "TraitCore/Trait.h"

Syntax

struct FTrait

Remarks

FTrait

Base class for all traits. A trait can implement any number of interfaces based on ITraitInterface. A trait may derive from another trait. A trait should implement GetInterface(..) and test against the interfaces that it supports.

Traits should NOT have any internal state, hence why all API functions are 'const'. The reason for this is that at runtime, a single instance of every trait exists. That single instance is used by all instances of a trait on a node and concurrently on all worker threads.

Traits can have shared read-only data that all instances of a graph can use (e.g. hard-coded properties). Shared data must derive from FAnimNextTraitSharedData. Traits can have instance data (e.g. blend weight). Instance data must derive from FTraitInstanceData.

Destructors

  Type Name Description
Public function Virtual  

~FTrait ()

  

Functions

  Type Name Description
Protected function Static TArray< FTraitEventUID >

BuildTraitEventList ( const TConstArrayView< FTraitEventUID >& SuperEvents,
std::initializer_list< FTraitEventUID > EventList
)

 Builds a list of events with the provided super events and current events as an initializer list.
Protected function Static TArray< FTraitInterfaceUID >

BuildTraitInterfaceList ( const TConstArrayView< FTraitInterfaceUID >& SuperInterfaces,
std::initializer_list< FTraitInterfaceUID > InterfaceList
)

 Builds a list of interfaces with the provided super interfaces and current interfaces as an initializer list.
Public function Const void

ConstructTraitInstance ( const FExecutionContext& Context,
const FTraitBinding& Binding
)

 Called when a new instance of the trait is created or destroyed Derived types must override this and forward to the instance data constructor/destructor
Public function Const void

DestructTraitInstance ( const FExecutionContext& Context,
const FTraitBinding& Binding
)

  
Public function Const TArray< FLatentPropertyMetadata >

GetLatentPropertyHandles ( bool bFilterEditorOnly,
const TFunction< uint16(FName PropertyName)>& GetTraitLatentPropertyIndex
)

 Takes the editor properties as authored in the graph and returns the latent property metadata using UE reflection.
Public function Virtual Const FTraitLatentPropertyMemoryLayout

GetLatentPropertyMemoryLayout ( FName PropertyName,
uint32 PropertyIndex
)

 Returns the memory layout of the specified latent property.
Protected function Const FTraitLatentPropertyMemoryLayout

GetLatentPropertyMemoryLayoutImpl ( FName PropertyName,
uint32 PropertyIndex,
TArray< FTraitLatentPropertyMemoryLayout >& LatentPropertyMemoryLayouts
)

 Implements GetLatentPropertyMemoryLayout() by allowing a map to be provided for caching purposes to speed up repeated queries.
Public function Virtual Const uint32 The number of latent property properties in the shared data of this trait.
Public function Virtual Const TConstArrayView< FTraitEventUID > Returns a list of events that this trait handles.
Public function Virtual Const const ITraitInterface * Returns a pointer to the specified interface if it is supported. Derived types must override this.
Public function Virtual Const TConstArrayView< FTraitInterfaceUID > Returns a list of interfaces that this trait supports.
Public function Const FTraitMemoryLayout Returns the memory requirements of the derived trait instance.
Public function Const ETraitMode Returns the trait mode.
Public function Virtual Const FString Returns the trait name.
Public function Virtual Const TConstArrayView< FTraitInterfaceUID > Returns a list of interfaces that this trait reqquires.
Public function Virtual Const UScriptStruct * Returns the UScriptStruct associated with the shared data for the trait.
Public function Virtual Const FTraitUID Returns the globally unique UID for this trait.
Public function Virtual Const bool Makes the Trait Editor only display this Trait in Advanced view.
Public function Virtual Const ETraitStackPropagation Called when an event reaches an instance of this trait.
Public function Virtual Const void

SaveTraitSharedData ( const TFunction< FString(FName PropertyName)>& GetTraitProperty,
FAnimNextTraitSharedData& OutSharedData
)

 Takes the editor properties as authored in the graph and converts them into an instance of the FAnimNextTraitSharedData derived type using UE reflection.
Public function Virtual Const void Called to serialize trait shared data.

Typedefs

Name Description
FInstanceData  
FSharedData Empty shared/instance data types Derived types must define an alias for these

Constants

Name Description
TraitUID The globally unique UID for this trait Derived types will have their own TraitUID member that hides/aliases/shadows this one

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page