Seleção
Encontrar a entidade sob um ponto, uma posição do ecrã, o rato ou um raio 3D, e registar seletores personalizados.
Namespace: caffeine.pick
world#
Lua: caffeine.pick.world
world(wx, wy) -> integer
Escolhe a entidade sob uma posição 2D do mundo.
| Parâmetros | Tipo | Descrição |
|---|---|---|
wx | number | x do mundo. |
wy | number | y do mundo. |
Devolve: integer. Id da entidade, ou 0 se nada for atingido.
Exemplo
local e = caffeine.pick.world(3, 4)
screen#
Lua: caffeine.pick.screen
screen(sx, sy) -> integer
Converte uma posição do ecrã para o mundo usando a câmara do modo de jogo e escolhe a entidade aí.
| Parâmetros | Tipo | Descrição |
|---|---|---|
sx | number | x do ecrã. |
sy | number | y do ecrã. |
Devolve: integer. Id da entidade, ou 0 se nada for atingido.
Exemplo
local e = caffeine.pick.screen(400, 300)
atMouse#
Lua: caffeine.pick.atMouse
atMouse() -> integer
Escolhe a entidade sob o cursor do rato; 0 sem mundo ou entrada.
Devolve: integer. Id da entidade, ou 0 se nada for atingido.
Exemplo
local e = caffeine.pick.atMouse()
screenToWorld#
Lua: caffeine.pick.screenToWorld
screenToWorld(sx, sy) -> table
Converte uma posição do ecrã numa posição 2D do mundo.
| Parâmetros | Tipo | Descrição |
|---|---|---|
sx | number | x do ecrã. |
sy | number | y do ecrã. |
Devolve: table. {x, y} em unidades do mundo.
Exemplo
local w = caffeine.pick.screenToWorld(400, 300)
register#
Lua: caffeine.pick.register
register(fn) -> integer
Regista um seletor personalizado consultado pelas pesquisas de seleção.
| Parâmetros | Tipo | Descrição |
|---|---|---|
fn | function | Chamada como fn(worldX, worldY); devolva um id de entidade (maior que 0) para um acerto, ou false/nil para nenhum. |
Devolve: integer. Handle para unregister.
Exemplo
local h = caffeine.pick.register(function(x, y) return 0 end)
unregister#
Lua: caffeine.pick.unregister
unregister(handle)
Remove um seletor personalizado.
| Parâmetros | Tipo | Descrição |
|---|---|---|
handle | integer | Handle devolvido por register. |
Devolve: nada
Exemplo
caffeine.pick.unregister(h)
query#
Lua: caffeine.pick.query
query(wx, wy) -> table
Pesquisa de seleção completa numa posição do mundo, incluindo seletores personalizados.
| Parâmetros | Tipo | Descrição |
|---|---|---|
wx | number | x do mundo. |
wy | number | y do mundo. |
Devolve: table. {kind = "entity", entityId}, {kind = "custom", customId} ou {kind = "none"}; vazia sem mundo.
Exemplo
local hit = caffeine.pick.query(3, 4)
if hit.kind == 'entity' then caffeine.debug.log(hit.entityId) end
raycast#
Lua: caffeine.pick.raycast
raycast(origin, dir) -> integer
Lança um raio 3D e devolve a entidade atingida.
| Parâmetros | Tipo | Descrição |
|---|---|---|
origin | table | {x, y, z}; partes em falta são 0. |
dir | table | Direção {x, y, z}; é normalizada por si (z = 1 por omissão). |
Devolve: integer. Id da entidade, ou 0 se nada for atingido.
Exemplo
local e = caffeine.pick.raycast({x=0,y=1,z=0}, {x=0,y=0,z=1})