Api Sandbox SoundEvent
class

SoundEvent

public class SoundEvent : GameResource

A sound event. It can play a set of random sounds with optionally random settings such as volume and pitch.

Constructors

SoundEvent()
SoundEvent(String soundName, Single volume)

Properties

Name Type Description
UI Boolean Is this sound 2D?
Volume RangedFloat How loud the sound should be.
Pitch RangedFloat The base pitch of the sound.
Decibels Int32 How loud is this sound, affects how far away it can be heard
SelectionMode SoundSelectionMode Selection strategy to use when picking from multiple sounds.
Sounds List<SoundFile> A random sound from the list will be selected to be played.
Occlusion Boolean Allow this sound to be occluded by geometry
Reflections Boolean Allow this sound to trace reflections, allowing it to be heard indirectly
AirAbsorption Boolean Allow this sound to be absorbed by air
Transmission Boolean Allow this sound to be transmitted through geometry
OcclusionRadius Single The radius of this sound's occlusion in inches.
DistanceAttenuation Boolean Should the sound fade out over distance
Distance Single How many units the sound can be heard from.
Falloff Curve The falloff curve for the sound.
DefaultMixer MixerHandle Default mixer to play this sound with if one isn't provided on play.
ResourceVersion virtual Int32
Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.SoundEvent