className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
3
36
code
stringlengths
0
11.4k
variables
listlengths
0
395
USequencePlayerLibrary::GetSequence
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Get the current sequence of the sequence player - DEPRECATED, please use pure version
AnimGraphRuntime
static [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) GetSequence ( const [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) & SequencePlayer, [UAnimSequenceBase](API\Runtime\Engine\Animation\UAnimSequenceBase) *& SequenceBase )
[]
USequencePlayerLibrary::GetSequencePure
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Get the current sequence of the sequence player
AnimGraphRuntime
static [UAnimSequenceBase](API\Runtime\Engine\Animation\UAnimSequenceBase) * GetSequencePure ( const [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) & SequencePlayer )
[]
USequencePlayerLibrary::GetStartPosition
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Get the start position of the sequence player
AnimGraphRuntime
static float GetStartPosition ( const [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) & SequencePlayer )
[]
USequencePlayerLibrary::SetAccumulatedTime
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Set the current accumulated time of the sequence player
AnimGraphRuntime
static [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) SetAccumulatedTime ( const [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) & SequencePlayer, float Time )
[]
USequencePlayerLibrary::SetPlayRate
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Set the play rate of the sequence player
AnimGraphRuntime
static [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) SetPlayRate ( const [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) & SequencePlayer, float PlayRate )
[]
USequencePlayerLibrary::SetSequence
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Set the current sequence of the sequence player
AnimGraphRuntime
static [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) SetSequence ( const [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) & SequencePlayer, [UAnimSequenceBase](API\Runtime\Engine\Animation\UAnimSequenceBase) * Sequence )
[]
USequencePlayerLibrary::SetSequenceWithInertialBlending
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Set the current sequence of the sequence player with an inertial blend time
AnimGraphRuntime
static [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) SetSequenceWithInertialBlending ( const [FAnimUpdateContext](API\Runtime\Engine\Animation\FAnimUpdateContext) & UpdateContext, const [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) & SequencePlayer, [UAnimSequenceBase](API\Runtime\Engine\Animation\UAnimSequenceBase) * Sequence, float BlendTime )
[]
USequencePlayerLibrary::SetStartPosition
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Set the start position of the sequence player. If this is called from On Become Relevant or On Initial Update then it should be accompanied by a call to SetAccumulatedTime to achieve the desired effect of resetting the play time of a sequence player.
AnimGraphRuntime
static [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) SetStartPosition ( const [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) & SequencePlayer, float StartPosition )
[]
USequencePlayerLibrary
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Exposes operations to be performed on a sequence player anim node Note: Experimental and subject to change!
AnimGraphRuntime
class USequencePlayerLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)
[]
USequencePlayerLibrary::ConvertToSequencePlayer
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
Get a sequence player context from an anim node context
AnimGraphRuntime
static [FSequencePlayerReference](API\Runtime\AnimGraphRuntime\FSequencePlayerReference) ConvertToSequencePlayer ( const [FAnimNodeReference](API\Runtime\Engine\Animation\FAnimNodeReference) & Node, EAnimNodeReferenceConversionResult & Result )
[]
USequencerAnimationSupport::USequencerAnimationSupport
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencerAnimationSupport.h
AnimGraphRuntime
USequencerAnimationSupport ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
USequencerAnimationSupport
/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencerAnimationSupport.h
AnimGraphRuntime
class USequencerAnimationSupport : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)
[]
USkeletalControlLibrary::ConvertToSkeletalControl
/Engine/Source/Runtime/AnimGraphRuntime/Public/SkeletalControlLibrary.h
Get a skeletal control from an anim node
AnimGraphRuntime
static [FSkeletalControlReference](API\Runtime\AnimGraphRuntime\FSkeletalControlReference) ConvertToSkeletalControl ( const [FAnimNodeReference](API\Runtime\Engine\Animation\FAnimNodeReference) & Node, EAnimNodeReferenceConversionResult & Result )
[]
USkeletalControlLibrary::ConvertToSkeletalControlPure
/Engine/Source/Runtime/AnimGraphRuntime/Public/SkeletalControlLibrary.h
Get a skeletal control from an anim node (pure)
AnimGraphRuntime
static void ConvertToSkeletalControlPure ( const [FAnimNodeReference](API\Runtime\Engine\Animation\FAnimNodeReference) & Node, [FSkeletalControlReference](API\Runtime\AnimGraphRuntime\FSkeletalControlReference) & SkeletalControl, bool & Result )
[]
USkeletalControlLibrary::GetAlpha
/Engine/Source/Runtime/AnimGraphRuntime/Public/SkeletalControlLibrary.h
Get the alpha value of this skeletal control
AnimGraphRuntime
static float GetAlpha ( const [FSkeletalControlReference](API\Runtime\AnimGraphRuntime\FSkeletalControlReference) & SkeletalControl )
[]
USkeletalControlLibrary::SetAlpha
/Engine/Source/Runtime/AnimGraphRuntime/Public/SkeletalControlLibrary.h
Set the alpha value of this skeletal control
AnimGraphRuntime
static [FSkeletalControlReference](API\Runtime\AnimGraphRuntime\FSkeletalControlReference) SetAlpha ( const [FSkeletalControlReference](API\Runtime\AnimGraphRuntime\FSkeletalControlReference) & SkeletalControl, float Alpha )
[]
USkeletalControlLibrary
/Engine/Source/Runtime/AnimGraphRuntime/Public/SkeletalControlLibrary.h
Exposes operations to be performed on a skeletal control anim node Note: Experimental and subject to change!
AnimGraphRuntime
class USkeletalControlLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)
[]
DecoratorConstructorFunc
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
A function pointer to a shim to construct a decorator into the desired memory location When called with a nullptr DestPtr, the function returns nullptr and only populates the memory description output argument. This allows the caller to determine how much space to reserve and how to properly align it. This is similar in spirit to various Windows SDK functions.
AnimNext
typedef [FDecorator](API\Plugins\AnimNext\DecoratorBase\FDecorator) *(*)(void *DestPtr, [FDecoratorMemoryLayout](API\Plugins\AnimNext\DecoratorBase\FDecoratorMemoryLayout) &MemoryDesc) DecoratorConstructorFunc
[]
DecoratorUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
FDecoratorimpl
AnimNext
static constexpr [UE::AnimNext::FDecoratorUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorUID) DecoratorUID = UE::AnimNext::FDecoratorUID(TEXT("FAdditiveDecorator"), 0x7ab3732a );
[]
DecoratorSuper
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
AnimNext
typedef [FDecorator](API\Plugins\AnimNext\DecoratorBase\FDecorator) DecoratorSuper
[]
FAdditiveDecorator::GetDecoratorMode
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns the decorator mode.
AnimNext
virtual [EDecoratorMode](API\Plugins\AnimNext\DecoratorBase\UE__AnimNext__EDecoratorMode) GetDecoratorMode() const
[]
FAdditiveDecorator::GetDecoratorUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns the globally unique UID for this decorator.
AnimNext
virtual [UE::AnimNext::FDecoratorUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorUID) GetDecoratorUID() const
[]
FAdditiveDecorator
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Base class for additive decorators that override behavior of other decorators.
AnimNext
struct FAdditiveDecorator : public [UE::AnimNext::FDecorator](API\Plugins\AnimNext\DecoratorBase\FDecorator)
[]
DECORATOR_SHIFT
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
Bottom 24 bits are used by the node shared offset while the top 8 bits by the decorator index.
AnimNext
static constexpr uint32 DECORATOR_SHIFT = 24;
[]
FAnimNextDecoratorHandle::GetDecoratorIndex
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
Returns the decorator index.
AnimNext
uint32 GetDecoratorIndex() const
[]
FAnimNextDecoratorHandle::GetNodeHandle
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
Returns a handle to the node in the shared data segment.
AnimNext
[UE::AnimNext::FNodeHandle](API\Plugins\AnimNext\DecoratorBase\FNodeHandle) GetNodeHandle() const
[]
INVALID_SHARED_OFFSET_VALUE
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
AnimNext
static constexpr uint32 INVALID_SHARED_OFFSET_VALUE = SHARED_OFFSET_MASK;
[]
FAnimNextDecoratorHandle::IsValid
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
Returns true if this decorator handle is valid, false otherwise.
AnimNext
bool IsValid() const
[]
SHARED_OFFSET_MASK
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
AnimNext
static constexpr uint32 SHARED_OFFSET_MASK = ~0u >> (32 - DECORATOR_SHIFT);
[]
FAnimNextDecoratorHandle::FAnimNextDecoratorHandle
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
Creates a decorator handle pointing to the first decorator of the specified node.
AnimNext
FAnimNextDecoratorHandle ( [UE::AnimNext::FNodeHandle](API\Plugins\AnimNext\DecoratorBase\FNodeHandle) NodeHandle )
[]
FAnimNextDecoratorHandle::FAnimNextDecoratorHandle
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
Creates a decorator handle pointing to the specified decorator on the specified node.
AnimNext
FAnimNextDecoratorHandle ( [UE::AnimNext::FNodeHandle](API\Plugins\AnimNext\DecoratorBase\FNodeHandle) NodeHandle, uint32 DecoratorIndex_ )
[]
FAnimNextDecoratorHandle::FAnimNextDecoratorHandle
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
Creates an invalid decorator handle.
AnimNext
FAnimNextDecoratorHandle()
[]
FAnimNextDecoratorHandle
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorHandle.h
FNodeDescription
AnimNext
[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FAnimNextDecoratorHandle
[]
FAnimNextDecoratorSharedData
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorSharedData.h
FNodeDescription
AnimNext
[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FAnimNextDecoratorSharedData
[]
DecoratorSuper
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
AnimNext
typedef [FDecorator](API\Plugins\AnimNext\DecoratorBase\FDecorator) DecoratorSuper
[]
DecoratorUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
FDecoratorimpl
AnimNext
static constexpr [UE::AnimNext::FDecoratorUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorUID) DecoratorUID = UE::AnimNext::FDecoratorUID(TEXT("FBaseDecorator"), 0xd23dcf79 );
[]
FBaseDecorator::GetDecoratorMode
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns the decorator mode.
AnimNext
virtual [EDecoratorMode](API\Plugins\AnimNext\DecoratorBase\UE__AnimNext__EDecoratorMode) GetDecoratorMode() const
[]
FBaseDecorator::GetDecoratorUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns the globally unique UID for this decorator.
AnimNext
virtual [UE::AnimNext::FDecoratorUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorUID) GetDecoratorUID() const
[]
FBaseDecorator
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Base class for base decorators that are standalone.
AnimNext
struct FBaseDecorator : public [UE::AnimNext::FDecorator](API\Plugins\AnimNext\DecoratorBase\FDecorator)
[]
FDecorator::ConstructDecoratorInstance
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Called when a new instance of the decorator is created or destroyed Derived types must override this and forward to the instance data constructor/destructor
AnimNext
void ConstructDecoratorInstance ( [FExecutionContext](API\Plugins\AnimNext\DecoratorBase\FExecutionContext) & Context, [FWeakDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FWeakDecoratorPtr) DecoratorPtr, const [FAnimNextDecoratorSharedData](API\Plugins\AnimNext\DecoratorBase\FAnimNextDecoratorSharedData) & DecoratorDesc, [FDecoratorInstanceData](API\Plugins\AnimNext\DecoratorBase\FDecoratorInstanceData) & DecoratorInstance ) const
[]
DecoratorUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
The globally unique UID for this decorator Derived types will have their own DecoratorUID member that hides/aliases/shadows this one
AnimNext
static constexpr [FDecoratorUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorUID) DecoratorUID = FDecoratorUID(TEXT("FDecorator"), 0x4fc735a2);
[]
FDecorator::DestructDecoratorInstance
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
AnimNext
void DestructDecoratorInstance ( [FExecutionContext](API\Plugins\AnimNext\DecoratorBase\FExecutionContext) & Context, [FWeakDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FWeakDecoratorPtr) DecoratorPtr, const [FAnimNextDecoratorSharedData](API\Plugins\AnimNext\DecoratorBase\FAnimNextDecoratorSharedData) & DecoratorDesc, [FDecoratorInstanceData](API\Plugins\AnimNext\DecoratorBase\FDecoratorInstanceData) & DecoratorInstance ) const
[]
FInstanceData
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
AnimNext
typedef [FDecoratorInstanceData](API\Plugins\AnimNext\DecoratorBase\FDecoratorInstanceData) FInstanceData
[]
FSharedData
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Empty shared/instance data types Derived types must define an alias for these
AnimNext
typedef [FAnimNextDecoratorSharedData](API\Plugins\AnimNext\DecoratorBase\FAnimNextDecoratorSharedData) FSharedData
[]
FDecorator::GetDecoratorInterface
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns a pointer to the specified interface if it is supported. Derived types must override this.
AnimNext
virtual const [IDecoratorInterface](API\Plugins\AnimNext\DecoratorBase\IDecoratorInterface) * GetDecoratorInterface ( [FDecoratorInterfaceUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorInterfaceUID) InterfaceUID ) const
[]
FDecorator::GetDecoratorMemoryDescription
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns the memory requirements of the derived decorator instance.
AnimNext
virtual [FDecoratorMemoryLayout](API\Plugins\AnimNext\DecoratorBase\FDecoratorMemoryLayout) GetDecoratorMemoryDescription() const
[]
FDecorator::GetDecoratorSharedDataStruct
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns theUScriptStructassociated with the shared data for the decorator.
AnimNext
virtual [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetDecoratorSharedDataStruct() const
[]
FDecorator::GetDecoratorMode
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns the decorator mode.
AnimNext
[EDecoratorMode](API\Plugins\AnimNext\DecoratorBase\UE__AnimNext__EDecoratorMode) GetDecoratorMode() const
[]
FDecorator::GetDecoratorUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Returns the globally unique UID for this decorator.
AnimNext
virtual [FDecoratorUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorUID) GetDecoratorUID() const
[]
FDecorator::SaveDecoratorSharedData
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Takes the editor properties as authored in the graph and converts them into an instance of theFAnimNextDecoratorSharedDataderived type using UE reflection. Decorators can override this function to control how editor only properties are coerced into the runtime shared data instance.
AnimNext
virtual void SaveDecoratorSharedData ( FDecoratorWriter & Writer, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & Properties, [FAnimNextDecoratorSharedData](API\Plugins\AnimNext\DecoratorBase\FAnimNextDecoratorSharedData) & OutSharedData ) const
[]
FDecorator::SerializeDecoratorSharedData
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Called to serialize decorator shared data.
AnimNext
virtual void SerializeDecoratorSharedData ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [FAnimNextDecoratorSharedData](API\Plugins\AnimNext\DecoratorBase\FAnimNextDecoratorSharedData) & SharedData ) const
[]
FDecorator::~FDecorator
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
AnimNext
virtual ~FDecorator()
[]
FDecoratorBinding::GetDecoratorPtr
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Returns the decorator pointer we are bound to.
AnimNext
[FWeakDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FWeakDecoratorPtr) GetDecoratorPtr() const
[]
FDecorator
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Decorators can have shared read-only data that all instances of a graph can use (e.g. hard-coded properties). Shared data must derive fromFAnimNextDecoratorSharedData. Decorators can have instance data (e.g. blend weight). Instance data must derive fromFDecoratorInstanceData.
AnimNext
struct FDecorator
[]
FDecoratorBinding::GetInstanceData
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Queries a node for a pointer to its decorator instance data. If the decorator handle is invalid, a null pointer is returned.
AnimNext
template<class InstanceDataType> InstanceDataType * GetInstanceData() const
[]
FDecoratorBinding::GetInterfaceTyped
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Performs a naked cast to the desired interface type.
AnimNext
template<class DecoratorInterfaceType> const DecoratorInterfaceType * GetInterfaceTyped() const
[]
FDecoratorBinding::GetInterfaceUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Returns the decorator interface UID when bound, an invalid UID otherwise.
AnimNext
[FDecoratorInterfaceUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorInterfaceUID) GetInterfaceUID() const
[]
FDecoratorBinding::GetSharedData
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Queries a node for a pointer to its decorator shared data. If the decorator handle is invalid, a null pointer is returned.
AnimNext
template<class SharedDataType> const SharedDataType * GetSharedData() const
[]
FDecoratorBinding::IsValid
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
AnimNext
bool IsValid() const
[]
FDecoratorBinding::operator==
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Equality and inequality tests.
AnimNext
bool operator== ( const [FDecoratorBinding](API\Plugins\AnimNext\DecoratorBase\FDecoratorBinding) & RHS ) const
[]
FDecoratorBinding::operator!=
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
AnimNext
bool operator!= ( const [FDecoratorBinding](API\Plugins\AnimNext\DecoratorBase\FDecoratorBinding) & RHS ) const
[]
FDecoratorBinding::FDecoratorBinding
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Creates an empty binding.
AnimNext
FDecoratorBinding()
[]
FDecoratorBinding::FDecoratorBinding
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Creates a valid binding.
AnimNext
FDecoratorBinding ( const [IDecoratorInterface](API\Plugins\AnimNext\DecoratorBase\IDecoratorInterface) * Interface_, const [FAnimNextDecoratorSharedData](API\Plugins\AnimNext\DecoratorBase\FAnimNextDecoratorSharedData) * SharedData_, [FDecoratorInstanceData](API\Plugins\AnimNext\DecoratorBase\FDecoratorInstanceData) * InstanceData_, [FWeakDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FWeakDecoratorPtr) DecoratorPtr_ )
[]
FDecoratorInstanceData::Construct
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInstanceData.h
Called after the constructor has been called when a new instance is created. This is called after the default constructor. You can override this function by adding a new one with the same name on your derived type. You can also specialize theFAnimNextDecoratorSharedDatawith the derived version as long as the reference can coerce to 'constFAnimNextDecoratorSharedData&'. Decorators are constructed from the bottom to the top.
AnimNext
void Construct ( [FExecutionContext](API\Plugins\AnimNext\DecoratorBase\FExecutionContext) & Context, [FWeakDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FWeakDecoratorPtr) DecoratorPtr, const [FAnimNextDecoratorSharedData](API\Plugins\AnimNext\DecoratorBase\FAnimNextDecoratorSharedData) & DecoratorDesc )
[]
FDecoratorInstanceData::Destruct
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInstanceData.h
Called before the destructor has been called when an instance is destroyed. This is called before the default destructor. You can override this function by adding a new one with the same name on your derived type. You can also specialize theFAnimNextDecoratorSharedDatawith the derived version as long as the reference can coerce to 'constFAnimNextDecoratorSharedData&'. Decorators are destructed from the top to the bottom.
AnimNext
void Destruct ( [FExecutionContext](API\Plugins\AnimNext\DecoratorBase\FExecutionContext) & Context, [FWeakDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FWeakDecoratorPtr) DecoratorPtr, const [FAnimNextDecoratorSharedData](API\Plugins\AnimNext\DecoratorBase\FAnimNextDecoratorSharedData) & DecoratorDesc )
[]
FDecoratorInstanceData
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInstanceData.h
FNodeInstance
AnimNext
struct FDecoratorInstanceData
[]
FDecoratorInterfaceUID::GetInterfaceName
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInterfaceUID.h
Returns a literal string to the interface name.
AnimNext
constexpr const TCHAR * GetInterfaceName() const
[]
FDecoratorBinding
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorBinding.h
Base class for all decorator bindings. A decorator binding contains untyped data about a specific decorator instance.
AnimNext
struct FDecoratorBinding
[ { "type": "FWeakDecoratorP...", "name": "DecoratorPtr", "description": "" }, { "type": "FDecoratorInsta...", "name": "InstanceData", "description": "" }, { "type": "constIDecorato...", "name": "Interface", "description": "" }, { "type": "constFAnimNext...", "name": "SharedData", "description": "" } ]
FDecoratorInterfaceUID::GetUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInterfaceUID.h
Returns the interface global UID.
AnimNext
constexpr uint32 GetUID() const
[]
FDecoratorInterfaceUID::IsValid
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInterfaceUID.h
Returns whether this UID is valid or not.
AnimNext
constexpr bool IsValid() const
[]
FDecoratorInterfaceUID::operator==
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInterfaceUID.h
Compares for equality and inequality.
AnimNext
constexpr bool operator== ( [FDecoratorInterfaceUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorInterfaceUID) RHS ) const
[]
FDecoratorInterfaceUID::operator!=
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInterfaceUID.h
AnimNext
constexpr bool operator!= ( [FDecoratorInterfaceUID](API\Plugins\AnimNext\DecoratorBase\FDecoratorInterfaceUID) RHS ) const
[]
FDecoratorInterfaceUID::FDecoratorInterfaceUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInterfaceUID.h
Constructs an invalid UID.
AnimNext
constexpr FDecoratorInterfaceUID()
[]
FDecoratorInterfaceUID::FDecoratorInterfaceUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInterfaceUID.h
Constructs an interface UID.
AnimNext
constexpr FDecoratorInterfaceUID ( const TCHAR * InterfaceName_, uint32 UID_ )
[]
FDecoratorInterfaceUID
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorInterfaceUID.h
The whole struct is meant to be 'constexpr' to allow inlining in interface queries.
AnimNext
struct FDecoratorInterfaceUID
[]
FDecoratorMemoryLayout
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/Decorator.h
Encapsulates size/alignment details for a decorator.
AnimNext
struct FDecoratorMemoryLayout
[ { "type": "uint32", "name": "DecoratorAlignment", "description": "The alignment in bytes of an instance of the decorator class which derives fromFDecorator." }, { "type": "uint32", "name": "DecoratorSize", "description": "The size in bytes of an instance of the decorator class which derives fromFDecorator." }, { "type": "uint32", "name": "InstanceDataAlignment", "description": "The alignment in bytes of the instance data for the decorator." }, { "type": "uint32", "name": "InstanceDataSize", "description": "The size in bytes of the instance data for the decorator." }, { "type": "uint32", "name": "SharedDataAlignment", "description": "The alignment in bytes of the shared data for the decorator." }, { "type": "uint32", "name": "SharedDataSize", "description": "The size in bytes of the shared data for the decorator." } ]
EFlags
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Various flags stored in the pointer alignment bits, assumes an alignment of at least 4 bytes.
AnimNext
enum EFlags { IS_WEAK_BIT = 0x01, FLAGS_MASK = 0x03, }
[]
FDecoratorPtr::GetDecoratorIndex
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Returns the decorator index this pointer handle references.
AnimNext
constexpr uint32 GetDecoratorIndex() const
[]
FDecoratorPtr::IsValid
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Returns true when the pointer is valid, false otherwise.
AnimNext
constexpr bool IsValid() const
[]
FDecoratorPtr::GetNodeInstance
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Returns a pointer to the node instance.
AnimNext
[FNodeInstance](API\Plugins\AnimNext\DecoratorBase\FNodeInstance) * GetNodeInstance() const
[]
FDecoratorPtr::IsWeak
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Returns true if this pointer handle is weak, false otherwise.
AnimNext
constexpr bool IsWeak() const
[]
FDecoratorPtr::operator=
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
AnimNext
[FDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FDecoratorPtr) & operator= ( const [FDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FDecoratorPtr) & DecoratorPtr )
[]
FDecoratorPtr::operator=
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
AnimNext
[FDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FDecoratorPtr) & operator= ( [FDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FDecoratorPtr) && DecoratorPtr )
[]
FDecoratorPtr::operator==
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Equality and inequality tests.
AnimNext
bool operator== ( const [FDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FDecoratorPtr) & RHS ) const
[]
FDecoratorPtr::operator==
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
AnimNext
bool operator== ( const [FWeakDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FWeakDecoratorPtr) & RHS ) const
[]
FDecoratorPtr::operator!=
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
AnimNext
bool operator!= ( const [FDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FDecoratorPtr) & RHS ) const
[]
FDecoratorPtr::operator!=
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
AnimNext
bool operator!= ( const [FWeakDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FWeakDecoratorPtr) & RHS ) const
[]
FDecoratorPtr::Reset
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Clears the handle and renders it invalid.
AnimNext
void Reset()
[]
FDecoratorPtr::FDecoratorPtr
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Constructs an invalid pointer handle.
AnimNext
constexpr FDecoratorPtr()
[]
FDecoratorPtr::FDecoratorPtr
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
AnimNext
FDecoratorPtr ( const [FDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FDecoratorPtr) & DecoratorPtr )
[]
FDecoratorPtr::FDecoratorPtr
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
AnimNext
FDecoratorPtr ( [FDecoratorPtr](API\Plugins\AnimNext\DecoratorBase\FDecoratorPtr) && DecoratorPtr )
[]
FDecoratorPtr::FDecoratorPtr
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Constructs a pointer handle to the provided instance.
AnimNext
FDecoratorPtr ( [FNodeInstance](API\Plugins\AnimNext\DecoratorBase\FNodeInstance) * NodeInstance, uint32 DecoratorIndex_ )
[]
FDecoratorPtr::FDecoratorPtr
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
Constructs a pointer handle to the provided instance.
AnimNext
FDecoratorPtr &40; FNodeInstance &42; NodeInstance, EFlags Flags, uint32 DecoratorIndex_ &41;
[]
FDecoratorPtr::~FDecoratorPtr
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
AnimNext
~FDecoratorPtr()
[]
FDecoratorRegistryHandle::GetDynamicIndex
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorRegistryHandle.h
Returns the dynamic array index for this handle when valid, otherwise INDEX_NONE.
AnimNext
int32 GetDynamicIndex() const
[]
FDecoratorPtr
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorPtr.h
FDecoratorInstanceData
AnimNext
struct FDecoratorPtr
[]
FDecoratorRegistryHandle::GetStaticOffset
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorRegistryHandle.h
Returns the static buffer offset for this handle when valid, otherwise INDEX_NONE.
AnimNext
int32 GetStaticOffset() const
[]
FDecoratorRegistryHandle::IsDynamic
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorRegistryHandle.h
Returns whether or not this handle is valid and points to a dynamic decorator.
AnimNext
bool IsDynamic() const
[]
FDecoratorRegistryHandle::IsStatic
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorRegistryHandle.h
Returns whether or not this handle is valid and points to a static decorator.
AnimNext
bool IsStatic() const
[]
FDecoratorRegistryHandle::IsValid
/Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/DecoratorBase/DecoratorRegistryHandle.h
Returns whether or not this handle points to a valid decorator.
AnimNext
bool IsValid() const
[]