Skip to content

Improved clarity of documentation for sound functions #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nwhis wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improved clarity of documentation for sound functions #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions lua/starfall/libs_sh/sound.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ function sound_methods:isPlaying()
return unwrap(self):IsPlaying()
end

--- Sets the sound level in dB. Won't work unless the sound is playing.
--- Sets the sound level in dB. Won't work if the sound is already playing.
-- @param number level dB level, for information on the value to use see https://developer.valvesoftware.com/wiki/Soundscripts#SoundLevel
function sound_methods:setSoundLevel(level)
checkluatype(level, TYPE_NUMBER)
Expand All @@ -199,15 +199,15 @@ function sound_methods:getSoundLevel()
return unwrap(self):GetSoundLevel()
end

--- Sets the sound dsp
--- Sets the sound dsp value
-- @param number dsp (0 - 133) DSP values. List can be found here https://developer.valvesoftware.com/wiki/Dsp_presets
function sound_methods:setDSP(dsp)
checkluatype(dsp, TYPE_NUMBER)
unwrap(self):SetDSP(math.Clamp(dsp, 0, 133))
end

--- Gets the sound dsp
-- @return number dsp (0 - 133) DSP value.
--- Gets the sound dsp value
-- @return number (0 - 133) DSP value.
function sound_methods:getDSP()
return unwrap(self):GetDSP()
end
Expand Down