1. Epic GamesDeveloper
  3. TAttribute

TAttribute

Attribute object

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/Attribute.h
Include #include "Misc/Attribute.h"

Syntax

template<typename ObjectType>  
class TAttribute

Remarks

Attribute object

Constructors

  Type Name Description
Public function   Default constructor.
Public function  

TAttribute ( const OtherType& InInitialValue
)

 Construct implicitly from an initial value
Public function  

TAttribute ( ObjectType&& InInitialValue
)

 Construct implicitly from moving an initial value
Public function  

TAttribute ( TSharedRef< SourceType > InUserObject,
typename FGetter::template TConstMethodPtr< SourceType > InMethodPtr
)

 Constructs by binding an arbitrary function that will be called to generate this attribute's value on demand.
Public function  

TAttribute ( SourceType* InUserObject,
typename FGetter::template TConstMethodPtr< SourceType > InMethodPtr
)

 Constructs by binding an arbitrary function that will be called to generate this attribute's value on demand.

Functions

  Type Name Description
Public function void

Bind ( SourceType* InUserObject,
typename FGetter::template TConstMethodPtr< SourceType > InMethodPtr
)

 Binds an arbitrary function that will be called to generate this attribute's value on demand.
Public function void

Bind ( TSharedRef< SourceType > InUserObject,
typename FGetter::template TConstMethodPtr< SourceType > InMethodPtr
)

 Binds an arbitrary function that will be called to generate this attribute's value on demand.
Public function void

Bind ( FGetter&& InGetter
)

 Binds an arbitrary function that will be called to generate this attribute's value on demand.
Public function void

Bind ( const FGetter& InGetter
)

 Binds an arbitrary function that will be called to generate this attribute's value on demand.
Public function void

BindRaw ( SourceType* InUserObject,
typename FGetter::template TConstMethodPtr< SourceType > InMethodPtr
)

 Binds an arbitrary function that will be called to generate this attribute's value on demand.
Public function void

BindStatic ( TIdentity_T< typename FGetter::template TFuncPtr< VarTypes... > > InFuncPtr,
VarTypes... Vars
)

 Binds an arbitrary function that will be called to generate this attribute's value on demand.
Public function void

BindUFunction ( SourceType* InUserObject,
const FName& InFunctionName
)

 Binds an arbitrary function that will be called to generate this attribute's value on demand.
Public function void

BindUObject ( SourceType* InUserObject,
typename FGetter::template TConstMethodPtr< SourceType > InMethodPtr
)

 Binds an arbitrary function that will be called to generate this attribute's value on demand.
Public function Static TAttribute< ObjectType >

Create ( SourceType* InUserObject,
const FName& InFunctionName
)

 Creates an attribute by binding an arbitrary function that will be called to generate this attribute's value on demand.
Public function Static TAttribute

Create ( const FGetter& InGetter
)

 Static: Creates an attribute that's pre-bound to the specified 'getter' delegate
Public function Static TAttribute< ObjectType >

Create ( TFunction< ObjectType(void)>&& InLambda
)

  
Public function Static TAttribute

CreateLambda ( LambdaType&& InCallable,
PayloadTypes&&... InputPayload
)

 Helper function for creating TAttributes from a lambda TAttribute FloatAttribute = TAttribute::CreateLambda([]{ return 10.f; });
Public function Static TAttribute

CreateRaw ( const SourceType* InObject,
ObjectType(SourceTypeOrBase::*)(PayloadTypes...) const InMethod,
typename TDecay< PayloadTypes >::Type... InputPayload
)

 Helper function for creating TAttributes from a const member function pointer, accessed through a raw pointer
Public function Static TAttribute

CreateSP ( const SourceType* InObject,
ObjectType(SourceTypeOrBase::*)(PayloadTypes...) const InMethod,
typename TDecay< PayloadTypes >::Type... InputPayload
)

 Helper function for creating TAttributes from a const member function pointer, accessed through a weak pointer to the shared object
Public function Static TAttribute

CreateStatic ( TIdentity_T< typename FGetter::template TFuncPtr< VarTypes... > > InFuncPtr,
VarTypes... Vars
)

 Creates an attribute by binding an arbitrary function that will be called to generate this attribute's value on demand.
Public function Static TAttribute

CreateStatic ( FuncPtrType&& InFuncPtr,
VarTypes... Vars
)

 Creates an attribute by binding an arbitrary function that will be called to generate this attribute's value on demand.
Public function Const const ObjectType &

Get ( const ObjectType& DefaultValue
)

 Gets the attribute's current value.
Public function Const const ObjectType &

Get ()

 Gets the attribute's current value. Assumes that the attribute is set.
Public function Const const FGetter & Gets the attribute's 'getter' which can be bound or unbound
Public function Const bool

IdenticalTo ( const TAttribute& InOther
)

 Is this attribute identical to another TAttribute.
Public function Const bool

IsBound ()

 Checks to see if this attribute has a 'getter' function bound
Public function Const bool

IsSet ()

 Was this TAttribute ever assigned?
Public function void

Set ( const OtherType& InNewValue
)

 Sets the attribute's value
Public function void

Set ( ObjectType&& InNewValue
)

 Sets the attribute's value
Public function TVariant< ObjectType, FGetter >

Steal ()

 Move the attribute's 'getter' or the attribute's `Value_ and reset the attribute.

Typedefs

Name Description
FGetter Attribute 'getter' delegateObjectType GetValue() const

Deprecated Functions

  Type Name Description
Public function Static TAttribute

CreateRaw ( SourceType* InObject,
ObjectType(SourceTypeOrBase::*)(PayloadTypes...) InMethod,
typename TDecay< PayloadTypes >::Type... InputPayload
)

 Attribute's Getter should be const.
Public function Static TAttribute

CreateSP ( SourceType* InObject,
ObjectType(SourceTypeOrBase::*)(PayloadTypes...) InMethod,
typename TDecay< PayloadTypes >::Type... InputPayload
)

 Attribute's Getter should be const.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page