Class SoundEventPlayer.Soundscape

Namespace: ValveResourceFormat.Renderer.Audio
Assembly: Renderer.dll

A soundscape region (env_soundscape): while the listener is within SoundEventPlayer.Soundscape.Radius of SoundEventPlayer.Soundscape.Position and can see it, SoundEventPlayer.Soundscape.Name plays as the ambient bed - a single sound event, or every event a SoundscapeBank soundscape resolves to when SoundEventPlayer.Soundscape.Scripted. A class so the registering entity can toggle SoundEventPlayer.Soundscape.Enabled live.

public sealed class SoundEventPlayer.Soundscape

Inheritance

object ← SoundEventPlayer.Soundscape

Constructors

Soundscape(Vector3, float, string, bool)

A soundscape region (env_soundscape): while the listener is within SoundEventPlayer.Soundscape.Radius of SoundEventPlayer.Soundscape.Position and can see it, SoundEventPlayer.Soundscape.Name plays as the ambient bed - a single sound event, or every event a SoundscapeBank soundscape resolves to when SoundEventPlayer.Soundscape.Scripted. A class so the registering entity can toggle SoundEventPlayer.Soundscape.Enabled live.

public Soundscape(Vector3 position, float radius, string name, bool scripted)

Parameters

position Vector3

radius float

name string

scripted bool

Properties

Enabled

Gets or sets whether the region can claim the listener. Disabling does not silence an ambient it already started.

public bool Enabled { get; set; }

Property Value

bool

Name

Gets the sound event or scripted soundscape the region plays.

public string Name { get; }

Property Value

string

Position

Gets or sets where the region is centered.

public Vector3 Position { get; set; }

Property Value

Vector3

Radius

Gets how far the region reaches, or a negative value for one with no range limit.

public float Radius { get; }

Property Value

float

Scripted

Gets whether SoundEventPlayer.Soundscape.Name is a scripted soundscape rather than a sound event.

public bool Scripted { get; }

Property Value

bool

Unlimited

Gets whether this region covers the whole map ("radius" authored as -1).

public bool Unlimited { get; }

Property Value

bool

Methods

InRange(float)

Gets whether a listener distance away is within range of this region.

public bool InRange(float distance)

Parameters

distance float

Returns

bool