UUserWidget Class Reference

#include <UserWidget.h>

Inheritance diagram for UUserWidget:

Public Member Functions
UMG_API	UUserWidget (const FObjectInitializer &ObjectInitializer)
virtual UMG_API class UWorld *	GetWorld () const override
virtual UMG_API void	PostDuplicate (bool bDuplicateForPIE) override
virtual UMG_API void	BeginDestroy () override
virtual UMG_API void	PostLoad () override
UMG_API void	DuplicateAndInitializeFromWidgetTree (UWidgetTree *InWidgetTree, const TMap< FName, UWidget * > &NamedSlotContentToMerge)
virtual UMG_API bool	Initialize ()
EWidgetTickFrequency	GetDesiredTickFrequency () const
UMG_API UWidgetBlueprintGeneratedClass *	GetWidgetTreeOwningClass () const
UMG_API void	UpdateCanTick ()
virtual UMG_API void	ReleaseSlateResources (bool bReleaseChildren) override
virtual UMG_API void	SynchronizeProperties () override
virtual UMG_API void	GetSlotNames (TArray< FName > &SlotNames) const override
virtual UMG_API UWidget *	GetContentForSlot (FName SlotName) const override
virtual UMG_API void	SetContentForSlot (FName SlotName, UWidget *Content) override
UMG_API void	AddToViewport (int32 ZOrder=0)
UMG_API bool	AddToPlayerScreen (int32 ZOrder=0)
UMG_API void	RemoveFromViewport ()
UMG_API void	SetPositionInViewport (FVector2D Position, bool bRemoveDPIScale=true)
UMG_API void	SetDesiredSizeInViewport (FVector2D Size)
UMG_API void	SetAnchorsInViewport (FAnchors Anchors)
UMG_API void	SetAlignmentInViewport (FVector2D Alignment)
UMG_API FAnchors	GetAnchorsInViewport () const
UMG_API FVector2D	GetAlignmentInViewport () const
UMG_API bool	GetIsVisible () const
virtual UMG_API void	SetVisibility (ESlateVisibility InVisibility) override
UMG_API void	SetPlayerContext (const FLocalPlayerContext &InPlayerContext)
UMG_API const FLocalPlayerContext &	GetPlayerContext () const
virtual UMG_API ULocalPlayer *	GetOwningLocalPlayer () const override
template<class T >
T *	GetOwningLocalPlayer () const
UMG_API void	SetOwningLocalPlayer (ULocalPlayer *LocalPlayer)
virtual UMG_API APlayerController *	GetOwningPlayer () const override
template<class T >
T *	GetOwningPlayer () const
UMG_API void	SetOwningPlayer (APlayerController *LocalPlayerController)
UMG_API class APawn *	GetOwningPlayerPawn () const
template<class T >
T *	GetOwningPlayerPawn () const
template<class TPlayerState = APlayerState>
TPlayerState *	GetOwningPlayerState (bool bChecked=false) const
UMG_API class APlayerCameraManager *	GetOwningPlayerCameraManager () const
template<class T >
T *	GetOwningPlayerCameraManager () const
UMG_API void	OnInitialized ()
UMG_API void	PreConstruct (bool IsDesignTime)
UMG_API void	Construct ()
UMG_API void	Destruct ()
UMG_API void	Tick (FGeometry MyGeometry, float InDeltaTime)
UMG_API void	OnPaint (UPARAM(ref) FPaintContext &Context) const
UMG_API bool	IsInteractable () const
UMG_API FEventReply	OnFocusReceived (FGeometry MyGeometry, FFocusEvent InFocusEvent)
UMG_API void	OnFocusLost (FFocusEvent InFocusEvent)
UMG_API void	OnAddedToFocusPath (FFocusEvent InFocusEvent)
UMG_API void	OnRemovedFromFocusPath (FFocusEvent InFocusEvent)
UMG_API FEventReply	OnKeyChar (FGeometry MyGeometry, FCharacterEvent InCharacterEvent)
UMG_API FEventReply	OnPreviewKeyDown (FGeometry MyGeometry, FKeyEvent InKeyEvent)
UMG_API FEventReply	OnKeyDown (FGeometry MyGeometry, FKeyEvent InKeyEvent)
UMG_API FEventReply	OnKeyUp (FGeometry MyGeometry, FKeyEvent InKeyEvent)
UMG_API FEventReply	OnAnalogValueChanged (FGeometry MyGeometry, FAnalogInputEvent InAnalogInputEvent)
UMG_API FEventReply	OnMouseButtonDown (FGeometry MyGeometry, const FPointerEvent &MouseEvent)
UMG_API FEventReply	OnPreviewMouseButtonDown (FGeometry MyGeometry, const FPointerEvent &MouseEvent)
UMG_API FEventReply	OnMouseButtonUp (FGeometry MyGeometry, const FPointerEvent &MouseEvent)
UMG_API FEventReply	OnMouseMove (FGeometry MyGeometry, const FPointerEvent &MouseEvent)
UMG_API void	OnMouseEnter (FGeometry MyGeometry, const FPointerEvent &MouseEvent)
UMG_API void	OnMouseLeave (const FPointerEvent &MouseEvent)
UMG_API FEventReply	OnMouseWheel (FGeometry MyGeometry, const FPointerEvent &MouseEvent)
UMG_API FEventReply	OnMouseButtonDoubleClick (FGeometry InMyGeometry, const FPointerEvent &InMouseEvent)
UMG_API void	OnDragDetected (FGeometry MyGeometry, const FPointerEvent &PointerEvent, UDragDropOperation *&Operation)
UMG_API void	OnDragCancelled (const FPointerEvent &PointerEvent, UDragDropOperation *Operation)
UMG_API void	OnDragEnter (FGeometry MyGeometry, FPointerEvent PointerEvent, UDragDropOperation *Operation)
UMG_API void	OnDragLeave (FPointerEvent PointerEvent, UDragDropOperation *Operation)
UMG_API bool	OnDragOver (FGeometry MyGeometry, FPointerEvent PointerEvent, UDragDropOperation *Operation)
UMG_API bool	OnDrop (FGeometry MyGeometry, FPointerEvent PointerEvent, UDragDropOperation *Operation)
UMG_API FEventReply	OnTouchGesture (FGeometry MyGeometry, const FPointerEvent &GestureEvent)
UMG_API FEventReply	OnTouchStarted (FGeometry MyGeometry, const FPointerEvent &InTouchEvent)
UMG_API FEventReply	OnTouchMoved (FGeometry MyGeometry, const FPointerEvent &InTouchEvent)
UMG_API FEventReply	OnTouchEnded (FGeometry MyGeometry, const FPointerEvent &InTouchEvent)
UMG_API FEventReply	OnMotionDetected (FGeometry MyGeometry, FMotionEvent InMotionEvent)
UMG_API void	OnMouseCaptureLost ()
UMG_API void	CancelLatentActions ()
UMG_API void	StopAnimationsAndLatentActions ()
UMG_API FEventReply	OnTouchForceChanged (FGeometry MyGeometry, const FPointerEvent &InTouchEvent)
UMG_API FEventReply	OnTouchFirstMove (FGeometry MyGeometry, const FPointerEvent &InTouchEvent)
UMG_API void	BindToAnimationStarted (UWidgetAnimation *Animation, FWidgetAnimationDynamicEvent Delegate)
UMG_API void	UnbindFromAnimationStarted (UWidgetAnimation *Animation, FWidgetAnimationDynamicEvent Delegate)
UMG_API void	UnbindAllFromAnimationStarted (UWidgetAnimation *Animation)
UMG_API void	BindToAnimationFinished (UWidgetAnimation *Animation, FWidgetAnimationDynamicEvent Delegate)
UMG_API void	UnbindFromAnimationFinished (UWidgetAnimation *Animation, FWidgetAnimationDynamicEvent Delegate)
UMG_API void	UnbindAllFromAnimationFinished (UWidgetAnimation *Animation)
UMG_API void	BindToAnimationEvent (UWidgetAnimation *Animation, FWidgetAnimationDynamicEvent Delegate, EWidgetAnimationEvent AnimationEvent, FName UserTag=NAME_None)
virtual bool	IsEditorUtility () const
	DECLARE_EVENT_OneParam (UUserWidget, FNativeOnVisibilityChangedEvent, ESlateVisibility)
	DECLARE_EVENT_OneParam (UUserWidget, FNativeOnDestruct, UUserWidget *)
UMG_API void	SetColorAndOpacity (FLinearColor InColorAndOpacity)
UMG_API const FLinearColor &	GetColorAndOpacity () const
UMG_API void	SetForegroundColor (FSlateColor InForegroundColor)
UMG_API const FSlateColor &	GetForegroundColor () const
UMG_API void	SetPadding (FMargin InPadding)
UMG_API FMargin	GetPadding () const
UMG_API int32	GetInputActionPriority () const
UMG_API bool	IsInputActionBlocking () const
UMG_API bool	IsFocusable () const
UMG_API void	SetIsFocusable (bool InIsFocusable)
UMG_API void	QueuePlayAnimation (UWidgetAnimation *InAnimation, float StartAtTime=0.0f, int32 NumLoopsToPlay=1, EUMGSequencePlayMode::Type PlayMode=EUMGSequencePlayMode::Forward, float PlaybackSpeed=1.0f, bool bRestoreState=false)
UMG_API void	QueuePlayAnimationTimeRange (UWidgetAnimation *InAnimation, float StartAtTime=0.0f, float EndAtTime=0.0f, int32 NumLoopsToPlay=1, EUMGSequencePlayMode::Type PlayMode=EUMGSequencePlayMode::Forward, float PlaybackSpeed=1.0f, bool bRestoreState=false)
UMG_API void	QueuePlayAnimationForward (UWidgetAnimation *InAnimation, float PlaybackSpeed=1.0f, bool bRestoreState=false)
UMG_API void	QueuePlayAnimationReverse (UWidgetAnimation *InAnimation, float PlaybackSpeed=1.0f, bool bRestoreState=false)
UMG_API void	QueueStopAnimation (const UWidgetAnimation *InAnimation)
UMG_API void	QueueStopAllAnimations ()
UMG_API float	QueuePauseAnimation (const UWidgetAnimation *InAnimation)
UMG_API FWidgetAnimationHandle	PlayAnimation (UWidgetAnimation *InAnimation, float StartAtTime=0.0f, int32 NumLoopsToPlay=1, EUMGSequencePlayMode::Type PlayMode=EUMGSequencePlayMode::Forward, float PlaybackSpeed=1.0f, bool bRestoreState=false)
UMG_API FWidgetAnimationHandle	PlayAnimationTimeRange (UWidgetAnimation *InAnimation, float StartAtTime=0.0f, float EndAtTime=0.0f, int32 NumLoopsToPlay=1, EUMGSequencePlayMode::Type PlayMode=EUMGSequencePlayMode::Forward, float PlaybackSpeed=1.0f, bool bRestoreState=false)
UMG_API FWidgetAnimationHandle	PlayAnimationForward (UWidgetAnimation *InAnimation, float PlaybackSpeed=1.0f, bool bRestoreState=false)
UMG_API FWidgetAnimationHandle	PlayAnimationReverse (UWidgetAnimation *InAnimation, float PlaybackSpeed=1.0f, bool bRestoreState=false)
UMG_API void	StopAnimation (const UWidgetAnimation *InAnimation)
UMG_API void	StopAllAnimations ()
UMG_API float	PauseAnimation (const UWidgetAnimation *InAnimation)
UMG_API float	GetAnimationCurrentTime (const UWidgetAnimation *InAnimation) const
UMG_API void	SetAnimationCurrentTime (const UWidgetAnimation *InAnimation, float InTime)
UMG_API bool	IsAnimationPlaying (const UWidgetAnimation *InAnimation) const
UMG_API bool	IsAnyAnimationPlaying () const
UMG_API void	SetNumLoopsToPlay (const UWidgetAnimation *InAnimation, int32 NumLoopsToPlay)
UMG_API void	SetPlaybackSpeed (const UWidgetAnimation *InAnimation, float PlaybackSpeed=1.0f)
UMG_API void	ReverseAnimation (const UWidgetAnimation *InAnimation)
UMG_API bool	IsAnimationPlayingForward (const UWidgetAnimation *InAnimation)
UMG_API void	FlushAnimations ()
template<typename ExtensionType >
ExtensionType *	GetExtension () const
UMG_API UUserWidgetExtension *	GetExtension (TSubclassOf< UUserWidgetExtension > ExtensionType) const
UMG_API TArray< UUserWidgetExtension * >	GetExtensions (TSubclassOf< UUserWidgetExtension > ExtensionType) const
template<typename ExtensionType >
ExtensionType *	AddExtension ()
UMG_API UUserWidgetExtension *	AddExtension (TSubclassOf< UUserWidgetExtension > InExtensionType)
UMG_API void	RemoveExtension (UUserWidgetExtension *InExtension)
template<typename ExtensionType >
void	RemoveExtensions ()
UMG_API void	RemoveExtensions (TSubclassOf< UUserWidgetExtension > InExtensionType)
UMG_API void	PlaySound (class USoundBase *SoundToPlay)
UMG_API bool	SetDesiredFocusWidget (FName WidgetName)
UMG_API bool	SetDesiredFocusWidget (UWidget *Widget)
UMG_API FName	GetDesiredFocusWidgetName () const
UMG_API UWidget *	GetDesiredFocusWidget () const
UMG_API UWidget *	GetWidgetHandle (TSharedRef< SWidget > InWidget)
UMG_API UWidget *	GetRootWidget () const
UMG_API TSharedPtr< SWidget >	GetSlateWidgetFromName (const FName &Name) const
UMG_API UWidget *	GetWidgetFromName (const FName &Name) const
virtual UMG_API bool	IsAsset () const
virtual UMG_API void	PreSave (FObjectPreSaveContext ObjectSaveContext) override
UMG_API bool	IsPlayingAnimation () const
Public Member Functions inherited from UWidget
	UE_FIELD_NOTIFICATION_DECLARE_CLASS_DESCRIPTOR_BASE_END ()
	DECLARE_DYNAMIC_DELEGATE_RetVal (bool, FGetBool)
	DECLARE_DYNAMIC_DELEGATE_RetVal (float, FGetFloat)
	DECLARE_DYNAMIC_DELEGATE_RetVal (int32, FGetInt32)
	DECLARE_DYNAMIC_DELEGATE_RetVal (FText, FGetText)
	DECLARE_DYNAMIC_DELEGATE_RetVal (FSlateColor, FGetSlateColor)
	DECLARE_DYNAMIC_DELEGATE_RetVal (FLinearColor, FGetLinearColor)
	DECLARE_DYNAMIC_DELEGATE_RetVal (FSlateBrush, FGetSlateBrush)
	DECLARE_DYNAMIC_DELEGATE_RetVal (ESlateVisibility, FGetSlateVisibility)
	DECLARE_DYNAMIC_DELEGATE_RetVal (EMouseCursor::Type, FGetMouseCursor)
	DECLARE_DYNAMIC_DELEGATE_RetVal (ECheckBoxState, FGetCheckBoxState)
	DECLARE_DYNAMIC_DELEGATE_RetVal (UWidget *, FGetWidget)
	DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam (UWidget *, FGenerateWidgetForString, FString, Item)
	DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam (UWidget *, FGenerateWidgetForObject, UObject *, Item)
	DECLARE_DYNAMIC_DELEGATE_RetVal (FEventReply, FOnReply)
	DECLARE_DYNAMIC_DELEGATE_RetVal_TwoParams (FEventReply, FOnPointerEvent, FGeometry, MyGeometry, const FPointerEvent &, MouseEvent)
	DECLARE_MULTICAST_DELEGATE_TwoParams (FOnWidgetStateBroadcast, UWidget *, const FWidgetStateBitfield &)
UMG_API const FWidgetTransform &	GetRenderTransform () const
UMG_API void	SetRenderTransform (FWidgetTransform InTransform)
UMG_API void	SetRenderScale (FVector2D Scale)
UMG_API void	SetRenderShear (FVector2D Shear)
UMG_API void	SetRenderTransformAngle (float Angle)
UMG_API float	GetRenderTransformAngle () const
UMG_API void	SetRenderTranslation (FVector2D Translation)
UMG_API FVector2D	GetRenderTransformPivot () const
UMG_API void	SetRenderTransformPivot (FVector2D Pivot)
UMG_API EFlowDirectionPreference	GetFlowDirectionPreference () const
UMG_API void	SetFlowDirectionPreference (EFlowDirectionPreference FlowDirection)
UMG_API bool	GetIsEnabled () const
virtual UMG_API void	SetIsEnabled (bool bInIsEnabled)
UMG_API bool	IsInViewport () const
UMG_API FText	GetToolTipText () const
UMG_API void	SetToolTipText (const FText &InToolTipText)
UMG_API UWidget *	GetToolTip () const
UMG_API void	SetToolTip (UWidget *Widget)
UMG_API EMouseCursor::Type	GetCursor () const
UMG_API void	SetCursor (EMouseCursor::Type InCursor)
UMG_API void	ResetCursor ()
UMG_API bool	IsRendered () const
UMG_API bool	IsVisible () const
UMG_API ESlateVisibility	GetVisibility () const
UMG_API float	GetRenderOpacity () const
UMG_API void	SetRenderOpacity (float InOpacity)
UMG_API EWidgetClipping	GetClipping () const
UMG_API void	SetClipping (EWidgetClipping InClipping)
UMG_API EWidgetPixelSnapping	GetPixelSnapping () const
UMG_API void	SetPixelSnapping (EWidgetPixelSnapping InPixelSnapping)
UMG_API void	ForceVolatile (bool bForce)
virtual UMG_API bool	IsHovered () const
UMG_API bool	HasKeyboardFocus () const
UMG_API bool	HasMouseCapture () const
UMG_API bool	HasMouseCaptureByUser (int32 UserIndex, int32 PointerIndex=-1) const
UMG_API void	SetKeyboardFocus ()
UMG_API bool	HasUserFocus (APlayerController *PlayerController) const
UMG_API bool	HasAnyUserFocus () const
UMG_API bool	HasFocusedDescendants () const
UMG_API bool	HasUserFocusedDescendants (APlayerController *PlayerController) const
UMG_API void	SetFocus ()
UMG_API void	SetUserFocus (APlayerController *PlayerController)
UMG_API void	ForceLayoutPrepass ()
UMG_API void	InvalidateLayoutAndVolatility ()
UMG_API FVector2D	GetDesiredSize () const
UMG_API void	SetAllNavigationRules (EUINavigationRule Rule, FName WidgetToFocus)
UMG_API void	SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
UMG_API void	SetNavigationRuleBase (EUINavigation Direction, EUINavigationRule Rule)
UMG_API void	SetNavigationRuleExplicit (EUINavigation Direction, UWidget *InWidget)
UMG_API void	SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate)
UMG_API void	SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate)
UMG_API void	SetNavigationMethod (const TInstancedStruct< FNavigationMethod > &NavigationMethod)
UMG_API class UPanelWidget *	GetParent () const
virtual UMG_API void	RemoveFromParent ()
UMG_API const FGeometry &	GetCachedGeometry () const
UMG_API const FGeometry &	GetTickSpaceGeometry () const
UMG_API const FGeometry &	GetPaintSpaceGeometry () const
virtual UMG_API FDelegateHandle	AddFieldValueChangedDelegate (UE::FieldNotification::FFieldId InFieldId, FFieldValueChangedDelegate InNewDelegate) override final
virtual UMG_API bool	RemoveFieldValueChangedDelegate (UE::FieldNotification::FFieldId InFieldId, FDelegateHandle InHandle) override final
virtual UMG_API int32	RemoveAllFieldValueChangedDelegates (FDelegateUserObjectConst InUserObject) override final
virtual UMG_API int32	RemoveAllFieldValueChangedDelegates (UE::FieldNotification::FFieldId InFieldId, FDelegateUserObjectConst InUserObject) override final
virtual UMG_API void	BroadcastFieldValueChanged (UE::FieldNotification::FFieldId InFieldId) override final
UMG_API void	K2_AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate)
UMG_API void	K2_RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate)
UMG_API TSharedRef< SWidget >	TakeWidget ()
template<class WidgetType = SObjectWidget>
TSharedRef< WidgetType >	TakeDerivedWidget (ConstructMethodType ConstructMethod)
UMG_API TSharedPtr< SWidget >	GetCachedWidget () const
UMG_API TSharedPtr< SWidget >	GetCachedWrappedWidget () const
UMG_API bool	IsConstructed () const
UMG_API UGameInstance *	GetGameInstance () const
template<class TGameInstance = UGameInstance>
TGameInstance *	GetGameInstance () const
template<class TPlayerController = APlayerController>
TPlayerController *	GetOwningPlayer () const
template<class T >
T *	GetOwningLocalPlayer () const
UMG_API FText	GetAccessibleText () const
UMG_API FText	GetAccessibleSummaryText () const
UMG_API void	BuildNavigation ()
bool	IsDesignTime () const
bool	IsPreviewTime () const
UMG_API bool	IsChildOf (UWidget *PossibleParent)
UMG_API bool	AddBinding (FDelegateProperty *DelegateProperty, UObject *SourceObject, const FDynamicPropertyPath &BindingPath)
UMG_API FDelegateHandle	RegisterPostStateListener (const FOnWidgetStateBroadcast::FDelegate &ListenerDelegate, bool bBroadcastCurrentState=true)
UMG_API void	UnregisterPostStateListener (const FDelegateHandle &ListenerDelegate)
virtual UMG_API void	FinishDestroy () override
bool	CanSafelyRouteEvent ()
bool	CanSafelyRoutePaint ()
Public Member Functions inherited from UVisual
virtual UMG_API bool	NeedsLoadForServer () const override
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 UObject *	CreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
template<class TReturnType >
TReturnType *	CreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType >
TReturnType *	CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType , class TClassToConstructByDefault >
TReturnType *	CreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType >
TReturnType *	CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
template<class TReturnType , class TClassToConstructByDefault >
TReturnType *	CreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
COREUOBJECT_API void	GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
COREUOBJECT_API UObject *	GetDefaultSubobjectByName (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	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	PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
virtual bool	IsReadyForFinishDestroy ()
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 (EDuplicateMode::Type DuplicateMode)
virtual COREUOBJECT_API bool	NeedsLoadForClient () 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 UScriptStruct *	GetSparseClassDataStruct () 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 FRestoreForUObjectOverwrite *	GetRestoreForUObjectOverwrite ()
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 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 UFunction *	FindFunction (FName InName) const
COREUOBJECT_API UFunction *	FindFunctionChecked (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 TCHAR *	GetConfigOverridePlatform () 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 UObject *	GetArchetype () 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 int32	GetFunctionCallspace (UFunction *Function, FFrame *Stack)
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 UClass *	RegenerateClass (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 UObject *	GetOutermostObject () const
COREUOBJECT_API UPackage *	GetPackage () const
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath	GetVersePath () const
COREUOBJECT_API UPackage *	GetOutermost () const
COREUOBJECT_API bool	MarkPackageDirty () const
COREUOBJECT_API bool	IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
COREUOBJECT_API UObject *	GetTypedOuter (UClass *Target) const
template<typename T >
T *	GetTypedOuter () const
template<typename InterfaceClassType >
InterfaceClassType *	GetImplementingOuter () const
COREUOBJECT_API UObjectBaseUtility *	GetImplementingOuterObject (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 UClass *	FindNearestCommonBaseClass (const UClass *TestClass) const
COREUOBJECT_API void *	GetInterfaceAddress (UClass *InterfaceClass)
COREUOBJECT_API void *	GetNativeInterfaceAddress (UClass *InterfaceClass)
const void *	GetNativeInterfaceAddress (UClass *InterfaceClass) const
COREUOBJECT_API bool	IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
COREUOBJECT_API bool	IsDefaultSubobject () const
COREUOBJECT_API class FLinkerLoad *	GetLinker () 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 UClass *	GetClass () const
FORCEINLINE UObject *	GetOuter () const
FORCEINLINE FName	GetFName () const
virtual COREUOBJECT_API FName	GetFNameForStatID () const
COREUOBJECT_API UPackage *	GetExternalPackage () const
COREUOBJECT_API void	SetExternalPackage (UPackage *InPackage)
COREUOBJECT_API UPackage *	GetExternalPackageInternal () 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)
Public Member Functions inherited from INotifyFieldValueChanged
virtual const UE::FieldNotification::IClassDescriptor &	GetFieldNotificationDescriptor () const =0
Public Member Functions inherited from INamedSlotInterface
UMG_API bool	ContainsContent (UWidget *Content) const
UMG_API FName	FindSlotForContent (UWidget *Content) const
UMG_API void	ReleaseNamedSlotSlateResources (bool bReleaseChildren)

Static Public Member Functions
static UMG_API UUserWidget *	CreateWidgetInstance (UWidget &OwningWidget, TSubclassOf< UUserWidget > UserWidgetClass, FName WidgetName)
static UMG_API UUserWidget *	CreateWidgetInstance (UWidgetTree &OwningWidgetTree, TSubclassOf< UUserWidget > UserWidgetClass, FName WidgetName)
static UMG_API UUserWidget *	CreateWidgetInstance (APlayerController &OwnerPC, TSubclassOf< UUserWidget > UserWidgetClass, FName WidgetName)
static UMG_API UUserWidget *	CreateWidgetInstance (UGameInstance &GameInstance, TSubclassOf< UUserWidget > UserWidgetClass, FName WidgetName)
static UMG_API UUserWidget *	CreateWidgetInstance (UWorld &World, TSubclassOf< UUserWidget > UserWidgetClass, FName WidgetName)
Static Public Member Functions inherited from UWidget
static UMG_API TSubclassOf< UPropertyBinding >	FindBinderClassForDestination (FProperty *Property)
static UMG_API EVisibility	ConvertSerializedVisibilityToRuntime (ESlateVisibility Input)
static UMG_API ESlateVisibility	ConvertRuntimeToSerializedVisibility (const EVisibility &Input)
static UMG_API FSizeParam	ConvertSerializedSizeParamToRuntime (const FSlateChildSize &Input)
static UMG_API UWidget *	FindChildContainingDescendant (UWidget *Root, UWidget *Descendant)
static UMG_API FString	GetDefaultFontName ()
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 FName &	SourceFileTagName ()
static COREUOBJECT_API UObject *	GetArchetypeFromRequiredInfo (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
FLinearColor	ColorAndOpacity
FGetLinearColor	ColorAndOpacityDelegate
FSlateColor	ForegroundColor
FGetSlateColor	ForegroundColorDelegate
FOnVisibilityChangedEvent	OnVisibilityChanged
FNativeOnVisibilityChangedEvent	OnNativeVisibilityChanged
FNativeOnDestruct	OnNativeDestruct
FMargin	Padding
int32	Priority
uint8	bIsFocusable: 1
uint8	bStopAction: 1
uint8	bAutomaticallyRegisterInputOnConstruction: 1
TArray< FQueuedWidgetAnimationTransition >	QueuedWidgetAnimationTransitions
TArray< TObjectPtr< UUMGSequencePlayer > >	ActiveSequencePlayers
TObjectPtr< UUMGSequenceTickManager >	AnimationTickManager
TArray< TObjectPtr< UUMGSequencePlayer > >	StoppedSequencePlayers
TObjectPtr< UWidgetTree >	WidgetTree
uint8	bHasScriptImplementedTick: 1
uint8	bHasScriptImplementedPaint: 1
Public Attributes inherited from UWidget
TObjectPtr< UPanelSlot >	Slot
FGetBool	bIsEnabledDelegate
FGetText	ToolTipTextDelegate
FText	ToolTipText
TObjectPtr< UWidget >	ToolTipWidget
FGetWidget	ToolTipWidgetDelegate
FGetSlateVisibility	VisibilityDelegate
FWidgetTransform	RenderTransform
FVector2D	RenderTransformPivot
EFlowDirectionPreference	FlowDirectionPreference
uint8	bIsVariable:1
uint8	bCreatedByConstructionScript:1
uint8	bIsEnabled:1
uint8	bOverride_Cursor: 1
uint8	bWrappedByComponent: 1
TEnumAsByte< EMouseCursor::Type >	Cursor
EWidgetClipping	Clipping
ESlateVisibility	Visibility
TObjectPtr< class UWidgetNavigation >	Navigation
TWeakObjectPtr< UClass >	WidgetGeneratedByClass

Protected Member Functions
virtual void	InitializeNativeClassData ()
virtual ERequiresLegacyPlayer	GetLegacyPlayerRequirement () const
UMG_API void	InitializeNamedSlots ()
UMG_API void	OnAnimationStarted (const UWidgetAnimation *Animation)
virtual UMG_API void	OnAnimationStarted_Implementation (const UWidgetAnimation *Animation)
UMG_API void	OnAnimationFinished (const UWidgetAnimation *Animation)
virtual UMG_API void	OnAnimationFinished_Implementation (const UWidgetAnimation *Animation)
UMG_API void	BroadcastAnimationStateChange (const UUMGSequencePlayer &Player, EWidgetAnimationEvent AnimationEvent)
FOnWidgetAnimationEvent &	OnAnimationStartedPlaying ()
FOnWidgetAnimationEvent &	OnAnimationFinishedPlaying ()
virtual void	OnAnimationStartedPlaying (UUMGSequencePlayer &Player)
virtual void	OnAnimationFinishedPlaying (UUMGSequencePlayer &Player)
virtual UMG_API TSharedRef< SWidget >	RebuildWidget () override
virtual UMG_API void	OnWidgetRebuilt () override
UMG_API FMargin	GetFullScreenOffset () const
virtual UMG_API void	NativeOnInitialized ()
virtual UMG_API void	NativePreConstruct ()
virtual UMG_API void	NativeConstruct ()
virtual UMG_API void	NativeDestruct ()
virtual UMG_API void	NativeTick (const FGeometry &MyGeometry, float InDeltaTime)
virtual UMG_API int32	NativePaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
FVector2D	GetMinimumDesiredSize () const
UMG_API void	SetMinimumDesiredSize (FVector2D InMinimumDesiredSize)
virtual UMG_API bool	NativeIsInteractable () const
virtual UMG_API bool	NativeSupportsKeyboardFocus () const
virtual bool	NativeSupportsCustomNavigation () const
virtual UMG_API FReply	NativeOnFocusReceived (const FGeometry &InGeometry, const FFocusEvent &InFocusEvent)
virtual UMG_API void	NativeOnFocusLost (const FFocusEvent &InFocusEvent)
virtual UMG_API void	NativeOnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)
virtual UMG_API void	NativeOnAddedToFocusPath (const FFocusEvent &InFocusEvent)
virtual UMG_API void	NativeOnRemovedFromFocusPath (const FFocusEvent &InFocusEvent)
virtual UMG_API FNavigationReply	NativeOnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent, const FNavigationReply &InDefaultReply)
virtual UMG_API FReply	NativeOnKeyChar (const FGeometry &InGeometry, const FCharacterEvent &InCharEvent)
virtual UMG_API FReply	NativeOnPreviewKeyDown (const FGeometry &InGeometry, const FKeyEvent &InKeyEvent)
virtual UMG_API FReply	NativeOnKeyDown (const FGeometry &InGeometry, const FKeyEvent &InKeyEvent)
virtual UMG_API FReply	NativeOnKeyUp (const FGeometry &InGeometry, const FKeyEvent &InKeyEvent)
virtual UMG_API FReply	NativeOnAnalogValueChanged (const FGeometry &InGeometry, const FAnalogInputEvent &InAnalogEvent)
virtual UMG_API FReply	NativeOnMouseButtonDown (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent)
virtual UMG_API FReply	NativeOnPreviewMouseButtonDown (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent)
virtual UMG_API FReply	NativeOnMouseButtonUp (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent)
virtual UMG_API FReply	NativeOnMouseMove (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent)
virtual UMG_API void	NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent)
virtual UMG_API void	NativeOnMouseLeave (const FPointerEvent &InMouseEvent)
virtual UMG_API FReply	NativeOnMouseWheel (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent)
virtual UMG_API FReply	NativeOnMouseButtonDoubleClick (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent)
virtual UMG_API void	NativeOnDragDetected (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent, UDragDropOperation *&OutOperation)
virtual UMG_API void	NativeOnDragEnter (const FGeometry &InGeometry, const FDragDropEvent &InDragDropEvent, UDragDropOperation *InOperation)
virtual UMG_API void	NativeOnDragLeave (const FDragDropEvent &InDragDropEvent, UDragDropOperation *InOperation)
virtual UMG_API bool	NativeOnDragOver (const FGeometry &InGeometry, const FDragDropEvent &InDragDropEvent, UDragDropOperation *InOperation)
virtual UMG_API bool	NativeOnDrop (const FGeometry &InGeometry, const FDragDropEvent &InDragDropEvent, UDragDropOperation *InOperation)
virtual UMG_API void	NativeOnDragCancelled (const FDragDropEvent &InDragDropEvent, UDragDropOperation *InOperation)
virtual UMG_API FReply	NativeOnTouchGesture (const FGeometry &InGeometry, const FPointerEvent &InGestureEvent)
virtual UMG_API FReply	NativeOnTouchStarted (const FGeometry &InGeometry, const FPointerEvent &InGestureEvent)
virtual UMG_API FReply	NativeOnTouchMoved (const FGeometry &InGeometry, const FPointerEvent &InGestureEvent)
virtual UMG_API FReply	NativeOnTouchEnded (const FGeometry &InGeometry, const FPointerEvent &InGestureEvent)
virtual UMG_API FReply	NativeOnMotionDetected (const FGeometry &InGeometry, const FMotionEvent &InMotionEvent)
virtual UMG_API FReply	NativeOnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
virtual UMG_API FReply	NativeOnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
virtual UMG_API FCursorReply	NativeOnCursorQuery (const FGeometry &InGeometry, const FPointerEvent &InCursorEvent)
virtual UMG_API FNavigationReply	NativeOnNavigation (const FGeometry &InGeometry, const FNavigationEvent &InNavigationEvent)
virtual UMG_API void	NativeOnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
virtual void	NativeOnFinishedPointerInput ()
UMG_API void	TickActionsAndAnimation (float InDeltaTime)
void	PostTickActionsAndAnimation (float InDeltaTime)
UMG_API void	RemoveObsoleteBindings (const TArray< FName > &NamedSlots)
UMG_API TSharedPtr< const FWidgetAnimationState >	GetAnimationState (const UWidgetAnimation *InAnimation) const
UMG_API TSharedPtr< FWidgetAnimationState >	GetAnimationState (const UWidgetAnimation *InAnimation)
UMG_API TSharedPtr< FWidgetAnimationState >	GetOrAddAnimationState (UWidgetAnimation *InAnimation)
UMG_API void	ExecuteQueuedAnimationTransitions ()
UMG_API void	ConditionalTearDownAnimations ()
UMG_API void	TearDownAnimations ()
UMG_API void	DisableAnimations ()
UMG_API void	Invalidate (EInvalidateWidgetReason InvalidateReason)
UMG_API void	ListenForInputAction (FName ActionName, TEnumAsByte< EInputEvent > EventType, bool bConsume, FOnInputAction Callback)
UMG_API void	StopListeningForInputAction (FName ActionName, TEnumAsByte< EInputEvent > EventType)
UMG_API void	StopListeningForAllInputActions ()
UMG_API void	RegisterInputComponent ()
UMG_API void	UnregisterInputComponent ()
UMG_API bool	IsListeningForInputAction (FName ActionName) const
UMG_API void	SetInputActionPriority (int32 NewPriority)
UMG_API void	SetInputActionBlocking (bool bShouldBlock)
UMG_API void	OnInputAction (FOnInputAction Callback)
virtual UMG_API void	InitializeInputComponent () final
virtual UMG_API void	CreateInputComponent ()
virtual UMG_API void	StartProcessingInputScriptDelegates ()
virtual UMG_API void	StopProcessingInputScriptDelegates ()
virtual UMG_API void	DestroyInputComponent ()
void	HandleOwningLocalPlayerControllerChanged (APlayerController *NewPlayerController)
void	StartListeningForPlayerControllerChanges ()
void	StopListeningForPlayerControllerChanges ()
	PROPERTY_BINDING_IMPLEMENTATION (FLinearColor, ColorAndOpacity)
	PROPERTY_BINDING_IMPLEMENTATION (FSlateColor, ForegroundColor)
Protected Member Functions inherited from UWidget
UMG_API void	SetVisibilityInternal (ESlateVisibility InVisibility)
UMG_API void	K2_BroadcastFieldValueChanged (FFieldNotificationId FieldId)
bool	CanSafelyRouteCall ()
virtual UMG_API void	OnBindingChanged (const FName &Property)
UMG_API void	BroadcastBinaryPostStateChange (const FWidgetStateBitfield &StateChange, bool bInValue)
UMG_API void	BroadcastEnumPostStateChange (const FWidgetStateBitfield &StateChange)
UMG_API UObject *	GetSourceAssetOrClass () const
UMG_API void	UpdateRenderTransform ()
UMG_API void	SynchronizeAccessibleData ()
EVisibility	ConvertVisibility (TAttribute< ESlateVisibility > SerializedType) const
TOptional< float >	ConvertFloatToOptionalFloat (TAttribute< float > InFloat) const
FSlateColor	ConvertLinearColorToSlateColor (TAttribute< FLinearColor > InLinearColor) const
UMG_API void	SetNavigationRuleInternal (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus=NAME_None, UWidget *InWidget=nullptr, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
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)

Static Protected Member Functions
static UMG_API void	AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)

Protected Attributes
TObjectPtr< class UInputComponent >	InputComponent
TArray< FAnimationEventBinding >	AnimationCallbacks
friend	UUMGSequencePlayer
friend	FWidgetAnimationState
friend	FWidgetAnimationHandle
friend	UUMGSequenceTickManager
Protected Attributes inherited from UWidget
uint8	bIsVolatile:1
uint8	bIsManagedByGameViewportSubsystem:1
bool	bShouldBroadcastState: 1
bool	bWidgetStateInitialized: 1
float	RenderOpacity
TWeakPtr< SWidget >	MyWidget
TWeakPtr< SWidget >	ComponentWrapperWidget
TWeakPtr< SObjectWidget >	MyGCWidget
FWidgetStateBitfield	MyWidgetStateBitfield
FOnWidgetStateBroadcast	PostWidgetStateChanged
TArray< TObjectPtr< UPropertyBinding > >	NativeBindings

Friends
class	SObjectWidget
class	FWidgetBlueprintCompilerContext

Additional Inherited Members
Public Types inherited from UWidget
typedef TFunctionRef< TSharedPtr< SObjectWidget >(UUserWidget *, TSharedRef< SWidget >)>	ConstructMethodType
Public Types inherited from UObject
enum class	ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
typedef UObject	WithinClass
Public Types inherited from INotifyFieldValueChanged
using	FFieldValueChangedDelegate = TDelegate< void(UObject *, UE::FieldNotification::FFieldId), FNotThreadSafeNotCheckedDelegateUserPolicy >
Static Protected Attributes inherited from UWidget
static UMG_API TArray< TSubclassOf< UPropertyBinding > >	BinderClasses

Detailed Description

A widget that enables UI extensibility through WidgetBlueprint.

Examples

/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

Constructor & Destructor Documentation

UUserWidget()

UUserWidget::UUserWidget

(

const FObjectInitializer &

ObjectInitializer

)

Member Function Documentation

AddExtension() [1/2]

template<typename ExtensionType >

ExtensionType * UUserWidget::AddExtension ( )

inline

Add the extension of the requested type.

AddExtension() [2/2]

UUserWidgetExtension * UUserWidget::AddExtension

(

TSubclassOf< UUserWidgetExtension >

InExtensionType

)

Add the extension of the requested type.

AddReferencedObjects()

void UUserWidget::AddReferencedObjects ( UObject *  InThis, FReferenceCollector &  Collector  )

staticprotected

AddToPlayerScreen()

bool UUserWidget::AddToPlayerScreen

(

int32

ZOrder = 0

)

Adds the widget to the game's viewport in a section dedicated to the player. This is valuable in a split screen game where you need to only show a widget over a player's portion of the viewport.

Parameters

ZOrder

The higher the number, the more on top this widget will be.

AddToViewport()

void UUserWidget::AddToViewport

(

int32

ZOrder = 0

)

Adds it to the game's viewport and fills the entire screen, unless SetDesiredSizeInViewport is called to explicitly set the size.

Parameters

ZOrder

The higher the number, the more on top this widget will be.

BeginDestroy()

void UUserWidget::BeginDestroy ( )

overridevirtual

Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

Reimplemented from UWidget.

BindToAnimationEvent()

void UUserWidget::BindToAnimationEvent	(	UWidgetAnimation *	Animation,
		FWidgetAnimationDynamicEvent	Delegate,
		EWidgetAnimationEvent	AnimationEvent,
		FName	UserTag = NAME_None
	)

Allows binding to a specific animation's event.

Parameters

Animation	the animation to listen for starting or finishing.
Delegate	the delegate to call when the animation's state changes
AnimationEvent	the event to watch for.
UserTag	Scopes the delegate to only be called when the animation completes with a specific tag set on it when it was played.

BindToAnimationFinished()

void UUserWidget::BindToAnimationFinished	(	UWidgetAnimation *	Animation,
		FWidgetAnimationDynamicEvent	Delegate
	)

Bind an animation finished delegate.

Parameters

Animation	the animation to listen for starting or finishing.
Delegate	the delegate to call when the animation's state changes

BindToAnimationStarted()

void UUserWidget::BindToAnimationStarted	(	UWidgetAnimation *	Animation,
		FWidgetAnimationDynamicEvent	Delegate
	)

Bind an animation started delegate.

Parameters

Animation	the animation to listen for starting or finishing.
Delegate	the delegate to call when the animation's state changes

BroadcastAnimationStateChange()

void UUserWidget::BroadcastAnimationStateChange ( const UUMGSequencePlayer &  Player, EWidgetAnimationEvent  AnimationEvent  )

protected

Broadcast any events based on a state transition for the sequence player, started, finished...etc.

CancelLatentActions()

void UUserWidget::CancelLatentActions

(

)

Cancels any pending Delays or timer callbacks for this widget.

ConditionalTearDownAnimations()

void UUserWidget::ConditionalTearDownAnimations ( )

protected

Construct()

UMG_API void UUserWidget::Construct

(

)

Called after the underlying slate widget is constructed. Depending on how the slate object is used this event may be called multiple times due to adding and removing from the hierarchy. If you need a true called-once-when-created event, use OnInitialized.

CreateInputComponent()

void UUserWidget::CreateInputComponent ( )

protectedvirtual

Spawns the InputComponent and binds any script delegates if bAutomaticallyRegisterInputOnConstruction is true.

bAutomaticallyRegisterInputOnConstruction is true when there are input event nodes in the graph of this widget, which would in turn need to be bound in order to receive their callbacks.

This should only happen once per widget when it is spawned and initialized.

CreateWidgetInstance() [1/5]

UUserWidget * UUserWidget::CreateWidgetInstance ( APlayerController &  OwnerPC, TSubclassOf< UUserWidget >  UserWidgetClass, FName  WidgetName  )

static

CreateWidgetInstance() [2/5]

UUserWidget * UUserWidget::CreateWidgetInstance ( UGameInstance &  GameInstance, TSubclassOf< UUserWidget >  UserWidgetClass, FName  WidgetName  )

static

CreateWidgetInstance() [3/5]

UUserWidget * UUserWidget::CreateWidgetInstance ( UWidget &  OwningWidget, TSubclassOf< UUserWidget >  UserWidgetClass, FName  WidgetName  )

static

CreateWidgetInstance() [4/5]

UUserWidget * UUserWidget::CreateWidgetInstance ( UWidgetTree &  OwningWidgetTree, TSubclassOf< UUserWidget >  UserWidgetClass, FName  WidgetName  )

static

CreateWidgetInstance() [5/5]

UUserWidget * UUserWidget::CreateWidgetInstance ( UWorld &  World, TSubclassOf< UUserWidget >  UserWidgetClass, FName  WidgetName  )

static

DECLARE_EVENT_OneParam() [1/2]

UUserWidget::DECLARE_EVENT_OneParam	(	UUserWidget	,
		FNativeOnDestruct	,
		UUserWidget *
	)

DECLARE_EVENT_OneParam() [2/2]

UUserWidget::DECLARE_EVENT_OneParam	(	UUserWidget	,
		FNativeOnVisibilityChangedEvent	,
		ESlateVisibility
	)

DestroyInputComponent()

void UUserWidget::DestroyInputComponent ( )

protectedvirtual

Unbinds all script delegates that this widget has bound to on its input component, removes it from the input stack, and deletes the actual input component object.

Destruct()

UMG_API void UUserWidget::Destruct

(

)

Called when a widget is no longer referenced causing the slate resource to destroyed. Just like Construct this event can be called multiple times.

DisableAnimations()

void UUserWidget::DisableAnimations ( )

protected

DuplicateAndInitializeFromWidgetTree()

void UUserWidget::DuplicateAndInitializeFromWidgetTree	(	UWidgetTree *	InWidgetTree,
		const TMap< FName, UWidget * > &	NamedSlotContentToMerge
	)

ExecuteQueuedAnimationTransitions()

void UUserWidget::ExecuteQueuedAnimationTransitions ( )

protected

FlushAnimations()

void UUserWidget::FlushAnimations

(

)

Flushes all animations on all widgets to guarantee that any queued updates are processed before this call returns

GetAlignmentInViewport()

FVector2D UUserWidget::GetAlignmentInViewport

(

)

const

GetAnchorsInViewport()

FAnchors UUserWidget::GetAnchorsInViewport

(

)

const

GetAnimationCurrentTime()

float UUserWidget::GetAnimationCurrentTime

(

const UWidgetAnimation *

InAnimation

)

const

Gets the current time of the animation in this widget

Parameters

The	name of the animation to get the current time for

Returns

the current time of the animation.

GetAnimationState() [1/2]

TSharedPtr< FWidgetAnimationState > UUserWidget::GetAnimationState ( const UWidgetAnimation *  InAnimation )

protected

GetAnimationState() [2/2]

TSharedPtr< const FWidgetAnimationState > UUserWidget::GetAnimationState ( const UWidgetAnimation *  InAnimation ) const

protected

GetColorAndOpacity()

const FLinearColor & UUserWidget::GetColorAndOpacity

(

)

const

Gets the tint of the widget.

GetContentForSlot()

UWidget * UUserWidget::GetContentForSlot ( FName  SlotName ) const

overridevirtual

Gets the widget for a given slot by name, will return nullptr if no widget is in the slot.

Implements INamedSlotInterface.

GetDesiredFocusWidget()

UWidget * UUserWidget::GetDesiredFocusWidget

(

)

const

Returns

The Widget that should receive focus when this UserWidget gets focus.

GetDesiredFocusWidgetName()

FName UUserWidget::GetDesiredFocusWidgetName

(

)

const

Returns

The Name of the Widget that should receive focus when this UserWidget gets focus.

GetDesiredTickFrequency()

EWidgetTickFrequency UUserWidget::GetDesiredTickFrequency ( ) const

inline

GetExtension() [1/2]

template<typename ExtensionType >

ExtensionType * UUserWidget::GetExtension ( ) const

inline

Find the first extension of the requested type.

GetExtension() [2/2]

UUserWidgetExtension * UUserWidget::GetExtension

(

TSubclassOf< UUserWidgetExtension >

ExtensionType

)

const

Find the first extension of the requested type.

GetExtensions()

TArray< UUserWidgetExtension * > UUserWidget::GetExtensions

(

TSubclassOf< UUserWidgetExtension >

ExtensionType

)

const

Find the extensions of the requested type.

GetForegroundColor()

const FSlateColor & UUserWidget::GetForegroundColor

(

)

const

Gets the foreground color of the widget, this is inherited by sub widgets. Any color property that is marked as inherit uses this color.

GetFullScreenOffset()

FMargin UUserWidget::GetFullScreenOffset ( ) const

protected

GetInputActionPriority()

int32 UUserWidget::GetInputActionPriority

(

)

const

Gets the priority of the input action.

GetIsVisible()

bool UUserWidget::GetIsVisible

(

)

const

GetLegacyPlayerRequirement()

virtual ERequiresLegacyPlayer UUserWidget::GetLegacyPlayerRequirement ( ) const

inlineprotectedvirtual

Returns whether this widget needs a legacy player.

GetMinimumDesiredSize()

FVector2D UUserWidget::GetMinimumDesiredSize ( ) const

inlineprotected

GetOrAddAnimationState()

TSharedPtr< FWidgetAnimationState > UUserWidget::GetOrAddAnimationState ( UWidgetAnimation *  InAnimation )

protected

GetOwningLocalPlayer() [1/2]

template<class T >

T * UUserWidget::GetOwningLocalPlayer ( ) const

inlinevirtual

Gets the local player associated with this UI cast to the template type.

Returns

The owning local player. May be NULL if the cast fails.

Reimplemented from UWidget.

GetOwningLocalPlayer() [2/2]

ULocalPlayer * UUserWidget::GetOwningLocalPlayer ( ) const

overridevirtual

Gets the local player associated with this UI.

Returns

The owning local player.

Reimplemented from UWidget.

GetOwningPlayer() [1/2]

template<class T >

T * UUserWidget::GetOwningPlayer ( ) const

inlinevirtual

Gets the player controller associated with this UI cast to the template type.

Returns

The player controller that owns the UI. May be NULL if the cast fails.

Reimplemented from UWidget.

GetOwningPlayer() [2/2]

APlayerController * UUserWidget::GetOwningPlayer ( ) const

overridevirtual

Gets the player controller associated with this UI.

Returns

The player controller that owns the UI.

Reimplemented from UWidget.

GetOwningPlayerCameraManager() [1/2]

APlayerCameraManager * UUserWidget::GetOwningPlayerCameraManager

(

)

const

Gets the player camera manager associated with this UI.

Returns

Gets the owning player camera manager that's owned by the player controller assigned to this widget.

GetOwningPlayerCameraManager() [2/2]

template<class T >

T * UUserWidget::GetOwningPlayerCameraManager ( ) const

inline

Gets the player camera manager associated with this UI cast to the template type.

Returns

Gets the owning player camera manager that's owned by the player controller assigned to this widget. May be NULL if the cast fails.

GetOwningPlayerPawn() [1/2]

APawn * UUserWidget::GetOwningPlayerPawn

(

)

const

Gets the player pawn associated with this UI.

Returns

Gets the owning player pawn that's owned by the player controller assigned to this widget.

GetOwningPlayerPawn() [2/2]

template<class T >

T * UUserWidget::GetOwningPlayerPawn ( ) const

inline

Gets the player pawn associated with this UI cast to the template type.

Returns

Gets the owning player pawn that's owned by the player controller assigned to this widget. May be NULL if the cast fails.

GetOwningPlayerState()

template<class TPlayerState = APlayerState>

TPlayerState * UUserWidget::GetOwningPlayerState ( bool  bChecked = false ) const

inline

Get the owning player's PlayerState.

Returns

const APlayerState*

GetPadding()

FMargin UUserWidget::GetPadding

(

)

const

Gets the padding for the user widget.

GetPlayerContext()

const FLocalPlayerContext & UUserWidget::GetPlayerContext

(

)

const

Gets the player context associated with this UI.

GetRootWidget()

UWidget * UUserWidget::GetRootWidget

(

)

const

Returns

The root UObject widget wrapper

GetSlateWidgetFromName()

TSharedPtr< SWidget > UUserWidget::GetSlateWidgetFromName

(

const FName &

Name

)

const

Returns

The slate widget corresponding to a given name

GetSlotNames()

void UUserWidget::GetSlotNames ( TArray< FName > &  SlotNames ) const

overridevirtual

Gets the names for slots that we can store widgets into.

Implements INamedSlotInterface.

GetWidgetFromName()

UWidget * UUserWidget::GetWidgetFromName

(

const FName &

Name

)

const

Returns

The uobject widget corresponding to a given name

GetWidgetHandle()

UWidget * UUserWidget::GetWidgetHandle

(

TSharedRef< SWidget >

InWidget

)

Returns

The UObject wrapper for a given SWidget

GetWidgetTreeOwningClass()

UWidgetBlueprintGeneratedClass * UUserWidget::GetWidgetTreeOwningClass

(

)

const

Returns the BlueprintGeneratedClass that generated the WidgetTree. A child UserWidget that extends a parent UserWidget will not have a new WidgetTree. The child UserWidget will have the same WidgetTree as the parent UserWidget. This function returns the parent UserWidget's BlueprintClass.

GetWorld()

PRAGMA_ENABLE_DEPRECATION_WARNINGS UWorld * UUserWidget::GetWorld ( ) const

overridevirtual

Reimplemented from UWidget.

HandleOwningLocalPlayerControllerChanged()

void UUserWidget::HandleOwningLocalPlayerControllerChanged ( APlayerController *  NewPlayerController )

protected

A callback bound to this widget's owning local player which will fire when the player controller has changed.

Initialize()

bool UUserWidget::Initialize ( )

virtual

InitializeInputComponent()

PRAGMA_DISABLE_DEPRECATION_WARNINGS void UUserWidget::InitializeInputComponent ( )

finalprotectedvirtual

InitializeNamedSlots()

void UUserWidget::InitializeNamedSlots ( )

protected

InitializeNativeClassData()

virtual void UUserWidget::InitializeNativeClassData ( )

inlineprotectedvirtual

The function is implemented only in nativized widgets (automatically converted from BP to c++)

Invalidate()

void UUserWidget::Invalidate ( EInvalidateWidgetReason  InvalidateReason )

protected

IsAnimationPlaying()

bool UUserWidget::IsAnimationPlaying

(

const UWidgetAnimation *

InAnimation

)

const

Gets whether an animation is currently playing on this widget.

Parameters

InAnimation

The animation to check the playback status of

Returns

True if the animation is currently playing

IsAnimationPlayingForward()

bool UUserWidget::IsAnimationPlayingForward

(

const UWidgetAnimation *

InAnimation

)

returns true if the animation is currently playing forward, false otherwise.

Parameters

InAnimation

The playing animation that we want to know about

IsAnyAnimationPlaying()

bool UUserWidget::IsAnyAnimationPlaying

(

)

const

Returns

True if any animation is currently playing

IsAsset()

bool UUserWidget::IsAsset ( ) const

virtual

Returns true if this object is considered an asset.

Reimplemented from UObject.

IsEditorUtility()

virtual bool UUserWidget::IsEditorUtility ( ) const

inlinevirtual

Is this widget an editor utility widget.

IsFocusable()

bool UUserWidget::IsFocusable

(

)

const

Sets whether this widget to accept focus when clicked, or when navigated to.

IsInputActionBlocking()

bool UUserWidget::IsInputActionBlocking

(

)

const

Returns whether the input action is blocking.

IsInteractable()

UMG_API bool UUserWidget::IsInteractable

(

)

const

Gets a value indicating if the widget is interactive.

IsListeningForInputAction()

bool UUserWidget::IsListeningForInputAction ( FName  ActionName ) const

protected

Checks if the action has a registered callback with the input component.

IsPlayingAnimation()

bool UUserWidget::IsPlayingAnimation

(

)

const

Are we currently playing any animations?

ListenForInputAction()

void UUserWidget::ListenForInputAction ( FName  ActionName, TEnumAsByte< EInputEvent >  EventType, bool  bConsume, FOnInputAction  Callback  )

protected

Listens for a particular Player Input Action by name. This requires that those actions are being executed, and that we're not currently in UI-Only Input Mode.

NativeConstruct()

void UUserWidget::NativeConstruct ( )

protectedvirtual

NativeDestruct()

void UUserWidget::NativeDestruct ( )

protectedvirtual

NativeIsInteractable()

bool UUserWidget::NativeIsInteractable ( ) const

protectedvirtual

NativeOnAddedToFocusPath()

void UUserWidget::NativeOnAddedToFocusPath ( const FFocusEvent &  InFocusEvent )

protectedvirtual

NativeOnAnalogValueChanged()

FReply UUserWidget::NativeOnAnalogValueChanged ( const FGeometry &  InGeometry, const FAnalogInputEvent &  InAnalogEvent  )

protectedvirtual

NativeOnCursorQuery()

FCursorReply UUserWidget::NativeOnCursorQuery ( const FGeometry &  InGeometry, const FPointerEvent &  InCursorEvent  )

protectedvirtual

NativeOnDragCancelled()

void UUserWidget::NativeOnDragCancelled ( const FDragDropEvent &  InDragDropEvent, UDragDropOperation *  InOperation  )

protectedvirtual

NativeOnDragDetected()

void UUserWidget::NativeOnDragDetected ( const FGeometry &  InGeometry, const FPointerEvent &  InMouseEvent, UDragDropOperation *&  OutOperation  )

protectedvirtual

NativeOnDragEnter()

void UUserWidget::NativeOnDragEnter ( const FGeometry &  InGeometry, const FDragDropEvent &  InDragDropEvent, UDragDropOperation *  InOperation  )

protectedvirtual

NativeOnDragLeave()

void UUserWidget::NativeOnDragLeave ( const FDragDropEvent &  InDragDropEvent, UDragDropOperation *  InOperation  )

protectedvirtual

NativeOnDragOver()

bool UUserWidget::NativeOnDragOver ( const FGeometry &  InGeometry, const FDragDropEvent &  InDragDropEvent, UDragDropOperation *  InOperation  )

protectedvirtual

NativeOnDrop()

bool UUserWidget::NativeOnDrop ( const FGeometry &  InGeometry, const FDragDropEvent &  InDragDropEvent, UDragDropOperation *  InOperation  )

protectedvirtual

NativeOnFinishedPointerInput()

virtual void UUserWidget::NativeOnFinishedPointerInput ( )

inlineprotectedvirtual

NativeOnFocusChanging()

void UUserWidget::NativeOnFocusChanging ( const FWeakWidgetPath &  PreviousFocusPath, const FWidgetPath &  NewWidgetPath, const FFocusEvent &  InFocusEvent  )

protectedvirtual

NativeOnFocusLost()

void UUserWidget::NativeOnFocusLost ( const FFocusEvent &  InFocusEvent )

protectedvirtual

NativeOnFocusReceived()

PRAGMA_ENABLE_DEPRECATION_WARNINGS FReply UUserWidget::NativeOnFocusReceived ( const FGeometry &  InGeometry, const FFocusEvent &  InFocusEvent  )

protectedvirtual

NativeOnInitialized()

void UUserWidget::NativeOnInitialized ( )

protectedvirtual

NativeOnKeyChar()

FReply UUserWidget::NativeOnKeyChar ( const FGeometry &  InGeometry, const FCharacterEvent &  InCharEvent  )

protectedvirtual

NativeOnKeyDown()

FReply UUserWidget::NativeOnKeyDown ( const FGeometry &  InGeometry, const FKeyEvent &  InKeyEvent  )

protectedvirtual

NativeOnKeyUp()

FReply UUserWidget::NativeOnKeyUp ( const FGeometry &  InGeometry, const FKeyEvent &  InKeyEvent  )

protectedvirtual

NativeOnMotionDetected()

FReply UUserWidget::NativeOnMotionDetected ( const FGeometry &  InGeometry, const FMotionEvent &  InMotionEvent  )

protectedvirtual

NativeOnMouseButtonDoubleClick()

FReply UUserWidget::NativeOnMouseButtonDoubleClick ( const FGeometry &  InGeometry, const FPointerEvent &  InMouseEvent  )

protectedvirtual

NativeOnMouseButtonDown()

FReply UUserWidget::NativeOnMouseButtonDown ( const FGeometry &  InGeometry, const FPointerEvent &  InMouseEvent  )

protectedvirtual

NativeOnMouseButtonUp()

FReply UUserWidget::NativeOnMouseButtonUp ( const FGeometry &  InGeometry, const FPointerEvent &  InMouseEvent  )

protectedvirtual

NativeOnMouseCaptureLost()

void UUserWidget::NativeOnMouseCaptureLost ( const FCaptureLostEvent &  CaptureLostEvent )

protectedvirtual

NativeOnMouseEnter()

void UUserWidget::NativeOnMouseEnter ( const FGeometry &  InGeometry, const FPointerEvent &  InMouseEvent  )

protectedvirtual

NativeOnMouseLeave()

void UUserWidget::NativeOnMouseLeave ( const FPointerEvent &  InMouseEvent )

protectedvirtual

NativeOnMouseMove()

FReply UUserWidget::NativeOnMouseMove ( const FGeometry &  InGeometry, const FPointerEvent &  InMouseEvent  )

protectedvirtual

NativeOnMouseWheel()

FReply UUserWidget::NativeOnMouseWheel ( const FGeometry &  InGeometry, const FPointerEvent &  InMouseEvent  )

protectedvirtual

NativeOnNavigation() [1/2]

FNavigationReply UUserWidget::NativeOnNavigation ( const FGeometry &  InGeometry, const FNavigationEvent &  InNavigationEvent  )

protectedvirtual

NativeOnNavigation() [2/2]

FNavigationReply UUserWidget::NativeOnNavigation ( const FGeometry &  MyGeometry, const FNavigationEvent &  InNavigationEvent, const FNavigationReply &  InDefaultReply  )

protectedvirtual

NativeOnPreviewKeyDown()

FReply UUserWidget::NativeOnPreviewKeyDown ( const FGeometry &  InGeometry, const FKeyEvent &  InKeyEvent  )

protectedvirtual

NativeOnPreviewMouseButtonDown()

FReply UUserWidget::NativeOnPreviewMouseButtonDown ( const FGeometry &  InGeometry, const FPointerEvent &  InMouseEvent  )

protectedvirtual

NativeOnRemovedFromFocusPath()

void UUserWidget::NativeOnRemovedFromFocusPath ( const FFocusEvent &  InFocusEvent )

protectedvirtual

NativeOnTouchEnded()

FReply UUserWidget::NativeOnTouchEnded ( const FGeometry &  InGeometry, const FPointerEvent &  InGestureEvent  )

protectedvirtual

NativeOnTouchFirstMove()

FReply UUserWidget::NativeOnTouchFirstMove ( const FGeometry &  MyGeometry, const FPointerEvent &  TouchEvent  )

protectedvirtual

NativeOnTouchForceChanged()

FReply UUserWidget::NativeOnTouchForceChanged ( const FGeometry &  MyGeometry, const FPointerEvent &  TouchEvent  )

protectedvirtual

NativeOnTouchGesture()

FReply UUserWidget::NativeOnTouchGesture ( const FGeometry &  InGeometry, const FPointerEvent &  InGestureEvent  )

protectedvirtual

NativeOnTouchMoved()

FReply UUserWidget::NativeOnTouchMoved ( const FGeometry &  InGeometry, const FPointerEvent &  InGestureEvent  )

protectedvirtual

NativeOnTouchStarted()

FReply UUserWidget::NativeOnTouchStarted ( const FGeometry &  InGeometry, const FPointerEvent &  InGestureEvent  )

protectedvirtual

NativePaint()

int32 UUserWidget::NativePaint ( const FPaintArgs &  Args, const FGeometry &  AllottedGeometry, const FSlateRect &  MyCullingRect, FSlateWindowElementList &  OutDrawElements, int32  LayerId, const FWidgetStyle &  InWidgetStyle, bool  bParentEnabled  ) const

protectedvirtual

Native implemented paint function for the Widget Returns the maximum LayerID painted on

NativePreConstruct()

void UUserWidget::NativePreConstruct ( )

protectedvirtual

NativeSupportsCustomNavigation()

virtual bool UUserWidget::NativeSupportsCustomNavigation ( ) const

inlineprotectedvirtual

NativeSupportsKeyboardFocus()

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool UUserWidget::NativeSupportsKeyboardFocus ( ) const

protectedvirtual

NativeTick()

void UUserWidget::NativeTick ( const FGeometry &  MyGeometry, float  InDeltaTime  )

protectedvirtual

OnAddedToFocusPath()

UMG_API void UUserWidget::OnAddedToFocusPath

(

FFocusEvent

InFocusEvent

)

If focus is gained on on this widget or on a child widget and this widget is added to the focus path, and wasn't previously part of it, this event is called.

Parameters

InFocusEvent

FocusEvent

OnAnalogValueChanged()

UMG_API FEventReply UUserWidget::OnAnalogValueChanged	(	FGeometry	MyGeometry,
		FAnalogInputEvent	InAnalogInputEvent
	)

Called when an analog value changes on a button that supports analog

Parameters

MyGeometry	The Geometry of the widget receiving the event
InAnalogInputEvent	Analog Event

Returns

Returns whether the event was handled, along with other possible actions

OnAnimationFinished()

UMG_API void UUserWidget::OnAnimationFinished ( const UWidgetAnimation *  Animation )

protected

Called when an animation has either played all the way through or is stopped

Parameters

Animation

The animation that has finished playing

OnAnimationFinished_Implementation()

void UUserWidget::OnAnimationFinished_Implementation ( const UWidgetAnimation *  Animation )

protectedvirtual

OnAnimationFinishedPlaying() [1/2]

FOnWidgetAnimationEvent & UUserWidget::OnAnimationFinishedPlaying ( )

inlineprotected

Called when a sequence player is finished playing an animation

OnAnimationFinishedPlaying() [2/2]

virtual void UUserWidget::OnAnimationFinishedPlaying ( UUMGSequencePlayer &  Player )

inlineprotectedvirtual

OnAnimationStarted()

UMG_API void UUserWidget::OnAnimationStarted ( const UWidgetAnimation *  Animation )

protected

Called when an animation is started.

Parameters

Animation

the animation that started

OnAnimationStarted_Implementation()

void UUserWidget::OnAnimationStarted_Implementation ( const UWidgetAnimation *  Animation )

protectedvirtual

OnAnimationStartedPlaying() [1/2]

FOnWidgetAnimationEvent & UUserWidget::OnAnimationStartedPlaying ( )

inlineprotected

Called when a sequence player is finished playing an animation

OnAnimationStartedPlaying() [2/2]

virtual void UUserWidget::OnAnimationStartedPlaying ( UUMGSequencePlayer &  Player )

inlineprotectedvirtual

OnDragCancelled()

UMG_API void UUserWidget::OnDragCancelled	(	const FPointerEvent &	PointerEvent,
		UDragDropOperation *	Operation
	)

Called when the user cancels the drag operation, typically when they simply release the mouse button after beginning a drag operation, but failing to complete the drag.

Parameters

PointerEvent	Last mouse event from when the drag was canceled.
Operation	The drag operation that was canceled.

OnDragDetected()

UMG_API void UUserWidget::OnDragDetected	(	FGeometry	MyGeometry,
		const FPointerEvent &	PointerEvent,
		UDragDropOperation *&	Operation
	)

Called when Slate detects that a widget started to be dragged.

Parameters

InMyGeometry	Widget geometry
PointerEvent	MouseMove that triggered the drag
Operation	The drag operation that was detected.

OnDragEnter()

UMG_API void UUserWidget::OnDragEnter	(	FGeometry	MyGeometry,
		FPointerEvent	PointerEvent,
		UDragDropOperation *	Operation
	)

Called during drag and drop when the drag enters the widget.

Parameters

MyGeometry	The geometry of the widget receiving the event.
PointerEvent	The mouse event from when the drag entered the widget.
Operation	The drag operation that entered the widget.

OnDragLeave()

UMG_API void UUserWidget::OnDragLeave	(	FPointerEvent	PointerEvent,
		UDragDropOperation *	Operation
	)

Called during drag and drop when the drag leaves the widget.

Parameters

PointerEvent	The mouse event from when the drag left the widget.
Operation	The drag operation that entered the widget.

OnDragOver()

UMG_API bool UUserWidget::OnDragOver	(	FGeometry	MyGeometry,
		FPointerEvent	PointerEvent,
		UDragDropOperation *	Operation
	)

Called during drag and drop when the the mouse is being dragged over a widget.

Parameters

MyGeometry	The geometry of the widget receiving the event.
PointerEvent	The mouse event from when the drag occurred over the widget.
Operation	The drag operation over the widget.

Returns

'true' to indicate that you handled the drag over operation. Returning 'false' will cause the operation to continue to bubble up.

OnDrop()

UMG_API bool UUserWidget::OnDrop	(	FGeometry	MyGeometry,
		FPointerEvent	PointerEvent,
		UDragDropOperation *	Operation
	)

Called when the user is dropping something onto a widget. Ends the drag and drop operation, even if no widget handles this.

Parameters

MyGeometry	The geometry of the widget receiving the event.
PointerEvent	The mouse event from when the drag occurred over the widget.
Operation	The drag operation over the widget.

Returns

'true' to indicate you handled the drop operation.

OnFocusLost()

UMG_API void UUserWidget::OnFocusLost

(

FFocusEvent

InFocusEvent

)

Called when this widget loses focus. This event does not bubble.

Parameters

InFocusEvent

FocusEvent

OnFocusReceived()

UMG_API FEventReply UUserWidget::OnFocusReceived	(	FGeometry	MyGeometry,
		FFocusEvent	InFocusEvent
	)

Called when keyboard focus is given to this widget. This event does not bubble.

Parameters

MyGeometry	The Geometry of the widget receiving the event
InFocusEvent	FocusEvent

Returns

Returns whether the event was handled, along with other possible actions

OnInitialized()

UMG_API void UUserWidget::OnInitialized

(

)

Called once only at game time on non-template instances. While Construct/Destruct pertain to the underlying Slate, this is called only once for the UUserWidget. If you have one-time things to establish up-front (like binding callbacks to events on BindWidget properties), do so here.

OnInputAction()

PRAGMA_ENABLE_DEPRECATION_WARNINGS void UUserWidget::OnInputAction ( FOnInputAction  Callback )

protected

OnKeyChar()

UMG_API FEventReply UUserWidget::OnKeyChar	(	FGeometry	MyGeometry,
		FCharacterEvent	InCharacterEvent
	)

Called after a character is entered while this widget has focus

Parameters

MyGeometry	The Geometry of the widget receiving the event
InCharacterEvent	Character event

Returns

Returns whether the event was handled, along with other possible actions

OnKeyDown()

UMG_API FEventReply UUserWidget::OnKeyDown	(	FGeometry	MyGeometry,
		FKeyEvent	InKeyEvent
	)

Called after a key (keyboard, controller, ...) is pressed when this widget has focus (this event bubbles if not handled)

Parameters

MyGeometry	The Geometry of the widget receiving the event
InKeyEvent	Key event

Returns

Returns whether the event was handled, along with other possible actions

OnKeyUp()

UMG_API FEventReply UUserWidget::OnKeyUp	(	FGeometry	MyGeometry,
		FKeyEvent	InKeyEvent
	)

Called after a key (keyboard, controller, ...) is released when this widget has focus

Parameters

MyGeometry	The Geometry of the widget receiving the event
InKeyEvent	Key event

Returns

Returns whether the event was handled, along with other possible actions

OnMotionDetected()

UMG_API FEventReply UUserWidget::OnMotionDetected	(	FGeometry	MyGeometry,
		FMotionEvent	InMotionEvent
	)

Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller.

Parameters

MyGeometry	The geometry of the widget receiving the event.
MotionEvent	The motion event generated

OnMouseButtonDoubleClick()

UMG_API FEventReply UUserWidget::OnMouseButtonDoubleClick	(	FGeometry	InMyGeometry,
		const FPointerEvent &	InMouseEvent
	)

Called when a mouse button is double clicked. Override this in derived classes.

Parameters

InMyGeometry	Widget geometry
InMouseEvent	Mouse button event

Returns

Returns whether the event was handled, along with other possible actions

OnMouseButtonDown()

UMG_API FEventReply UUserWidget::OnMouseButtonDown	(	FGeometry	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns

Whether the event was handled along with possible requests for the system to take action.

OnMouseButtonUp()

UMG_API FEventReply UUserWidget::OnMouseButtonUp	(	FGeometry	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns

Whether the event was handled along with possible requests for the system to take action.

OnMouseCaptureLost()

UMG_API void UUserWidget::OnMouseCaptureLost

(

)

Called when mouse capture is lost if it was owned by this widget.

OnMouseEnter()

UMG_API void UUserWidget::OnMouseEnter	(	FGeometry	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

The system will use this event to notify a widget that the cursor has entered it. This event is NOT bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

OnMouseLeave()

UMG_API void UUserWidget::OnMouseLeave

(

const FPointerEvent &

MouseEvent

)

The system will use this event to notify a widget that the cursor has left it. This event is NOT bubbled.

Parameters

MouseEvent

Information about the input event

OnMouseMove()

UMG_API FEventReply UUserWidget::OnMouseMove	(	FGeometry	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

The system calls this method to notify the widget that a mouse moved within it. This event is bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns

Whether the event was handled along with possible requests for the system to take action.

OnMouseWheel()

UMG_API FEventReply UUserWidget::OnMouseWheel	(	FGeometry	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

Called when the mouse wheel is spun. This event is bubbled.

Parameters

MouseEvent

Mouse event

Returns

Returns whether the event was handled, along with other possible actions

OnPaint()

UMG_API void UUserWidget::OnPaint

(

UPARAM(ref) FPaintContext &

Context

)

const

OnPreviewKeyDown()

UMG_API FEventReply UUserWidget::OnPreviewKeyDown	(	FGeometry	MyGeometry,
		FKeyEvent	InKeyEvent
	)

Called after a key (keyboard, controller, ...) is pressed when this widget or a child of this widget has focus If a widget handles this event, OnKeyDown will not be passed to the focused widget.

This event is primarily to allow parent widgets to consume an event before a child widget processes it and it should be used only when there is no better design alternative.

Parameters

MyGeometry	The Geometry of the widget receiving the event
InKeyEvent	Key event

Returns

Returns whether the event was handled, along with other possible actions

OnPreviewMouseButtonDown()

UMG_API FEventReply UUserWidget::OnPreviewMouseButtonDown	(	FGeometry	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

Just like OnMouseButtonDown, but tunnels instead of bubbling. If this event is handled, OnMouseButtonDown will not be sent.

Use this event sparingly as preview events generally make UIs more difficult to reason about.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns

Whether the event was handled along with possible requests for the system to take action.

OnRemovedFromFocusPath()

UMG_API void UUserWidget::OnRemovedFromFocusPath

(

FFocusEvent

InFocusEvent

)

If focus is lost on on this widget or on a child widget and this widget is no longer part of the focus path.

Parameters

InFocusEvent

FocusEvent

OnTouchEnded()

UMG_API FEventReply UUserWidget::OnTouchEnded	(	FGeometry	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

Called when a touchpad touch is ended (finger lifted)

Parameters

MyGeometry	The geometry of the widget receiving the event.
InTouchEvent	The touch event generated

OnTouchFirstMove()

UMG_API FEventReply UUserWidget::OnTouchFirstMove	(	FGeometry	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

Called when a touchpad touch is first moved (initial finger movement)

Parameters

MyGeometry	The geometry of the widget receiving the event.
InTouchEvent	The touch event generated

OnTouchForceChanged()

UMG_API FEventReply UUserWidget::OnTouchForceChanged	(	FGeometry	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

Called when a touchpad force has changed (user pressed down harder or let up)

Parameters

MyGeometry	The geometry of the widget receiving the event.
InTouchEvent	The touch event generated

OnTouchGesture()

UMG_API FEventReply UUserWidget::OnTouchGesture	(	FGeometry	MyGeometry,
		const FPointerEvent &	GestureEvent
	)

Called when the user performs a gesture on trackpad. This event is bubbled.

Parameters

MyGeometry	The geometry of the widget receiving the event.
GestureEvent	gesture event

Returns

Returns whether the event was handled, along with other possible actions

OnTouchMoved()

UMG_API FEventReply UUserWidget::OnTouchMoved	(	FGeometry	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

Called when a touchpad touch is moved (finger moved)

Parameters

MyGeometry	The geometry of the widget receiving the event.
InTouchEvent	The touch event generated

OnTouchStarted()

UMG_API FEventReply UUserWidget::OnTouchStarted	(	FGeometry	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

Called when a touchpad touch is started (finger down)

Parameters

MyGeometry	The geometry of the widget receiving the event.
InTouchEvent	The touch event generated

OnWidgetRebuilt()

void UUserWidget::OnWidgetRebuilt ( )

overrideprotectedvirtual

Function called after the underlying SWidget is constructed.

Reimplemented from UWidget.

PauseAnimation()

float UUserWidget::PauseAnimation

(

const UWidgetAnimation *

InAnimation

)

Pauses an already running animation in this widget

Parameters

The	name of the animation to pause

Returns

the time point the animation was at when it was paused, relative to its start position. Use this as the StartAtTime when you trigger PlayAnimation.

PlayAnimation()

FWidgetAnimationHandle UUserWidget::PlayAnimation	(	UWidgetAnimation *	InAnimation,
		float	StartAtTime = 0.0f,
		int32	NumLoopsToPlay = 1,
		EUMGSequencePlayMode::Type	PlayMode = EUMGSequencePlayMode::Forward,
		float	PlaybackSpeed = 1.0f,
		bool	bRestoreState = false
	)

Plays an animation in this widget a specified number of times

Parameters

InAnimation	The animation to play
StartAtTime	The time in the animation from which to start playing, relative to the start position. For looped animations, this will only affect the first playback of the animation.
NumLoopsToPlay	The number of times to loop this animation (0 to loop indefinitely)
PlaybackSpeed	The speed at which the animation should play
PlayMode	Specifies the playback mode
bRestoreState	Restores widgets to their pre-animated state when the animation stops

PlayAnimationForward()

FWidgetAnimationHandle UUserWidget::PlayAnimationForward	(	UWidgetAnimation *	InAnimation,
		float	PlaybackSpeed = 1.0f,
		bool	bRestoreState = false
	)

Plays an animation on this widget relative to it's current state forward. You should use this version in situations where say a user can click a button and that causes a panel to slide out, and you want to reverse that same animation to begin sliding in the opposite direction.

Parameters

InAnimation	The animation to play
PlayMode	Specifies the playback mode
PlaybackSpeed	The speed at which the animation should play
bRestoreState	Restores widgets to their pre-animated state when the animation stops

PlayAnimationReverse()

FWidgetAnimationHandle UUserWidget::PlayAnimationReverse	(	UWidgetAnimation *	InAnimation,
		float	PlaybackSpeed = 1.0f,
		bool	bRestoreState = false
	)

Plays an animation on this widget relative to it's current state in reverse. You should use this version in situations where say a user can click a button and that causes a panel to slide out, and you want to reverse that same animation to begin sliding in the opposite direction.

Parameters

InAnimation	The animation to play
PlayMode	Specifies the playback mode
PlaybackSpeed	The speed at which the animation should play
bRestoreState	Restores widgets to their pre-animated state when the animation stops

PlayAnimationTimeRange()

FWidgetAnimationHandle UUserWidget::PlayAnimationTimeRange	(	UWidgetAnimation *	InAnimation,
		float	StartAtTime = 0.0f,
		float	EndAtTime = 0.0f,
		int32	NumLoopsToPlay = 1,
		EUMGSequencePlayMode::Type	PlayMode = EUMGSequencePlayMode::Forward,
		float	PlaybackSpeed = 1.0f,
		bool	bRestoreState = false
	)

Plays an animation in this widget a specified number of times stopping at a specified time

Parameters

InAnimation	The animation to play
StartAtTime	The time in the animation from which to start playing, relative to the start position. For looped animations, this will only affect the first playback of the animation.
EndAtTime	The absolute time in the animation where to stop, this is only considered in the last loop.
NumLoopsToPlay	The number of times to loop this animation (0 to loop indefinitely)
PlayMode	Specifies the playback mode
PlaybackSpeed	The speed at which the animation should play
bRestoreState	Restores widgets to their pre-animated state when the animation stops

PlaySound()

void UUserWidget::PlaySound

(

class USoundBase *

SoundToPlay

)

Plays a sound through the UI

Parameters

The	sound to play

PostDuplicate()

void UUserWidget::PostDuplicate ( bool  bDuplicateForPIE )

overridevirtual

Called after duplication & serialization and before PostLoad. Used to e.g. make sure UStaticMesh's UModel gets copied as well. Note: NOT called on components on actor duplication (alt-drag or copy-paste). Use PostEditImport as well to cover that case.

Reimplemented from UObject.

PostLoad()

void UUserWidget::PostLoad ( )

overridevirtual

Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

Reimplemented from UObject.

PostTickActionsAndAnimation()

void UUserWidget::PostTickActionsAndAnimation ( float  InDeltaTime )

inlineprotected

PreConstruct()

UMG_API void UUserWidget::PreConstruct

(

bool

IsDesignTime

)

Called by both the game and the editor. Allows users to run initial setup for their widgets to better preview the setup in the designer and since generally that same setup code is required at runtime, it's called there as well.

WARNING This is intended purely for cosmetic updates using locally owned data, you can not safely access any game related state, if you call something that doesn't expect to be run at editor time, you may crash the editor.

In the event you save the asset with blueprint code that causes a crash on evaluation. You can turn off PreConstruct evaluation in the Widget Designer settings in the Editor Preferences.

PreSave()

void UUserWidget::PreSave ( FObjectPreSaveContext  SaveContext )

overridevirtual

Presave function. Gets called once before an object gets serialized for saving. This function is necessary for save time computation as Serialize gets called three times per object from within SavePackage.

Warning

: Objects created from within PreSave will NOT have PreSave called on them!!!

Reimplemented from UWidget.

PROPERTY_BINDING_IMPLEMENTATION() [1/2]

UUserWidget::PROPERTY_BINDING_IMPLEMENTATION ( FLinearColor  , ColorAndOpacity    )

protected

PROPERTY_BINDING_IMPLEMENTATION() [2/2]

UUserWidget::PROPERTY_BINDING_IMPLEMENTATION ( FSlateColor  , ForegroundColor    )

protected

QueuePauseAnimation()

float UUserWidget::QueuePauseAnimation

(

const UWidgetAnimation *

InAnimation

)

Pauses an already running animation in this widget

Parameters

The	name of the animation to pause

Returns

the time point the animation was at when it was paused, relative to its start position. Use this as the StartAtTime when you trigger PlayAnimation.

QueuePlayAnimation()

void UUserWidget::QueuePlayAnimation	(	UWidgetAnimation *	InAnimation,
		float	StartAtTime = 0.0f,
		int32	NumLoopsToPlay = 1,
		EUMGSequencePlayMode::Type	PlayMode = EUMGSequencePlayMode::Forward,
		float	PlaybackSpeed = 1.0f,
		bool	bRestoreState = false
	)

Plays an animation in this widget a specified number of times

Parameters

InAnimation	The animation to play
StartAtTime	The time in the animation from which to start playing, relative to the start position. For looped animations, this will only affect the first playback of the animation.
NumLoopsToPlay	The number of times to loop this animation (0 to loop indefinitely)
PlaybackSpeed	The speed at which the animation should play
PlayMode	Specifies the playback mode
bRestoreState	Restores widgets to their pre-animated state when the animation stops

QueuePlayAnimationForward()

void UUserWidget::QueuePlayAnimationForward	(	UWidgetAnimation *	InAnimation,
		float	PlaybackSpeed = 1.0f,
		bool	bRestoreState = false
	)

Plays an animation on this widget relative to it's current state forward. You should use this version in situations where say a user can click a button and that causes a panel to slide out, and you want to reverse that same animation to begin sliding in the opposite direction.

Parameters

InAnimation	The animation to play
PlayMode	Specifies the playback mode
PlaybackSpeed	The speed at which the animation should play
bRestoreState	Restores widgets to their pre-animated state when the animation stops

QueuePlayAnimationReverse()

void UUserWidget::QueuePlayAnimationReverse	(	UWidgetAnimation *	InAnimation,
		float	PlaybackSpeed = 1.0f,
		bool	bRestoreState = false
	)

Plays an animation on this widget relative to it's current state in reverse. You should use this version in situations where say a user can click a button and that causes a panel to slide out, and you want to reverse that same animation to begin sliding in the opposite direction.

Parameters

InAnimation	The animation to play
PlayMode	Specifies the playback mode
PlaybackSpeed	The speed at which the animation should play
bRestoreState	Restores widgets to their pre-animated state when the animation stops

QueuePlayAnimationTimeRange()

void UUserWidget::QueuePlayAnimationTimeRange	(	UWidgetAnimation *	InAnimation,
		float	StartAtTime = 0.0f,
		float	EndAtTime = 0.0f,
		int32	NumLoopsToPlay = 1,
		EUMGSequencePlayMode::Type	PlayMode = EUMGSequencePlayMode::Forward,
		float	PlaybackSpeed = 1.0f,
		bool	bRestoreState = false
	)

Plays an animation in this widget a specified number of times stopping at a specified time

Parameters

InAnimation	The animation to play
StartAtTime	The time in the animation from which to start playing, relative to the start position. For looped animations, this will only affect the first playback of the animation.
EndAtTime	The absolute time in the animation where to stop, this is only considered in the last loop.
NumLoopsToPlay	The number of times to loop this animation (0 to loop indefinitely)
PlayMode	Specifies the playback mode
PlaybackSpeed	The speed at which the animation should play
bRestoreState	Restores widgets to their pre-animated state when the animation stops

QueueStopAllAnimations()

void UUserWidget::QueueStopAllAnimations

(

)

Stop All actively running animations.

QueueStopAnimation()

void UUserWidget::QueueStopAnimation

(

const UWidgetAnimation *

InAnimation

)

Stops an already running animation in this widget

Parameters

The	name of the animation to stop

RebuildWidget()

TSharedRef< SWidget > UUserWidget::RebuildWidget ( )

overrideprotectedvirtual

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Reimplemented from UWidget.

RegisterInputComponent()

void UUserWidget::RegisterInputComponent ( )

protected

ListenForInputAction will automatically Register an Input Component with the player input system. If you however, want to Pause and Resume, listening for a set of actions, the best way is to use UnregisterInputComponent to pause, and RegisterInputComponent to resume listening.

ReleaseSlateResources()

void UUserWidget::ReleaseSlateResources ( bool  bReleaseChildren )

overridevirtual

Reimplemented from UVisual.

RemoveExtension()

void UUserWidget::RemoveExtension

(

UUserWidgetExtension *

InExtension

)

Remove the extension.

RemoveExtensions() [1/2]

template<typename ExtensionType >

void UUserWidget::RemoveExtensions ( )

inline

Remove all extensions of the requested type.

RemoveExtensions() [2/2]

void UUserWidget::RemoveExtensions

(

TSubclassOf< UUserWidgetExtension >

InExtensionType

)

Remove all extensions of the requested type.

RemoveFromViewport()

void UUserWidget::RemoveFromViewport

(

)

Removes the widget from the viewport.

RemoveObsoleteBindings()

void UUserWidget::RemoveObsoleteBindings ( const TArray< FName > &  NamedSlots )

protected

ReverseAnimation()

void UUserWidget::ReverseAnimation

(

const UWidgetAnimation *

InAnimation

)

If an animation is playing, this function will reverse the playback.

Parameters

InAnimation

The playing animation that we want to reverse

SetAlignmentInViewport()

void UUserWidget::SetAlignmentInViewport

(

FVector2D

Alignment

)

SetAnchorsInViewport()

void UUserWidget::SetAnchorsInViewport

(

FAnchors

Anchors

)

SetAnimationCurrentTime()

void UUserWidget::SetAnimationCurrentTime	(	const UWidgetAnimation *	InAnimation,
		float	InTime
	)

Sets the current time of the animation in this widget. Does not change state.

Parameters

The	name of the animation to get the current time for
The	current time of the animation.

SetColorAndOpacity()

PRAGMA_DISABLE_DEPRECATION_WARNINGS void UUserWidget::SetColorAndOpacity

(

FLinearColor

InColorAndOpacity

)

Sets the tint of the widget, this affects all child widgets.

Parameters

InColorAndOpacity

The tint to apply to all child widgets.

SetContentForSlot()

void UUserWidget::SetContentForSlot ( FName  SlotName, UWidget *  Content  )

overridevirtual

Sets the widget for a given slot by name.

Implements INamedSlotInterface.

SetDesiredFocusWidget() [1/2]

bool UUserWidget::SetDesiredFocusWidget

(

FName

WidgetName

)

Sets the child Widget that should receive focus when this UserWidget gets focus using it's name.

Parameters

WidgetName

Name of the Widget to forward the focus to when this widget receives focus.

Returns

True if the Widget is set properly. Will return false if we can't find a child widget with the specified name.

SetDesiredFocusWidget() [2/2]

bool UUserWidget::SetDesiredFocusWidget

(

UWidget *

Widget

)

Sets the child Widget that should receive focus when this UserWidget gets focus.

Parameters

Widget

Widget to forward the focus to when this widget receives focus

Returns

True if the Widget is set properly. Will return false if it's not a child of this UserWidget.

SetDesiredSizeInViewport()

void UUserWidget::SetDesiredSizeInViewport

(

FVector2D

Size

)

SetForegroundColor()

void UUserWidget::SetForegroundColor

(

FSlateColor

InForegroundColor

)

Sets the foreground color of the widget, this is inherited by sub widgets. Any color property that is marked as inherit will use this color.

Parameters

InForegroundColor

The foreground color.

SetInputActionBlocking()

void UUserWidget::SetInputActionBlocking ( bool  bShouldBlock )

protected

SetInputActionPriority()

PRAGMA_DISABLE_DEPRECATION_WARNINGS void UUserWidget::SetInputActionPriority ( int32  NewPriority )

protected

SetIsFocusable()

void UUserWidget::SetIsFocusable

(

bool

InIsFocusable

)

SetMinimumDesiredSize()

void UUserWidget::SetMinimumDesiredSize ( FVector2D  InMinimumDesiredSize )

protected

SetNumLoopsToPlay()

void UUserWidget::SetNumLoopsToPlay	(	const UWidgetAnimation *	InAnimation,
		int32	NumLoopsToPlay
	)

Changes the number of loops to play given a playing animation

Parameters

InAnimation	The animation that is already playing
NumLoopsToPlay	The number of loops to play. (0 to loop indefinitely)

SetOwningLocalPlayer()

void UUserWidget::SetOwningLocalPlayer

(

ULocalPlayer *

LocalPlayer

)

Sets the player associated with this UI via LocalPlayer reference.

Parameters

LocalPlayer

The local player you want to be the conceptual owner of this UI.

SetOwningPlayer()

void UUserWidget::SetOwningPlayer

(

APlayerController *

LocalPlayerController

)

Sets the local player associated with this UI via PlayerController reference.

Parameters

LocalPlayerController

The PlayerController of the local player you want to be the conceptual owner of this UI.

SetPadding()

void UUserWidget::SetPadding

(

FMargin

InPadding

)

Sets the padding for the user widget, putting a larger gap between the widget border and it's root widget.

SetPlaybackSpeed()

void UUserWidget::SetPlaybackSpeed	(	const UWidgetAnimation *	InAnimation,
		float	PlaybackSpeed = 1.0f
	)

Changes the playback rate of a playing animation

Parameters

InAnimation	The animation that is already playing
PlaybackRate	Playback rate multiplier (1 is default)

SetPlayerContext()

void UUserWidget::SetPlayerContext

(

const FLocalPlayerContext &

InPlayerContext

)

Sets the player context associated with this UI.

SetPositionInViewport()

void UUserWidget::SetPositionInViewport	(	FVector2D	Position,
		bool	bRemoveDPIScale = true
	)

Sets the widgets position in the viewport.

Parameters

Position	The 2D position to set the widget to in the viewport.
bRemoveDPIScale	If you've already calculated inverse DPI, set this to false. Otherwise inverse DPI is applied to the position so that when the location is scaled by DPI, it ends up in the expected position.

SetVisibility()

void UUserWidget::SetVisibility ( ESlateVisibility  InVisibility )

overridevirtual

Sets the visibility of the widget.

Reimplemented from UWidget.

StartListeningForPlayerControllerChanges()

void UUserWidget::StartListeningForPlayerControllerChanges ( )

protected

StartProcessingInputScriptDelegates()

void UUserWidget::StartProcessingInputScriptDelegates ( )

protectedvirtual

Pushes the input component to the input stack and allows for any script delegates on this widget to get called.

StopAllAnimations()

void UUserWidget::StopAllAnimations

(

)

Stop All actively running animations.

Parameters

The	name of the animation to stop

StopAnimation()

void UUserWidget::StopAnimation

(

const UWidgetAnimation *

InAnimation

)

Stops an already running animation in this widget

Parameters

The	name of the animation to stop

StopAnimationsAndLatentActions()

void UUserWidget::StopAnimationsAndLatentActions

(

)

Cancels any pending Delays or timer callbacks for this widget, and stops all active animations on the widget.

StopListeningForAllInputActions()

void UUserWidget::StopListeningForAllInputActions ( )

protected

Stops listening to all input actions, and unregisters the input component with the player controller.

StopListeningForInputAction()

void UUserWidget::StopListeningForInputAction ( FName  ActionName, TEnumAsByte< EInputEvent >  EventType  )

protected

Removes the binding for a particular action's callback.

StopListeningForPlayerControllerChanges()

void UUserWidget::StopListeningForPlayerControllerChanges ( )

protected

StopProcessingInputScriptDelegates()

void UUserWidget::StopProcessingInputScriptDelegates ( )

protectedvirtual

Removes this widget's input component from the input stack, stopping any script delegates from being called.

This does not actually destroy or unbind any of the delegates yet, because the widget may be added to the viewport again the future, and the binding process can be expensive.

SynchronizeProperties()

void UUserWidget::SynchronizeProperties ( )

overridevirtual

Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

Reimplemented from UWidget.

TearDownAnimations()

void UUserWidget::TearDownAnimations ( )

protected

Tick()

UMG_API void UUserWidget::Tick	(	FGeometry	MyGeometry,
		float	InDeltaTime
	)

Ticks this widget. Override in derived classes, but always call the parent implementation.

Parameters

MyGeometry	The space allotted for this widget
InDeltaTime	Real time passed since last tick

TickActionsAndAnimation()

void UUserWidget::TickActionsAndAnimation ( float  InDeltaTime )

protected

Ticks the active sequences and latent actions that have been scheduled for this Widget.

UnbindAllFromAnimationFinished()

void UUserWidget::UnbindAllFromAnimationFinished

(

UWidgetAnimation *

Animation

)

UnbindAllFromAnimationStarted()

void UUserWidget::UnbindAllFromAnimationStarted

(

UWidgetAnimation *

Animation

)

UnbindFromAnimationFinished()

void UUserWidget::UnbindFromAnimationFinished	(	UWidgetAnimation *	Animation,
		FWidgetAnimationDynamicEvent	Delegate
	)

Unbind an animation finished delegate.

Parameters

Animation	the animation to listen for starting or finishing.
Delegate	the delegate to call when the animation's state changes

UnbindFromAnimationStarted()

void UUserWidget::UnbindFromAnimationStarted	(	UWidgetAnimation *	Animation,
		FWidgetAnimationDynamicEvent	Delegate
	)

Unbind an animation started delegate.

Parameters

Animation	the animation to listen for starting or finishing.
Delegate	the delegate to call when the animation's state changes

UnregisterInputComponent()

void UUserWidget::UnregisterInputComponent ( )

protected

StopListeningForAllInputActions will automatically Register an Input Component with the player input system. If you however, want to Pause and Resume, listening for a set of actions, the best way is to use UnregisterInputComponent to pause, and RegisterInputComponent to resume listening.

UpdateCanTick()

PRAGMA_ENABLE_DEPRECATION_WARNINGS void UUserWidget::UpdateCanTick

(

)

Friends And Related Symbol Documentation

FWidgetBlueprintCompilerContext

friend class FWidgetBlueprintCompilerContext

friend

The compiler is a friend so that it can disable initialization from the widget tree

SObjectWidget

friend class SObjectWidget

friend

Member Data Documentation

ActiveSequencePlayers

TArray<TObjectPtr<UUMGSequencePlayer> > UUserWidget::ActiveSequencePlayers

AnimationCallbacks

TArray<FAnimationEventBinding> UUserWidget::AnimationCallbacks

protected

AnimationTickManager

TObjectPtr<UUMGSequenceTickManager> UUserWidget::AnimationTickManager

Global tick manager for running widget animations

bAutomaticallyRegisterInputOnConstruction

uint8 UUserWidget::bAutomaticallyRegisterInputOnConstruction

If true, this widget will automatically register its own input component upon construction. This will allow the use of binding input delegates in the event graph.

This is set during the compilation of the widget blueprint.

bHasScriptImplementedPaint

uint8 UUserWidget::bHasScriptImplementedPaint

If a widget has an implemented paint blueprint function

bHasScriptImplementedTick

uint8 UUserWidget::bHasScriptImplementedTick

If a widget has an implemented tick blueprint function

bIsFocusable

uint8 UUserWidget::bIsFocusable

Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to.

bStopAction

uint8 UUserWidget::bStopAction

ColorAndOpacity

FLinearColor UUserWidget::ColorAndOpacity

The color and opacity of this widget. Tints all child widgets.

ColorAndOpacityDelegate

FGetLinearColor UUserWidget::ColorAndOpacityDelegate

ForegroundColor

FSlateColor UUserWidget::ForegroundColor

The foreground color of the widget, this is inherited by sub widgets. Any color property that is marked as inherit will use this color.

ForegroundColorDelegate

FGetSlateColor UUserWidget::ForegroundColorDelegate

FWidgetAnimationHandle

friend UUserWidget::FWidgetAnimationHandle

protected

FWidgetAnimationState

friend UUserWidget::FWidgetAnimationState

protected

InputComponent

TObjectPtr<class UInputComponent> UUserWidget::InputComponent

protected

OnNativeDestruct

FNativeOnDestruct UUserWidget::OnNativeDestruct

OnNativeVisibilityChanged

FNativeOnVisibilityChangedEvent UUserWidget::OnNativeVisibilityChanged

OnVisibilityChanged

FOnVisibilityChangedEvent UUserWidget::OnVisibilityChanged

Called when the visibility has changed

Padding

FMargin UUserWidget::Padding

The padding area around the content.

Priority

int32 UUserWidget::Priority

QueuedWidgetAnimationTransitions

TArray<FQueuedWidgetAnimationTransition> UUserWidget::QueuedWidgetAnimationTransitions

Animation transitions to trigger on next tick

StoppedSequencePlayers

TArray<TObjectPtr<UUMGSequencePlayer> > UUserWidget::StoppedSequencePlayers

UUMGSequencePlayer

friend UUserWidget::UUMGSequencePlayer

protected

The sequence player is a friend because we need to be alerted when animations start and finish without going through the normal event callbacks as people have a tendency to RemoveAll(this), which would permanently disable callbacks that are critical for UserWidget's base class - so rather we just directly report to the owning UserWidget of state transitions.

UUMGSequenceTickManager

friend UUserWidget::UUMGSequenceTickManager

protected

WidgetTree

TObjectPtr<UWidgetTree> UUserWidget::WidgetTree

The widget tree contained inside this user widget initialized by the blueprint

---

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

• Engine/Source/Runtime/UMG/Public/Blueprint/UserWidget.h
• Engine/Source/Runtime/UMG/Private/UserWidget.cpp