class SoundEvent

in global :: Sandbox

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

public bool UI { get; set; }

Is this sound 2D?

public RangedFloat Volume { get; set; }

How loud the sound should be.

public RangedFloat Pitch { get; set; }

The base pitch of the sound.

public int Decibels { get; set; }

How loud is this sound, affects how far away it can be heard

public SoundEvent.SoundSelectionMode SelectionMode { get; set; }

Selection strategy to use when picking from multiple sounds.

public List<SoundFile> Sounds { get; set; }

A random sound from the list will be selected to be played.

public bool Occlusion { get; set; }

Allow this sound to be occluded by geometry

public bool Reflections { get; set; }

Allow this sound to trace reflections, allowing it to be heard indirectly

public bool AirAbsorption { get; set; }

Allow this sound to be absorbed by air

public bool Transmission { get; set; }

Allow this sound to be transmitted through geometry

public float OcclusionRadius { get; set; }

The radius of this sound's occlusion in inches.

public bool DistanceAttenuation { get; set; }

Should the sound fade out over distance

public float Distance { get; set; }

How many units the sound can be heard from.

public Curve Falloff { get; set; }

The falloff curve for the sound.

public MixerHandle DefaultMixer { get; set; }

Default mixer to play this sound with if one isn't provided on play.

public int GetHashCode( )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public string ResourceName { get; }

😔 No documentation found.

public string ResourcePath { get; }

😔 No documentation found.

public int ResourceId { get; }

😔 No documentation found.

public SoundEvent( string soundName, float volume = 0.5 )

😔 No documentation found.

public void Deserialize( JsonObject jso )

😔 No documentation found.

public void LoadFromJson( string json )

😔 No documentation found.

public JsonObject Serialize( )

😔 No documentation found.

public IEnumerable<string> GetReferencedPackages( )

😔 No documentation found.

public void StateHasChanged( )

😔 No documentation found.

public bool HasUnsavedChanges { get; }

😔 No documentation found.

public SoundEvent( )

😔 No documentation found.

public bool IsValid { get; }

😔 No documentation found.

public int ResourceVersion { get; }

😔 No documentation found.