Terraria.GameContent.UI.Elements.UIScrollbar Class Reference

Public Member Functions
void	GoToBottom ()
	UIScrollbar ()
void	SetView (float viewSize, float maxViewSize)
float	GetValue ()
override void	LeftMouseDown (UIMouseEvent evt)
override void	LeftMouseUp (UIMouseEvent evt)
delegate void	MouseEvent (UIMouseEvent evt, UIElement listeningElement)
delegate void	ScrollWheelEvent (UIScrollWheelEvent evt, UIElement listeningElement)
delegate void	ElementEvent (UIElement affectedElement)
delegate void	UIElementAction (UIElement element)
void	SetSnapPoint (string name, int id, Vector2? anchor=null, Vector2? offset=null)
bool	GetSnapPoint (out SnapPoint point)
virtual void	ExecuteRecursively (UIElementAction action)
void	Append (UIElement element)
void	Remove ()
void	RemoveChild (UIElement child)
void	RemoveAllChildren ()
virtual void	Draw (SpriteBatch spriteBatch)
virtual void	Update (GameTime gameTime)
Rectangle	GetClippingRectangle (SpriteBatch spriteBatch)
virtual List< SnapPoint >	GetSnapPoints ()
virtual void	Recalculate ()
UIElement	GetElementAt (Vector2 point)
virtual bool	ContainsPoint (Vector2 point)
virtual Rectangle	GetViewCullingArea ()
void	SetPadding (float pixels)
virtual void	RecalculateChildren ()
CalculatedStyle	GetInnerDimensions ()
CalculatedStyle	GetDimensions ()
CalculatedStyle	GetOuterDimensions ()
void	CopyStyle (UIElement element)
virtual void	LeftClick (UIMouseEvent evt)
virtual void	LeftDoubleClick (UIMouseEvent evt)
virtual void	RightMouseDown (UIMouseEvent evt)
virtual void	RightMouseUp (UIMouseEvent evt)
virtual void	RightClick (UIMouseEvent evt)
virtual void	RightDoubleClick (UIMouseEvent evt)
virtual void	MouseOver (UIMouseEvent evt)
virtual void	MouseOut (UIMouseEvent evt)
virtual void	ScrollWheel (UIScrollWheelEvent evt)
void	Activate ()
virtual void	OnActivate ()
void	DrawDebugHitbox (BasicDebugDrawer drawer, float colorIntensity=0f)
void	Deactivate ()
virtual void	OnDeactivate ()
void	Initialize ()
virtual void	OnInitialize ()
virtual int	CompareTo (object obj)
int	CompareTo (object? obj)
int	CompareTo (T? other)

Public Attributes
StyleDimension	Top
StyleDimension	Left
StyleDimension	Width
StyleDimension	Height
StyleDimension	MaxWidth = StyleDimension.Fill
StyleDimension	MaxHeight = StyleDimension.Fill
StyleDimension	MinWidth = StyleDimension.Empty
StyleDimension	MinHeight = StyleDimension.Empty
bool	IgnoresMouseInteraction
bool	OverflowHidden
SamplerState	OverrideSamplerState
float	PaddingTop
float	PaddingLeft
float	PaddingRight
float	PaddingBottom
float	MarginTop
float	MarginLeft
float	MarginRight
float	MarginBottom
float	HAlign
float	VAlign
bool	UseImmediateMode

Protected Member Functions
override void	DrawSelf (SpriteBatch spriteBatch)
virtual void	DrawChildren (SpriteBatch spriteBatch)

Protected Attributes
readonly List< UIElement >	Elements = new List<UIElement>()

Properties
float	ViewPosition [get, set]
bool	CanScroll [get]
UIElement	Parent [get, private set]
int	UniqueId [get, private set]
IEnumerable< UIElement >	Children [get]
bool	IsMouseHovering [get, private set]

Events
MouseEvent	OnLeftMouseDown
MouseEvent	OnLeftMouseUp
MouseEvent	OnLeftClick
MouseEvent	OnLeftDoubleClick
MouseEvent	OnRightMouseDown
MouseEvent	OnRightMouseUp
MouseEvent	OnRightClick
MouseEvent	OnRightDoubleClick
MouseEvent	OnMouseOver
MouseEvent	OnMouseOut
ScrollWheelEvent	OnScrollWheel
ElementEvent	OnUpdate

Private Member Functions
Rectangle	GetHandleRectangle ()
void	DrawBar (SpriteBatch spriteBatch, Texture2D texture, Rectangle dimensions, Color color)
CalculatedStyle	GetDimensionsBasedOnParentDimensions (CalculatedStyle parentDimensions)

Private Attributes
float	_viewPosition
float	_viewSize = 1f
float	_maxViewSize = 20f
bool	_isDragging
bool	_isHoveringOverHandle
float	_dragYOffset
Asset< Texture2D >	_texture
Asset< Texture2D >	_innerTexture
bool	_isInitialized
CalculatedStyle	_innerDimensions
CalculatedStyle	_dimensions
CalculatedStyle	_outerDimensions
SnapPoint	_snapPoint

Static Private Attributes
static readonly RasterizerState	OverflowHiddenRasterizerState
static int	_idCounter = 0

Detailed Description

Definition at line 9 of file UIScrollbar.cs.

---

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

• source/Terraria.GameContent.UI.Elements/UIScrollbar.cs