Caffeine

Referência da API de scripting

Reference Última atualização:

Todas as funções que o engine expõe aos scripts, agrupadas como uma biblioteca padrão. Os nomes Lua aparecem como caffeine.<namespace>.<função>; o native Dryad é mostrado quando existe.

232 funções em 29 namespaces.

Core#

Namespace Funções Descrição
Componente 14 Acesso genérico a todos os componentes descritos no registo de reflexão: listar, adicionar, remover, ler e escrever campos pelo nome.
Núcleo 1 Auxiliares de topo da tabela caffeine.
Depuração 3 Registo na consola do motor.
Entidade 5 Nomes e procura. As entidades são ids numéricos; o nome é opcional e não tem de ser único.
Hierarquia 6 Ligações pai e filho entre entidades. O transform do filho compõe-se com o do pai.
Matemática 23 Tabelas de vetor ({x, y[, z]}), auxiliares escalares e conversão de ângulos. Define também as constantes caffeine.math.pi e caffeine.math.epsilon (1e-5).
Aleatório 5 Um gerador determinístico: a mesma semente dá sempre a mesma sequência, em todas as plataformas.
Tempo 11 O relógio de jogo: tempo de frame com e sem escala, o passo fixo, pausa e a semente aleatória determinística.
Mundo 27 Criar e destruir entidades, movê-las e ler ou escrever transformações, física 2D, sprites e emissores de partículas. O Dryad acrescenta natives de posição e escala.

Input#

Namespace Funções Descrição
Entrada 11 Teclado, eixos e ações mapeados e o rato. O Dryad espelha-os com as natives caffeine_input_*.
Seleção 8 Encontrar a entidade sob um ponto, uma posição do ecrã, o rato ou um raio 3D, e registar seletores personalizados.

Physics#

Namespace Funções Descrição
Física 3D 7 Consultas por raio e forças no mundo 3D Bullet. Tudo é um no-op seguro (false ou nil) quando o host corre sem física 3D. Forças e velocidade só afetam corpos dinâmicos.

Game#

Namespace Funções Descrição
Recursos 1 Ler recursos do projeto a partir de scripts.
Áudio 13 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.
Eventos 3 Um barramento simples de eventos nomeados: subscrever, emitir e cancelar a subscrição.
Estado de jogo 5 Uma pilha opcional de estados de jogo nomeados.
Módulos nativos 2 Carregar e chamar módulos nativos através de JSON.
Cena 4 Mudança entre cenas. O pedido é diferido: o mundo é substituído depois dos scripts do frame atual, por isso pode chamá-lo de qualquer hook. A aplicação runtime trata os pedidos; outros hosts podem não tratar. Uma mudança de cena remove todas as entidades, por isso guarde em caffeine.session os dados de que precisa.
Sessão 5 Um armazenamento chave-valor que sobrevive às mudanças de cena enquanto o jogo corre (pontuação, definições, escolhas). Os valores são números, booleanos ou texto. Não é gravado em disco.

World#

Namespace Funções Descrição
Mapa 1 Ganchos para pedidos de chunks de superfícies de mapa.
Navegação 5 Agentes de navegação: destinos, pontos de patrulha, alvos a seguir e scripts de comportamento.
Procedural 12 Auxiliares de ruído determinístico, streaming de chunks e geração de terreno para mundos procedurais.

Rendering#

Namespace Funções Descrição
Animação 7 Controlo de animação por clips, máquina de estados, malhas com skin e sprite sheets.
Efeitos 6 Componentes de efeitos em entidades: partículas, luz volumétrica, superfícies refletoras, sombreados de material e nevoeiro.
Render forward 6 Funcionalidades do renderer forward por entidade: instancing, iluminação baseada em imagem, oclusão, reflexos e volumétricos.
Partículas 1 Emissão manual de partículas em entidades com um emissor de partículas.
Pós-processamento 29 Efeitos de pós-processamento por entidade, como bloom, vinheta, correção de cor e nevoeiro, com presets e acesso a campos por caminho.

UI#

Namespace Funções Descrição
Desenho 2D 5 Formas 2D de sobreposição em modo imediato (linhas, círculos, retângulos, polilinhas) em espaço de mundo ou de ecrã.
Interface 6 Criar canvases, rótulos e botões, atualizá-los e testar acertos em posições do ecrã.

Como esta página é construída#

Gerada a partir do registo da API no repositório do engine; um teste falha quando um binding não está documentado. Não editar à mão.