1. Epic GamesDeveloper
  3. UFunction

UFunction

Reflection data for a replicated or Kismet callable function.

API > API/Runtime > API/Runtime/CoreUObject

Reflection data for a replicated or Kismet callable function.

   
Name UFunction
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h
Include Path #include "UObject/Class.h"

Syntax

class UFunction : public UStruct

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UFunction ( UFunction* InSuperFunction,
EFunctionFlags InFunctionFlags,
SIZE_T ParamsSize
)

   UObject/Class.h  

UFunction ( const FObjectInitializer& ObjectInitializer
)

   UObject/Class.h  

UFunction ( FVTableHelper& Helper
)

 DO NOT USE. This constructor is for internal usage only for hot-reload purposes. UObject/Class.h  

UFunction ( const FObjectInitializer& ObjectInitializer,
UFunction* InSuperFunction,
EFunctionFlags InFunctionFlags,
SIZE_T ParamsSize
)

 Constructors. UObject/Class.h  

Typedefs

Name Type Remarks Include Path
Super UStruct Typedef for the base class (UStruct) UObject/Class.h
ThisClass UFunction Typedef for UFunction. UObject/Class.h
WithinClass class UClass The required type of this object's outer (class UClass) UObject/Class.h

Constants

Name Type Remarks Include Path
StaticClassFlags EClassFlags Bitwise union of EClassFlags pertaining to this class. UObject/Class.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers  
EventGraphCallOffset int32 The state offset inside of the event graph (persistent) UObject/Class.h    
EventGraphFunction UFunction * The event graph this function calls in to (persistent) UObject/Class.h    
FirstPropertyToInit FProperty * Pointer to first local struct property in this UFunction that contains defaults UObject/Class.h    
FunctionFlags EFunctionFlags EFunctionFlags set defined for this function UObject/Class.h    
NumParms uint8 Number of parameters total UObject/Class.h    
ParmsSize uint16 Total size of parameters in memory UObject/Class.h    
ReturnValueOffset uint16 Memory offset of return value property UObject/Class.h    
RPCId uint16 Id of this RPC function call (must be FUNC_Net & (FUNC_NetService FUNC_NetResponse)) UObject/Class.h  
RPCResponseId uint16 Id of the corresponding response call (must be FUNC_Net & FUNC_NetService) UObject/Class.h    

Protected

Name Type Remarks Include Path Unreal Specifiers
Func FNativeFuncPtr C++ function this is bound to UObject/Class.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FNativeFuncPtr GetNativeFunc()

 Returns the native func pointer. UObject/Class.h  

UClass * GetOuterUClass()

   UObject/Class.h  

UClass * GetOuterUClassUnchecked()

 Returns the owning UClass* without branching UObject/Class.h  

FProperty * GetReturnProperty()

 Returns the return value property if there is one, or null UObject/Class.h  

UFunction * GetSuperFunction()

 Returns parent function if there is one, or null UObject/Class.h  

bool HasAllFunctionFlags ( EFunctionFlags FlagsToCheck
) const

 Used to safely check whether all of the passed in flags are set. UObject/Class.h  

bool HasAnyFunctionFlags ( EFunctionFlags FlagsToCheck
) const

 Used to safely check whether the passed in flag is set. UObject/Class.h  

void InitializeDerivedMembers()

 Initializes transient members like return value offset UObject/Class.h  

void Invoke ( UObject* Obj,
FFrame& Stack,
void*const Z_Param__Result
)

 Invokes the UFunction on a UObject. UObject/Class.h  

bool IsSignatureCompatibleWith ( const UFunction* OtherFunction,
uint64 IgnoreFlags
) const

 Determines if two functions have an identical signature (note: currently doesn't allow matches with class parameters that differ only in how derived they are; there is no directionality to the call) UObject/Class.h  

bool IsSignatureCompatibleWith ( const UFunction* OtherFunction
) const

 Determines if two functions have an identical signature (note: currently doesn't allow matches with class parameters that differ only in how derived they are; there is no directionality to the call) UObject/Class.h  

void SetNativeFunc ( FNativeFuncPtr InFunc
)

 Sets the native func pointer. UObject/Class.h  

Overridden from UStruct

Name Remarks Include Path Unreal Specifiers

virtual UStruct * GetInheritanceSuper()

 Returns the structure used for inheritance, may be changed by child types UObject/Class.h  

virtual void Link ( FArchive& Ar,
bool bRelinkExistingProperties
)

 Creates the field/property links and gets structure ready for use at runtime UObject/Class.h  

Overridden from UField

Name Remarks Include Path Unreal Specifiers

virtual void Bind()

   UObject/Class.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad ()

 Do any object-specific cleanup required immediately after loading an object. UObject/Class.h  

virtual void Serialize ( FArchive& Ar
)

 Handles reading, writing, and reference collecting using FArchive. UObject/Class.h  

Static

Name Remarks Include Path Unreal Specifiers

static void __DefaultConstructor ( const FObjectInitializer& X
)

   UObject/Class.h  

static UObject * __VTableCtorCaller ( FVTableHelper& Helper
)

   UObject/Class.h  

static uint64 GetDefaultIgnoredSignatureCompatibilityFlags()

 Returns the flags that are ignored by default when comparing function signatures. UObject/Class.h  

static UClass * GetPrivateStaticClass()

   UObject/Class.h  

static void IntrinsicClassInit ( UClass* Class
)

   UObject/Class.h  

static UClass * StaticClass()

 Returns a UClass object representing this class at runtime UObject/Class.h  

static EClassCastFlags StaticClassCastFlags()

 Returns the static cast flags for this class UObject/Class.h  

static const TCHAR * StaticPackage()

 Returns the package this class belongs in UObject/Class.h  

static void StaticRegisterNativesUFunction()

   UObject/Class.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator delete ( void* InMem
)

 Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy. UObject/Class.h  

void * operator new ( const size_t InSize,
EInternal* InMem
)

 For internal use only; use StaticConstructObject() to create new objects. UObject/Class.h  

void * operator new ( const size_t InSize,
EInternal InInternalOnly,
UObject* InOuter,
FName InName,
EObjectFlags InSetFlags
)

 For internal use only; use StaticConstructObject() to create new objects. UObject/Class.h  
  UObject/Class.h  
  UObject/Class.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page