Caffeine

Animação

Reference Rendering Última atualização: Lua 7 · Dryad 0

Controlo de animação por clips, máquina de estados, malhas com skin e sprite sheets.

Todos os namespaces

Namespace: caffeine.animation

playClip#

Lua: caffeine.animation.playClip

text
playClip(entity, path) -> boolean

Reproduz um clip de animação na entidade.

ParâmetrosTipoDescrição
entitynumberId da entidade.
pathstringCaminho do asset do clip.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.animation.playClip(e, 'clips/run.anim')

playSkinnedClip#

Lua: caffeine.animation.playSkinnedClip

text
playSkinnedClip(entity, meshPath, clipIndex) -> boolean

Reproduz um clip de uma malha com skin pelo índice.

ParâmetrosTipoDescrição
entitynumberId da entidade.
meshPathstringCaminho da malha com skin.
clipIndexnumberÍndice do clip na malha.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.animation.playSkinnedClip(e, 'models/hero.glb', 0)

playState#

Lua: caffeine.animation.playState

text
playState(entity, state) -> boolean

Muda o animator para um estado com nome.

ParâmetrosTipoDescrição
entitynumberId da entidade.
statestringNome do estado.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.animation.playState(e, 'Idle')

setBool#

Lua: caffeine.animation.setBool

text
setBool(entity, name, value) -> boolean

Define um parâmetro booleano do animator.

ParâmetrosTipoDescrição
entitynumberId da entidade.
namestringNome do parâmetro.
valuebooleanNovo valor.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.animation.setBool(e, 'grounded', true)

setFloat#

Lua: caffeine.animation.setFloat

text
setFloat(entity, name, value) -> boolean

Define um parâmetro float do animator.

ParâmetrosTipoDescrição
entitynumberId da entidade.
namestringNome do parâmetro.
valuenumberNovo valor.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.animation.setFloat(e, 'speed', 3.5)

setTrigger#

Lua: caffeine.animation.setTrigger

text
setTrigger(entity, name) -> boolean

Dispara um trigger do animator.

ParâmetrosTipoDescrição
entitynumberId da entidade.
namestringNome do trigger.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.animation.setTrigger(e, 'jump')

setSpriteSheet#

Lua: caffeine.animation.setSpriteSheet

text
setSpriteSheet(entity, columns, rows, frameCount) -> boolean

Configura a animação por sprite sheet na entidade.

ParâmetrosTipoDescrição
entitynumberId da entidade.
columnsnumberColunas na folha.
rowsnumberLinhas na folha.
frameCountnumberNúmero total de frames.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.animation.setSpriteSheet(e, 4, 4, 16)