Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > TAttribute

Light Theme

Dark Theme

TAttribute

Copyright Epic Games, Inc. All Rights Reserved.

Choose your operating system:

Windows

macOS

Linux

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

	Name	Description
	TAttribute()	Default constructor.
	TAttribute ( const OtherType& InInitialValue )	Construct implicitly from an initial value
	TAttribute ( ObjectType&& InInitialValue )	Construct implicitly from moving an initial value
	TAttribute ( TSharedRef< SourceType > InUserObje..., typename FGetter::template TConstMe... )	Constructs by binding an arbitrary function that will be called to generate this attribute's value on demand.
	TAttribute ( SourceType* InUserObject, typename FGetter::template TConstMe... )	Constructs by binding an arbitrary function that will be called to generate this attribute's value on demand.

Functions

	Name	Description
void	Bind ( SourceType* InUserObject, typename FGetter::template TConstMe... )	Binds an arbitrary function that will be called to generate this attribute's value on demand.
void	Bind ( TSharedRef< SourceType > InUserObje..., typename FGetter::template TConstMe... )	Binds an arbitrary function that will be called to generate this attribute's value on demand.
void	Bind ( FGetter&& InGetter )	Binds an arbitrary function that will be called to generate this attribute's value on demand.
void	Bind ( const FGetter& InGetter )	Binds an arbitrary function that will be called to generate this attribute's value on demand.
void	BindRaw ( SourceType* InUserObject, typename FGetter::template TConstMe... )	Binds an arbitrary function that will be called to generate this attribute's value on demand.
void	BindStatic ( typename FGetter::template FStaticD..., VarTypes... Vars )	Binds an arbitrary function that will be called to generate this attribute's value on demand.
void	BindUFunction ( SourceType* InUserObject, const FName& InFunctionName )	Binds an arbitrary function that will be called to generate this attribute's value on demand.
void	BindUObject ( SourceType* InUserObject, typename FGetter::template TConstMe... )	Binds an arbitrary function that will be called to generate this attribute's value on demand.
TAttribute< ...	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.
TAttribute	Create ( typename FGetter::template FStaticD..., VarTypes... Vars )	Creates an attribute by binding an arbitrary function that will be called to generate this attribute's value on demand.
TAttribute	Create ( const FGetter& InGetter )	Static: Creates an attribute that's pre-bound to the specified 'getter' delegate
TAttribute< ...	Create ( TFunction< ObjectType(void)>&& InL... )
TAttribute	CreateLambda ( LambdaType&& InCallable, PayloadTypes&&... InputPayload )	Helper function for creating TAttributes from a lambda TAttribute FloatAttribute = TAttribute::CreateLambda;
TAttribute	CreateRaw ( const SourceType* InObject, ObjectType(SourceTypeOrBase::*)..., typename TDecay< PayloadTypes >::Ty... )	Helper function for creating TAttributes from a const member function pointer, accessed through a raw pointer
TAttribute	CreateSP ( const SourceType* InObject, ObjectType(SourceTypeOrBase::*)..., typename TDecay< PayloadTypes >::Ty... )	Helper function for creating TAttributes from a const member function pointer, accessed through a weak pointer to the shared object
const Object...	Get ( const ObjectType& DefaultValue )	Gets the attribute's current value.
const Object...	Get()	Gets the attribute's current value. Assumes that the attribute is set.
const FGette...	GetBinding()	Gets the attribute's 'getter' which can be bound or unbound
bool	IdenticalTo ( const TAttribute& InOther )	Is this attribute identical to another TAttribute.
bool	IsBound()	Checks to see if this attribute has a 'getter' function bound
bool	IsSet()	Was this TAttribute ever assigned?
void	Set ( const OtherType& InNewValue )	Sets the attribute's value
void	Set ( ObjectType&& InNewValue )	Sets the attribute's value
TVariant< Ob...	Steal()	Move the attribute's 'getter' or the attribute's `Value_ and reset the attribute.

Typedefs

Name	Description
FGetter	Attribute 'getter' delegate ObjectType GetValue() const

Name

Description

FGetter

Attribute 'getter' delegate

ObjectType GetValue() const

Deprecated Functions

		Name	Description
	TAttribute	CreateRaw ( SourceType* InObject, ObjectType(SourceTypeOrBase::*)..., typename TDecay< PayloadTypes >::Ty... )	Attribute's Getter should be const.
	TAttribute	CreateSP ( SourceType* InObject, ObjectType(SourceTypeOrBase::*)..., typename TDecay< PayloadTypes >::Ty... )	Attribute's Getter should be const.