Fire Controls widget, allows the user to toggle fire effects, adjust the darkness of the scene, and adjust the fire and smoke amounts. More...

Inheritance diagram for FireControlsWidget:

Public Member Functions
override void	SetWidgetContainer (WidgetContainer widgetContainer)
	Sets the widget container and updates the inspector visibility based on the container's scale factor.

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 ()
	Initializes the Fire Controls widget.

override void	Start ()
	Starts the Fire Controls widget and sets up event listeners.

Protected Member Functions inherited from FMAR.UI.Widgets.Widget
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

Fire Controls widget, allows the user to toggle fire effects, adjust the darkness of the scene, and adjust the fire and smoke amounts.

Member Function Documentation

override void FireControlsWidget.Awake ( )

inlineprotectedvirtual

Initializes the Fire Controls widget.

override void FireControlsWidget.SetWidgetContainer ( WidgetContainer widgetContainer )

inlinevirtual

Sets the widget container and updates the inspector visibility based on the container's scale factor.

Parameters

widgetContainer The widget container.

override void FireControlsWidget.Start ( )

inlineprotectedvirtual

Starts the Fire Controls widget and sets up event listeners.

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

/github/workspace/Packages/FMAR/UI/WidgetFireControls/Runtime/Scripts/FireControlsWidget.cs