Component:AvatarLiveIndicator: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
add info that was missing
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarLiveIndicatorComponent.png
|Image=AvatarLiveIndicatorComponent.png
Line 9: Line 8:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''AvatarLiveIndicator''' component is used to show or enable a [[Slot|slot]] (usually a visual) to let other [[User|users]] know that you are live. This activates from the [[Camera#Photo_Controls|streaming camera control panel]], specifically the "Mirror to display" button.


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{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
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== 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).


<!--T:5-->
<!--T:5-->
Line 28: Line 27:
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar Live Indicator]]
[[Category:Components{{#translation:}}|Avatar Live Indicator]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System:Nameplate{{#translation:}}|Avatar Live Indicator]]
[[Category:Components:Users:Common Avatar System:Nameplate{{#translation:}}|Avatar Live Indicator]]

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