UserWidget.h File Reference

#include "Blueprint/UMGSequencePlayMode.h"
#include "Blueprint/WidgetChild.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectSaveContext.h"
#include "Styling/SlateColor.h"
#include "Layout/Geometry.h"
#include "Input/CursorReply.h"
#include "Input/Events.h"
#include "Input/Reply.h"
#include "Widgets/SWidget.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Layout/Margin.h"
#include "Components/SlateWrapperTypes.h"
#include "Components/Widget.h"
#include "Components/NamedSlotInterface.h"
#include "Engine/World.h"
#include "GameFramework/PlayerController.h"
#include "Engine/LocalPlayer.h"
#include "Widgets/Layout/Anchors.h"
#include "Logging/MessageLog.h"
#include "Stats/Stats.h"
#include "EngineStats.h"
#include "SlateGlobals.h"
#include "Animation/WidgetAnimationEvents.h"
#include "Animation/WidgetAnimationHandle.h"
#include "Animation/WidgetAnimationState.h"
#include "UserWidget.generated.h"

Go to the source code of this file.

Classes
struct	FQueuedWidgetAnimationTransition
struct	FAnimationEventBinding
struct	FPaintContext
struct	FNamedSlotBinding
class	UUserWidgetFunctionLibrary
class	UUserWidget

Namespaces
namespace	CreateWidgetHelpers

Macros
#define	LOCTEXT_NAMESPACE   "UMG"

Enumerations
enum class	EQueuedWidgetAnimationMode : uint8 {   Play , PlayTo , Forward , Reverse ,   Stop , Pause , None }
enum class	ERequiresLegacyPlayer : uint8 { AutoDetect , Yes , No }
enum class	EWidgetTickFrequency : uint8 { Never = 0 , Auto }
enum class	EWidgetAnimationEvent : uint8 { Started , Finished }

Functions
	DECLARE_DYNAMIC_MULTICAST_DELEGATE (FOnConstructEvent)
	DECLARE_DYNAMIC_DELEGATE (FOnInputAction)
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnVisibilityChangedEvent, ESlateVisibility, InVisibility)
UMG_API bool	CreateWidgetHelpers::ValidateUserWidgetClass (const UClass *UserWidgetClass)
	DECLARE_CYCLE_STAT (TEXT("UserWidget Create"), STAT_CreateWidget, STATGROUP_Slate)
template<typename WidgetT = UUserWidget, typename OwnerType = UObject>
WidgetT *	CreateWidget (OwnerType OwningObject, TSubclassOf< UUserWidget > UserWidgetClass=WidgetT::StaticClass(), FName WidgetName=NAME_None)

Macro Definition Documentation

LOCTEXT_NAMESPACE

#define LOCTEXT_NAMESPACE   "UMG"

Enumeration Type Documentation

EQueuedWidgetAnimationMode

enum class EQueuedWidgetAnimationMode : uint8

strong

Describes overall action driving this animation transition.

Enumerator
Play	Animation plays with given params.
PlayTo	Animation plays with given params to given point.
Forward	Animation plays from current position forward.
Reverse	Animation plays from current position reverse.
Stop	Animation stops playing.
Pause	Animation stops playing.
None	Default state, should not be used.

ERequiresLegacyPlayer

enum class ERequiresLegacyPlayer : uint8

strong

Describes whether the widget needs a legacy UMG sequence player to be created.

Enumerator
AutoDetect	Will create a legacy player if the widget class has native C++ children.
Yes	Force creating a legacy player.
No	Declares that no legacy player is required.

EWidgetAnimationEvent

enum class EWidgetAnimationEvent : uint8

strong

Different animation events.

Enumerator
Started
Finished

EWidgetTickFrequency

enum class EWidgetTickFrequency : uint8

strong

Determines what strategy we use to determine when and if the widget ticks.

Enumerator
Never	This widget never ticks
Auto	This widget will tick if a blueprint tick function is implemented, any latent actions are found or animations need to play If the widget inherits from something other than UserWidget it will also tick so that native C++ or inherited ticks function To disable native ticking use add the class metadata flag "DisableNativeTick". I.E: meta=(DisableNativeTick)

Function Documentation

CreateWidget()

template<typename WidgetT = UUserWidget, typename OwnerType = UObject>

WidgetT * CreateWidget	(	OwnerType	OwningObject,
		TSubclassOf< UUserWidget >	UserWidgetClass = WidgetT::StaticClass(),
		FName	WidgetName = NAME_None
	)

DECLARE_CYCLE_STAT()

DECLARE_CYCLE_STAT	(	TEXT("UserWidget Create")	,
		STAT_CreateWidget	,
		STATGROUP_Slate
	)

DECLARE_DYNAMIC_DELEGATE()

DECLARE_DYNAMIC_DELEGATE

(

FOnInputAction

)

DECLARE_DYNAMIC_MULTICAST_DELEGATE()

DECLARE_DYNAMIC_MULTICAST_DELEGATE

(

FOnConstructEvent

)

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam()

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FOnVisibilityChangedEvent	,
		ESlateVisibility	,
		InVisibility
	)