Colshapes

Uma colshape é um volume invisível. Ela não aparece no jogo, não bloqueia nada e não colide com ninguém — a única coisa que ela faz é delimitar uma região do mapa para que você possa perguntar “isso aqui está dentro?”.

O uso é sempre parecido: você cria a forma uma vez, guarda o handle numa variável e trabalha em cima dele. Como uma colshape é um elemento, ela pode ser passada como elemento anexado em addEventHandler — assim o handler só roda para aquela forma — e é removida com destroyElement quando não for mais necessária.

Para descobrir o que está dentro da área você tem isInsideColShape nesta página, e isElementWithinColShape / getElementsWithinColShape nas funções de elemento.

As formas disponíveis

Função	Forma	O que a posição significa	O que define o tamanho
createColCircle	Círculo	centro em X e Y	raio. O Z é ignorado, o círculo é infinitamente alto.
createColCuboid	Caixa	canto de menor X, Y e Z	tamanhoX, tamanhoY e tamanhoZ, contados a partir desse canto.
createColSphere	Esfera	centro	raio.
createColRectangle	Retângulo	canto de menor X e Y	tamanhoX e tamanhoY. O Z é ignorado.
createColPolygon	Polígono	centro da área — não é um vértice	os vértices que você lista depois. Sem limite de altura por padrão.
createColTube	Tubo	centro da base	raio e altura, crescendo para cima.

Sempre que uma função recebe um par X, Y ou um trio X, Y, Z, um Vector2 ou Vector3 serve no lugar — createColSphere(Vector3(x, y, z), 10) é o mesmo que createColSphere(x, y, z, 10). Strings numéricas são aceitas como números.

Nota

Qualquer dimensão negativa passada na criação vira 0.1 — exceto o tamanho em Z de createColCuboid no cliente, que fica como foi passado. Nos setters (setColShapeRadius, setColShapeSize) um valor negativo vira 0.

Como as falhas aparecem

Nem todas as falhas aparecem do mesmo jeito:

• As funções createCol*, getColShapeType e isInsideColShape escrevem um aviso no console de debug e devolvem false quando falta um argumento ou ele tem o tipo errado (ou, nas duas últimas, quando o primeiro argumento não é uma colshape válida).
• Todas as outras funções desta página geram um erro Lua — interrompendo o código que as chamou — quando o primeiro argumento não é uma colshape, quando a forma já foi destruída, quando ela é de um tipo que não serve para aquela função (pedir o raio de um retângulo, por exemplo), ou quando falta um número necessário ou ele é inválido.
• Um índice de vértice 0 ou depois do último vértice só gera um aviso e false (um índice negativo é erro).

Estas 19 funções existem no servidor e no cliente. Você pode usá-las em scripts declarados em server_files, client_files ou shared_files.

createColCircle Cria um círculo no plano do mapa, sem limite de altura.

createColCuboid Cria uma caixa alinhada aos eixos.

createColSphere Cria uma esfera.

createColRectangle Cria um retângulo no plano do mapa, sem limite de altura.

createColPolygon Cria uma área com o formato que você quiser, descrita por uma lista de vértices.

createColTube Cria um cilindro em pé, com a base na posição informada.

getColShapeType Descobre qual é o formato de uma colshape.

isInsideColShape Verifica se uma posição está dentro da forma.

getColShapeRadius Lê o raio de um círculo, esfera ou tubo.

setColShapeRadius Altera o raio de um círculo, esfera ou tubo.

getColShapeSize Lê as dimensões de um retângulo, caixa ou tubo.

setColShapeSize Altera as dimensões de um retângulo, caixa ou tubo.

getColPolygonPoints Lista todos os vértices de um polígono.

getColPolygonPointPosition Lê a posição de um vértice específico.

setColPolygonPointPosition Move um vértice existente.

addColPolygonPoint Acrescenta um vértice ao polígono.

removeColPolygonPoint Remove um vértice do polígono.

getColPolygonHeight Lê os limites de altura de um polígono.

setColPolygonHeight Define entre quais alturas o polígono vale.