FMAR.UI.Widgets.WidgetManager Class Reference

The WidgetManager is responsible for spawning and managing the "grid" of widgets, which is not currently in use in favor of the tabbed display system. More...

Inheritance diagram for FMAR.UI.Widgets.WidgetManager:

Classes
class	BuddyHudWidgetPrefab
	A prefab for a widget. Allows widgets to be assigned to a default slot. More...
class	BuddyHudWidgetUserConfigFile
	Represents a user's configuration for the widget system, saves the widget layout so the user doesn't have to set it every time. More...
class	BuddyHudWidgetUserConfigItem
	Describes the slot a widget is in, in a serializable format. More...
class	WidgetInContainer
	Represents a spawned widget in a container. More...

Public Member Functions
GridSlot	GetSlotByInstanceID (int instanceID)
	Gets a grid slot by its instance ID.

Static Public Member Functions
static void	CreateFloatingDisplay (Widget widget, Vector3 position, Quaternion rotation)
	Creates a floating display for a widget, allowing it to be moved outside of the grid.
static void	RemoveFloatingDisplay (FloatingDisplay fd)
	Destroys the floating display and removes it from the list of floating displays.
static void	CreateCubeWidget (Widget widget)
	Creates a cube widget, which is a widget that is spawned in a grid slot.
static void	RecallAllFloatingDisplays ()
	Recalls all floating displays, returning them to their preferred grid slots.
static void	SaveWidgetLayout ()
	Saves the widget layout to the user's config file.

Public Attributes
List< BuddyHudWidgetPrefab >	widgetPrefabs
	The prefabs for widgets to spawn.
List< WidgetInContainer >	widgetsInContainers

Properties
static WidgetManager	Instance [get]
List< FloatingDisplay >	FloatingDisplays [get]
Material	UnlitTransparentMaterial [get]
static AudioClip	LockUnlockSfx [get]
static AudioClip	LockedResistSfx [get]

Detailed Description

The WidgetManager is responsible for spawning and managing the "grid" of widgets, which is not currently in use in favor of the tabbed display system.

Member Function Documentation

CreateCubeWidget()

static void FMAR.UI.Widgets.WidgetManager.CreateCubeWidget ( Widget widget )

inlinestatic

Creates a cube widget, which is a widget that is spawned in a grid slot.

Parameters

widget

The widget to create.

CreateFloatingDisplay()

static void FMAR.UI.Widgets.WidgetManager.CreateFloatingDisplay ( Widget widget, Vector3 position, Quaternion rotation )

inlinestatic

Creates a floating display for a widget, allowing it to be moved outside of the grid.

Parameters

widget	The widget to create a floating display for.
position	The position to spawn the floating display at.
rotation	The rotation to spawn the floating display with.

GetSlotByInstanceID()

GridSlot FMAR.UI.Widgets.WidgetManager.GetSlotByInstanceID ( int instanceID )

inline

Gets a grid slot by its instance ID.

Parameters

instanceID

The instance ID of the grid slot.

Returns

The grid slot with the matching instance ID.

RecallAllFloatingDisplays()

static void FMAR.UI.Widgets.WidgetManager.RecallAllFloatingDisplays ( )

inlinestatic

Recalls all floating displays, returning them to their preferred grid slots.

RemoveFloatingDisplay()

static void FMAR.UI.Widgets.WidgetManager.RemoveFloatingDisplay ( FloatingDisplay fd )

inlinestatic

Destroys the floating display and removes it from the list of floating displays.

Parameters

fd	The floating display to remove.

SaveWidgetLayout()

static void FMAR.UI.Widgets.WidgetManager.SaveWidgetLayout ( )

inlinestatic

Saves the widget layout to the user's config file.

Member Data Documentation

widgetPrefabs

List<BuddyHudWidgetPrefab> FMAR.UI.Widgets.WidgetManager.widgetPrefabs

The prefabs for widgets to spawn.

widgetsInContainers

List<WidgetInContainer> FMAR.UI.Widgets.WidgetManager.widgetsInContainers

Property Documentation

FloatingDisplays

List<FloatingDisplay> FMAR.UI.Widgets.WidgetManager.FloatingDisplays

get

Instance

WidgetManager FMAR.UI.Widgets.WidgetManager.Instance

staticget

LockedResistSfx

AudioClip FMAR.UI.Widgets.WidgetManager.LockedResistSfx

staticget

LockUnlockSfx

AudioClip FMAR.UI.Widgets.WidgetManager.LockUnlockSfx

staticget

UnlitTransparentMaterial

Material FMAR.UI.Widgets.WidgetManager.UnlitTransparentMaterial

get

---

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

• /github/workspace/Packages/FMAR/UI/Widgets/Runtime/Scripts/WidgetManager.cs