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

Inherits UIElement, and IGroupOptionButton.

Public Member Functions

 GroupOptionButton (T option, LocalizedText title, LocalizedText description, Color textColor, string iconTexturePath, float textSize=1f, float titleAlignmentX=0.5f, float titleWidthReduction=10f)
override void LeftMouseDown (UIMouseEvent evt)
override void MouseOut (UIMouseEvent evt)
override void MouseOver (UIMouseEvent evt)
void SetBorderColor (Color color)
void SetColor (Color color, float opacity)
void SetColorsBasedOnSelectionState (Color pickedColor, Color unpickedColor, float opacityPicked, float opacityNotPicked)
void SetCurrentOption (T option)
void SetText (LocalizedText text, float textSize, Color color)
- 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)
void SetBorderColor (Color color)
void SetColorsBasedOnSelectionState (Color pickedColor, Color unpickedColor, float opacityPicked, float opacityNotPicked)

Public Attributes

readonly LocalizedText Description
float FadeFromBlack = 1f
bool ShowHighlightWhenSelected = true
- 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

override void DrawSelf (SpriteBatch spriteBatch)
- Protected Member Functions inherited from UIElement
virtual void DrawChildren (SpriteBatch spriteBatch)
virtual void DrawSelf (SpriteBatch spriteBatch)


bool IsSelected [get]
OptionValue [get]
- Properties inherited from UIElement
IEnumerable< UIElementChildren [get]
bool IsMouseHovering [get]
UIElement Parent [get]
int UniqueId [get]

Additional Inherited Members

- Protected Attributes inherited from UIElement
readonly List< UIElementElements = new List<UIElement>()
- 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

Member Function Documentation

◆ DrawSelf()

override void GroupOptionButton< T >.DrawSelf ( SpriteBatch  spriteBatch)

Reimplemented from UIElement.

◆ LeftMouseDown()

override void GroupOptionButton< T >.LeftMouseDown ( UIMouseEvent  evt)

Reimplemented from UIElement.

◆ MouseOut()

override void GroupOptionButton< T >.MouseOut ( UIMouseEvent  evt)

Reimplemented from UIElement.

◆ MouseOver()

override void GroupOptionButton< T >.MouseOver ( UIMouseEvent  evt)

Reimplemented from UIElement.

◆ SetBorderColor()

void GroupOptionButton< T >.SetBorderColor ( Color  color)

Implements IGroupOptionButton.

◆ SetColorsBasedOnSelectionState()

void GroupOptionButton< T >.SetColorsBasedOnSelectionState ( Color  pickedColor,
Color  unpickedColor,
float  opacityPicked,
float  opacityNotPicked 

Implements IGroupOptionButton.