Componente
Acesso genérico a todos os componentes descritos no registo de reflexão: listar, adicionar, remover, ler e escrever campos pelo nome.
Namespace: caffeine.component · Dryad prefix: caffeine_component_
list#
Lua: caffeine.component.list · Dryad: caffeine_component_list
list() -> table
Lista todos os tipos de componente descritos no registo de reflexão, com os campos. Em Dryad devolve apenas os nomes.
Devolve: table. Lista de {name, id, fields}; cada campo tem name, kind, min, max e options (enums).
Exemplo
for _, c in ipairs(caffeine.component.list()) do caffeine.debug.log(c.name) end
names#
Lua: caffeine.component.names · Dryad: caffeine_component_names
names(entity) -> table
Lista os componentes que a entidade tem. Dá erro se a entidade não existir.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
Devolve: table. Lista de nomes de componentes.
Exemplo
local names = caffeine.component.names(e)
has#
Lua: caffeine.component.has · Dryad: caffeine_component_has
has(entity, name) -> boolean
Verifica se uma entidade tem um componente. Dá erro para um nome de componente desconhecido.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
Devolve: boolean. Verdadeiro se a entidade tiver o componente.
Exemplo
if caffeine.component.has(e, 'Rigid Body 3D') then end
add#
Lua: caffeine.component.add · Dryad: caffeine_component_add
add(entity, name) -> boolean
Adiciona um componente com valores por omissão; não faz nada se a entidade já o tiver. Em Dryad devolve false e regista um erro em caso de falha.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.component.add(e, 'Rigid Body 3D')
remove#
Lua: caffeine.component.remove · Dryad: caffeine_component_remove
remove(entity, name) -> boolean
Remove um componente de uma entidade.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
Devolve: boolean. Verdadeiro se o componente foi removido, falso se a entidade não o tinha.
Exemplo
caffeine.component.remove(e, 'Rigid Body 3D')
get#
Lua: caffeine.component.get · Dryad: caffeine_component_get
get(entity, name) -> table|nil
Lê todos os campos de um componente. Os vetores são {x, y, z}; cores e vetores 4D também têm r, g, b, a; os enums são nomes de opção.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
Devolve: table. Tabela com todos os campos, ou nil se a entidade não tiver o componente.
Exemplo
local rb = caffeine.component.get(e, 'Rigid Body 3D')
getField#
Lua: caffeine.component.getField · Dryad: caffeine_component_get_field
getField(entity, name, field) -> any
Lê um campo. Dá erro para componente ou campo desconhecido, ou se a entidade não tiver o componente (o Dryad regista o erro e devolve null).
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
field | string | Nome do campo. |
Devolve: any. O valor do campo.
Exemplo
local mass = caffeine.component.getField(e, 'Rigid Body 3D', 'Mass')
setField#
Lua: caffeine.component.setField · Dryad: caffeine_component_set_field
setField(entity, name, field, value)
Escreve um campo. A entidade já tem de ter o componente (use caffeine.component.add); um tipo de valor errado provoca erro.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
field | string | Nome do campo. |
value | any | Novo valor: número, booleano, texto, nome ou índice de opção de enum, ou tabela de vetor. |
Devolve: nada
Exemplo
caffeine.component.setField(e, 'Rigid Body 3D', 'Mass', 7.5)
set#
Lua: caffeine.component.set · Dryad: caffeine_component_set
set(entity, name, values)
Adiciona o componente se não existir e escreve os campos indicados.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
values | table | Mapa de nome de campo para valor; os campos omitidos mantêm o valor. |
Devolve: nada
Exemplo
caffeine.component.set(e, 'Rigid Body 3D', { Mass = 3 })
caffeine_component_get_number#
Lua: indisponível · Dryad: caffeine_component_get_number
caffeine_component_get_number(entity, name, field[, index]) -> number
Apenas Dryad: lê um campo numérico, booleano ou de enum, ou uma parte de um vetor.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
field | string | Nome do campo. |
index | integer | Parte do vetor (0 = x); por omissão 0. |
Devolve: number. Número; inteiros, índices de enum e booleanos voltam como inteiro/booleano. null em caso de erro.
Exemplo
let mass = caffeine_component_get_number(entity, "Rigid Body 3D", "Mass");
caffeine_component_set_number#
Lua: indisponível · Dryad: caffeine_component_set_number
caffeine_component_set_number(entity, name, field, value[, index]) -> boolean
Apenas Dryad: escreve um campo numérico, booleano ou índice de enum, ou uma parte de um vetor.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
field | string | Nome do campo. |
value | number | Número (ou booleano). |
index | integer | Parte do vetor (0 = x); por omissão 0. |
Devolve: boolean. Verdadeiro em caso de sucesso.
Exemplo
caffeine_component_set_number(entity, "Rigid Body 3D", "Mass", 7.5);
caffeine_component_set_vec#
Lua: indisponível · Dryad: caffeine_component_set_vec
caffeine_component_set_vec(entity, name, field, x, y[, z[, w]]) -> boolean
Apenas Dryad: escreve um campo inteiro de vetor ou cor a partir das suas partes.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
field | string | Nome do campo. |
x | number | Primeira parte. |
y | number | Segunda parte. |
z | number | Terceira parte (opcional). |
w | number | Quarta parte (opcional). |
Devolve: boolean. Verdadeiro se todas as partes foram escritas.
Exemplo
caffeine_component_set_vec(entity, "Position 3D", "Position", 4, 5, 6);
caffeine_component_get_text#
Lua: indisponível · Dryad: caffeine_component_get_text
caffeine_component_get_text(entity, name, field) -> string
Apenas Dryad: lê um campo de texto ou o nome de uma opção de enum.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
field | string | Nome do campo. |
Devolve: string. Texto ou rótulo de enum; null em caso de erro.
Exemplo
let kind = caffeine_component_get_text(entity, "Mesh Filter", "Primitive");
caffeine_component_set_text#
Lua: indisponível · Dryad: caffeine_component_set_text
caffeine_component_set_text(entity, name, field, text) -> boolean
Apenas Dryad: escreve um campo de texto ou define um enum pelo nome da opção.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | integer | Id da entidade. |
name | string | Nome do componente, como listado por `caffeine.component.list()`. |
field | string | Nome do campo. |
text | string | Texto ou nome de opção de enum. |
Devolve: boolean. Verdadeiro em caso de sucesso.
Exemplo
caffeine_component_set_text(entity, "Mesh Filter", "Primitive", "Cone");