# Sandbox.SoundscapeTrigger

Plays a soundscape when the listener enters the trigger area.

- Kind: class
- Namespace: `Sandbox`
- Assembly: `Sandbox.Engine`
- Inherits: [Sandbox.Component](/api/Sandbox.Component)

## Constructors

- [`SoundscapeTrigger`](/api/Sandbox.SoundscapeTrigger/.ctor)

## Properties

- [`BoxSize`](/api/Sandbox.SoundscapeTrigger/BoxSize): The size of the Soundscape when [Sandbox.SoundscapeTrigger.Type](/api/Sandbox.SoundscapeTrigger/Type) is set to [Sandbox.SoundscapeTrigger.TriggerType.Box](/api/Sandbox.SoundscapeTrigger.TriggerType/Box).
- [`Playing`](/api/Sandbox.SoundscapeTrigger/Playing)
- [`Radius`](/api/Sandbox.SoundscapeTrigger/Radius): The radius of the Soundscape when [Sandbox.SoundscapeTrigger.Type](/api/Sandbox.SoundscapeTrigger/Type) is set to [Sandbox.SoundscapeTrigger.TriggerType.Sphere](/api/Sandbox.SoundscapeTrigger.TriggerType/Sphere).
- [`Soundscape`](/api/Sandbox.SoundscapeTrigger/Soundscape)
- [`StayActiveOnExit`](/api/Sandbox.SoundscapeTrigger/StayActiveOnExit): When true the soundscape will keep playing after exiting the area, and will only stop playing once another soundscape takes over.
- [`TargetMixer`](/api/Sandbox.SoundscapeTrigger/TargetMixer): The mixer that the soundscape will play on.
- [`Type`](/api/Sandbox.SoundscapeTrigger/Type): Determines when/where the soundscape can be heard.
- [`Volume`](/api/Sandbox.SoundscapeTrigger/Volume)

## Methods

- [`TestListenerPosition`](/api/Sandbox.SoundscapeTrigger/TestListenerPosition): Return true if they should hear this soundscape when in this position