Caffeine

Interface

Reference UI Última atualização: Lua 6 · Dryad 0

Criar canvases, rótulos e botões, atualizá-los e testar acertos em posições do ecrã.

Todos os namespaces

Namespace: caffeine.ui

createCanvas#

Lua: caffeine.ui.createCanvas

text
createCanvas([w, h]) -> integer

Cria uma entidade de canvas de UI.

ParâmetrosTipoDescrição
wnumberLargura (por omissão 1280).
hnumberAltura (por omissão 720).

Devolve: integer. Id da entidade do canvas, ou 0 sem sistema de UI ou mundo.

Exemplo

lua
local canvas = caffeine.ui.createCanvas(1280, 720)

createLabel#

Lua: caffeine.ui.createLabel

text
createLabel(parent, text, pos) -> integer

Cria um rótulo de texto sob um pai.

ParâmetrosTipoDescrição
parentintegerId do canvas ou widget pai.
textstringTexto do rótulo.
postablePosição {x, y}.

Devolve: integer. Id da entidade do rótulo, ou 0.

Exemplo

lua
local l = caffeine.ui.createLabel(canvas, 'Score: 0', { x = 10, y = 10 })

createButton#

Lua: caffeine.ui.createButton

text
createButton(parent, text, pos[, w, h]) -> integer

Cria um botão sob um pai.

ParâmetrosTipoDescrição
parentintegerId do canvas ou widget pai.
textstringTexto do botão.
postablePosição {x, y}.
wnumberLargura (por omissão 120).
hnumberAltura (por omissão 40).

Devolve: integer. Id da entidade do botão, ou 0.

Exemplo

lua
local b = caffeine.ui.createButton(canvas, 'Play', { x = 20, y = 60 })

hitTest#

Lua: caffeine.ui.hitTest

text
hitTest(sx, sy) -> integer

Encontra o elemento de UI numa posição do ecrã.

ParâmetrosTipoDescrição
sxnumberx do ecrã.
synumbery do ecrã.

Devolve: integer. Id da entidade de UI sob o ponto, ou 0.

Exemplo

lua
local hit = caffeine.ui.hitTest(100, 80)

setLabel#

Lua: caffeine.ui.setLabel

text
setLabel(entity, text)

Muda o texto de um rótulo. Não faz nada se a entidade não tiver rótulo.

ParâmetrosTipoDescrição
entityintegerId da entidade.
textstringNovo texto (até 255 caracteres).

Devolve: nada

Exemplo

lua
caffeine.ui.setLabel(l, 'Score: 10')

setProgress#

Lua: caffeine.ui.setProgress

text
setProgress(entity, normalized)

Define uma barra de progresso entre o mínimo e o máximo. Não faz nada se a entidade não tiver barra de progresso.

ParâmetrosTipoDescrição
entityintegerId da entidade.
normalizednumber0..1; é limitado.

Devolve: nada

Exemplo

lua
caffeine.ui.setProgress(bar, 0.5)