1. Epic GamesDeveloper
  3. FScriptInterface

FScriptInterface

This utility class stores the [FProperty](API\Runtime\CoreUObject\UObject\FProperty) data for an interface property used in both blueprint and native code.

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/ScriptInterface.h
Include #include "UObject/ScriptInterface.h"

Syntax

class FScriptInterface

Remarks

This utility class stores the FProperty data for an interface property used in both blueprint and native code. For objects natively implementing an interface, ObjectPointer and InterfacePointer point to different locations in the same UObject. For objects that only implement an interface in blueprint, only ObjectPointer will be set because there is no native representation. UClass::ImplementsInterface can be used along with Execute_ event wrappers to properly handle BP-implemented interfaces.

Constructors

  Type Name Description
Public function   Default constructor
Public function   Copyable
Public function  

FScriptInterface ( UObject* InObjectPointer,
void* InInterfacePointer
)

 Construction from object and interface

Functions

  Type Name Description
Public function void  
Public function Const void * Returns the pointer to the native interface if it is valid
Public function Const UObject * Returns the ObjectPointer contained by this FScriptInterface
Public function TObjectPtr< UObject > & Returns the ObjectPointer contained by this FScriptInterface
Protected function FArchive &

Serialize ( FArchive& Ar,
UClass* InterfaceType
)

 Serialize ScriptInterface
Public function void

SetInterface ( void* InInterfacePointer
)

 Sets the value of the InterfacePointer for this FScriptInterface
Public function void

SetObject ( UObject* InObjectPointer
)

 Sets the value of the ObjectPointer for this FScriptInterface

Operators

  Type Name Description
Public function Const bool

operator!= ( const FScriptInterface& Other
)

  
Public function FScriptInterface &  
Public function Const bool

operator== ( const FScriptInterface& Other
)

 Comparison operator, taking a reference to another FScriptInterface

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page