Type:ClipData: Difference between revisions

Revision as of 18:04, 15 February 2025

Used by Component:RandomAudioClipPlayer, Component:ChildParentAudioClipPlayer and Component:ButtonAudioClipPlayer as a choice item with a weight to play an audio clip.

Fields
Name	Type	Description
`Clip`	[[Type:AudioClip\|AudioClip]]	The AudioClip to play. This can be a StaticAudioClip.
`Weight`	Float	How likely it is for this audio clip to play
`MinVolume`	Float	The minimum volume
`MaxVolume`	Float	The maximum volume
`MinSpeed`	Float	The minimum playback speed this audio should be played at
`MaxSpeed`	Float	The maximum playback speed this audio should be played at
`Spatialize`	Boolean	Whether this audio plays in 2d or 3d
`SpatialBlend`	Float	Amount of spatial blending (0 to 1)
`MinDistance`	Float	The distance in meters in the audio's set transform space where the audio's perceived volume stops increasing and stays constant all the way to the center.
`MaxDistance`	Float	The maximum distance in meters in the audio's set transform space in meters before it cannot be heard.

@@ Line 1: / Line 1: @@
-Used by [[Component:RandomAudioClipPlayer]] as a choice item with a weight to play an audio clip.
+Used by [[Component:RandomAudioClipPlayer]], [[Component:ChildParentAudioClipPlayer]] and [[Component:ButtonAudioClipPlayer]] as a choice item with a weight to play an audio clip.
 {{Table TypeFields
+|Clip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv5=true|The AudioClip to play. This can be a [[Component:StaticAudioClip|StaticAudioClip]].
 |Weight|Float|How likely it is for this audio clip to play
-|MinDistance|Float| the distance in meters in the audio's set transform space where the audio's perceived volume stops increasing and stays constant all the way to the center.
+|MinVolume|Float|The minimum volume
-|MaxDistance|Float| the maximum distance in meters in the audio's set transform space in meters before it cannot be heard.
+|MaxVolume|Float|The maximum volume
-|MinSpeed|Float| The minimum playback speed this audio should be played at
+|MinSpeed|Float|The minimum playback speed this audio should be played at
-|MaxSpeed|Float| The maximum playback speed this audio should be played at
+|MaxSpeed|Float|The maximum playback speed this audio should be played at
-|Clip|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv5=true| The AudioClip to play. This can be a [[Component:StaticAudioClip|StaticAudioClip]].
+|Spatialize|Boolean|Whether this audio plays in 2d or 3d
+|SpatialBlend|Float|Amount of spatial blending (0 to 1)
+|MinDistance|Float|The distance in meters in the audio's set transform space where the audio's perceived volume stops increasing and stays constant all the way to the center.
+|MaxDistance|Float|The maximum distance in meters in the audio's set transform space in meters before it cannot be heard.
 }}