Caffeine

Efeitos

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

Componentes de efeitos em entidades: partículas, luz volumétrica, superfícies refletoras, sombreados de material e nevoeiro.

Todos os namespaces

Namespace: caffeine.effects

set#

Lua: caffeine.effects.set

text
set(entity, kind, quality) -> boolean

Atribui um tipo de efeito e uma qualidade à entidade.

ParâmetrosTipoDescrição
entitynumberId da entidade.
kindnumber0 Particles, 1 VolumetricLight, 2 ReflectiveSurface, 3 MaterialShade, 4 Fog; limitado a 4.
qualitynumber0 Performance, 1 Balanced, 2 Quality; limitado a 2.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.effects.set(e, 0, 1)

particle#

Lua: caffeine.effects.particle

text
particle(entity, domain) -> boolean

Transforma a entidade num emissor de partículas para o domínio indicado.

ParâmetrosTipoDescrição
entitynumberId da entidade.
domainnumber0 Both, 1 2D, 2 3D; limitado a 2.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.effects.particle(e, 2)

particleParams#

Lua: caffeine.effects.particleParams

text
particleParams(entity, rate, lifetime, maxParticles, startSize, endSize, gravityY) -> boolean

Define os parâmetros do emissor de partículas.

ParâmetrosTipoDescrição
entitynumberId da entidade.
ratenumberTaxa de emissão.
lifetimenumberTempo de vida da partícula.
maxParticlesnumberMáximo de partículas vivas.
startSizenumberTamanho ao nascer.
endSizenumberTamanho ao fim da vida.
gravityYnumberGravidade vertical.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.effects.particleParams(e, 30, 2, 200, 0.2, 0.0, -1)

volumetric#

Lua: caffeine.effects.volumetric

text
volumetric(entity) -> boolean

Torna a entidade uma luz volumétrica e garante a respetiva malha de volume.

ParâmetrosTipoDescrição
entitynumberId da entidade.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.effects.volumetric(lamp)

volumetricShape#

Lua: caffeine.effects.volumetricShape

text
volumetricShape(entity, shape, columns, rows) -> boolean

Define a forma de uma luz volumétrica.

ParâmetrosTipoDescrição
entitynumberId da entidade.
shapenumber0 Sphere, 1 Cone, 2 Box, 3 Cylinder, 4 Window; limitado a 4.
columnsnumberNúmero de colunas.
rowsnumberNúmero de linhas.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.effects.volumetricShape(lamp, 1, 8, 8)

fog#

Lua: caffeine.effects.fog

text
fog(entity, domain, style) -> boolean

Transforma a entidade num efeito de nevoeiro com o estilo indicado.

ParâmetrosTipoDescrição
entitynumberId da entidade.
domainnumber0 Both, 1 2D, 2 3D; limitado a 2.
stylenumber0 Fog, 1 Dust, 2 Mist, 3 Smoke; limitado a 3.

Devolve: boolean. true em caso de sucesso.

Exemplo

lua
caffeine.effects.fog(e, 2, 2)