Áudio
Reproduz ficheiros WAV do projeto. O play devolve um handle para controlar esse som enquanto toca. Sem dispositivo de áudio, todas as chamadas são no-ops seguros (0 ou false). Os handles só são válidos enquanto o som toca: depois de acabar, o espaço pode ser reutilizado por outro som.
Namespace: caffeine.audio · Dryad prefix: caffeine_audio_
isAvailable#
Lua: caffeine.audio.isAvailable · Dryad: caffeine_audio_available
isAvailable() -> boolean
Indica se é possível reproduzir som.
Devolve: boolean. true quando há um dispositivo de reprodução aberto.
Exemplo
if not caffeine.audio.isAvailable() then caffeine.debug.warn("no sound") end
play#
Lua: caffeine.audio.play · Dryad: caffeine_audio_play
play(path[, volume[, pan[, loop]]]) -> number
Toca um som. O ficheiro é descodificado uma vez e fica em cache.
| Parâmetros | Tipo | Descrição |
|---|---|---|
path | string | Ficheiro WAV, relativo à raiz do projeto. |
volume | number | 0 a 1, por omissão 1. |
pan | number | -1 esquerda a 1 direita, por omissão 0. |
loop | boolean | Repetir até parar, por omissão false. |
Devolve: number. Um handle maior que 0, ou 0 quando o som não pôde tocar (sem dispositivo, ficheiro em falta, 32 canais ocupados).
Exemplo
local h = caffeine.audio.play("audio/jump.wav", 0.8)
playAt#
Lua: caffeine.audio.playAt · Dryad: caffeine_audio_play_at
playAt(path, x, y[, maxDistance[, volume]]) -> number
Toca um som cujo volume e panning esquerda/direita seguem a distância ao ouvinte (ver setListener).
| Parâmetros | Tipo | Descrição |
|---|---|---|
path | string | Ficheiro WAV, relativo à raiz do projeto. |
x, y | number | Posição do som no mundo 2D. |
maxDistance | number | Distância a que o som fica mudo, por omissão 500. |
volume | number | Ganho extra, por omissão 1. |
Devolve: number. Um handle, ou 0 se não pôde tocar.
Exemplo
caffeine.audio.playAt("audio/boom.wav", 120, 40, 300)
stop#
Lua: caffeine.audio.stop · Dryad: caffeine_audio_stop
stop(handle) -> boolean
Para um som.
| Parâmetros | Tipo | Descrição |
|---|---|---|
handle | number | Handle devolvido por play ou playAt. |
Devolve: boolean. false se o handle for desconhecido ou o som já tiver terminado.
Exemplo
caffeine.audio.stop(h)
pause#
Lua: caffeine.audio.pause · Dryad: caffeine_audio_pause
pause(handle) -> boolean
Pausa um som; o resume continua-o.
| Parâmetros | Tipo | Descrição |
|---|---|---|
handle | number | Handle devolvido por play ou playAt. |
Devolve: boolean. false se o handle for desconhecido ou o som já tiver terminado.
Exemplo
caffeine.audio.pause(h)
resume#
Lua: caffeine.audio.resume · Dryad: caffeine_audio_resume
resume(handle) -> boolean
Retoma um som em pausa.
| Parâmetros | Tipo | Descrição |
|---|---|---|
handle | number | Handle devolvido por play ou playAt. |
Devolve: boolean. false se o handle for desconhecido ou o som já tiver terminado.
Exemplo
caffeine.audio.resume(h)
setVolume#
Lua: caffeine.audio.setVolume · Dryad: caffeine_audio_set_volume
setVolume(handle, volume) -> boolean
Altera o volume de um som a tocar.
| Parâmetros | Tipo | Descrição |
|---|---|---|
handle | number | Handle devolvido por play ou playAt. |
volume | number | 0 a 1. |
Devolve: boolean. false se o handle for desconhecido ou o som já tiver terminado.
Exemplo
caffeine.audio.setVolume(h, 0.3)
setLoop#
Lua: caffeine.audio.setLoop · Dryad: caffeine_audio_set_loop
setLoop(handle, loop) -> boolean
Liga ou desliga a repetição de um som a tocar.
| Parâmetros | Tipo | Descrição |
|---|---|---|
handle | number | Handle devolvido por play ou playAt. |
loop | boolean | true para repetir. |
Devolve: boolean. false se o handle for desconhecido ou o som já tiver terminado.
Exemplo
caffeine.audio.setLoop(h, false)
isPlaying#
Lua: caffeine.audio.isPlaying · Dryad: caffeine_audio_is_playing
isPlaying(handle) -> boolean
Indica se um som ainda está a tocar.
| Parâmetros | Tipo | Descrição |
|---|---|---|
handle | number | Handle devolvido por play ou playAt. |
Devolve: boolean. true enquanto o som toca (não em pausa, não terminado).
Exemplo
if not caffeine.audio.isPlaying(h) then h = caffeine.audio.play("audio/loop.wav") end
stopAll#
Lua: caffeine.audio.stopAll · Dryad: caffeine_audio_stop_all
stopAll()
Para todos os sons. As mudanças de cena fazem-no automaticamente.
Devolve: nada
Exemplo
caffeine.audio.stopAll()
setMasterVolume#
Lua: caffeine.audio.setMasterVolume · Dryad: caffeine_audio_set_master_volume
setMasterVolume(volume)
Define o volume aplicado aos sons iniciados depois.
| Parâmetros | Tipo | Descrição |
|---|---|---|
volume | number | 0 a 1. |
Devolve: nada
Exemplo
caffeine.audio.setMasterVolume(0.5)
masterVolume#
Lua: caffeine.audio.masterVolume · Dryad: caffeine_audio_master_volume
masterVolume() -> number
Lê o volume geral.
Devolve: number. O volume geral, 0 a 1 (0 sem áudio).
Exemplo
local v = caffeine.audio.masterVolume()
setListener#
Lua: caffeine.audio.setListener · Dryad: caffeine_audio_set_listener
setListener(x, y)
Define o ponto de onde o playAt mede a distância, normalmente o jogador ou a câmara.
| Parâmetros | Tipo | Descrição |
|---|---|---|
x, y | number | Posição do ouvinte no mundo 2D. |
Devolve: nada
Exemplo
caffeine.audio.setListener(player_x, player_y)