Browsing StarfallEx's section
โ† Back to ACE
Back to StarfallEx

SFEX.Bass:setFade

C๐Ÿท๏ธ Bass

Part of StarfallEx namespace

๐Ÿ”— External
Bass:setFade(min, max, useSimpleFading)
View on GitHub|lua/starfall/libs_cl/bass.lua:324
๐Ÿ“‹ Has LDoc๐Ÿ‘๏ธ 0 viewsUpdated 2 months ago

Description

Sets the fade distance of the sound in 3D space. Must have 3d flag for this to have any effect. For both fading styles, the sound will be at full volume (the value of :setVolume()) at distances between 0 and min. If simple fading is enabled, the sound will fade towards 0 until the max distance is reached, becoming inaudible. If simple fading is disabled, the sound will start to fade, then lock its volume once max distance is reached. It will almost always be faintly heard.

Parameters

NameTypeDescription
minnumberThe distance where the sound starts to fade. (50-1,000)
maxnumberThe maximal distance, as described above. (min-20,000 for simple fading, 5,000-200,000 for non-simple fading)
useSimpleFading?booleanWhether to use simple fading for this sound. True by default.

Returns

No return values documented.

Examples

No examples available.

Used In

No usages found in the codebase.