Animação
Controlo de animação por clips, máquina de estados, malhas com skin e sprite sheets.
Namespace: caffeine.animation
playClip#
Lua: caffeine.animation.playClip
playClip(entity, path) -> boolean
Reproduz um clip de animação na entidade.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
path | string | Caminho do asset do clip. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.animation.playClip(e, 'clips/run.anim')
playSkinnedClip#
Lua: caffeine.animation.playSkinnedClip
playSkinnedClip(entity, meshPath, clipIndex) -> boolean
Reproduz um clip de uma malha com skin pelo índice.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
meshPath | string | Caminho da malha com skin. |
clipIndex | number | Índice do clip na malha. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.animation.playSkinnedClip(e, 'models/hero.glb', 0)
playState#
Lua: caffeine.animation.playState
playState(entity, state) -> boolean
Muda o animator para um estado com nome.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
state | string | Nome do estado. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.animation.playState(e, 'Idle')
setBool#
Lua: caffeine.animation.setBool
setBool(entity, name, value) -> boolean
Define um parâmetro booleano do animator.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
name | string | Nome do parâmetro. |
value | boolean | Novo valor. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.animation.setBool(e, 'grounded', true)
setFloat#
Lua: caffeine.animation.setFloat
setFloat(entity, name, value) -> boolean
Define um parâmetro float do animator.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
name | string | Nome do parâmetro. |
value | number | Novo valor. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.animation.setFloat(e, 'speed', 3.5)
setTrigger#
Lua: caffeine.animation.setTrigger
setTrigger(entity, name) -> boolean
Dispara um trigger do animator.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
name | string | Nome do trigger. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.animation.setTrigger(e, 'jump')
setSpriteSheet#
Lua: caffeine.animation.setSpriteSheet
setSpriteSheet(entity, columns, rows, frameCount) -> boolean
Configura a animação por sprite sheet na entidade.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
columns | number | Colunas na folha. |
rows | number | Linhas na folha. |
frameCount | number | Número total de frames. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.animation.setSpriteSheet(e, 4, 4, 16)