TScriptInterface< InInterfaceType > Class Template Reference

#include <ScriptInterface.h>

Inheritance diagram for TScriptInterface< InInterfaceType >:

Public Types
using	InterfaceType = InInterfaceType
using	UObjectType = TCopyQualifiersFromTo_T< InterfaceType, UObject >

Public Member Functions
	TScriptInterface ()=default
	TScriptInterface (TYPE_OF_NULLPTR)
template<typename U >
	TScriptInterface (U &&Source)
template<typename OtherInterfaceType >
	TScriptInterface (const TScriptInterface< OtherInterfaceType > &Other)
template<typename ObjectType >
	TScriptInterface (TObjectPtr< ObjectType > SourceObject)
	TScriptInterface (const TScriptInterface &)=default
TScriptInterface &	operator= (const TScriptInterface &)=default
TScriptInterface &	operator= (TYPE_OF_NULLPTR)
template<typename U >
TScriptInterface &	operator= (U &&Source)
template<typename OtherInterfaceType >
TScriptInterface &	operator= (const TScriptInterface< OtherInterfaceType > &Other)
template<typename ObjectType >
TScriptInterface &	operator= (TObjectPtr< ObjectType > SourceObject)
template<typename OtherInterface >
UE_FORCEINLINE_HINT bool	operator== (const OtherInterface *Other) const
template<typename OtherInterface >
UE_FORCEINLINE_HINT bool	operator!= (const OtherInterface *Other) const
UE_FORCEINLINE_HINT bool	operator== (const TScriptInterface &Other) const
UE_FORCEINLINE_HINT bool	operator!= (const TScriptInterface &Other) const
UE_FORCEINLINE_HINT bool	operator== (TYPE_OF_NULLPTR) const
UE_FORCEINLINE_HINT bool	operator!= (TYPE_OF_NULLPTR) const
UE_FORCEINLINE_HINT InInterfaceType *	operator-> () const
UE_FORCEINLINE_HINT InInterfaceType &	operator* () const
UE_FORCEINLINE_HINT InInterfaceType *	GetInterface () const
UE_FORCEINLINE_HINT void	SetInterface (InInterfaceType *InInterfacePointer)
UE_FORCEINLINE_HINT UObjectType *	GetObject () const
UE_FORCEINLINE_HINT TObjectPtr< UObjectType > &	GetObjectRef ()
UE_FORCEINLINE_HINT void	SetObject (UObjectType *InObjectPointer)
UE_FORCEINLINE_HINT	operator bool () const
Public Member Functions inherited from FScriptInterface
	FScriptInterface ()=default
	FScriptInterface (UObject *InObjectPointer, void *InInterfacePointer)
	FScriptInterface (const FScriptInterface &)=default
FScriptInterface &	operator= (const FScriptInterface &)=default
UE_FORCEINLINE_HINT UObject *	GetObject () const
UE_FORCEINLINE_HINT TObjectPtr< UObject > &	GetObjectRef ()
UE_FORCEINLINE_HINT void *	GetInterface () const
void	SetObject (UObject *InObjectPointer)
UE_FORCEINLINE_HINT void	SetInterface (void *InInterfacePointer)
UE_FORCEINLINE_HINT bool	operator== (const FScriptInterface &Other) const
UE_FORCEINLINE_HINT bool	operator!= (const FScriptInterface &Other) const
void	AddReferencedObjects (FReferenceCollector &Collector)

Friends
FArchive &	operator<< (FArchive &Ar, TScriptInterface &Interface)

Additional Inherited Members
Protected Member Functions inherited from FScriptInterface
COREUOBJECT_API FArchive &	Serialize (FArchive &Ar, class UClass *InterfaceType)

Detailed Description

template<typename InInterfaceType>
class TScriptInterface< InInterfaceType >

Templated version of FScriptInterface, which provides accessors and operators for referencing the interface portion of an object implementing an interface. This type is only useful with native interfaces, UClass::ImplementsInterface should be used to check for blueprint interfaces.

Member Typedef Documentation

InterfaceType

template<typename InInterfaceType >

using TScriptInterface< InInterfaceType >::InterfaceType = InInterfaceType

UObjectType

template<typename InInterfaceType >

using TScriptInterface< InInterfaceType >::UObjectType = TCopyQualifiersFromTo_T<InterfaceType, UObject>

Constructor & Destructor Documentation

TScriptInterface() [1/6]

template<typename InInterfaceType >

TScriptInterface< InInterfaceType >::TScriptInterface ( )

default

Default constructor

TScriptInterface() [2/6]

template<typename InInterfaceType >

TScriptInterface< InInterfaceType >::TScriptInterface ( TYPE_OF_NULLPTR  )

inline

Construction from nullptr

TScriptInterface() [3/6]

template<typename InInterfaceType >

template<typename U >

TScriptInterface< InInterfaceType >::TScriptInterface ( U &&  Source )

inline

Construction from an object type that may natively implement InterfaceType

TScriptInterface() [4/6]

template<typename InInterfaceType >

template<typename OtherInterfaceType >

TScriptInterface< InInterfaceType >::TScriptInterface ( const TScriptInterface< OtherInterfaceType > &  Other )

inline

Construction from another script interface of a compatible interface type

TScriptInterface() [5/6]

template<typename InInterfaceType >

template<typename ObjectType >

TScriptInterface< InInterfaceType >::TScriptInterface ( TObjectPtr< ObjectType >  SourceObject )

inline

Assignment from an object type that may natively implement InterfaceType

TScriptInterface() [6/6]

template<typename InInterfaceType >

TScriptInterface< InInterfaceType >::TScriptInterface ( const TScriptInterface< InInterfaceType > &  )

default

Copyable

Member Function Documentation

GetInterface()

template<typename InInterfaceType >

UE_FORCEINLINE_HINT InInterfaceType * TScriptInterface< InInterfaceType >::GetInterface ( ) const

inline

Returns the pointer to the interface

GetObject()

template<typename InInterfaceType >

UE_FORCEINLINE_HINT UObjectType * TScriptInterface< InInterfaceType >::GetObject ( ) const

inline

Returns the ObjectPointer contained by this TScriptInterface

GetObjectRef()

template<typename InInterfaceType >

UE_FORCEINLINE_HINT TObjectPtr< UObjectType > & TScriptInterface< InInterfaceType >::GetObjectRef ( )

inline

Returns the ObjectPointer contained by this TScriptInterface

operator bool()

template<typename InInterfaceType >

UE_FORCEINLINE_HINT TScriptInterface< InInterfaceType >::operator bool ( ) const

inlineexplicit

Boolean operator, returns true if this object natively implements InterfaceType. This will return false for objects that only implement the interface in blueprint classes.

operator!=() [1/3]

template<typename InInterfaceType >

template<typename OtherInterface >

UE_FORCEINLINE_HINT bool TScriptInterface< InInterfaceType >::operator!= ( const OtherInterface *  Other ) const

inline

operator!=() [2/3]

template<typename InInterfaceType >

UE_FORCEINLINE_HINT bool TScriptInterface< InInterfaceType >::operator!= ( const TScriptInterface< InInterfaceType > &  Other ) const

inline

operator!=() [3/3]

template<typename InInterfaceType >

UE_FORCEINLINE_HINT bool TScriptInterface< InInterfaceType >::operator!= ( TYPE_OF_NULLPTR  ) const

inline

operator*()

template<typename InInterfaceType >

UE_FORCEINLINE_HINT InInterfaceType & TScriptInterface< InInterfaceType >::operator* ( ) const

inline

Dereference operator. Provides transparent access to the native interface pointer contained by this TScriptInterface

Returns

a reference (of type InterfaceType) to the object pointed to by InterfacePointer

operator->()

template<typename InInterfaceType >

UE_FORCEINLINE_HINT InInterfaceType * TScriptInterface< InInterfaceType >::operator-> ( ) const

inline

Member access operator. Provides transparent access to the native interface pointer contained by this TScriptInterface

operator=() [1/5]

template<typename InInterfaceType >

TScriptInterface & TScriptInterface< InInterfaceType >::operator= ( const TScriptInterface< InInterfaceType > &  )

default

operator=() [2/5]

template<typename InInterfaceType >

template<typename OtherInterfaceType >

TScriptInterface & TScriptInterface< InInterfaceType >::operator= ( const TScriptInterface< OtherInterfaceType > &  Other )

inline

Assignment from another script interface of a compatible interface type

operator=() [3/5]

template<typename InInterfaceType >

template<typename ObjectType >

TScriptInterface & TScriptInterface< InInterfaceType >::operator= ( TObjectPtr< ObjectType >  SourceObject )

inline

Assignment from an object type that may natively implement InterfaceType

operator=() [4/5]

template<typename InInterfaceType >

TScriptInterface & TScriptInterface< InInterfaceType >::operator= ( TYPE_OF_NULLPTR  )

inline

Assignment from nullptr

operator=() [5/5]

template<typename InInterfaceType >

template<typename U >

TScriptInterface & TScriptInterface< InInterfaceType >::operator= ( U &&  Source )

inline

Assignment from an object type that may natively implement InterfaceType

operator==() [1/3]

template<typename InInterfaceType >

template<typename OtherInterface >

UE_FORCEINLINE_HINT bool TScriptInterface< InInterfaceType >::operator== ( const OtherInterface *  Other ) const

inline

Comparison operator, taking a pointer to InterfaceType

operator==() [2/3]

template<typename InInterfaceType >

UE_FORCEINLINE_HINT bool TScriptInterface< InInterfaceType >::operator== ( const TScriptInterface< InInterfaceType > &  Other ) const

inline

Comparison operator, taking a reference to another TScriptInterface

operator==() [3/3]

template<typename InInterfaceType >

UE_FORCEINLINE_HINT bool TScriptInterface< InInterfaceType >::operator== ( TYPE_OF_NULLPTR  ) const

inline

Comparison operator, taking a nullptr

SetInterface()

template<typename InInterfaceType >

UE_FORCEINLINE_HINT void TScriptInterface< InInterfaceType >::SetInterface ( InInterfaceType *  InInterfacePointer )

inline

Sets the value of the InterfacePointer for this TScriptInterface

SetObject()

template<typename InInterfaceType >

UE_FORCEINLINE_HINT void TScriptInterface< InInterfaceType >::SetObject ( UObjectType *  InObjectPointer )

inline

Sets the value of the ObjectPointer for this TScriptInterface

Friends And Related Symbol Documentation

operator<<

template<typename InInterfaceType >

FArchive & operator<< ( FArchive &  Ar, TScriptInterface< InInterfaceType > &  Interface  )

friend

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/CoreUObject/Public/UObject/ScriptInterface.h