StatsWidget Class Reference

FMAR widget that displays debug-stats, such as FPS. More...

Inheritance diagram for StatsWidget:

Public Member Functions
override void	SetWidgetContainer (WidgetContainer widgetContainer)
	Called when the widget is moved into a new container. Handles widget resizing and repositioning. Can be overridden to provide additional functionality.
Public Member Functions inherited from FMAR.UI.Widgets.Widget
void	SetBorderPositions (Vector2 size)
	Sets the border positions.
void	UpdateBorderTransparency ()
	Updates the border transparency based on the widget container's border transparency.
void	DetachFromContainer ()
	Detaches the widget from the widget container.
void	PlaySound (AudioClip clip)
	Plays a sound localized to the widget.
bool	TryMove ()
	Tries to move the widget out of the widget container.
void	SetBackgroundEnabled (bool enabled)
	Sets the background's enabled state.

Protected Member Functions
override void	Awake ()
override void	Update ()
Protected Member Functions inherited from FMAR.UI.Widgets.Widget
virtual void	Start ()
void	CreateBorder (Vector2 size)
	Creates a border for the widget, around the edges.

Additional Inherited Members
Public Attributes inherited from FMAR.UI.Widgets.Widget
Sprite	widgetIcon
Protected Attributes inherited from FMAR.UI.Widgets.Widget
Image	bg
RectTransform	rt
AudioSource	aud
Properties inherited from FMAR.UI.Widgets.Widget
WidgetContainer	WidgetContainer [get]
Vector2	PreferredFloatingDisplaySize [get]
Color	BackgroundBaseColor [get]
RectTransform	Rt [get]
bool	Locked [get]

Detailed Description

FMAR widget that displays debug-stats, such as FPS.

Member Function Documentation

Awake()

override void StatsWidget.Awake ( )

inlineprotectedvirtual

Reimplemented from FMAR.UI.Widgets.Widget.

SetWidgetContainer()

override void StatsWidget.SetWidgetContainer ( WidgetContainer widgetContainer )

inlinevirtual

Called when the widget is moved into a new container. Handles widget resizing and repositioning. Can be overridden to provide additional functionality.

Parameters

widgetContainer

Reimplemented from FMAR.UI.Widgets.Widget.

Update()

override void StatsWidget.Update ( )

inlineprotectedvirtual

Reimplemented from FMAR.UI.Widgets.Widget.

---

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

• /github/workspace/Packages/FMAR/UI/WidgetStats/Runtime/Scripts/StatsWidget.cs