Component:ChildParentAudioClipPlayer: Difference between revisions

Latest revision as of 06:01, 17 March 2025

Component image

The ChildParentAudioClipPlayer component plays specified audio clips when it's immediate children are added to or removed from.

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.
`ParentUnder`	Slot	Where to parent the slots to when playing sounds. (DON'T SET THIS TO THE SLOT THIS COMPONENT IS ON. else it will spam audio every game tick)
`MinDistance`	Nullable`1<Float>	The override for all ClipDatas Min Distance when they are played.
`MaxDistance`	Nullable`1<Float>	The override for all ClipDatas Max Distance when they are played.
`RolloffMode`	Nullable`1<AudioRolloffMode>	The override for all ClipDatas Rolloff Mode when they are played.
`PlayPointMode`	ChildParentAudioClipPlayer.PointMode	Where to position audio clips when they are played.
`ChildLimit`	Int	If the immediate children count of this component's slot is above this amount, it will not play sounds.
`FilterTag`	String	If an added or removed immediate child has a tag that matches this value, a sound will not be played.
`ParentedClips`	list of ClipData	A list of audio clips to play when a slot is added to the immediate children of this component's slot.
`UnparentedClips`	list of ClipData	A list of audio clips to play when a slot is removed from the immediate children of this component's slot.

Values
Name	Value	Description
`ParentOrigin`	0	Play the audio at the global position of this component's slot.
`ChildOrigin`	1	Play the audio at the global position of the slot being added or removed.
`ParentBoundsCenter`	2	Play the audio at the global center of the bounding box of this component's slot.
`ChildBoundsCenter`	3	Play the audio at the global center of the bounding box of the slot being added or removed.

@@ Line 11: / Line 11: @@
 |MaxDistance|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv2=true| The override for all [[Type:ClipData|ClipData]]s Max Distance when they are played.
 |RolloffMode|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:AudioRolloffMode|AudioRolloffMode]]&gt;'''|TypeAdv3=true| The override for all [[Type:ClipData|ClipData]]s Rolloff Mode when they are played.
-|PlayPointMode|'''[[#PointMode|PointMode]]'''|TypeAdv4=true| Where to position audio clips when they are played.
+|PlayPointMode|'''[[#PointMode|ChildParentAudioClipPlayer.PointMode]]'''|TypeAdv4=true| Where to position audio clips when they are played.
 |ChildLimit|Int| If the immediate children count of this component's slot is above this amount, it will not play sounds.
 |FilterTag|String| If an added or removed immediate child has a tag that matches this value, a sound will not be played.