Component:UserJoinAudioIndicator: Difference between revisions

Latest revision as of 17:54, 6 February 2025

Component image

**User Join Audio Indicator** component as seen in the Scene Inspector

The UserJoinAudioIndicator component plays an audio clip when a user joins and leaves a session.

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
`JoinedClips`	list of AssetRef`1<AudioClip>	A list of random audio clips to choose from when a user joins the session. Each one will have a different weight.
`LeftClips`	list of AssetRef`1<AudioClip>	A list of random audio clips to choose from when a user leaves the session. Each one will have a different weight.
`Spatialize`	Bool	Whether to play the sounds from the slot this component is on or globally.
`Volume`	Float	How loud the audio clips should be by default.

Usage

Attach to a slot and provide some audio clips to play. The next time a user joins or leaves the session, a clip from the corresponding list will play.

Examples

Can be used for world join notifiers or for an elevator ding when a user arrives.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=UserJoinAudioIndicatorComponent.png
-|Name=UserJoinAudioIndicator
+|Name=User Join Audio Indicator
 }}
 <!--T:2-->
-The UserJoinAudioIndicator plays an audio clip when a user joins and leaves a session.
+The '''UserJoinAudioIndicator''' component plays an audio clip when a user joins and leaves a session.
 <!--T:3-->
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|JoinedClips|{{RootFieldType|SyncList`1|[[Type:AssetRef`1|AssetRef`1]]&lt;[[Type:AudioClip|AudioClip]]&gt;}}|TypeAdv0=true|
+|JoinedClips|{{RootFieldType|SyncList`1|[[Type:AssetRef`1|AssetRef`1]]&lt;[[Type:AudioClip|AudioClip]]&gt;}}|TypeAdv0=true| A list of random audio clips to choose from when a user joins the session. Each one will have a different weight.
-|LeftClips|{{RootFieldType|SyncList`1|[[Type:AssetRef`1|AssetRef`1]]&lt;[[Type:AudioClip|AudioClip]]&gt;}}|TypeAdv1=true|
+|LeftClips|{{RootFieldType|SyncList`1|[[Type:AssetRef`1|AssetRef`1]]&lt;[[Type:AudioClip|AudioClip]]&gt;}}|TypeAdv1=true| A list of random audio clips to choose from when a user leaves the session. Each one will have a different weight.
-|Spatialize|Bool|
+|Spatialize|Bool| Whether to play the sounds from the slot this component is on or globally.
-|Volume|Float|
+|Volume|Float| How loud the audio clips should be by default.
 }}
 <!--T:4-->
-== Behavior ==
+== Usage ==
+Attach to a slot and provide some audio clips to play. The next time a user joins or leaves the session, a clip from the corresponding list will play.
 <!--T:5-->
 == Examples ==
+Can be used for world join notifiers or for an elevator ding when a user arrives.
 <!--T:6-->
-== Related Components ==
+== See Also ==
 </translate>
 [[Category:Components{{#translation:}}|User Join Audio Indicator]]
-[[Category:ComponentStubs]]
 [[Category:Components:Users{{#translation:}}|User Join Audio Indicator]]