infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Api
Components
BaseSoundComponent
chevron_left Components
class
BaseSoundComponent

Constructors

lockBaseSoundComponent

Fields

lockSoundHandle

Properties

data_objectDistancedata_objectDistanceAttenuationdata_objectDistanceAttenuationOverridedata_objectFalloffdata_objectForce2ddata_objectMaxRepeatTimedata_objectMinRepeatTimeremove_circleOcclusiondata_objectOcclusionEnableddata_objectOcclusionOverrideremove_circleOcclusionRadiusdata_objectPitchdata_objectPlayOnStartremove_circleReflectionOverrideremove_circleReflectionsdata_objectRepeatdata_objectReverbEnableddata_objectReverbOverridedata_objectSoundEventdata_objectSoundOverridedata_objectStopOnNewdata_objectTargetMixerdata_objectVolume

Methods

lockApplyOverridesfunctionsStartSoundfunctionsStopSoundlockTestSound
BaseSoundComponent
class Sandbox .account_tree extends Component
abstractSandbox.Engine

build Constructors 1

BaseSoundComponent ()

crop_din Fields 1

SoundHandle
SoundHandle

data_object Properties 23

Distance
float
DistanceAttenuation
bool
DistanceAttenuationOverride
bool
Falloff
Curve
Force2d
bool
MaxRepeatTime
float
MinRepeatTime
float
Occlusion
obsoletebool
Legacy alias for Sandbox.BaseSoundComponent.OcclusionEnabled.
OcclusionEnabled
bool
OcclusionOverride
bool
OcclusionRadius
obsoletefloat
Legacy occlusion radius. No longer used by the simulation.
Pitch
float
PlayOnStart
bool
ReflectionOverride
obsoletebool
Legacy alias for Sandbox.BaseSoundComponent.ReverbOverride.
Reflections
obsoletebool
Legacy alias for Sandbox.BaseSoundComponent.ReverbEnabled.
Repeat
bool
ReverbEnabled
bool
ReverbOverride
bool
SoundEvent
SoundEvent
SoundOverride
bool
StopOnNew
bool
TargetMixer
MixerHandle
The mixer we want this sound to play through
Volume
float

functions Methods 4

ApplyOverrides (h)
StartSound ()
StopSound ()
TestSound ()

Inheritance

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