CorsixTH Lua Documentation

function Audio:Audio(app)

Parameters:

Declared on: line 35 of Lua/audio.lua.

function Audio:cacheSoundFilenamesAssociatedWithName(name)

Parameters:

Declared on: line 403 of Lua/audio.lua.

function Audio:clearCallbacks()

Declared on: line 55 of Lua/audio.lua.

function Audio:destroy()

Declared on: line 849 of Lua/audio.lua.

function Audio:dumpSoundArchive(out_dir)

Parameters:

Declared on: line 292 of Lua/audio.lua.

function Audio:entityNoLongerWaitingForSoundsToBeTurnedOn(entity)

Parameters:

Declared on: line 819 of Lua/audio.lua.

function Audio:entitySoundsHandler(sounds, entity, silences, silences_pointer)

Called by the above function. This function's integer array parameters for the min and max silence lengths should provide lengths for this game's different speeds, indexed as follows: [1] Slowest [2] Slow [3] Normal [4] Fast [5] Maximum Speed

Parameters:

Declared on: line 482 of Lua/audio.lua.

function Audio:findIndexOfCurrentTrack()

Declared on: line 571 of Lua/audio.lua.

function Audio:getFileData(index)

Parameters:

Declared on: line 681 of Lua/audio.lua.

function Audio:getMidiApiList()

Declared on: line 215 of Lua/audio.lua.

function Audio:getMidiPortList()

Declared on: line 219 of Lua/audio.lua.

function Audio:init()

Declared on: line 71 of Lua/audio.lua.

function Audio:initMidiPlayer()

Declared on: line 196 of Lua/audio.lua.

function Audio:initSpeech(speech_file)

Parameters:

Declared on: line 227 of Lua/audio.lua.

function Audio:isPlaying(sound)

Determine if a given sound is still playing

Parameters:

Declared on: line 389 of Lua/audio.lua.

function Audio:isPlayingWithMidiPlayer()

Declared on: line 611 of Lua/audio.lua.

function Audio:notifyJukebox()

search for jukebox and notify it to update its play button

Declared on: line 827 of Lua/audio.lua.

function Audio:onEndPause()

Declared on: line 527 of Lua/audio.lua.

function Audio:onMusicOver()

Declared on: line 769 of Lua/audio.lua.

function Audio:onSoundPlayed(played_callbacks_id)

Parameters:

Declared on: line 533 of Lua/audio.lua.

function Audio:pauseBackgroundTrack()

Returns whether music is currently paused or not after the call.

If nil is returned music might either be playing or completely stopped.

Declared on: line 615 of Lua/audio.lua.

function Audio:playBackgroundTrack(index)

Plays a given background track.

Playback will only start if the configuration says it's ok. (play_music = true)

Parameters:

Declared on: line 696 of Lua/audio.lua.

function Audio:playEntitySounds(names, entity, min_silence_lengths, max_silence_lengths, num_silences)

Plays related sounds at an entity in a random sequence, with random length silences between the sounds. This function's integer array parameters for the min and max silence lengths should provide lengths for this game's different speeds, indexed as follows: [1] Slowest [2] Slow [3] Normal [4] Fast [5] Maximum Speed

Parameters:

Declared on: line 456 of Lua/audio.lua.

function Audio:playNextBackgroundTrack()

Declared on: line 603 of Lua/audio.lua.

function Audio:playNextOrPreviousBackgroundTrack(direction)

Parameters:

Declared on: line 581 of Lua/audio.lua.

function Audio:playPreviousBackgroundTrack()

Declared on: line 607 of Lua/audio.lua.

function Audio:playRandomBackgroundTrack()

Declared on: line 554 of Lua/audio.lua.

function Audio:playSound(name, where, is_announcement, played_callback, played_callback_delay, loops)

Play a sound from the sound archive

Parameters:

Declared on: line 316 of Lua/audio.lua.

function Audio:playSoundEffects(play_effects)

Parameters:

Declared on: line 798 of Lua/audio.lua.

function Audio:readPlaylistPreferences()

Load the playlist disabled tracks file

Declared on: line 857 of Lua/audio.lua.

function Audio:releaseChannel(channel)

Parameters:

Declared on: line 843 of Lua/audio.lua.

function Audio:reserveChannel()

Declared on: line 835 of Lua/audio.lua.

function Audio:resolveFilenameWildcard(name)

Resolves sound filename containing wildcard character from its associated variants

Parameters:

Declared on: line 420 of Lua/audio.lua.

function Audio:setAnnouncementVolume(volume)

Parameters:

Declared on: line 823 of Lua/audio.lua.

function Audio:setBackgroundVolume(volume)

Parameters:

Declared on: line 776 of Lua/audio.lua.

function Audio:setSoundStage()

Set the visual area for sound effects playback

Declared on: line 283 of Lua/audio.lua.

function Audio:setSoundVolume(volume)

Parameters:

Declared on: line 789 of Lua/audio.lua.

function Audio:soundExists(sound)

Returns whether the given sound (either a string or a number)

exists in the sound archive

Parameters:

Declared on: line 542 of Lua/audio.lua.

function Audio:stopBackgroundTrack()

Stops playing background music for the time being.

Does not affect the configuration setting play_music.

Declared on: line 665 of Lua/audio.lua.

function Audio:stopSound(sound)

Stop a playing sound. A stopped sound is destroyed and cannot be resumed. The callback will be not be called for the stopped sound.

Parameters:

Declared on: line 374 of Lua/audio.lua.

function Audio:tellInterestedEntitiesTheyCanNowPlaySounds()

Declared on: line 810 of Lua/audio.lua.

function Audio:togglePauseSound(sound)

Pause or unpause a playing sound

Parameters:

Declared on: line 361 of Lua/audio.lua.

function Audio:updatePlaylistPreferences()

Create a set of playlist filenames that are disabled and write this to file

Declared on: line 870 of Lua/audio.lua.