Matemática
Tabelas de vetor ({x, y[, z]}), auxiliares escalares e conversão de ângulos. Define também as constantes caffeine.math.pi e caffeine.math.epsilon (1e-5).
Namespace: caffeine.math
vec2#
Lua: caffeine.math.vec2
vec2(x, y) -> table
Cria uma tabela de vetor 2D.
| Parâmetros | Tipo | Descrição |
|---|---|---|
x | number | X. |
y | number | Y. |
Devolve: table. {x, y}
Exemplo
local v = caffeine.math.vec2(1, 2)
vec3#
Lua: caffeine.math.vec3
vec3(x, y, z) -> table
Cria uma tabela de vetor 3D.
| Parâmetros | Tipo | Descrição |
|---|---|---|
x | number | X. |
y | number | Y. |
z | number | Z. |
Devolve: table. {x, y, z}
Exemplo
local v = caffeine.math.vec3(1, 2, 3)
add#
Lua: caffeine.math.add
add(a, b) -> table
Soma componente a componente de dois vetores.
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | table | Tabela de vetor {x, y[, z]}. |
b | table | Tabela de vetor {x, y[, z]}. |
Devolve: table. Tabela de vetor; só tem z se um operando tiver z.
Exemplo
local p = caffeine.math.add(a, b)
sub#
Lua: caffeine.math.sub
sub(a, b) -> table
Diferença componente a componente a - b.
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | table | Tabela de vetor {x, y[, z]}. |
b | table | Tabela de vetor {x, y[, z]}. |
Devolve: table. Tabela de vetor; só tem z se um operando tiver z.
Exemplo
local d = caffeine.math.sub(a, b)
mul#
Lua: caffeine.math.mul
mul(a, b) -> table
Produto componente a componente de dois vetores (não é o produto escalar).
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | table | Tabela de vetor {x, y[, z]}. |
b | table | Tabela de vetor {x, y[, z]}. |
Devolve: table. Tabela de vetor; só tem z se um operando tiver z.
Exemplo
local m = caffeine.math.mul(a, b)
scale#
Lua: caffeine.math.scale
scale(v, s) -> table
Multiplica um vetor por um escalar.
| Parâmetros | Tipo | Descrição |
|---|---|---|
v | table | Tabela de vetor {x, y[, z]}. |
s | number | Fator escalar. |
Devolve: table. Vetor escalado.
Exemplo
local v2 = caffeine.math.scale(v, 2)
dot#
Lua: caffeine.math.dot
dot(a, b) -> number
Produto escalar de dois vetores; um z em falta conta como 0.
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | table | Tabela de vetor {x, y[, z]}. |
b | table | Tabela de vetor {x, y[, z]}. |
Devolve: number. Produto escalar.
Exemplo
local d = caffeine.math.dot(a, b)
cross#
Lua: caffeine.math.cross
cross(a, b) -> table
Produto vetorial; o resultado é sempre 3D.
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | table | Tabela de vetor {x, y[, z]}. |
b | table | Tabela de vetor {x, y[, z]}. |
Devolve: table. Vetor {x, y, z}.
Exemplo
local n = caffeine.math.cross(a, b)
length#
Lua: caffeine.math.length
length(v) -> number
Comprimento de um vetor.
| Parâmetros | Tipo | Descrição |
|---|---|---|
v | table | Tabela de vetor {x, y[, z]}. |
Devolve: number. Comprimento do vetor.
Exemplo
local l = caffeine.math.length(v)
lengthSquared#
Lua: caffeine.math.lengthSquared
lengthSquared(v) -> number
Comprimento ao quadrado de um vetor, sem a raiz quadrada.
| Parâmetros | Tipo | Descrição |
|---|---|---|
v | table | Tabela de vetor {x, y[, z]}. |
Devolve: number. Comprimento ao quadrado.
Exemplo
local l2 = caffeine.math.lengthSquared(v)
distance#
Lua: caffeine.math.distance
distance(a, b) -> number
Distância entre dois pontos.
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | table | Tabela de vetor {x, y[, z]}. |
b | table | Tabela de vetor {x, y[, z]}. |
Devolve: number. Distância entre os pontos.
Exemplo
local d = caffeine.math.distance(a, b)
normalize#
Lua: caffeine.math.normalize
normalize(v) -> table
Devolve o vetor escalado para comprimento 1.
| Parâmetros | Tipo | Descrição |
|---|---|---|
v | table | Tabela de vetor {x, y[, z]}. |
Devolve: table. Vetor unitário, ou zeros se o comprimento for no máximo 0.0001.
Exemplo
local dir = caffeine.math.normalize(caffeine.math.sub(b, a))
lerpVec#
Lua: caffeine.math.lerpVec
lerpVec(a, b, t) -> table
Interpolação linear entre dois vetores.
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | table | Tabela de vetor {x, y[, z]}. |
b | table | Tabela de vetor {x, y[, z]}. |
t | number | Fator de mistura; não é limitado. |
Devolve: table. Tabela de vetor; só tem z se um operando tiver z.
Exemplo
local mid = caffeine.math.lerpVec(a, b, 0.5)
clamp#
Lua: caffeine.math.clamp
clamp(v, lo, hi) -> number
Limita um valor a um intervalo; limites trocados são aceites.
| Parâmetros | Tipo | Descrição |
|---|---|---|
v | number | Valor. |
lo | number | Limite inferior. |
hi | number | Limite superior. |
Devolve: number. Valor limitado.
Exemplo
local hp = caffeine.math.clamp(hp, 0, 100)
clamp01#
Lua: caffeine.math.clamp01
clamp01(v) -> number
Limita um valor a 0..1.
| Parâmetros | Tipo | Descrição |
|---|---|---|
v | number | Valor. |
Devolve: number. Valor limitado a 0..1.
Exemplo
local t = caffeine.math.clamp01(t)
lerp#
Lua: caffeine.math.lerp
lerp(a, b, t) -> number
Interpolação linear entre dois números.
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | number | Início. |
b | number | Fim. |
t | number | Fator de mistura; não é limitado. |
Devolve: number. a + (b - a) * t
Exemplo
local x = caffeine.math.lerp(0, 10, 0.25)
inverseLerp#
Lua: caffeine.math.inverseLerp
inverseLerp(a, b, v) -> number
O inverso de lerp; o resultado não é limitado.
| Parâmetros | Tipo | Descrição |
|---|---|---|
a | number | Início. |
b | number | Fim. |
v | number | Valor. |
Devolve: number. Posição de v entre a e b; 0 se a e b forem iguais.
Exemplo
local t = caffeine.math.inverseLerp(0, 10, 5)
remap#
Lua: caffeine.math.remap
remap(v, inLo, inHi, outLo, outHi) -> number
Mapeia um valor de um intervalo para outro.
| Parâmetros | Tipo | Descrição |
|---|---|---|
v | number | Valor. |
inLo | number | Início do intervalo de entrada. |
inHi | number | Fim do intervalo de entrada. |
outLo | number | Início do intervalo de saída. |
outHi | number | Fim do intervalo de saída. |
Devolve: number. Valor remapeado (não limitado).
Exemplo
local pct = caffeine.math.remap(hp, 0, 100, 0, 1)
smoothstep#
Lua: caffeine.math.smoothstep
smoothstep(e0, e1, v) -> number
Interpolação suave de Hermite entre dois limites.
| Parâmetros | Tipo | Descrição |
|---|---|---|
e0 | number | Limite inferior. |
e1 | number | Limite superior. |
v | number | Valor. |
Devolve: number. Valor suave entre 0 e 1.
Exemplo
local s = caffeine.math.smoothstep(0, 1, t)
approach#
Lua: caffeine.math.approach
approach(cur, target, step) -> number
Move um valor para um alvo em no máximo step.
| Parâmetros | Tipo | Descrição |
|---|---|---|
cur | number | Valor atual. |
target | number | Valor alvo. |
step | number | Mudança máxima; usa-se o valor absoluto. |
Devolve: number. Novo valor, nunca além do alvo.
Exemplo
speed = caffeine.math.approach(speed, 0, 20 * caffeine.time.delta())
sign#
Lua: caffeine.math.sign
sign(v) -> number
Sinal de um número.
| Parâmetros | Tipo | Descrição |
|---|---|---|
v | number | Valor. |
Devolve: number. -1, 0 ou 1.
Exemplo
local s = caffeine.math.sign(-3)
radians#
Lua: caffeine.math.radians
radians(deg) -> number
Converte graus em radianos.
| Parâmetros | Tipo | Descrição |
|---|---|---|
deg | number | Graus. |
Devolve: number. Radianos.
Exemplo
local r = caffeine.math.radians(90)
degrees#
Lua: caffeine.math.degrees
degrees(rad) -> number
Converte radianos em graus.
| Parâmetros | Tipo | Descrição |
|---|---|---|
rad | number | Radianos. |
Devolve: number. Graus.
Exemplo
local d = caffeine.math.degrees(caffeine.math.pi)