VoiceComms Class Reference

Voice Communications widget, Displays data for voice channel management, and voice transcriptions, and allows the user to join and leave voice channels. More...

Inheritance diagram for VoiceComms:

Public Member Functions
override void	SetWidgetContainer (WidgetContainer widgetContainer)
	Sets the widget container for the widget, updating the size and position of the widget based on the container.
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 ()
Protected Member Functions inherited from FMAR.UI.Widgets.Widget
virtual void	Start ()
virtual void	Update ()
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

Voice Communications widget, Displays data for voice channel management, and voice transcriptions, and allows the user to join and leave voice channels.

Member Function Documentation

Awake()

override void VoiceComms.Awake ( )

inlineprotectedvirtual

Reimplemented from FMAR.UI.Widgets.Widget.

SetWidgetContainer()

override void VoiceComms.SetWidgetContainer ( WidgetContainer widgetContainer )

inlinevirtual

Sets the widget container for the widget, updating the size and position of the widget based on the container.

Parameters

widgetContainer

The widget container to use for the widget.

Reimplemented from FMAR.UI.Widgets.Widget.

---

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

• /github/workspace/Packages/FMAR/UI/WidgetVoiceComms/Runtime/Scripts/VoiceComms.cs