FMAR.UI.Widgets.Notifications.Notifications Class Reference

Notifications widget, displays notifications from various sources and allows the user to interact with them. More...

Inheritance diagram for FMAR.UI.Widgets.Notifications.Notifications:

Public Member Functions
override void	SetWidgetContainer (WidgetContainer widgetContainer)
	Sets the widget container and updates the UI activation based on the container's scale factor.
void	MarkSeen (int index)
	Marks a notification as seen.
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 notifications widget.
override void	Update ()
	Updates the notifications widget each frame, handles debug input.
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

Notifications widget, displays notifications from various sources and allows the user to interact with them.

Member Function Documentation

Awake()

override void FMAR.UI.Widgets.Notifications.Notifications.Awake ( )

inlineprotectedvirtual

Initializes the notifications widget.

Reimplemented from FMAR.UI.Widgets.Widget.

MarkSeen()

void FMAR.UI.Widgets.Notifications.Notifications.MarkSeen ( int index )

inline

Marks a notification as seen.

Parameters

index

The index of the notification in the list.

SetWidgetContainer()

override void FMAR.UI.Widgets.Notifications.Notifications.SetWidgetContainer ( WidgetContainer widgetContainer )

inlinevirtual

Sets the widget container and updates the UI activation based on the container's scale factor.

Parameters

widgetContainer

The widget container.

Reimplemented from FMAR.UI.Widgets.Widget.

Update()

override void FMAR.UI.Widgets.Notifications.Notifications.Update ( )

inlineprotectedvirtual

Updates the notifications widget each frame, handles debug input.

Reimplemented from FMAR.UI.Widgets.Widget.

---

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

• /github/workspace/Packages/FMAR/UI/WidgetNotifications/Runtime/Scripts/Notifications.cs