Efeitos
Componentes de efeitos em entidades: partículas, luz volumétrica, superfícies refletoras, sombreados de material e nevoeiro.
Namespace: caffeine.effects
set#
Lua: caffeine.effects.set
set(entity, kind, quality) -> boolean
Atribui um tipo de efeito e uma qualidade à entidade.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
kind | number | 0 Particles, 1 VolumetricLight, 2 ReflectiveSurface, 3 MaterialShade, 4 Fog; limitado a 4. |
quality | number | 0 Performance, 1 Balanced, 2 Quality; limitado a 2. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.effects.set(e, 0, 1)
particle#
Lua: caffeine.effects.particle
particle(entity, domain) -> boolean
Transforma a entidade num emissor de partículas para o domínio indicado.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
domain | number | 0 Both, 1 2D, 2 3D; limitado a 2. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.effects.particle(e, 2)
particleParams#
Lua: caffeine.effects.particleParams
particleParams(entity, rate, lifetime, maxParticles, startSize, endSize, gravityY) -> boolean
Define os parâmetros do emissor de partículas.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
rate | number | Taxa de emissão. |
lifetime | number | Tempo de vida da partícula. |
maxParticles | number | Máximo de partículas vivas. |
startSize | number | Tamanho ao nascer. |
endSize | number | Tamanho ao fim da vida. |
gravityY | number | Gravidade vertical. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.effects.particleParams(e, 30, 2, 200, 0.2, 0.0, -1)
volumetric#
Lua: caffeine.effects.volumetric
volumetric(entity) -> boolean
Torna a entidade uma luz volumétrica e garante a respetiva malha de volume.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.effects.volumetric(lamp)
volumetricShape#
Lua: caffeine.effects.volumetricShape
volumetricShape(entity, shape, columns, rows) -> boolean
Define a forma de uma luz volumétrica.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
shape | number | 0 Sphere, 1 Cone, 2 Box, 3 Cylinder, 4 Window; limitado a 4. |
columns | number | Número de colunas. |
rows | number | Número de linhas. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.effects.volumetricShape(lamp, 1, 8, 8)
fog#
Lua: caffeine.effects.fog
fog(entity, domain, style) -> boolean
Transforma a entidade num efeito de nevoeiro com o estilo indicado.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
domain | number | 0 Both, 1 2D, 2 3D; limitado a 2. |
style | number | 0 Fog, 1 Dust, 2 Mist, 3 Smoke; limitado a 3. |
Devolve: boolean. true em caso de sucesso.
Exemplo
caffeine.effects.fog(e, 2, 2)