CorsixTH Lua Documentation

Audio Class

Layer which handles the Lua-facing side of loading and playing audio.

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

Method Index

Member Index

function Audio:Audio(app)

Parameters:

NameTypeDescription
app ? ?

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

function Audio:dumpSoundArchive(out_dir)

Parameters:

NameTypeDescription
out_dir ? ?

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

function Audio:initSpeech(speech_file)

Parameters:

NameTypeDescription
speech_file ? ?

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

function Audio:notifyJukebox()

search for jukebox and notify it to update its play button

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

function Audio:playBackgroundTrack(index)

Parameters:

NameTypeDescription
index ? ?

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

function Audio:playNextOrPreviousBackgroundTrack(direction)

Parameters:

NameTypeDescription
direction ? ?

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

function Audio:playSound(name, where, is_announcement)

Parameters:

NameTypeDescription
name ? ?
where ? ?
is_announcement ? ?

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

function Audio:playSoundEffects(play_effects)

Parameters:

NameTypeDescription
play_effects ? ?

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

function Audio:setAnnouncementVolume(volume)

Parameters:

NameTypeDescription
volume ? ?

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

function Audio:setBackgroundVolume(volume)

Parameters:

NameTypeDescription
volume ? ?

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

function Audio:setSoundVolume(volume)

Parameters:

NameTypeDescription
volume ? ?

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

Page generated on Thu Jun 24, 2010 at 02:46:54 by LDocGen.