Caffeine

Mundo

Reference Core Última atualização: Lua 17 · Dryad 13

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.

Todos os namespaces

Namespace: caffeine.world · Dryad prefix: caffeine_world_

create#

Lua: caffeine.world.create · Dryad: caffeine_world_create

text
create() -> integer

Cria uma entidade com o nome "LuaEntity".

Devolve: integer. O id da nova entidade, ou 0 se não houver mundo.

Exemplo

lua
local e = caffeine.world.create()

destroy#

Lua: caffeine.world.destroy · Dryad: caffeine_world_destroy

text
destroy(entity)

Destrói uma entidade. Não faz nada se não houver mundo.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: nada

Exemplo

lua
caffeine.world.destroy(e)

hasComponent#

Lua: caffeine.world.hasComponent

text
hasComponent(entity, type) -> boolean

Verifica um de quatro tipos de componente incorporados. "Transform" também é verdadeiro para Position3D. Para outros componentes use caffeine.component.has.

ParâmetrosTipoDescrição
entityintegerId da entidade.
typestringUm de "Transform", "Sprite", "RigidBody2D", "Collider2D".

Devolve: boolean. Verdadeiro se a entidade o tiver; falso para qualquer outro nome.

Exemplo

lua
if caffeine.world.hasComponent(e, 'Sprite') then end

getTransform#

Lua: caffeine.world.getTransform

text
getTransform(entity) -> table

Lê a posição da entidade (de Position3D ou Transform); a rotação e a escala vêm de Transform.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: table. {x, y, z, rotation, scaleX, scaleY}; por omissão 0 e escala 1.

Exemplo

lua
local t = caffeine.world.getTransform(e)
caffeine.debug.log(t.x .. ', ' .. t.y)

setTransform#

Lua: caffeine.world.setTransform

text
setTransform(entity, t)

Escreve a posição (e rotação/escala num Transform). Cria um Transform se a entidade não tiver Transform nem Position3D.

ParâmetrosTipoDescrição
entityintegerId da entidade.
ttableCampos x, y, z, rotation, scaleX, scaleY; os campos em falta mantêm o valor atual.

Devolve: nada

Exemplo

lua
caffeine.world.setTransform(e, { x = 1, y = 2 })

addTransform#

Lua: caffeine.world.addTransform

text
addTransform(entity, t)

Alias de caffeine.world.setTransform.

ParâmetrosTipoDescrição
entityintegerId da entidade.
ttableOs mesmos campos que setTransform.

Devolve: nada

Exemplo

lua
caffeine.world.addTransform(e, { x = 0, y = 0 })

distanceTo#

Lua: caffeine.world.distanceTo · Dryad: caffeine_world_distance

text
distanceTo(a, b) -> number

Distância em linha reta entre duas entidades.

ParâmetrosTipoDescrição
aintegerId da primeira entidade.
bintegerId da segunda entidade.

Devolve: number. Distância em unidades do mundo; 1e9 se alguma entidade não tiver posição ou não houver mundo.

Exemplo

lua
local d = caffeine.world.distanceTo(e, target)

findNearest#

Lua: caffeine.world.findNearest

text
findNearest(from, maxDist) -> integer

Encontra a entidade mais próxima, com Position3D ou Transform, dentro de maxDist.

ParâmetrosTipoDescrição
fromintegerEntidade à volta da qual procurar.
maxDistnumberRaio de pesquisa; tem de ser maior que 0.

Devolve: integer. Id da entidade mais próxima com posição, ou 0.

Exemplo

lua
local near = caffeine.world.findNearest(e, 10)

setYawPitch#

Lua: caffeine.world.setYawPitch

text
setYawPitch(entity, yaw, pitch)

Define uma rotação 3D (quaternião de Rotation3D, roll 0). Se a entidade tiver Transform, a rotação x/y também é escrita em graus.

ParâmetrosTipoDescrição
entityintegerId da entidade.
yawnumberGuinada em radianos.
pitchnumberInclinação em radianos.

Devolve: nada

Exemplo

lua
caffeine.world.setYawPitch(e, caffeine.math.radians(90), 0)

getRigidBody2D#

Lua: caffeine.world.getRigidBody2D

text
getRigidBody2D(entity) -> table

Lê o corpo rígido 2D de uma entidade.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: table. {mass, restitution, friction, linearDamping, isKinematic, lockRotation, velocityX, velocityY}; vazia se não houver RigidBody2D.

Exemplo

lua
local rb = caffeine.world.getRigidBody2D(e)

setRigidBody2D#

Lua: caffeine.world.setRigidBody2D

text
setRigidBody2D(entity, t)

Adiciona um RigidBody2D se não existir e escreve-o. Os campos omitidos voltam aos valores por omissão indicados, exceto velocityX/velocityY, que mantêm o valor.

ParâmetrosTipoDescrição
entityintegerId da entidade.
ttableCampos mass (1), restitution (0.3), friction (0.5), linearDamping (0), isKinematic (false), lockRotation (true), velocityX, velocityY.

Devolve: nada

Exemplo

lua
caffeine.world.setRigidBody2D(e, { mass = 2, friction = 0.8 })

getVelocity#

Lua: caffeine.world.getVelocity

text
getVelocity(entity) -> table

Lê a velocidade 2D do corpo rígido.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: table. {x, y}; 0 se não houver RigidBody2D.

Exemplo

lua
local v = caffeine.world.getVelocity(e)

setVelocity#

Lua: caffeine.world.setVelocity

text
setVelocity(entity, v)

Define a velocidade 2D (adiciona um RigidBody2D se não existir) e acorda o corpo.

ParâmetrosTipoDescrição
entityintegerId da entidade.
vtable{x, y}; os campos em falta mantêm o valor atual.

Devolve: nada

Exemplo

lua
caffeine.world.setVelocity(e, { x = 5, y = 0 })

getSprite#

Lua: caffeine.world.getSprite

text
getSprite(entity) -> table

Lê o nome e o índice de frame do sprite.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: table. {name, frameIndex}; vazia se não houver Sprite.

Exemplo

lua
local s = caffeine.world.getSprite(e)

setSprite#

Lua: caffeine.world.setSprite

text
setSprite(entity, t)

Adiciona um Sprite se não existir e escreve o nome e o índice de frame.

ParâmetrosTipoDescrição
entityintegerId da entidade.
ttableCampos name (texto, por omissão "") e frameIndex (por omissão 0).

Devolve: nada

Exemplo

lua
caffeine.world.setSprite(e, { name = 'hero', frameIndex = 2 })

addSprite#

Lua: caffeine.world.addSprite

text
addSprite(entity, t)

Alias de caffeine.world.setSprite.

ParâmetrosTipoDescrição
entityintegerId da entidade.
ttableOs mesmos campos que setSprite.

Devolve: nada

Exemplo

lua
caffeine.world.addSprite(e, { name = 'hero' })

addParticleEmitter#

Lua: caffeine.world.addParticleEmitter

text
addParticleEmitter(entity, t)

Adiciona um componente emissor de partículas à entidade (e um Transform se não existir).

ParâmetrosTipoDescrição
entityintegerId da entidade.
ttableCampos maxParticles (100), emissionRate (10), lifetime (2), startSize (1), endSize (0), startColor e endColor ({r,g,b,a} em 0..1).

Devolve: nada

Exemplo

lua
caffeine.world.addParticleEmitter(e, { emissionRate = 30, lifetime = 1.5 })

caffeine_world_is_alive#

Lua: indisponível · Dryad: caffeine_world_is_alive

text
caffeine_world_is_alive(entity) -> boolean

Apenas Dryad: verifica se um id ainda corresponde a uma entidade viva.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: boolean. Verdadeiro se a entidade existir.

Exemplo

dryad
function onUpdate(entity, dt) {
  if (caffeine_world_is_alive(entity)) { caffeine_translate(entity, 0, dt, 0); }
}

caffeine_set_position#

Lua: indisponível · Dryad: caffeine_set_position

text
caffeine_set_position(entity, x, y, z)

Apenas Dryad: define a posição de uma entidade (Position3D e/ou Transform; é criado um Transform se não tiver nenhum).

ParâmetrosTipoDescrição
entityintegerId da entidade.
xnumberX.
ynumberY.
znumberZ.

Devolve: nada

Exemplo

dryad
caffeine_set_position(entity, 0, 1, 0);

caffeine_translate#

Lua: indisponível · Dryad: caffeine_translate

text
caffeine_translate(entity, dx, dy, dz)

Apenas Dryad: move uma entidade por um deslocamento.

ParâmetrosTipoDescrição
entityintegerId da entidade.
dxnumberDeslocamento em X.
dynumberDeslocamento em Y.
dznumberDeslocamento em Z.

Devolve: nada

Exemplo

dryad
caffeine_translate(entity, 1 * dt, 0, 0);

caffeine_get_position_x#

Lua: indisponível · Dryad: caffeine_get_position_x

text
caffeine_get_position_x(entity) -> number

Apenas Dryad: lê a posição X de uma entidade.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: number. Posição em X; 0 se a entidade não tiver.

Exemplo

dryad
let p = caffeine_get_position_x(entity);

caffeine_get_position_y#

Lua: indisponível · Dryad: caffeine_get_position_y

text
caffeine_get_position_y(entity) -> number

Apenas Dryad: lê a posição Y de uma entidade.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: number. Posição em Y; 0 se a entidade não tiver.

Exemplo

dryad
let p = caffeine_get_position_y(entity);

caffeine_get_position_z#

Lua: indisponível · Dryad: caffeine_get_position_z

text
caffeine_get_position_z(entity) -> number

Apenas Dryad: lê a posição Z de uma entidade.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: number. Posição em Z; 0 se a entidade não tiver.

Exemplo

dryad
let p = caffeine_get_position_z(entity);

caffeine_set_scale#

Lua: indisponível · Dryad: caffeine_set_scale

text
caffeine_set_scale(entity, x, y, z)

Apenas Dryad: define a escala de uma entidade (Scale3D ou Transform).

ParâmetrosTipoDescrição
entityintegerId da entidade.
xnumberEscala em X.
ynumberEscala em Y.
znumberEscala em Z.

Devolve: nada

Exemplo

dryad
caffeine_set_scale(entity, 2, 2, 2);

caffeine_get_scale_x#

Lua: indisponível · Dryad: caffeine_get_scale_x

text
caffeine_get_scale_x(entity) -> number

Apenas Dryad: lê a escala X de uma entidade.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: number. Escala em X; 1 se a entidade não tiver.

Exemplo

dryad
let s = caffeine_get_scale_x(entity);

caffeine_get_scale_y#

Lua: indisponível · Dryad: caffeine_get_scale_y

text
caffeine_get_scale_y(entity) -> number

Apenas Dryad: lê a escala Y de uma entidade.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: number. Escala em Y; 1 se a entidade não tiver.

Exemplo

dryad
let s = caffeine_get_scale_y(entity);

caffeine_get_scale_z#

Lua: indisponível · Dryad: caffeine_get_scale_z

text
caffeine_get_scale_z(entity) -> number

Apenas Dryad: lê a escala Z de uma entidade.

ParâmetrosTipoDescrição
entityintegerId da entidade.

Devolve: number. Escala em Z; 1 se a entidade não tiver.

Exemplo

dryad
let s = caffeine_get_scale_z(entity);