s&box docs
API ReferenceSandbox

SoundscapeTriggerclass

Plays a soundscape when the listener enters the trigger area.

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

Constructors1

Showing 1 constructors

Methods5

Showing 5 methods

protected virtual void DrawGizmos()PROTECTEDVIRTUAL

Returns:void—

protected virtual void OnDestroy()PROTECTEDVIRTUALLIFECYCLE

Returns:void—

protected virtual void OnDisabled()PROTECTEDVIRTUALLIFECYCLE

Returns:void—

protected virtual void OnUpdate()PROTECTEDVIRTUALPER-FRAME

Returns:void—

public bool TestListenerPosition(Vector3 position)PUBLIC

Return true if they should hear this soundscape when in this position

ParameterTypeDescription
positionVector3—
Returns:bool—

Properties8

Showing 8 properties

public Vector3 Sandbox.SoundscapeTrigger.BoxSize { get; set; }PUBLICGETSET

The size of the Soundscape when `Sandbox.SoundscapeTrigger.Type` is set to `Sandbox.SoundscapeTrigger.TriggerType.Box`.

Returns:Vector3—

public bool Sandbox.SoundscapeTrigger.Playing { get; set; }PUBLICGETSET

Returns:bool—

public float Sandbox.SoundscapeTrigger.Radius { get; set; }PUBLICGETSET

The radius of the Soundscape when `Sandbox.SoundscapeTrigger.Type` is set to `Sandbox.SoundscapeTrigger.TriggerType.Sphere`.

Returns:float—

public bool Sandbox.SoundscapeTrigger.StayActiveOnExit { get; set; }PUBLICGETSET

When true the soundscape will keep playing after exiting the area, and will only stop playing once another soundscape takes over.

Returns:bool—

public float Sandbox.SoundscapeTrigger.Volume { get; set; }PUBLICGETSET

Returns:float—

Related Guides

→Map Entities→Playing Sounds→Sound

Soundscape.ctor()

Previous Page

BoxSize

Next Page

On this page

Constructorspublic SoundscapeTrigger()Methodsprotected virtual System.Void DrawGizmos()protected virtual System.Void OnDestroy()protected virtual System.Void OnDisabled()protected virtual System.Void OnUpdate()public System.Boolean TestListenerPosition(Vector3 position)Propertiespublic Vector3 Sandbox.SoundscapeTrigger.BoxSize { get; set; }public System.Boolean Sandbox.SoundscapeTrigger.Playing { get; set; }public System.Single Sandbox.SoundscapeTrigger.Radius { get; set; }public Sandbox.Soundscape Sandbox.SoundscapeTrigger.Soundscape { get; set; }public System.Boolean Sandbox.SoundscapeTrigger.StayActiveOnExit { get; set; }public Sandbox.Audio.MixerHandle Sandbox.SoundscapeTrigger.TargetMixer { get; set; }public Sandbox.SoundscapeTrigger.TriggerType Sandbox.SoundscapeTrigger.Type { get; set; }public System.Single Sandbox.SoundscapeTrigger.Volume { get; set; }Metadata