Interface
Criar canvases, rótulos e botões, atualizá-los e testar acertos em posições do ecrã.
Namespace: caffeine.ui
createCanvas#
Lua: caffeine.ui.createCanvas
createCanvas([w, h]) -> integer
Cria uma entidade de canvas de UI.
| Parâmetros | Tipo | Descrição |
|---|---|---|
w | number | Largura (por omissão 1280). |
h | number | Altura (por omissão 720). |
Devolve: integer. Id da entidade do canvas, ou 0 sem sistema de UI ou mundo.
Exemplo
local canvas = caffeine.ui.createCanvas(1280, 720)
createLabel#
Lua: caffeine.ui.createLabel
createLabel(parent, text, pos) -> integer
Cria um rótulo de texto sob um pai.
| Parâmetros | Tipo | Descrição |
|---|---|---|
parent | integer | Id do canvas ou widget pai. |
text | string | Texto do rótulo. |
pos | table | Posição {x, y}. |
Devolve: integer. Id da entidade do rótulo, ou 0.
Exemplo
local l = caffeine.ui.createLabel(canvas, 'Score: 0', { x = 10, y = 10 })
createButton#
Lua: caffeine.ui.createButton
createButton(parent, text, pos[, w, h]) -> integer
Cria um botão sob um pai.
| Parâmetros | Tipo | Descrição |
|---|---|---|
parent | integer | Id do canvas ou widget pai. |
text | string | Texto do botão. |
pos | table | Posição {x, y}. |
w | number | Largura (por omissão 120). |
h | number | Altura (por omissão 40). |
Devolve: integer. Id da entidade do botão, ou 0.
Exemplo
local b = caffeine.ui.createButton(canvas, 'Play', { x = 20, y = 60 })
hitTest#
Lua: caffeine.ui.hitTest
hitTest(sx, sy) -> integer
Encontra o elemento de UI numa posição do ecrã.
| Parâmetros | Tipo | Descrição |
|---|---|---|
sx | number | x do ecrã. |
sy | number | y do ecrã. |
Devolve: integer. Id da entidade de UI sob o ponto, ou 0.
Exemplo
local hit = caffeine.ui.hitTest(100, 80)
setLabel#
Lua: caffeine.ui.setLabel
setLabel(entity, text)
Muda o texto de um rótulo. Não faz nada se a entidade não tiver rótulo.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
text | string | Novo texto (até 255 caracteres). |
Devolve: nada
Exemplo
caffeine.ui.setLabel(l, 'Score: 10')
setProgress#
Lua: caffeine.ui.setProgress
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âmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
normalized | number | 0..1; é limitado. |
Devolve: nada
Exemplo
caffeine.ui.setProgress(bar, 0.5)