UStatEntryWidget Class Reference

UStatEntryWidget. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UAlkUserWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UCommonUserWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UUserWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UVisual
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Stat Entry Widget|Fluff
float	m_FixedWidth
	The fixed width to be used for the entry.
TMap< int, UTexture2D >	m_MasteryIcons
	Icons for the different mastery levels. Can be set in the class defaults and overridden in instances.
TMap< float32, FText >	m_ChangeTextForSelectedValues
	For each value it will change the name to the selected text.
bool	m_CanBeConsideredFirst
	If this flag isn't set this entry will never be considered the first entry (e.g. for UStatMainWidget::SelectFirstEntry()).
bool	m_UseFixedWidth
	If the fixed width should be used for the entry.
Stat Entry Widget|Restrictions
bool	m_HideWhenUntrained
	If the entry should be hidden when the mastery level is set to "untrained".
TArray< float32 >	m_HideWhenIsEqualToAny
	If set the entry will be hidden when its value is zero.
bool	m_IsSurvivalModeExclusive
	If set the stat will only be shown in survival mode.
bool	m_HideWhenMissing
	If the entry should be hidden when no mastery level is set.
StatEntryWidget
FItemTooltipInfo	m_ItemTooltipInfo
	Information of the attribute modifications for external attributes in relation with this attribute.
Public Attributes inherited from UAlkUserWidget
ECommonInputType	m_CurrentInputType
	The current input type, cached.
const UPlayerWidget	PlayerWidget
const ECommonInputType	CurrentInputType
	Returns the current input type.
FHoveredChangedEventBP__AlkUserWidget	m_OnHoveredChangedBP
Public Attributes inherited from UCommonUserWidget
bool	bConsumePointerInput
	Set this to true if you don't want any pointer (mouse and touch) input to bubble past this widget.
bool	bDisplayInActionBar
	True to generally display this widget's actions in the action bar, assuming it has actions.
Public Attributes inherited from UUserWidget
FOnVisibilityChangedEvent	OnVisibilityChanged
	Called when the visibility has changed.
UTexture2D	PreviewBackground
	A preview background that you can use when designing the UI to get a sense of scale on the screen. Use a texture with a screenshot of your game in it, for example if you were designing a HUD.
UWidget	DesiredFocusWidget
bool	bIsFocusable
	Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to.
EWidgetTickFrequency	TickFrequency
	This widget is allowed to tick. If this is unchecked tick will never be called, animations will not play correctly, and latent actions will not execute. Uncheck this for performance reasons only.
UWidget	RootWidget
FText	PaletteCategory
	The category this widget appears in the palette.
const FName	DesiredFocusWidgetName
FLinearColor	ColorAndOpacity
	The color and opacity of this widget. Tints all child widgets.
FSlateColor	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.
FMargin	Padding
	The padding area around the content.
bool	bStopAction
int	Priority
const APawn	OwningPlayerPawn
	Gets the player pawn associated with this UI.
const APlayerCameraManager	OwningPlayerCameraManager
	Gets the player camera manager associated with this UI.
FVector2D	AlignmentInViewport
FAnchors	AnchorsInViewport
Public Attributes inherited from UWidget
FText	AccessibleSummaryText
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
FText	AccessibleText
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
ESlateAccessibleBehavior	AccessibleBehavior
	Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
ESlateAccessibleBehavior	AccessibleSummaryBehavior
	How to describe this widget when it's being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
EMouseCursor	Cursor
	The cursor to show when the mouse is over the widget.
FText	ToolTipText
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	ToolTipWidget
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	bIsEnabled
	Sets whether this widget can be modified interactively by the user.
ESlateVisibility	Visibility
	The visibility of the widget.
UPanelSlot	Slot
	The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
EFlowDirectionPreference	FlowDirectionPreference
	Allows you to set a new flow direction.
UWidgetNavigation	Navigation
	The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.
bool	bIsVolatile
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
FVector2D	RenderTransformPivot
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
FWidgetTransform	RenderTransform
	The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
EWidgetPixelSnapping	PixelSnapping
	If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation.
EWidgetClipping	Clipping
	Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.
float32	RenderOpacity
	The opacity of the widget.
const FGeometry	CachedGeometry
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
const FGeometry	PaintSpaceGeometry
const UGameInstance	GameInstance
	Gets the game instance associated with this UI.
const UPanelWidget	Parent
	Gets the parent widget.
const FVector2D	DesiredSize
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
const FGeometry	TickSpaceGeometry
bool	IsEnabled
	Gets the current enabled status of the widget.
const ULocalPlayer	OwningLocalPlayer
	Gets the local player associated with this UI.
const APlayerController	OwningPlayer
	Gets the player controller associated with this UI.
float32	RenderTransformAngle
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Stat Entry Widget
bool	m_IsAttributeMaxValueOverridden
	If the max value of the attribute is overridden or not.
UTexture2D	m_Icon
	The icon used to represent the stat.
EStatEntryWidget_StatType	m_StatType
	The type of this stat entry.
const FVector2D	UMGSize
	Implement this to return the actual size of the UMG widget.
FGameplayAttribute	m_Attribute
	The gameplay attribute driving this stat entry.
FGameplayAttribute	m_MaxAttribute
	If set this gameplay attribute will be used as a max value for the driving gameplay attribute.
bool	m_IsNeedAttribute
	If is Need attribute, it will show the applied gameplay effects to the current threshold.
FGameplayTag	m_SkillMasteryTag
	Cached highest mastery tag of the owning player if the represented skill is a mastery.
float32	m_AttributeMaxValue
	Cached max value of the attribute.
FGameplayTag	m_GameplayTag
	The gameplay tag driving this stat entry.
EStatEntryWidget_SkillType	m_SkillType
	The type of skill this entry represents. Binary: The player either has the skill or not. Mastery: The player has a mastery level for the skill.
bool	m_MasteryLevelAsBinarySkill
	If the Mastery levels should be treated as separated binary skills.
EStatEntryWidget_MasteryLevel	m_MasteryLevelToShow
	Set the Mastery Level to be checked.
int	m_MasteryLevel
	Cached mastery level of the skill.
float32	m_AttributeValue
	Cached value of the attribute.
bool	m_IsSelected
	The selection state of the entry widget.
bool	m_ShowIcon
	If the icon is to be shown or not.
FText	m_DisplayName
	Cached display name of the stat.
FText	m_MasteryDescription
	Cached description of the mastery level of the skill.
FText	m_MasteryDisplayName
	Cached display name of the mastery level of the skill.
FText	m_Description
	Cached description of the stat.
bool	m_IsSkillLearned
	If the skill is considered learned by the owning player.
void	OnDeselected ()
	Called when the widget is deselected.
UTexture2D	GetMasteryIcon (int _MasteryLevel) const
	Returns the icon for the given mastery level.
FVector2D	GetUMGSize () const
	Implement this to return the actual size of the UMG widget.
bool	IsAllowedToBeShown () const
	Returns if the stat entry is currently even allowed to be shown.
bool	IsUnseen () const
	Returns if the stat entry is new for the player.
void	ClearAttributeMaxValueOverride ()
	Clear the max value override of the attribute.
void	OnSelected ()
	Called when the widget is selected.
void	OverrideAttributeMaxValue (float32 _Value)
	Override the max value of the attribute.
void	UpdateValue ()
	Called when the widget should update its stat value.

Additional Inherited Members
Public Member Functions inherited from UAlkUserWidget
void	OnControlMappingsRebuilt ()
UPlayerWidget	GetPlayerWidget ()
void	OnUnhovered ()
	Called when the mouse stops hovering over the item.
void	OnInputTypeChanged (ECommonInputType _InputType)
	Called when the input type changes.
void	OnHovered ()
	Called when the mouse starts hovering over the item.
ECommonInputType	GetCurrentInputType () const
	Returns the current input type.
Public Member Functions inherited from UCommonUserWidget
void	SetConsumePointerInput (bool bInConsumePointerInput)
	Sets whether or not this widget will consume ALL pointer input that reaches it.
void	UnregisterScrollRecipientExternal (const UWidget AnalogScrollRecipient)
	Remove a widget from the list of widgets to get scroll events for this input root node.
void	RegisterScrollRecipientExternal (const UWidget AnalogScrollRecipient)
	Add a widget to the list of widgets to get scroll events for this input root node.
Public Member Functions inherited from UUserWidget
void	OnAnimationFinished (const UWidgetAnimation Animation)
	Called when an animation has either played all the way through or is stopped.
void	OnAnimationStarted (const UWidgetAnimation Animation)
	Called when an animation is started.
void	BindToAnimationStarted (UWidgetAnimation Animation, FWidgetAnimationDynamicEvent Delegate=FWidgetAnimationDynamicEvent())
	Bind an animation started delegate.
void	UnbindAllFromAnimationStarted (UWidgetAnimation Animation)
void	BindToAnimationEvent (UWidgetAnimation Animation, FWidgetAnimationDynamicEvent Delegate, EWidgetAnimationEvent AnimationEvent, FName UserTag=NAME_None)
	Allows binding to a specific animation's event.
void	UnbindFromAnimationStarted (UWidgetAnimation Animation, FWidgetAnimationDynamicEvent Delegate=FWidgetAnimationDynamicEvent())
	Unbind an animation started delegate.
void	UnbindAllFromAnimationFinished (UWidgetAnimation Animation)
void	UnbindFromAnimationFinished (UWidgetAnimation Animation, FWidgetAnimationDynamicEvent Delegate=FWidgetAnimationDynamicEvent())
	Unbind an animation finished delegate.
void	BindToAnimationFinished (UWidgetAnimation Animation, FWidgetAnimationDynamicEvent Delegate=FWidgetAnimationDynamicEvent())
	Bind an animation finished delegate.
void	StopAnimationsAndLatentActions ()
	Cancels any pending Delays or timer callbacks for this widget, and stops all active animations on the widget.
void	CancelLatentActions ()
	Cancels any pending Delays or timer callbacks for this widget.
void	OnDragCancelled (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.
void	OnDragDetected (FGeometry MyGeometry, FPointerEvent PointerEvent, UDragDropOperation &Operation)
	Called when Slate detects that a widget started to be dragged.
bool	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.
void	OnDragLeave (FPointerEvent PointerEvent, UDragDropOperation Operation)
	Called during drag and drop when the drag leaves the widget.
void	OnDragEnter (FGeometry MyGeometry, FPointerEvent PointerEvent, UDragDropOperation Operation)
	Called during drag and drop when the drag enters the widget.
bool	OnDragOver (FGeometry MyGeometry, FPointerEvent PointerEvent, UDragDropOperation Operation)
	Called during drag and drop when the the mouse is being dragged over a widget.
void	OnMouseLeave (FPointerEvent MouseEvent)
	The system will use this event to notify a widget that the cursor has left it. This event is NOT bubbled.
void	OnMouseEnter (FGeometry MyGeometry, FPointerEvent MouseEvent)
	The system will use this event to notify a widget that the cursor has entered it. This event is NOT bubbled.
FEventReply	OnPreviewMouseButtonDown (FGeometry MyGeometry, FPointerEvent MouseEvent)
	Just like OnMouseButtonDown, but tunnels instead of bubbling. If this event is handled, OnMouseButtonDown will not be sent.
FEventReply	OnMouseButtonUp (FGeometry MyGeometry, FPointerEvent MouseEvent)
	The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled.
FEventReply	OnMouseWheel (FGeometry MyGeometry, FPointerEvent MouseEvent)
	Called when the mouse wheel is spun. This event is bubbled.
FEventReply	OnMouseMove (FGeometry MyGeometry, FPointerEvent MouseEvent)
	The system calls this method to notify the widget that a mouse moved within it. This event is bubbled.
FEventReply	OnMouseButtonDown (FGeometry MyGeometry, FPointerEvent MouseEvent)
	The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.
FEventReply	OnMouseButtonDoubleClick (FGeometry InMyGeometry, FPointerEvent InMouseEvent)
	Called when a mouse button is double clicked. Override this in derived classes.
void	PlaySound (USoundBase SoundToPlay)
	Plays a sound through the UI.
FEventReply	OnTouchForceChanged (FGeometry MyGeometry, FPointerEvent InTouchEvent)
	Called when a touchpad force has changed (user pressed down harder or let up).
FEventReply	OnTouchGesture (FGeometry MyGeometry, FPointerEvent GestureEvent)
	Called when the user performs a gesture on trackpad. This event is bubbled.
void	OnMouseCaptureLost ()
	Called when mouse capture is lost if it was owned by this widget.
FEventReply	OnTouchEnded (FGeometry MyGeometry, FPointerEvent InTouchEvent)
	Called when a touchpad touch is ended (finger lifted).
FEventReply	OnTouchMoved (FGeometry MyGeometry, FPointerEvent InTouchEvent)
	Called when a touchpad touch is moved (finger moved).
FEventReply	OnTouchStarted (FGeometry MyGeometry, FPointerEvent InTouchEvent)
	Called when a touchpad touch is started (finger down).
FEventReply	OnMotionDetected (FGeometry MyGeometry, FMotionEvent InMotionEvent)
	Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller.
void	Tick (FGeometry MyGeometry, float32 InDeltaTime)
	Ticks this widget. Override in derived classes, but always call the parent implementation.
void	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.
void	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.
void	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.
void	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.
bool	IsInteractable () const
	Gets a value indicating if the widget is interactive.
void	OnPaint (FPaintContext &Context) const
bool	IsAnimationPlaying (const UWidgetAnimation InAnimation) const
	Gets whether an animation is currently playing on this widget.
bool	IsAnimationPlayingForward (const UWidgetAnimation InAnimation)
	returns true if the animation is currently playing forward, false otherwise.
float32	GetAnimationCurrentTime (const UWidgetAnimation InAnimation) const
	Gets the current time of the animation in this widget.
bool	IsAnyAnimationPlaying () const
bool	IsPlayingAnimation () const
	Are we currently playing any animations?
void	FlushAnimations ()
	Flushes all animations on all widgets to guarantee that any queued updates are processed before this call returns.
void	QueuePlayAnimation (UWidgetAnimation InAnimation, float32 StartAtTime=0.000000, int NumLoopsToPlay=1, EUMGSequencePlayMode PlayMode=EUMGSequencePlayMode ::Forward, float32 PlaybackSpeed=1.000000, bool bRestoreState=false)
	Plays an animation in this widget a specified number of times.
UUMGSequencePlayer	PlayAnimationTimeRange (UWidgetAnimation InAnimation, float32 StartAtTime=0.000000, float32 EndAtTime=0.000000, int NumLoopsToPlay=1, EUMGSequencePlayMode PlayMode=EUMGSequencePlayMode ::Forward, float32 PlaybackSpeed=1.000000, bool bRestoreState=false)
	Plays an animation in this widget a specified number of times stopping at a specified time.
void	StopAnimation (const UWidgetAnimation InAnimation)
	Stops an already running animation in this widget.
void	StopAllAnimations ()
	Stop All actively running animations.
void	SetNumLoopsToPlay (const UWidgetAnimation InAnimation, int NumLoopsToPlay)
	Changes the number of loops to play given a playing animation.
void	SetPlaybackSpeed (const UWidgetAnimation InAnimation, float32 PlaybackSpeed=1.000000)
	Changes the playback rate of a playing animation.
float32	PauseAnimation (const UWidgetAnimation InAnimation)
	Pauses an already running animation in this widget.
UUMGSequencePlayer	PlayAnimation (UWidgetAnimation InAnimation, float32 StartAtTime=0.000000, int NumLoopsToPlay=1, EUMGSequencePlayMode PlayMode=EUMGSequencePlayMode ::Forward, float32 PlaybackSpeed=1.000000, bool bRestoreState=false)
	Plays an animation in this widget a specified number of times.
UUMGSequencePlayer	PlayAnimationForward (UWidgetAnimation InAnimation, float32 PlaybackSpeed=1.000000, 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.
UUMGSequencePlayer	PlayAnimationReverse (UWidgetAnimation InAnimation, float32 PlaybackSpeed=1.000000, 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.
void	QueueStopAnimation (const UWidgetAnimation InAnimation)
	Stops an already running animation in this widget.
void	SetAnimationCurrentTime (const UWidgetAnimation InAnimation, float32 InTime)
	Sets the current time of the animation in this widget. Does not change state.
float32	QueuePauseAnimation (const UWidgetAnimation InAnimation)
	Pauses an already running animation in this widget.
void	ReverseAnimation (const UWidgetAnimation InAnimation)
	If an animation is playing, this function will reverse the playback.
void	QueuePlayAnimationForward (UWidgetAnimation InAnimation, float32 PlaybackSpeed=1.000000, 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.
void	QueuePlayAnimationReverse (UWidgetAnimation InAnimation, float32 PlaybackSpeed=1.000000, 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.
void	QueuePlayAnimationTimeRange (UWidgetAnimation InAnimation, float32 StartAtTime=0.000000, float32 EndAtTime=0.000000, int NumLoopsToPlay=1, EUMGSequencePlayMode PlayMode=EUMGSequencePlayMode ::Forward, float32 PlaybackSpeed=1.000000, bool bRestoreState=false)
	Plays an animation in this widget a specified number of times stopping at a specified time.
void	QueueStopAllAnimations ()
	Stop All actively running animations.
UUserWidgetExtension	AddExtension (TSubclassOf< UUserWidgetExtension > InExtensionType)
	Add the extension of the requested type.
void	RemoveExtensions (TSubclassOf< UUserWidgetExtension > InExtensionType)
	Remove all extensions of the requested type.
void	RemoveExtension (UUserWidgetExtension InExtension)
	Remove the extension.
TArray< UUserWidgetExtension >	GetExtensions (TSubclassOf< UUserWidgetExtension > ExtensionType) const
	Find the extensions of the requested type.
UUserWidgetExtension	GetExtension (TSubclassOf< UUserWidgetExtension > ExtensionType) const
	Find the first extension of the requested type.
void	GetSlotNames (TArray< FName > &OutSlotNames) const
bool	SetDesiredFocusWidget (FName WidgetName)
void	GetAllWidgetsOfClass (TSubclassOf< UWidget > WidgetClass, TArray< UWidget > &OutWidgets, bool bIncludeDescendants=false) const
FName	GetDesiredFocusWidgetName () const
UWidget	GetDesiredFocusWidget () const
UWidget	GetContentForSlot (FName SlotName) const
FText	GetPaletteCategory () const
bool	SetDesiredFocusWidget (UWidget Widget)
void	GetAllWidgetsAndDescendants (TArray< UWidget > &OutWidgets) const
UWidget	GetWidgetFromNameRecursive (FName Name) const
UWidget	GetWidgetFromName (FName Name, TSubclassOf< UWidget > WidgetClass) const
void	SetContentForSlot (FName SlotName, UWidget Content)
UWidget	GetWidgetFromName (FName Name) const
void	GetAllWidgets (TArray< UWidget > &Widgets) const
bool	RemoveWidget (UWidget WidgetToRemove)
UWidget	ConstructWidget (UClass WidgetClass, FName WidgetName=NAME_None)
void	SetRootWidget (UWidget NewRootWidget)
UWidget	GetRootWidget () const
void	SetPaletteCategory (FText InPaletteCategory)
const FLinearColor &	GetColorAndOpacity () const
	The color and opacity of this widget. Tints all child widgets.
const FSlateColor &	GetForegroundColor () const
	The foreground color of the widget, this is inherited by sub widgets. Any color property that is marked as inherit will use this color.
const FMargin &	GetPadding () const
	The padding area around the content.
const int &	GetPriority () const
bool	GetbIsFocusable () const
	Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to.
void	SetbIsFocusable (bool Value)
	Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to.
bool	GetbStopAction () const
void	SetPadding (FMargin InPadding)
	Sets the padding for the user widget, putting a larger gap between the widget border and it's root widget.
void	SetColorAndOpacity (FLinearColor InColorAndOpacity)
	Sets the tint of the widget, this affects all child widgets.
void	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.
void	SetInputActionPriority (int NewPriority)
void	SetInputActionBlocking (bool bShouldBlock)
void	SetPriority (int NewPriority)
void	StopListeningForInputAction (FName ActionName, EInputEvent EventType)
	Removes the binding for a particular action's callback.
void	UnregisterInputComponent ()
	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.
bool	IsListeningForInputAction (FName ActionName) const
	Checks if the action has a registered callback with the input component.
void	RegisterInputComponent ()
	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.
FEventReply	OnFocusReceived (FGeometry MyGeometry, FFocusEvent InFocusEvent)
	Called when keyboard focus is given to this widget. This event does not bubble.
void	OnFocusLost (FFocusEvent InFocusEvent)
	Called when this widget loses focus. This event does not bubble.
FEventReply	OnKeyDown (FGeometry MyGeometry, FKeyEvent InKeyEvent)
	Called after a key (keyboard, controller, ...) is pressed when this widget has focus (this event bubbles if not handled).
FEventReply	OnKeyChar (FGeometry MyGeometry, FCharacterEvent InCharacterEvent)
	Called after a character is entered while this widget has focus.
void	StopListeningForAllInputActions ()
	Stops listening to all input actions, and unregisters the input component with the player controller.
void	SetbStopAction (bool bShouldBlock)
FEventReply	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.
void	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.
FEventReply	OnKeyUp (FGeometry MyGeometry, FKeyEvent InKeyEvent)
	Called after a key (keyboard, controller, ...) is released when this widget has focus.
FEventReply	OnAnalogValueChanged (FGeometry MyGeometry, FAnalogInputEvent InAnalogInputEvent)
	Called when an analog value changes on a button that supports analog.
void	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.
void	ListenForInputAction (FName ActionName, EInputEvent EventType, bool bConsume, FOnInputAction Callback=FOnInputAction())
	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.
void	SetOwningPlayer (APlayerController LocalPlayerController)
	Sets the local player associated with this UI via PlayerController reference.
APlayerCameraManager	GetOwningPlayerCameraManager () const
	Gets the player camera manager associated with this UI.
APawn	GetOwningPlayerPawn () const
	Gets the player pawn associated with this UI.
FAnchors	GetAnchorsInViewport () const
void	RemoveFromViewport ()
void	SetAlignmentInViewport (FVector2D Alignment)
void	SetAnchorsInViewport (FAnchors Anchors)
FVector2D	GetAlignmentInViewport () const
bool	AddToPlayerScreen (int 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.
void	SetDesiredSizeInViewport (FVector2D Size)
void	SetPositionInViewport (FVector2D Position, bool bRemoveDPIScale=true)
	Sets the widgets position in the viewport.
void	AddToViewport (int ZOrder=0)
	Adds it to the game's viewport and fills the entire screen, unless SetDesiredSizeInViewport is called to explicitly set the size.
Public Member Functions inherited from UWidget
bool	IsInViewport () const
void	RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	BroadcastFieldValueChanged (FFieldNotificationId FieldId)
void	AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	SetbOverride_Cursor (bool Value)
void	SetToolTipWidget (UWidget Widget)
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	GetbIsEnabled () const
	Sets whether this widget can be modified interactively by the user.
void	SetbIsEnabled (bool bInIsEnabled)
	Sets whether this widget can be modified interactively by the user.
const FWidgetTransform &	GetRenderTransform ()
const FText &	GetToolTipText () const
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	GetToolTipWidget () const
	Tooltip widget to show when the user hovers over the widget with the mouse.
const FVector2D &	GetRenderTransformPivot () const
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
void	GetChildWidgets (TArray< UWidget > &OutChildWidgets) const
void	SetbOverrideAccessibleDefaults (bool Value)
	Override all of the default accessibility behavior and text for this widget.
void	SetbCanChildrenBeAccessible (bool Value)
	Whether or not children of this widget can appear as distinct accessible widgets.
void	SetAccessibleText (FText Value)
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
void	SetAccessibleSummaryText (FText Value)
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
bool	GetbIsVolatile () const
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
void	SetbIsVolatile (bool Value)
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
const EMouseCursor &	GetCursor () const
	The cursor to show when the mouse is over the widget.
const FGeometry &	GetCachedGeometry () const
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
EWidgetClipping	GetClipping () const
	Gets the clipping state of this widget.
FVector2D	GetDesiredSize () const
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
FText	GetAccessibleText () const
	Gets the accessible text from the underlying Slate accessible widget.
FText	GetAccessibleSummaryText () const
	Gets the accessible summary text from the underlying Slate accessible widget.
UGameInstance	GetGameInstance () const
	Gets the game instance associated with this UI.
ULocalPlayer	GetOwningLocalPlayer () const
	Gets the local player associated with this UI.
APlayerController	GetOwningPlayer () const
	Gets the player controller associated with this UI.
const FGeometry &	GetPaintSpaceGeometry () const
UPanelWidget	GetParent () const
	Gets the parent widget.
float32	GetRenderOpacity () const
	Gets the current visibility of the widget.
bool	GetIsEnabled () const
	Gets the current enabled status of the widget.
void	ForceVolatile (bool bForce)
	Sets the forced volatility of the widget.
ESlateVisibility	GetVisibility () const
	Gets the current visibility of the widget.
bool	HasAnyUserFocus () const
	Returns true if this widget is focused by any user.
bool	HasFocusedDescendants () const
	Returns true if any descendant widget is focused by any user.
bool	HasKeyboardFocus () const
	Checks to see if this widget currently has the keyboard focus.
bool	HasMouseCapture () const
	Checks to see if this widget is the current mouse captor.
bool	HasMouseCaptureByUser (int UserIndex, int PointerIndex=- 1) const
	Checks to see if this widget is the current mouse captor.
bool	HasUserFocus (APlayerController PlayerController) const
	Returns true if this widget is focused by a specific user.
bool	HasUserFocusedDescendants (APlayerController PlayerController) const
	Returns true if any descendant widget is focused by a specific user.
void	InvalidateLayoutAndVolatility ()
	Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass.
bool	IsHovered () const
	Returns true if the widget is currently being hovered by a pointer device.
void	ForceLayoutPrepass ()
	Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget. One pre-pass already happens for every widget before Tick occurs. You only need to perform another pre-pass if you are adding child widgets this frame and want them to immediately be visible this frame.
bool	IsRendered () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
bool	IsVisible () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
const FGeometry &	GetTickSpaceGeometry () const
void	SetClipping (EWidgetClipping InClipping)
	Sets the clipping state of this widget.
void	SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Custom Rule.
void	RemoveFromParent ()
	Removes the widget from its parent widget. If this widget was added to the player's screen or the viewport it will also be removed from those containers.
void	ResetCursor ()
	Resets the cursor to use on the widget, removing any customization for it.
void	SetAllNavigationRules (EUINavigationRule Rule, FName WidgetToFocus)
	Sets the widget navigation rules for all directions. This can only be called on widgets that are in a widget tree.
void	SetVisibility (ESlateVisibility InVisibility)
	Sets the visibility of the widget.
void	SetCursor (EMouseCursor InCursor)
	Sets the cursor to show over the widget.
void	SetFocus ()
	Sets the focus to this widget for the owning user.
void	SetIsEnabled (bool bInIsEnabled)
	Sets the current enabled status of the widget.
void	SetKeyboardFocus ()
	Sets the focus to this widget.
void	SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
void	SetNavigationRuleBase (EUINavigation Direction, EUINavigationRule Rule)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for non Explicit, non Custom and non CustomBoundary Rules.
void	SetUserFocus (APlayerController PlayerController)
	Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus()).
void	SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for CustomBoundary Rule.
void	SetNavigationRuleExplicit (EUINavigation Direction, UWidget InWidget)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Explicit Rule.
void	SetRenderOpacity (float32 InOpacity)
	Sets the visibility of the widget.
void	SetToolTip (UWidget Widget)
	Sets a custom widget as the tooltip of the widget.
void	SetToolTipText (FText InToolTipText)
	Sets the tooltip text for the widget.
void	SetRenderTransformAngle (float32 Angle)
void	SetRenderTransformPivot (FVector2D Pivot)
float32	GetRenderTransformAngle () const
void	SetRenderTransform (FWidgetTransform InTransform)
void	SetRenderShear (FVector2D Shear)
void	SetRenderScale (FVector2D Scale)
void	SetRenderTranslation (FVector2D Translation)
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Detailed Description

UStatEntryWidget.

A widget representing a single stat entry.

Member Function Documentation

ClearAttributeMaxValueOverride()

void ClearAttributeMaxValueOverride

(

)

Clear the max value override of the attribute.

GetMasteryIcon()

UTexture2D GetMasteryIcon

(

int

_MasteryLevel

)

const

Returns the icon for the given mastery level.

GetUMGSize()

FVector2D GetUMGSize

(

)

const

Implement this to return the actual size of the UMG widget.

IsAllowedToBeShown()

bool IsAllowedToBeShown

(

)

const

Returns if the stat entry is currently even allowed to be shown.

IsUnseen()

bool IsUnseen

(

)

const

Returns if the stat entry is new for the player.

OnDeselected()

void OnDeselected

(

)

Called when the widget is deselected.

OnSelected()

void OnSelected

(

)

Called when the widget is selected.

OverrideAttributeMaxValue()

void OverrideAttributeMaxValue

(

float32

_Value

)

Override the max value of the attribute.

StaticClass()

UClass StaticClass ( )

static

UpdateValue()

void UpdateValue

(

)

Called when the widget should update its stat value.

Member Data Documentation

m_Attribute

FGameplayAttribute m_Attribute

The gameplay attribute driving this stat entry.

m_AttributeMaxValue

float32 m_AttributeMaxValue

Cached max value of the attribute.

m_AttributeValue

float32 m_AttributeValue

Cached value of the attribute.

m_CanBeConsideredFirst

bool m_CanBeConsideredFirst

If this flag isn't set this entry will never be considered the first entry (e.g. for UStatMainWidget::SelectFirstEntry()).

m_ChangeTextForSelectedValues

TMap<float32,FText> m_ChangeTextForSelectedValues

For each value it will change the name to the selected text.

m_Description

FText m_Description

Cached description of the stat.

m_DisplayName

FText m_DisplayName

Cached display name of the stat.

m_FixedWidth

float m_FixedWidth

The fixed width to be used for the entry.

m_GameplayTag

FGameplayTag m_GameplayTag

The gameplay tag driving this stat entry.

m_HideWhenIsEqualToAny

TArray<float32> m_HideWhenIsEqualToAny

If set the entry will be hidden when its value is zero.

m_HideWhenMissing

bool m_HideWhenMissing

If the entry should be hidden when no mastery level is set.

m_HideWhenUntrained

bool m_HideWhenUntrained

If the entry should be hidden when the mastery level is set to "untrained".

m_Icon

UTexture2D m_Icon

The icon used to represent the stat.

m_IsAttributeMaxValueOverridden

bool m_IsAttributeMaxValueOverridden

If the max value of the attribute is overridden or not.

m_IsNeedAttribute

bool m_IsNeedAttribute

If is Need attribute, it will show the applied gameplay effects to the current threshold.

m_IsSelected

bool m_IsSelected

The selection state of the entry widget.

m_IsSkillLearned

bool m_IsSkillLearned

If the skill is considered learned by the owning player.

m_IsSurvivalModeExclusive

bool m_IsSurvivalModeExclusive

If set the stat will only be shown in survival mode.

m_ItemTooltipInfo

FItemTooltipInfo m_ItemTooltipInfo

Information of the attribute modifications for external attributes in relation with this attribute.

m_MasteryDescription

FText m_MasteryDescription

Cached description of the mastery level of the skill.

m_MasteryDisplayName

FText m_MasteryDisplayName

Cached display name of the mastery level of the skill.

m_MasteryIcons

TMap<int,UTexture2D> m_MasteryIcons

Icons for the different mastery levels. Can be set in the class defaults and overridden in instances.

m_MasteryLevel

int m_MasteryLevel

Cached mastery level of the skill.

m_MasteryLevelAsBinarySkill

bool m_MasteryLevelAsBinarySkill

If the Mastery levels should be treated as separated binary skills.

m_MasteryLevelToShow

EStatEntryWidget_MasteryLevel m_MasteryLevelToShow

Set the Mastery Level to be checked.

m_MaxAttribute

FGameplayAttribute m_MaxAttribute

If set this gameplay attribute will be used as a max value for the driving gameplay attribute.

m_ShowIcon

bool m_ShowIcon

If the icon is to be shown or not.

m_SkillMasteryTag

FGameplayTag m_SkillMasteryTag

Cached highest mastery tag of the owning player if the represented skill is a mastery.

m_SkillType

EStatEntryWidget_SkillType m_SkillType

The type of skill this entry represents. Binary: The player either has the skill or not. Mastery: The player has a mastery level for the skill.

m_StatType

EStatEntryWidget_StatType m_StatType

The type of this stat entry.

m_UseFixedWidth

bool m_UseFixedWidth

If the fixed width should be used for the entry.

UMGSize

const FVector2D UMGSize

Implement this to return the actual size of the UMG widget.