UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UWidgetBlueprintLibrary Class Reference

#include <WidgetBlueprintLibrary.h>

+ Inheritance diagram for UWidgetBlueprintLibrary:

Public Member Functions

 UFUNCTION (BlueprintPure, meta=(DeprecatedFunction, DeprecationMessage="Use SetUserFocus() instead"), Category="Widget|Event Reply") static UMG_API FEventReply CaptureJoystick(UPARAM(ref) FEventReply &Reply
 
 UFUNCTION (BlueprintPure, meta=(DeprecatedFunction, DeprecationMessage="Use ClearUserFocus() instead"), Category="Widget|Event Reply") static UMG_API FEventReply ReleaseJoystickCapture(UPARAM(ref) FEventReply &Reply
 
 DECLARE_DYNAMIC_DELEGATE (FOnGameWindowCloseButtonClickedDelegate)
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Static Public Member Functions

static UMG_API class UUserWidgetCreate (UObject *WorldContextObject, TSubclassOf< class UUserWidget > WidgetType, APlayerController *OwningPlayer)
 
static UMG_API UDragDropOperationCreateDragDropOperation (TSubclassOf< UDragDropOperation > OperationClass)
 
static UMG_API void SetInputMode_UIOnlyEx (APlayerController *PlayerController, UWidget *InWidgetToFocus=nullptr, EMouseLockMode InMouseLockMode=EMouseLockMode::DoNotLock, const bool bFlushInput=false)
 
static UMG_API void SetInputMode_GameAndUIEx (APlayerController *PlayerController, UWidget *InWidgetToFocus=nullptr, EMouseLockMode InMouseLockMode=EMouseLockMode::DoNotLock, bool bHideCursorDuringCapture=true, const bool bFlushInput=false)
 
static UMG_API void SetInputMode_GameOnly (APlayerController *PlayerController, const bool bFlushInput=false)
 
static UMG_API void SetFocusToGameViewport ()
 
static UMG_API void DrawBox (UPARAM(ref) FPaintContext &Context, FVector2D Position, FVector2D Size, USlateBrushAsset *Brush, FLinearColor Tint=FLinearColor::White)
 
static UMG_API void DrawSpline (UPARAM(ref) FPaintContext &Context, FVector2D Start, FVector2D StartDir, FVector2D End, FVector2D EndDir, FLinearColor Tint=FLinearColor::White, float Thickness=1.0f)
 
static UMG_API void DrawLine (UPARAM(ref) FPaintContext &Context, FVector2D PositionA, FVector2D PositionB, FLinearColor Tint=FLinearColor::White, bool bAntiAlias=true, float Thickness=1.0f)
 
static UMG_API void DrawLines (UPARAM(ref) FPaintContext &Context, const TArray< FVector2D > &Points, FLinearColor Tint=FLinearColor::White, bool bAntiAlias=true, float Thickness=1.0f)
 
static UMG_API void DrawText (UPARAM(ref) FPaintContext &Context, const FString &InString, FVector2D Position, FLinearColor Tint=FLinearColor::White)
 
static UMG_API void DrawTextFormatted (UPARAM(ref) FPaintContext &Context, const FText &Text, FVector2D Position, UFont *Font, float FontSize=16.0f, FName FontTypeFace=FName(TEXT("Regular")), FLinearColor Tint=FLinearColor::White)
 
static UMG_API FEventReply Handled ()
 
static UMG_API FEventReply Unhandled ()
 
static UMG_API FEventReply CaptureMouse (UPARAM(ref) FEventReply &Reply, UWidget *CapturingWidget)
 
static UMG_API FEventReply ReleaseMouseCapture (UPARAM(ref) FEventReply &Reply)
 
static UMG_API FEventReply LockMouse (UPARAM(ref) FEventReply &Reply, UWidget *CapturingWidget)
 
static UMG_API FEventReply UnlockMouse (UPARAM(ref) FEventReply &Reply)
 
static UMG_API FEventReply SetUserFocus (UPARAM(ref) FEventReply &Reply, UWidget *FocusWidget, bool bInAllUsers=false)
 
static UMG_API FEventReply ClearUserFocus (UPARAM(ref) FEventReply &Reply, bool bInAllUsers=false)
 
static UMG_API FEventReply SetMousePosition (UPARAM(ref) FEventReply &Reply, FVector2D NewMousePosition)
 
static UMG_API FEventReply DetectDrag (UPARAM(ref) FEventReply &Reply, UWidget *WidgetDetectingDrag, FKey DragKey)
 
static UMG_API FEventReply DetectDragIfPressed (const FPointerEvent &PointerEvent, UWidget *WidgetDetectingDrag, FKey DragKey)
 
static UMG_API FEventReply EndDragDrop (UPARAM(ref) FEventReply &Reply)
 
static UMG_API bool IsDragDropping ()
 
static UMG_API UDragDropOperationGetDragDroppingContent ()
 
static UMG_API void CancelDragDrop ()
 
static UMG_API FSlateBrush MakeBrushFromAsset (USlateBrushAsset *BrushAsset)
 
static UMG_API FSlateBrush MakeBrushFromTexture (UTexture2D *Texture, int32 Width=0, int32 Height=0)
 
static UMG_API FSlateBrush MakeBrushFromMaterial (UMaterialInterface *Material, int32 Width=32, int32 Height=32)
 
static UMG_API UObjectGetBrushResource (const FSlateBrush &Brush)
 
static UMG_API UTexture2DGetBrushResourceAsTexture2D (const FSlateBrush &Brush)
 
static UMG_API UMaterialInterfaceGetBrushResourceAsMaterial (const FSlateBrush &Brush)
 
static UMG_API void SetBrushResourceToTexture (UPARAM(ref) FSlateBrush &Brush, UTexture2D *Texture)
 
static UMG_API void SetBrushResourceToMaterial (UPARAM(ref) FSlateBrush &Brush, UMaterialInterface *Material)
 
static UMG_API FSlateBrush NoResourceBrush ()
 
static UMG_API UMaterialInstanceDynamicGetDynamicMaterial (UPARAM(ref) FSlateBrush &Brush)
 
static UMG_API void DismissAllMenus ()
 
static UMG_API void GetAllWidgetsOfClass (const UObject *WorldContextObject, TArray< UUserWidget * > &FoundWidgets, TSubclassOf< UUserWidget > WidgetClass, bool TopLevelOnly=true)
 
static UMG_API void GetAllWidgetsWithInterface (const UObject *WorldContextObject, TArray< UUserWidget * > &FoundWidgets, TSubclassOf< UInterface > Interface, bool TopLevelOnly)
 
static UMG_API FInputEvent GetInputEventFromKeyEvent (const FKeyEvent &Event)
 
static UMG_API FKeyEvent GetKeyEventFromAnalogInputEvent (const FAnalogInputEvent &Event)
 
static UMG_API FInputEvent GetInputEventFromCharacterEvent (const FCharacterEvent &Event)
 
static UMG_API FInputEvent GetInputEventFromPointerEvent (const FPointerEvent &Event)
 
static UMG_API FInputEvent GetInputEventFromNavigationEvent (const FNavigationEvent &Event)
 
static UMG_API void GetSafeZonePadding (const UObject *WorldContextObject, FVector4 &SafePadding, FVector2D &SafePaddingScale, FVector4 &SpillOverPadding)
 
static UMG_API void SetColorVisionDeficiencyType (EColorVisionDeficiency Type, float Severity, bool CorrectDeficiency, bool ShowCorrectionWithDeficiency)
 
static UMG_API bool SetHardwareCursor (const UObject *WorldContextObject, EMouseCursor::Type CursorShape, FName CursorName, FVector2D HotSpot)
 
static UMG_API void SetWindowTitleBarState (UWidget *TitleBarContent, EWindowTitleBarMode Mode, bool bTitleBarDragEnabled, bool bWindowButtonsVisible, bool bTitleBarVisible)
 
static UMG_API void RestorePreviousWindowTitleBarState ()
 
static UMG_API void SetWindowTitleBarOnCloseClickedDelegate (FOnGameWindowCloseButtonClickedDelegate Delegate)
 
static UMG_API void SetWindowTitleBarCloseButtonActive (bool bActive)
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Public Attributes

UWidgetCapturingWidget
 
UWidget bool bInAllJoysticks = false)
 
bool bInAllJoysticks = false)
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Member Function Documentation

◆ CancelDragDrop()

void UWidgetBlueprintLibrary::CancelDragDrop ( )
static

Cancels any current drag drop operation.

◆ CaptureMouse()

FEventReply UWidgetBlueprintLibrary::CaptureMouse ( UPARAM(ref) FEventReply Reply,
UWidget CapturingWidget 
)
static

◆ ClearUserFocus()

FEventReply UWidgetBlueprintLibrary::ClearUserFocus ( UPARAM(ref) FEventReply Reply,
bool  bInAllUsers = false 
)
static

◆ Create()

UUserWidget * UWidgetBlueprintLibrary::Create ( UObject WorldContextObject,
TSubclassOf< class UUserWidget WidgetType,
APlayerController OwningPlayer 
)
static

Creates a widget

◆ CreateDragDropOperation()

UDragDropOperation * UWidgetBlueprintLibrary::CreateDragDropOperation ( TSubclassOf< UDragDropOperation OperationClass)
static

Creates a new drag and drop operation that can be returned from a drag begin to inform the UI what i being dragged and dropped and what it looks like.

◆ DECLARE_DYNAMIC_DELEGATE()

UWidgetBlueprintLibrary::DECLARE_DYNAMIC_DELEGATE ( FOnGameWindowCloseButtonClickedDelegate  )

◆ DetectDrag()

FEventReply UWidgetBlueprintLibrary::DetectDrag ( UPARAM(ref) FEventReply Reply,
UWidget WidgetDetectingDrag,
FKey  DragKey 
)
static

Ask Slate to detect if a user starts dragging in this widget later. Slate internally tracks the movement and if it surpasses the drag threshold, Slate will send an OnDragDetected event to the widget.

Parameters
WidgetDetectingDragDetect dragging in this widget
DragKeyThis button should be pressed to detect the drag

◆ DetectDragIfPressed()

FEventReply UWidgetBlueprintLibrary::DetectDragIfPressed ( const FPointerEvent PointerEvent,
UWidget WidgetDetectingDrag,
FKey  DragKey 
)
static

Given the pointer event, emit the DetectDrag reply if the provided key was pressed. If the DragKey is a touch key, that will also automatically work.

Parameters
PointerEventThe pointer device event coming in.
WidgetDetectingDragDetect dragging in this widget.
DragKeyThis button should be pressed to detect the drag, won't emit the DetectDrag FEventReply unless this is pressed.

◆ DismissAllMenus()

void UWidgetBlueprintLibrary::DismissAllMenus ( )
static

Closes any popup menu

◆ DrawBox()

void UWidgetBlueprintLibrary::DrawBox ( UPARAM(ref) FPaintContext Context,
FVector2D  Position,
FVector2D  Size,
USlateBrushAsset Brush,
FLinearColor  Tint = FLinearColor::White 
)
static

Draws a box

◆ DrawLine()

void UWidgetBlueprintLibrary::DrawLine ( UPARAM(ref) FPaintContext Context,
FVector2D  PositionA,
FVector2D  PositionB,
FLinearColor  Tint = FLinearColor::White,
bool  bAntiAlias = true,
float  Thickness = 1.0f 
)
static

Draws a line.

Parameters
PositionAStarting position of the line in local space.
PositionBEnding position of the line in local space.
TintColor to render the line.
bAntialiasWhether the line should be antialiased.
ThicknessHow many pixels thick this line should be.

◆ DrawLines()

void UWidgetBlueprintLibrary::DrawLines ( UPARAM(ref) FPaintContext Context,
const TArray< FVector2D > &  Points,
FLinearColor  Tint = FLinearColor::White,
bool  bAntiAlias = true,
float  Thickness = 1.0f 
)
static

Draws several line segments.

Parameters
PointsLine pairs, each line needs to be 2 separate points in the array.
TintColor to render the line.
bAntialiasWhether the line should be antialiased.
ThicknessHow many pixels thick this line should be.

◆ DrawSpline()

void UWidgetBlueprintLibrary::DrawSpline ( UPARAM(ref) FPaintContext Context,
FVector2D  Start,
FVector2D  StartDir,
FVector2D  End,
FVector2D  EndDir,
FLinearColor  Tint = FLinearColor::White,
float  Thickness = 1.0f 
)
static

Draws a hermite spline.

Parameters
StartStarting position of the spline in local space.
StartDirThe direction of the spline from the start point.
EndEnding position of the spline in local space.
EndDirThe direction of the spline to the end point.
TintColor to render the spline.
ThicknessHow many pixels thick this spline should be.

◆ DrawText()

void UWidgetBlueprintLibrary::DrawText ( UPARAM(ref) FPaintContext Context,
const FString &  InString,
FVector2D  Position,
FLinearColor  Tint = FLinearColor::White 
)
static

Draws text.

Parameters
InStringThe string to draw.
PositionThe starting position where the text is drawn in local space.
TintColor to render the line.

◆ DrawTextFormatted()

void UWidgetBlueprintLibrary::DrawTextFormatted ( UPARAM(ref) FPaintContext Context,
const FText Text,
FVector2D  Position,
UFont Font,
float  FontSize = 16.0f,
FName  FontTypeFace = FName(TEXT("Regular")),
FLinearColor  Tint = FLinearColor::White 
)
static

Draws text.

Parameters
TextThe string to draw.
PositionThe starting position where the text is drawn in local space.
TintColor to render the line.

◆ EndDragDrop()

FEventReply UWidgetBlueprintLibrary::EndDragDrop ( UPARAM(ref) FEventReply Reply)
static

An event should return FReply::Handled().EndDragDrop() to request that the current drag/drop operation be terminated.

◆ GetAllWidgetsOfClass()

void UWidgetBlueprintLibrary::GetAllWidgetsOfClass ( const UObject WorldContextObject,
TArray< UUserWidget * > &  FoundWidgets,
TSubclassOf< UUserWidget WidgetClass,
bool  TopLevelOnly = true 
)
static

Find all widgets of a certain class.

Parameters
FoundWidgetsThe widgets that were found matching the filter.
WidgetClassThe widget class to filter by.
TopLevelOnlyOnly the widgets that are direct children of the viewport will be returned.

◆ GetAllWidgetsWithInterface()

void UWidgetBlueprintLibrary::GetAllWidgetsWithInterface ( const UObject WorldContextObject,
TArray< UUserWidget * > &  FoundWidgets,
TSubclassOf< UInterface Interface,
bool  TopLevelOnly 
)
static

Find all widgets in the world with the specified interface. This is a slow operation, use with caution e.g. do not use every frame.

Parameters
InterfaceThe interface to find. Must be specified or result array will be empty.
FoundWidgetsOutput array of widgets that implement the specified interface.
TopLevelOnlyOnly the widgets that are direct children of the viewport will be returned.

◆ GetBrushResource()

UObject * UWidgetBlueprintLibrary::GetBrushResource ( const FSlateBrush Brush)
static

Gets the resource object on a brush. This could be a UTexture2D or a UMaterialInterface.

◆ GetBrushResourceAsMaterial()

UMaterialInterface * UWidgetBlueprintLibrary::GetBrushResourceAsMaterial ( const FSlateBrush Brush)
static

Gets the brush resource as a material.

◆ GetBrushResourceAsTexture2D()

UTexture2D * UWidgetBlueprintLibrary::GetBrushResourceAsTexture2D ( const FSlateBrush Brush)
static

Gets the brush resource as a texture 2D.

◆ GetDragDroppingContent()

UDragDropOperation * UWidgetBlueprintLibrary::GetDragDroppingContent ( )
static

Returns the drag and drop operation that is currently occurring if any, otherwise nothing.

◆ GetDynamicMaterial()

UMaterialInstanceDynamic * UWidgetBlueprintLibrary::GetDynamicMaterial ( UPARAM(ref) FSlateBrush Brush)
static

Gets the material that allows changes to parameters at runtime. The brush must already have a material assigned to it, if it does it will automatically be converted to a MID.

Returns
A material that supports dynamic input from the game.

◆ GetInputEventFromCharacterEvent()

FInputEvent UWidgetBlueprintLibrary::GetInputEventFromCharacterEvent ( const FCharacterEvent Event)
static

◆ GetInputEventFromKeyEvent()

FInputEvent UWidgetBlueprintLibrary::GetInputEventFromKeyEvent ( const FKeyEvent Event)
static

◆ GetInputEventFromNavigationEvent()

FInputEvent UWidgetBlueprintLibrary::GetInputEventFromNavigationEvent ( const FNavigationEvent Event)
static

◆ GetInputEventFromPointerEvent()

FInputEvent UWidgetBlueprintLibrary::GetInputEventFromPointerEvent ( const FPointerEvent Event)
static

◆ GetKeyEventFromAnalogInputEvent()

FKeyEvent UWidgetBlueprintLibrary::GetKeyEventFromAnalogInputEvent ( const FAnalogInputEvent Event)
static

◆ GetSafeZonePadding()

void UWidgetBlueprintLibrary::GetSafeZonePadding ( const UObject WorldContextObject,
FVector4 SafePadding,
FVector2D SafePaddingScale,
FVector4 SpillOverPadding 
)
static

Gets the amount of padding that needs to be added when accounting for the safe zone on TVs.

◆ Handled()

FEventReply UWidgetBlueprintLibrary::Handled ( )
static

The event reply to use when you choose to handle an event. This will prevent the event from continuing to bubble up / down the widget hierarchy.

◆ IsDragDropping()

bool UWidgetBlueprintLibrary::IsDragDropping ( )
static

Returns true if a drag/drop event is occurring that a widget can handle.

◆ LockMouse()

FEventReply UWidgetBlueprintLibrary::LockMouse ( UPARAM(ref) FEventReply Reply,
UWidget CapturingWidget 
)
static

◆ MakeBrushFromAsset()

FSlateBrush UWidgetBlueprintLibrary::MakeBrushFromAsset ( USlateBrushAsset BrushAsset)
static

Creates a Slate Brush from a Slate Brush Asset

Returns
A new slate brush using the asset's brush.

◆ MakeBrushFromMaterial()

FSlateBrush UWidgetBlueprintLibrary::MakeBrushFromMaterial ( UMaterialInterface Material,
int32  Width = 32,
int32  Height = 32 
)
static

Creates a Slate Brush from a Material. Materials don't have an implicit size, so providing a widget and height is required to hint slate with how large the image wants to be by default.

Returns
A new slate brush using the material.

◆ MakeBrushFromTexture()

FSlateBrush UWidgetBlueprintLibrary::MakeBrushFromTexture ( UTexture2D Texture,
int32  Width = 0,
int32  Height = 0 
)
static

Creates a Slate Brush from a Texture2D

Parameters
WidthWhen less than or equal to zero, the Width of the brush will default to the Width of the Texture
HeightWhen less than or equal to zero, the Height of the brush will default to the Height of the Texture
Returns
A new slate brush using the texture.

◆ NoResourceBrush()

FSlateBrush UWidgetBlueprintLibrary::NoResourceBrush ( )
static

Creates a Slate Brush that wont draw anything, the "Null Brush".

Returns
A new slate brush that wont draw anything.

◆ ReleaseMouseCapture()

FEventReply UWidgetBlueprintLibrary::ReleaseMouseCapture ( UPARAM(ref) FEventReply Reply)
static

◆ RestorePreviousWindowTitleBarState()

void UWidgetBlueprintLibrary::RestorePreviousWindowTitleBarState ( )
static

◆ SetBrushResourceToMaterial()

void UWidgetBlueprintLibrary::SetBrushResourceToMaterial ( UPARAM(ref) FSlateBrush Brush,
UMaterialInterface Material 
)
static

Sets the resource on a brush to be a Material.

◆ SetBrushResourceToTexture()

void UWidgetBlueprintLibrary::SetBrushResourceToTexture ( UPARAM(ref) FSlateBrush Brush,
UTexture2D Texture 
)
static

Sets the resource on a brush to be a UTexture2D.

◆ SetColorVisionDeficiencyType()

void UWidgetBlueprintLibrary::SetColorVisionDeficiencyType ( EColorVisionDeficiency  Type,
float  Severity,
bool  CorrectDeficiency,
bool  ShowCorrectionWithDeficiency 
)
static

Apply color deficiency correction settings to the game window

Parameters
TypeThe type of color deficiency correction to apply.
SeverityIntensity of the color deficiency correction effect, from 0 to 1.
CorrectDeficiencyShifts the color spectrum to the visible range based on the current deficiency type.
ShowCorrectionWithDeficiencyIf you're correcting the color deficiency, you can use this to visualize what the correction looks like with the deficiency.

◆ SetFocusToGameViewport()

void UWidgetBlueprintLibrary::SetFocusToGameViewport ( )
static

◆ SetHardwareCursor()

bool UWidgetBlueprintLibrary::SetHardwareCursor ( const UObject WorldContextObject,
EMouseCursor::Type  CursorShape,
FName  CursorName,
FVector2D  HotSpot 
)
static

Loads or sets a hardware cursor from the content directory in the game.

◆ SetInputMode_GameAndUIEx()

void UWidgetBlueprintLibrary::SetInputMode_GameAndUIEx ( APlayerController PlayerController,
UWidget InWidgetToFocus = nullptr,
EMouseLockMode  InMouseLockMode = EMouseLockMode::DoNotLock,
bool  bHideCursorDuringCapture = true,
const bool  bFlushInput = false 
)
static

Setup an input mode that allows only the UI to respond to user input, and if the UI doesn't handle it player input / player controller gets a chance.

Note: This means that any bound Input events in the widget will be called.

◆ SetInputMode_GameOnly()

void UWidgetBlueprintLibrary::SetInputMode_GameOnly ( APlayerController PlayerController,
const bool  bFlushInput = false 
)
static

Setup an input mode that allows only player input / player controller to respond to user input.

Note: Any bound Input Events in this widget will be called.

◆ SetInputMode_UIOnlyEx()

void UWidgetBlueprintLibrary::SetInputMode_UIOnlyEx ( APlayerController PlayerController,
UWidget InWidgetToFocus = nullptr,
EMouseLockMode  InMouseLockMode = EMouseLockMode::DoNotLock,
const bool  bFlushInput = false 
)
static

Setup an input mode that allows only the UI to respond to user input.

Note: This means that any bound Input Events in the widget will not be called!

◆ SetMousePosition()

FEventReply UWidgetBlueprintLibrary::SetMousePosition ( UPARAM(ref) FEventReply Reply,
FVector2D  NewMousePosition 
)
static

◆ SetUserFocus()

FEventReply UWidgetBlueprintLibrary::SetUserFocus ( UPARAM(ref) FEventReply Reply,
UWidget FocusWidget,
bool  bInAllUsers = false 
)
static

◆ SetWindowTitleBarCloseButtonActive()

void UWidgetBlueprintLibrary::SetWindowTitleBarCloseButtonActive ( bool  bActive)
static

◆ SetWindowTitleBarOnCloseClickedDelegate()

void UWidgetBlueprintLibrary::SetWindowTitleBarOnCloseClickedDelegate ( FOnGameWindowCloseButtonClickedDelegate  Delegate)
static

◆ SetWindowTitleBarState()

void UWidgetBlueprintLibrary::SetWindowTitleBarState ( UWidget TitleBarContent,
EWindowTitleBarMode  Mode,
bool  bTitleBarDragEnabled,
bool  bWindowButtonsVisible,
bool  bTitleBarVisible 
)
static

◆ UFUNCTION() [1/2]

UWidgetBlueprintLibrary::UFUNCTION ( BlueprintPure  ,
meta  = (DeprecatedFunction, DeprecationMessage = "Use ClearUserFocus() instead"),
Category  = "Widget|Event Reply" 
) &

◆ UFUNCTION() [2/2]

UWidgetBlueprintLibrary::UFUNCTION ( BlueprintPure  ,
meta  = (DeprecatedFunction, DeprecationMessage = "Use SetUserFocus() instead"),
Category  = "Widget|Event Reply" 
) &

◆ Unhandled()

FEventReply UWidgetBlueprintLibrary::Unhandled ( )
static

The event reply to use when you choose not to handle an event.

◆ UnlockMouse()

FEventReply UWidgetBlueprintLibrary::UnlockMouse ( UPARAM(ref) FEventReply Reply)
static

Member Data Documentation

◆ bInAllJoysticks [1/2]

UWidget bool UWidgetBlueprintLibrary::bInAllJoysticks = false)

◆ bInAllJoysticks [2/2]

bool UWidgetBlueprintLibrary::bInAllJoysticks = false)

◆ CapturingWidget

UWidget* UWidgetBlueprintLibrary::CapturingWidget

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