Пользовательские дополнения

На главную


GetVolume( self )

Возвращает текущую громкость звука, диапазон 0.0f (нет звука) - 1.0f (максимальная громкость)

Внимание! Корректность данных гарантируется только для тех звуков для которых был вызван Play

Внимание! Возвращается состояние данного конкретного звука. Итоговое состояние может отличаться в зависимости от настройки вышележащих групп звуков.

Примечание - для пользовательских дополнений все звуки относятся к группе Интерфейс, опция interfaceVolume / audio_option_interface_volume

-- класс
Sound2DLua

-- семантика
function GetVolume( self )

-- входные параметры
self - Sound2DLua - экземпляр Sound2DLua

-- возвращаемое значение
number (float) - текущая громкость звука, в диапазоне 0.0f - 1.0f

-- пример
LogInfo( "Current sound volume is", sound:GetVolume() )

Связанные страницы: "CategoryLuaApi" "CategoryLuaSound"

CategoryLuaSound
FunctionCommonCreateProlongedStateSound
FunctionCommonCreateSound
FunctionCommonGetAddonRelatedSoundGroup
FunctionCommonGetStateRelatedSoundGroup
FunctionCommonIsSoundEnabled
FunctionCommonPlayMusic
FunctionSound2DLuaGetVolume
FunctionSound2DLuaIsMuted
FunctionSound2DLuaIsPaused
FunctionSound2DLuaIsPlaying
FunctionSound2DLuaPlay
FunctionSound2DLuaSetMuted
FunctionSound2DLuaSetPaused
FunctionSound2DLuaSetVolume
FunctionSound2DLuaStop
Sound2DId


CategoryLuaApi CategoryLuaSound

На главную