FMemberReference

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

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/MemberReference.h

Include

#include "Engine/MemberReference.h"

Syntax

struct FMemberReference

Remarks

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

Variables

Name Description

Protected variable

bool

 

bSelfContext

Whether or not this should be a "self" context

Protected variable

bool

 

bWasDeprecated

Whether or not this property has been deprecated

Protected variable

FGuid

 

MemberGuid

The Guid of the variable

Protected variable

FName

 

MemberName

Name of variable

Protected variable

UObject *

 

MemberParent

Most often the Class that this member is defined in.

Protected variable

FString

 

MemberScope

Constructors

Name Description

Public function

FMemberReference()

Functions

Name Description

Public function Const

bool

 

CompareClassesHelper

(
    const FFieldClass* ClassA,
    const UClass* ClassB
)

Public function Const

bool

 

CompareClassesHelper

(
    const TFieldClassA* ClassA,
    const TFieldClassB* ClassB
)

Public function Const

bool

 

CompareClassesHelper

(
    const UClass* ClassA,
    const FFieldClass* ClassB
)

Public function Static

void

 

FillSimpleMemberReference

(
    const TFieldType* InField,
    FSimpleMemberReference& OutReferen...
)

Public function Static

UField *

 

FindRemappedField

(
    UClass* FieldClass,
    UClass* InitialScope,
    FName InitialName,
    bool bInitialScopeMustBeOwnerOfFiel...
)

Searches the field redirect map for the specified named field in the scope, and returns the remapped field if found

Public function Static

TFieldType &...

 

FindRemappedField

(
    UClass* InitialScope,
    FName InitialName,
    bool bInitialScopeMustBeOwnerOfFiel...
)

Templated version of above, extracts FieldClass and Casts result

Public function Static

FField *

 

FindRemappedField

(
    FFieldClass* FieldClass,
    UClass* InitialScope,
    FName InitialName,
    bool bInitialScopeMustBeOwnerOfFiel...
)

Searches the field redirect map for the specified named field in the scope, and returns the remapped field if found

Protected function Static

UClass *

 

GetClassToUse

(
    UClass* InClass,
    bool bUseUpToDateClass
)

Protected function Const

UObject *...

 

GetFieldOuter

(
    TFieldType Field
)

Public function Const

UObject *...

 

GetFieldOuter

(
    FField* Field
)

Public function Const

FGuid

 

GetMemberGuid()

Public function Const

FName

 

GetMemberName()

Get the name of this member

Public function Const

UClass *

 

GetMemberParentClass

(
    UClass* SelfScope
)

Get the class that owns this member

Public function Const

UClass *

 

GetMemberParentClass()

Public function Const

UPackage ...

 

GetMemberParentPackage()

Public function Const

UStruct *...

 

GetMemberScope

(
    UClass* InMemberParentClass
)

Get the scope of this member

Public function Const

FString

 

GetMemberScopeName()

Get the name of the scope of this member

Public function Const

FString

 

GetReferenceSearchString

(
    UClass* InFieldOwner
)

Returns a search string to submit to Find-in-Blueprints to find references to this reference

Public function Const

UClass *

 

GetScope

(
    UClass* SelfScope
)

Returns the scope for the current member.

Public function Static

void

 

InitFieldRedirectMap()

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

Public function

void

 

InvalidateScope()

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

Public function Const

bool

 

IsDeprecated()

Returns whether or not the variable has been deprecated

Public function Const

bool

 

IsLocalScope()

Returns if this is a local scope.

Public function

bool

 

IsSameReference

(
    FMemberReference& InReference
)

Compares with another MemberReference to see if they are identical

Public function Const

bool

 

IsSelfContext()

Returns if this is a 'self' context.

Public function Const

bool

 

IsSparseClassData

(
    const UClass* OwningClass
)

Returns true if this is in the sparse data struct for OwningClass

Public function

void

 

RefreshGivenNewSelfScope

(
    UClass* SelfScope
)

Update given a new self

Public function Const

TFieldType &...

 

ResolveMember

(
    UClass* SelfScope
)

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.

Public function

TFieldType &...

 

ResolveMember

(
    UBlueprint* SelfScope
)

Public function Static

TFieldType &...

 

ResolveSimpleMemberReference

(
    const FSimpleMemberReference& Refe...,
    UClass* SelfScope
)

Protected function Const

TFieldType &...

 

ResolveUField

(
    UClass* InClass,
    UPackage* TargetPackage
)

Protected function Const

TFieldType &...

 

ResolveUField

(
    FFieldClass* InClass,
    UPackage* TargetPackage
)

Public function Const

UFunction &#...

 

ResolveUFunction()

Protected function Const

TFieldType &...

 

ResolveUFunction()

Public function

void

 

SetDirect

(
    const FName InMemberName,
    const FGuid InMemberGuid,
    TSubclassOf< class UObject > InMemb...,
    bool bIsConsideredSelfContext
)

Only intended for backwards compat!

Public function

void

 

SetExternalDelegateMember

(
    FName InMemberName
)

Set to a non-'self' delegate member, this is not self-context but is not given a parent class

Public function

void

 

SetExternalMember

(
    FName InMemberName,
    TSubclassOf< class UObject > InMemb...
)

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

Public function

void

 

SetExternalMember

(
    FName InMemberName,
    TSubclassOf< class UObject > InMemb...,
    FGuid& InMemberGuid
)

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

Public function

void

 

SetFromField

(
    const typename TFieldType::BaseFiel...,
    const bool bIsConsideredSelfContext,
    UClass* OwnerClass
)

Set up this reference from a supplied field

Public function

void

 

SetFromField

(
    const typename TFieldType::BaseFiel...,
    UClass* SelfScope
)

Protected function Const

void

 

SetGivenSelfScope

(
    const FName InMemberName,
    const FGuid InMemberGuid,
    TSubclassOf< class UObject > InMemb...,
    TSubclassOf< class UObject > SelfSc...
)

Only intended for backwards compat!

Public function

void

 

SetGlobalField

(
    FName InFieldName,
    UPackage* InParentPackage
)

Set to reference a global field (intended for things like natively defined delegate signatures)

Public function

void

 

SetLocalMember

(
    FName InMemberName,
    FString InScopeName,
    const FGuid InMemberGuid
)

Set up this reference to a 'self' member name, scoped to a struct name

Public function

void

 

SetLocalMember

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

Set up this reference to a 'self' member name, scoped to a struct

Public function

void

 

SetMemberName

(
    FName NewName
)

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

Public function

void

 

SetSelfMember

(
    FName InMemberName
)

Set up this reference to a 'self' member name

Public function

void

 

SetSelfMember

(
    FName InMemberName,
    FGuid& InMemberGuid
)

Set up this reference to a 'self' member name

Constants

Name

Description

bFieldRedirectMapInitialized

Has the field map been initialized this run
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss