Caffeine

Seleção

Reference Input Última atualização: Lua 8 · Dryad 0

Encontrar a entidade sob um ponto, uma posição do ecrã, o rato ou um raio 3D, e registar seletores personalizados.

Todos os namespaces

Namespace: caffeine.pick

world#

Lua: caffeine.pick.world

text
world(wx, wy) -> integer

Escolhe a entidade sob uma posição 2D do mundo.

ParâmetrosTipoDescrição
wxnumberx do mundo.
wynumbery do mundo.

Devolve: integer. Id da entidade, ou 0 se nada for atingido.

Exemplo

lua
local e = caffeine.pick.world(3, 4)

screen#

Lua: caffeine.pick.screen

text
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âmetrosTipoDescrição
sxnumberx do ecrã.
synumbery do ecrã.

Devolve: integer. Id da entidade, ou 0 se nada for atingido.

Exemplo

lua
local e = caffeine.pick.screen(400, 300)

atMouse#

Lua: caffeine.pick.atMouse

text
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

lua
local e = caffeine.pick.atMouse()

screenToWorld#

Lua: caffeine.pick.screenToWorld

text
screenToWorld(sx, sy) -> table

Converte uma posição do ecrã numa posição 2D do mundo.

ParâmetrosTipoDescrição
sxnumberx do ecrã.
synumbery do ecrã.

Devolve: table. {x, y} em unidades do mundo.

Exemplo

lua
local w = caffeine.pick.screenToWorld(400, 300)

register#

Lua: caffeine.pick.register

text
register(fn) -> integer

Regista um seletor personalizado consultado pelas pesquisas de seleção.

ParâmetrosTipoDescrição
fnfunctionChamada 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

lua
local h = caffeine.pick.register(function(x, y) return 0 end)

unregister#

Lua: caffeine.pick.unregister

text
unregister(handle)

Remove um seletor personalizado.

ParâmetrosTipoDescrição
handleintegerHandle devolvido por register.

Devolve: nada

Exemplo

lua
caffeine.pick.unregister(h)

query#

Lua: caffeine.pick.query

text
query(wx, wy) -> table

Pesquisa de seleção completa numa posição do mundo, incluindo seletores personalizados.

ParâmetrosTipoDescrição
wxnumberx do mundo.
wynumbery do mundo.

Devolve: table. {kind = "entity", entityId}, {kind = "custom", customId} ou {kind = "none"}; vazia sem mundo.

Exemplo

lua
local hit = caffeine.pick.query(3, 4)
if hit.kind == 'entity' then caffeine.debug.log(hit.entityId) end

raycast#

Lua: caffeine.pick.raycast

text
raycast(origin, dir) -> integer

Lança um raio 3D e devolve a entidade atingida.

ParâmetrosTipoDescrição
origintable{x, y, z}; partes em falta são 0.
dirtableDireção {x, y, z}; é normalizada por si (z = 1 por omissão).

Devolve: integer. Id da entidade, ou 0 se nada for atingido.

Exemplo

lua
local e = caffeine.pick.raycast({x=0,y=1,z=0}, {x=0,y=0,z=1})