1. Epic GamesDeveloper
  3. FMemberReference

FMemberReference

@TODO: this can encapsulate globally defined fields as well (like with native delegate signatures); consider renaming to FFieldReference

API > API/Runtime > API/Runtime/Engine

@TODO: this can encapsulate globally defined fields as well (like with native delegate signatures); consider renaming to FFieldReference

   
Name FMemberReference
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Engine/MemberReference.h
Include Path #include "Engine/MemberReference.h"

Syntax

USTRUCT ()  
struct FMemberReference

Constructors

Name Remarks Include Path Unreal Specifiers

FMemberReference()

   Engine/MemberReference.h  

Constants

Name Type Remarks Include Path
bFieldRedirectMapInitialized bool Has the field map been initialized this run Engine/MemberReference.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

FGuid GetMemberGuid()

   Engine/MemberReference.h  

FName GetMemberName()

 Get the name of this member Engine/MemberReference.h  
  Engine/MemberReference.h  

UClass * GetMemberParentClass ( UClass* SelfScope
) const

 Get the class that owns this member Engine/MemberReference.h  

UPackage * GetMemberParentPackage()

   Engine/MemberReference.h  

UStruct * GetMemberScope ( UClass* InMemberParentClass
) const

 Get the scope of this member Engine/MemberReference.h  

FString GetMemberScopeName()

 Get the name of the scope of this member Engine/MemberReference.h  

FString GetReferenceSearchString ( UClass* InFieldOwner
) const

 Returns a search string to submit to Find-in-Blueprints to find references to this reference Engine/MemberReference.h  

UClass * GetScope ( UClass* SelfScope
) const

 Returns the scope for the current member. Engine/MemberReference.h  

void InvalidateScope ()

 Invalidate the current MemberParent, if this is a self scope, or the MemberScope if it is not (and set). Engine/MemberReference.h  

bool IsDeprecated()

 Returns whether or not the variable has been deprecated Engine/MemberReference.h  

bool IsLocalScope()

 Returns if this is a local scope. Engine/MemberReference.h  

bool IsSameReference ( const FMemberReference& InReference
) const

 Compares with another MemberReference to see if they are identical Engine/MemberReference.h  

bool IsSelfContext()

 Returns if this is a 'self' context. Engine/MemberReference.h  

bool IsSparseClassData ( const UClass* OwningClass
) const

 Returns true if this is in the sparse data struct for OwningClass Engine/MemberReference.h  

void RefreshGivenNewSelfScope ( UClass* SelfScope
)

 Update given a new self Engine/MemberReference.h  

UFunction * ResolveMember ( UClass* SelfScope,
const bool bAlwaysFollowRedirects
) const

   Engine/MemberReference.h  

TFieldType * ResolveMember ( UClass* SelfScope,
const bool bAlwaysFollowRedirects
) const

 Returns the member FProperty/UFunction this reference is pointing to, or NULL if it no longer exists Derives 'self' scope from supplied Blueprint node if required Will check for redirects and fix itself up if one is found (when WITH_EDITOR, or when bAlwaysFollowRedirects is true). Engine/MemberReference.h  

TFieldType * ResolveMember ( UBlueprint* SelfScope
)

 ResolveMember overload for UBlueprint, uses the skeleton class so it can be more up to date Engine/MemberReference.h  

void SetDirect ( const FName InMemberName,
const FGuid InMemberGuid,
TSubclassOf< class UObject > InMemberParentClass,
bool bIsConsideredSelfContext
)

 Only intended for backwards compat! Engine/MemberReference.h  

void SetExternalDelegateMember ( FName InMemberName
)

 Set to a non-'self' delegate member, this is not self-context but is not given a parent class Engine/MemberReference.h  

void SetExternalMember ( FName InMemberName,
TSubclassOf< class UObject > InMemberParentClass
)

 Set to a non-'self' member, so must include reference to class owning the member. Engine/MemberReference.h  

void SetExternalMember ( FName InMemberName,
TSubclassOf< class UObject > InMemberParentClass,
const FGuid& InMemberGuid
)

   Engine/MemberReference.h  

void SetFromField ( const typename TFieldType::BaseFieldClass* InField,
UClass* SelfScope
)

   Engine/MemberReference.h  

void SetFromField ( const typename TFieldType::BaseFieldClass* InField,
const bool bIsConsideredSelfContext,
UClass* OwnerClass
)

 Set up this reference from a supplied field Engine/MemberReference.h  

void SetGlobalField ( FName InFieldName,
UPackage* InParentPackage
)

 Set to reference a global field (intended for things like natively defined delegate signatures) Engine/MemberReference.h  

void SetLocalMember ( FName InMemberName,
UStruct* InScope,
const FGuid InMemberGuid
)

 Set up this reference to a 'self' member name, scoped to a struct Engine/MemberReference.h  

void SetLocalMember ( FName InMemberName,
FString InScopeName,
const FGuid InMemberGuid
)

 Set up this reference to a 'self' member name, scoped to a struct name Engine/MemberReference.h  

void SetMemberName ( FName NewName
)

 Reset the member name only. Intended for use primarily as a helper method for rename operations. Engine/MemberReference.h  

void SetSelfMember ( FName InMemberName
)

 Set up this reference to a 'self' member name Engine/MemberReference.h  

void SetSelfMember ( FName InMemberName,
const FGuid& InMemberGuid
)

   Engine/MemberReference.h  

Protected

Name Remarks Include Path Unreal Specifiers

UFunction * ResolveMemberFunction ( UClass* SelfScope,
const bool bAlwaysFollowRedirects
) const

   Engine/MemberReference.h  

TFieldType * ResolveMemberImpl ( UClass* SelfScope,
TFieldTypeClass* FieldClas,
const bool bAlwaysFollowRedirects,
const bool bIsUFunctionOrMulticastDelegate
) const

   Engine/MemberReference.h  

FProperty * ResolveMemberProperty ( UClass* SelfScope,
const bool bAlwaysFollowRedirects,
FFieldClass* FieldClass
) const

   Engine/MemberReference.h  

void SetGivenSelfScope ( const FName InMemberName,
const FGuid InMemberGuid,
TSubclassOf< class UObject > InMemberParentClass,
TSubclassOf< class UObject > SelfScope
) const

 Only intended for backwards compat! Engine/MemberReference.h  

Static

Name Remarks Include Path Unreal Specifiers

static void FillSimpleMemberReference ( const TFieldType* InField,
FSimpleMemberReference& OutReference
)

   Engine/MemberReference.h  

static FField * FindRemappedField ( FFieldClass* FieldClass,
UClass* InitialScope,
FName InitialName,
bool bInitialScopeMustBeOwnerOfFieldForParentScopeRedirect
)

   Engine/MemberReference.h  

static UField * FindRemappedField ( UClass* FieldClass,
UClass* InitialScope,
FName InitialName,
bool bInitialScopeMustBeOwnerOfFieldForParentScopeRedirect
)

 Searches the field redirect map for the specified named field in the scope, and returns the remapped field if found Engine/MemberReference.h  

static TFieldType * FindRemappedField ( UClass* InitialScope,
FName InitialName,
bool bInitialScopeMustBeOwnerOfFieldForParentScopeRedirect
)

 Templated version of above, extracts FieldClass and Casts result Engine/MemberReference.h  

static UClass * GetClassToUse ( UClass* InClass,
bool bUseUpToDateClass
)

   Engine/MemberReference.h  

static void InitFieldRedirectMap()

 Init the field redirect map (if not already done) from .ini file entries Engine/MemberReference.h  

static TFieldType * ResolveSimpleMemberReference ( const FSimpleMemberReference& Reference,
UClass* SelfScope
)

   Engine/MemberReference.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page