s&box docs
API ReferenceSandbox

BaseSoundComponentclass

object→Component→BaseSoundComponent
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public abstract class Sandbox.BaseSoundComponent : Sandbox.Component

Constructors1

Showing 1 constructors

Methods4

Showing 4 methods

protected void ApplyOverrides(Sandbox.SoundHandle h)PROTECTED

ParameterTypeDescription
hSoundHandle—
Returns:void—

public virtual void StartSound()PUBLICVIRTUAL

Returns:void—

public virtual void StopSound()PUBLICVIRTUAL

Returns:void—

protected void TestSound()PROTECTED

Returns:void—

Properties23

Showing 23 properties

public float Sandbox.BaseSoundComponent.Distance { get; set; }PUBLICGETSET

Returns:float—

public bool Sandbox.BaseSoundComponent.DistanceAttenuation { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.BaseSoundComponent.DistanceAttenuationOverride { get; set; }PUBLICGETSET

Returns:bool—

public float Sandbox.BaseSoundComponent.MaxRepeatTime { get; set; }PUBLICGETSET

Returns:float—

public float Sandbox.BaseSoundComponent.MinRepeatTime { get; set; }PUBLICGETSET

Returns:float—

public bool Sandbox.BaseSoundComponent.Occlusion { get; set; }PUBLICGETSETOBSOLETE

Legacy alias for `Sandbox.BaseSoundComponent.OcclusionEnabled`.

Obsolete: Use OcclusionEnabled instead.

Returns:bool—

public bool Sandbox.BaseSoundComponent.OcclusionEnabled { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.BaseSoundComponent.OcclusionOverride { get; set; }PUBLICGETSET

Returns:bool—

public float Sandbox.BaseSoundComponent.OcclusionRadius { get; set; }PUBLICGETSETOBSOLETE

Legacy occlusion radius. No longer used by the simulation.

Obsolete: OcclusionRadius is no longer used by the simulation.

Returns:float—

public bool Sandbox.BaseSoundComponent.PlayOnStart { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.BaseSoundComponent.ReflectionOverride { get; set; }PUBLICGETSETOBSOLETE

Legacy alias for `Sandbox.BaseSoundComponent.ReverbOverride`.

Obsolete: Use ReverbOverride instead.

Returns:bool—

public bool Sandbox.BaseSoundComponent.Reflections { get; set; }PUBLICGETSETOBSOLETE

Legacy alias for `Sandbox.BaseSoundComponent.ReverbEnabled`.

Obsolete: Use ReverbEnabled instead.

Returns:bool—

public bool Sandbox.BaseSoundComponent.ReverbEnabled { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.BaseSoundComponent.ReverbOverride { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.BaseSoundComponent.SoundOverride { get; set; }PUBLICGETSET

Returns:bool—

GetWeighted()

Previous Page

Distance

Next Page

On this page

Constructorsprotected BaseSoundComponent()Methodsprotected System.Void ApplyOverrides(Sandbox.SoundHandle h)public virtual System.Void StartSound()public virtual System.Void StopSound()protected System.Void TestSound()Propertiespublic System.Single Sandbox.BaseSoundComponent.Distance { get; set; }public System.Boolean Sandbox.BaseSoundComponent.DistanceAttenuation { get; set; }public System.Boolean Sandbox.BaseSoundComponent.DistanceAttenuationOverride { get; set; }public Sandbox.Curve Sandbox.BaseSoundComponent.Falloff { get; set; }public System.Boolean Sandbox.BaseSoundComponent.Force2d { get; set; }public System.Single Sandbox.BaseSoundComponent.MaxRepeatTime { get; set; }public System.Single Sandbox.BaseSoundComponent.MinRepeatTime { get; set; }public System.Boolean Sandbox.BaseSoundComponent.Occlusion { get; set; }public System.Boolean Sandbox.BaseSoundComponent.OcclusionEnabled { get; set; }public System.Boolean Sandbox.BaseSoundComponent.OcclusionOverride { get; set; }public System.Single Sandbox.BaseSoundComponent.OcclusionRadius { get; set; }public System.Single Sandbox.BaseSoundComponent.Pitch { get; set; }public System.Boolean Sandbox.BaseSoundComponent.PlayOnStart { get; set; }public System.Boolean Sandbox.BaseSoundComponent.ReflectionOverride { get; set; }public System.Boolean Sandbox.BaseSoundComponent.Reflections { get; set; }public System.Boolean Sandbox.BaseSoundComponent.Repeat { get; set; }public System.Boolean Sandbox.BaseSoundComponent.ReverbEnabled { get; set; }public System.Boolean Sandbox.BaseSoundComponent.ReverbOverride { get; set; }public Sandbox.SoundEvent Sandbox.BaseSoundComponent.SoundEvent { get; set; }public System.Boolean Sandbox.BaseSoundComponent.SoundOverride { get; set; }public System.Boolean Sandbox.BaseSoundComponent.StopOnNew { get; set; }public Sandbox.Audio.MixerHandle Sandbox.BaseSoundComponent.TargetMixer { get; set; }public System.Single Sandbox.BaseSoundComponent.Volume { get; set; }Metadata