newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
Api
Components
SoundscapeTrigger
chevron_left Components
class
SoundscapeTrigger

Constructors

functionsSoundscapeTrigger

Properties

data_objectBoxSizedata_objectPlayingdata_objectRadiusdata_objectSoundscapedata_objectStayActiveOnExitdata_objectTargetMixerdata_objectTypedata_objectVolume

Methods

lockDrawGizmoslockOnDestroylockOnDisabledlockOnUpdatefunctionsTestListenerPosition
SoundscapeTrigger
Plays a soundscape when the listener enters the trigger area.
class Sandbox .account_tree extends Component
Sandbox.Engine

build Constructors 1

SoundscapeTrigger ()

data_object Properties 8

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

functions Methods 5

DrawGizmos ()
OnDestroy ()
OnDisabled ()
OnUpdate ()
TestListenerPosition (position)
bool
Return true if they should hear this soundscape when in this position

Inheritance

Component
SoundscapeTrigger
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.