mirror of
https://gitlab.com/OpenMW/openmw.git
synced 2025-01-09 03:39:14 +00:00
76 lines
2.7 KiB
Lua
76 lines
2.7 KiB
Lua
---
|
|
-- `openmw.ambient` controls background sounds, specific to given player (2D-sounds).
|
|
-- Can be used only by local scripts, that are attached to a player.
|
|
-- @module ambient
|
|
-- @usage local ambient = require('openmw.ambient')
|
|
|
|
|
|
|
|
---
|
|
-- Play a 2D sound
|
|
-- @function [parent=#ambient] playSound
|
|
-- @param #string soundId ID of Sound record to play
|
|
-- @param #table options An optional table with additional optional arguments. Can contain:
|
|
--
|
|
-- * `timeOffset` - a floating point number >= 0, to some time (in second) from beginning of sound file (default: 0);
|
|
-- * `volume` - a floating point number >= 0, to set a sound volume (default: 1);
|
|
-- * `pitch` - a floating point number >= 0, to set a sound pitch (default: 1);
|
|
-- * `scale` - a boolean, to set if sound pitch should be scaled by simulation time scaling (default: true);
|
|
-- * `loop` - a boolean, to set if sound should be repeated when it ends (default: false);
|
|
-- @usage local params = {
|
|
-- timeOffset=0.1
|
|
-- volume=0.3,
|
|
-- scale=false,
|
|
-- pitch=1.0,
|
|
-- loop=true
|
|
-- };
|
|
-- ambient.playSound("shock bolt", params)
|
|
|
|
---
|
|
-- Play a 2D sound file
|
|
-- @function [parent=#ambient] playSoundFile
|
|
-- @param #string fileName Path to sound file in VFS
|
|
-- @param #table options An optional table with additional optional arguments. Can contain:
|
|
--
|
|
-- * `timeOffset` - a floating point number >= 0, to some time (in second) from beginning of sound file (default: 0);
|
|
-- * `volume` - a floating point number >= 0, to set a sound volume (default: 1);
|
|
-- * `pitch` - a floating point number >= 0, to set a sound pitch (default: 1);
|
|
-- * `scale` - a boolean, to set if sound pitch should be scaled by simulation time scaling (default: true);
|
|
-- * `loop` - a boolean, to set if sound should be repeated when it ends (default: false);
|
|
-- @usage local params = {
|
|
-- timeOffset=0.1
|
|
-- volume=0.3,
|
|
-- scale=false,
|
|
-- pitch=1.0,
|
|
-- loop=true
|
|
-- };
|
|
-- ambient.playSoundFile("Sound\\test.mp3", params)
|
|
|
|
---
|
|
-- Stop a sound
|
|
-- @function [parent=#ambient] stopSound
|
|
-- @param #string soundId ID of Sound record to stop
|
|
-- @usage ambient.stopSound("shock bolt");
|
|
|
|
---
|
|
-- Stop a sound file
|
|
-- @function [parent=#ambient] stopSoundFile
|
|
-- @param #string fileName Path to sound file in VFS
|
|
-- @usage ambient.stopSoundFile("Sound\\test.mp3");
|
|
|
|
---
|
|
-- Check if sound is playing
|
|
-- @function [parent=#ambient] isSoundPlaying
|
|
-- @param #string soundId ID of Sound record to check
|
|
-- @return #boolean
|
|
-- @usage local isPlaying = ambient.isSoundPlaying("shock bolt");
|
|
|
|
---
|
|
-- Check if sound file is playing
|
|
-- @function [parent=#ambient] isSoundFilePlaying
|
|
-- @param #string fileName Path to sound file in VFS
|
|
-- @return #boolean
|
|
-- @usage local isPlaying = ambient.isSoundFilePlaying("Sound\\test.mp3");
|
|
|
|
return nil
|