Api Sandbox SoundscapeTrigger
class

SoundscapeTrigger

public class SoundscapeTrigger : Component

Plays a soundscape when the listener enters the trigger area.

Constructors

SoundscapeTrigger()

Properties

Name Type Description
Type TriggerType Determines when/where the soundscape can be heard.
Soundscape Soundscape
TargetMixer MixerHandle The mixer that the soundscape will play on.
StayActiveOnExit Boolean When true the soundscape will keep playing after exiting the area, and will only stop playing once another soundscape takes over.
Volume Single
Radius Single The radius of the Soundscape when Type is set to Sphere.
BoxSize Vector3 The size of the Soundscape when Type is set to Box.
Playing Boolean

Methods

Boolean TestListenerPosition(Vector3 position)

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

Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.SoundscapeTrigger