Component:AvatarLiveIndicator: Difference between revisions

Latest revision as of 16:36, 15 October 2024

Component image

**AvatarLiveIndicator** component as seen in the Scene Inspector

The AvatarLiveIndicator component is used to show or enable a slot (usually a visual) to let other users know that you are live. This activates from the streaming camera control panel, specifically the "Mirror to display" button.

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled.
`IsLive`	raw output of Bool	Whether `_activeUser` is streaming or not.
`_activeUser`	User	The user that this component is monitoring

Usage

Usually this is used with the Camera, especially when streaming. This is also already setup along with the Nameplate and positioned on it (however, this can be customizable).

Examples

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AvatarLiveIndicatorComponent.png
@@ Line 13: / Line 12: @@
 <!--T:3-->
 {{Table ComponentFields
-|IsLive|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv0=true|
+|IsLive|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv0=true| Whether <code>_activeUser</code> is streaming or not.
-|_activeUser|User|
+|_activeUser|User| The user that this component is monitoring
 }}
@@ Line 28: / Line 27: @@
 </translate>
 [[Category:Components{{#translation:}}|Avatar Live Indicator]]
-[[Category:ComponentStubs]]
 [[Category:Components:Users:Common Avatar System:Nameplate{{#translation:}}|Avatar Live Indicator]]