Sound Effect (SFX)
The SFX component is a scriptable object for playing sound effects. It can be used to easily create and play randomized sound effects.
Properties
| Property | Function |
|---|---|
| Sound Category | Determine which audio group the sound is in. This will be used to allow users to modify the volume of certain sounds. Currently unused. |
| Clips | When the SFX is played one of the clips will be chosen at random. |
| Volume | When the SFX is played a random volume will be chosen between the min and max values. |
| Pitch | When the SFX is played a random pitch will be chosen between the min and max values. |
| Spatial Blend | Determines how “spatial” the audio source is when the SFX is played. 1 = fully 3D |
| Reverb Mix | How “wet” is the reverb effect applied to the audio source. |
| Rolloff | What type of 3D rolloff will be applied when the spatial blend is 3D. |
| Rolloff Min | Max distance where the clip is played at full volume. |
| Rolloff Max | Max distance where the clip can be heard. |
Create SFX
Create a new Spatial SFX via the menu Assets > Create > Spatial > SFX . This will create a new asset in your project folder. Inside the asset, you can define the clips and parameters that make up your sound effect.
Play SFX
Sound effects can be played via C# Scripting or Visual Scripting.
C# Scripting
Use the SpatialSFX.Play method to play an SFX.
Visual Scripting
Use the Spatial SFX: Play nodes.
