tModLoader v2024.03
A mod to make and play Terraria mods
UIButton< T > Class Template Reference

A text panel that supports hover and click sounds, hover colors, and alternate colors. More...

Inherits UIAutoScaleTextTextPanel< T >.

Public Member Functions

 UIButton (T text, float textScaleMax=1, bool large=false)
 
override void Draw (SpriteBatch spriteBatch)
 
override void LeftClick (UIMouseEvent evt)
 
override void MouseOver (UIMouseEvent evt)
 
override void OnActivate ()
 
override void Recalculate ()
 
- Public Member Functions inherited from UIAutoScaleTextTextPanel< T >
 UIAutoScaleTextTextPanel (T text, float textScaleMax=1f, bool large=false)
 
override void Recalculate ()
 
void SetText (T text)
 
virtual void SetText (T text, float textScaleMax, bool large)
 
- Public Member Functions inherited from UIPanel
 UIPanel (Asset< Texture2D > customBackground, Asset< Texture2D > customborder, int customCornerSize=12, int customBarSize=4)
 
- Public Member Functions inherited from UIElement
void Activate ()
 
void Append (UIElement element)
 
virtual int CompareTo (object obj)
 
virtual bool ContainsPoint (Vector2 point)
 
void CopyStyle (UIElement element)
 
void Deactivate ()
 
virtual void Draw (SpriteBatch spriteBatch)
 
void DrawDebugHitbox (BasicDebugDrawer drawer, float colorIntensity=0f)
 
delegate void ElementEvent (UIElement affectedElement)
 
virtual void ExecuteRecursively (UIElementAction action)
 
Rectangle GetClippingRectangle (SpriteBatch spriteBatch)
 
CalculatedStyle GetDimensions ()
 
UIElement GetElementAt (Vector2 point)
 
CalculatedStyle GetInnerDimensions ()
 
CalculatedStyle GetOuterDimensions ()
 
bool GetSnapPoint (out SnapPoint point)
 
virtual List< SnapPointGetSnapPoints ()
 
virtual Rectangle GetViewCullingArea ()
 
bool HasChild (UIElement child)
 
void Initialize ()
 
virtual void LeftClick (UIMouseEvent evt)
 
virtual void LeftDoubleClick (UIMouseEvent evt)
 
virtual void LeftMouseDown (UIMouseEvent evt)
 
virtual void LeftMouseUp (UIMouseEvent evt)
 
virtual void MiddleClick (UIMouseEvent evt)
 
virtual void MiddleDoubleClick (UIMouseEvent evt)
 
virtual void MiddleMouseDown (UIMouseEvent evt)
 
virtual void MiddleMouseUp (UIMouseEvent evt)
 
delegate void MouseEvent (UIMouseEvent evt, UIElement listeningElement)
 
virtual void MouseOut (UIMouseEvent evt)
 
virtual void MouseOver (UIMouseEvent evt)
 
virtual void OnActivate ()
 
virtual void OnDeactivate ()
 
virtual void OnInitialize ()
 
virtual void Recalculate ()
 
virtual void RecalculateChildren ()
 
void Remove ()
 
void RemoveAllChildren ()
 
void RemoveChild (UIElement child)
 
virtual void RightClick (UIMouseEvent evt)
 
virtual void RightDoubleClick (UIMouseEvent evt)
 
virtual void RightMouseDown (UIMouseEvent evt)
 
virtual void RightMouseUp (UIMouseEvent evt)
 
virtual void ScrollWheel (UIScrollWheelEvent evt)
 
delegate void ScrollWheelEvent (UIScrollWheelEvent evt, UIElement listeningElement)
 
void SetPadding (float pixels)
 
void SetSnapPoint (string name, int id, Vector2? anchor=null, Vector2? offset=null)
 
delegate void UIElementAction (UIElement element)
 
virtual void Update (GameTime gameTime)
 
virtual void XButton1Click (UIMouseEvent evt)
 
virtual void XButton1DoubleClick (UIMouseEvent evt)
 
virtual void XButton1MouseDown (UIMouseEvent evt)
 
virtual void XButton1MouseUp (UIMouseEvent evt)
 
virtual void XButton2Click (UIMouseEvent evt)
 
virtual void XButton2DoubleClick (UIMouseEvent evt)
 
virtual void XButton2MouseDown (UIMouseEvent evt)
 
virtual void XButton2MouseUp (UIMouseEvent evt)
 

Public Attributes

Color? AltBorderColor = null
 
Color? AltHoverBorderColor = null
 
Color? AltHoverPanelColor = null
 
AltHoverText = default
 
Color? AltPanelColor = null
 
SoundStyleClickSound = null
 
Color HoverBorderColor = UICommon.DefaultUIBorderMouseOver
 
Color HoverPanelColor = UICommon.DefaultUIBlue
 
SoundStyleHoverSound = null
 
HoverText = default
 
bool TooltipText = false
 
Func< bool > UseAltColors = () => false
 
- Public Attributes inherited from UIAutoScaleTextTextPanel< T >
bool ScalePanel = false
 
float TextOriginX = 0.5f
 
float TextOriginY = 0.5f
 
bool UseInnerDimensions = false
 
- Public Attributes inherited from UIPanel
Color BackgroundColor = new Color(63, 82, 151) * 0.7f
 
Color BorderColor = Color.Black
 
- Public Attributes inherited from UIElement
float HAlign
 
StyleDimension Height
 
bool IgnoresMouseInteraction
 
StyleDimension Left
 
float MarginBottom
 
float MarginLeft
 
float MarginRight
 
float MarginTop
 
StyleDimension MaxHeight = StyleDimension.Fill
 
StyleDimension MaxWidth = StyleDimension.Fill
 
StyleDimension MinHeight = StyleDimension.Empty
 
StyleDimension MinWidth = StyleDimension.Empty
 
bool OverflowHidden
 
SamplerState OverrideSamplerState
 
float PaddingBottom
 
float PaddingLeft
 
float PaddingRight
 
float PaddingTop
 
StyleDimension Top
 
bool UseImmediateMode
 
float VAlign
 
StyleDimension Width
 

Protected Member Functions

void SetPanelColors ()
 
- Protected Member Functions inherited from UIAutoScaleTextTextPanel< T >
override void DrawSelf (SpriteBatch spriteBatch)
 
override void DrawSelf (SpriteBatch spriteBatch)
 
- Protected Member Functions inherited from UIElement
virtual void DrawChildren (SpriteBatch spriteBatch)
 
virtual void DrawSelf (SpriteBatch spriteBatch)
 

Additional Inherited Members

- Protected Attributes inherited from UIElement
readonly List< UIElementElements = new List<UIElement>()
 
- Properties inherited from UIAutoScaleTextTextPanel< T >
bool DrawPanel = true [get, set]
 
bool IsLarge [get]
 
string Text [get]
 
Color TextColor = Color.White [get, set]
 
float TextScale = 1f [get, set]
 
float TextScaleMax = 1f [get, set]
 
Vector2 TextSize = Vector2.Zero [get]
 
- Properties inherited from UIElement
IEnumerable< UIElementChildren [get]
 
bool IsMouseHovering [get]
 
UIElement Parent [get]
 
int UniqueId [get]
 
- Events inherited from UIElement
MouseEvent OnLeftClick
 
MouseEvent OnLeftDoubleClick
 
MouseEvent OnLeftMouseDown
 
MouseEvent OnLeftMouseUp
 
MouseEvent OnMiddleClick
 
MouseEvent OnMiddleDoubleClick
 
MouseEvent OnMiddleMouseDown
 
MouseEvent OnMiddleMouseUp
 
MouseEvent OnMouseOut
 
MouseEvent OnMouseOver
 
MouseEvent OnRightClick
 
MouseEvent OnRightDoubleClick
 
MouseEvent OnRightMouseDown
 
MouseEvent OnRightMouseUp
 
ScrollWheelEvent OnScrollWheel
 
ElementEvent OnUpdate
 
MouseEvent OnXButton1Click
 
MouseEvent OnXButton1DoubleClick
 
MouseEvent OnXButton1MouseDown
 
MouseEvent OnXButton1MouseUp
 
MouseEvent OnXButton2Click
 
MouseEvent OnXButton2DoubleClick
 
MouseEvent OnXButton2MouseDown
 
MouseEvent OnXButton2MouseUp
 

Detailed Description

A text panel that supports hover and click sounds, hover colors, and alternate colors.

Template Parameters
T

Member Function Documentation

◆ Draw()

override void UIButton< T >.Draw ( SpriteBatch  spriteBatch)
virtual

Reimplemented from UIElement.

◆ LeftClick()

override void UIButton< T >.LeftClick ( UIMouseEvent  evt)
virtual

Reimplemented from UIElement.

◆ MouseOver()

override void UIButton< T >.MouseOver ( UIMouseEvent  evt)
virtual

Reimplemented from UIElement.

◆ OnActivate()

override void UIButton< T >.OnActivate ( )
virtual

Reimplemented from UIElement.

◆ Recalculate()

override void UIButton< T >.Recalculate ( )
virtual

Reimplemented from UIAutoScaleTextTextPanel< T >.