Caffeine

Matemática

Reference Core Última atualização: Lua 23 · Dryad 0

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).

Todos os namespaces

Namespace: caffeine.math

vec2#

Lua: caffeine.math.vec2

text
vec2(x, y) -> table

Cria uma tabela de vetor 2D.

ParâmetrosTipoDescrição
xnumberX.
ynumberY.

Devolve: table. {x, y}

Exemplo

lua
local v = caffeine.math.vec2(1, 2)

vec3#

Lua: caffeine.math.vec3

text
vec3(x, y, z) -> table

Cria uma tabela de vetor 3D.

ParâmetrosTipoDescrição
xnumberX.
ynumberY.
znumberZ.

Devolve: table. {x, y, z}

Exemplo

lua
local v = caffeine.math.vec3(1, 2, 3)

add#

Lua: caffeine.math.add

text
add(a, b) -> table

Soma componente a componente de dois vetores.

ParâmetrosTipoDescrição
atableTabela de vetor {x, y[, z]}.
btableTabela de vetor {x, y[, z]}.

Devolve: table. Tabela de vetor; só tem z se um operando tiver z.

Exemplo

lua
local p = caffeine.math.add(a, b)

sub#

Lua: caffeine.math.sub

text
sub(a, b) -> table

Diferença componente a componente a - b.

ParâmetrosTipoDescrição
atableTabela de vetor {x, y[, z]}.
btableTabela de vetor {x, y[, z]}.

Devolve: table. Tabela de vetor; só tem z se um operando tiver z.

Exemplo

lua
local d = caffeine.math.sub(a, b)

mul#

Lua: caffeine.math.mul

text
mul(a, b) -> table

Produto componente a componente de dois vetores (não é o produto escalar).

ParâmetrosTipoDescrição
atableTabela de vetor {x, y[, z]}.
btableTabela de vetor {x, y[, z]}.

Devolve: table. Tabela de vetor; só tem z se um operando tiver z.

Exemplo

lua
local m = caffeine.math.mul(a, b)

scale#

Lua: caffeine.math.scale

text
scale(v, s) -> table

Multiplica um vetor por um escalar.

ParâmetrosTipoDescrição
vtableTabela de vetor {x, y[, z]}.
snumberFator escalar.

Devolve: table. Vetor escalado.

Exemplo

lua
local v2 = caffeine.math.scale(v, 2)

dot#

Lua: caffeine.math.dot

text
dot(a, b) -> number

Produto escalar de dois vetores; um z em falta conta como 0.

ParâmetrosTipoDescrição
atableTabela de vetor {x, y[, z]}.
btableTabela de vetor {x, y[, z]}.

Devolve: number. Produto escalar.

Exemplo

lua
local d = caffeine.math.dot(a, b)

cross#

Lua: caffeine.math.cross

text
cross(a, b) -> table

Produto vetorial; o resultado é sempre 3D.

ParâmetrosTipoDescrição
atableTabela de vetor {x, y[, z]}.
btableTabela de vetor {x, y[, z]}.

Devolve: table. Vetor {x, y, z}.

Exemplo

lua
local n = caffeine.math.cross(a, b)

length#

Lua: caffeine.math.length

text
length(v) -> number

Comprimento de um vetor.

ParâmetrosTipoDescrição
vtableTabela de vetor {x, y[, z]}.

Devolve: number. Comprimento do vetor.

Exemplo

lua
local l = caffeine.math.length(v)

lengthSquared#

Lua: caffeine.math.lengthSquared

text
lengthSquared(v) -> number

Comprimento ao quadrado de um vetor, sem a raiz quadrada.

ParâmetrosTipoDescrição
vtableTabela de vetor {x, y[, z]}.

Devolve: number. Comprimento ao quadrado.

Exemplo

lua
local l2 = caffeine.math.lengthSquared(v)

distance#

Lua: caffeine.math.distance

text
distance(a, b) -> number

Distância entre dois pontos.

ParâmetrosTipoDescrição
atableTabela de vetor {x, y[, z]}.
btableTabela de vetor {x, y[, z]}.

Devolve: number. Distância entre os pontos.

Exemplo

lua
local d = caffeine.math.distance(a, b)

normalize#

Lua: caffeine.math.normalize

text
normalize(v) -> table

Devolve o vetor escalado para comprimento 1.

ParâmetrosTipoDescrição
vtableTabela de vetor {x, y[, z]}.

Devolve: table. Vetor unitário, ou zeros se o comprimento for no máximo 0.0001.

Exemplo

lua
local dir = caffeine.math.normalize(caffeine.math.sub(b, a))

lerpVec#

Lua: caffeine.math.lerpVec

text
lerpVec(a, b, t) -> table

Interpolação linear entre dois vetores.

ParâmetrosTipoDescrição
atableTabela de vetor {x, y[, z]}.
btableTabela de vetor {x, y[, z]}.
tnumberFator de mistura; não é limitado.

Devolve: table. Tabela de vetor; só tem z se um operando tiver z.

Exemplo

lua
local mid = caffeine.math.lerpVec(a, b, 0.5)

clamp#

Lua: caffeine.math.clamp

text
clamp(v, lo, hi) -> number

Limita um valor a um intervalo; limites trocados são aceites.

ParâmetrosTipoDescrição
vnumberValor.
lonumberLimite inferior.
hinumberLimite superior.

Devolve: number. Valor limitado.

Exemplo

lua
local hp = caffeine.math.clamp(hp, 0, 100)

clamp01#

Lua: caffeine.math.clamp01

text
clamp01(v) -> number

Limita um valor a 0..1.

ParâmetrosTipoDescrição
vnumberValor.

Devolve: number. Valor limitado a 0..1.

Exemplo

lua
local t = caffeine.math.clamp01(t)

lerp#

Lua: caffeine.math.lerp

text
lerp(a, b, t) -> number

Interpolação linear entre dois números.

ParâmetrosTipoDescrição
anumberInício.
bnumberFim.
tnumberFator de mistura; não é limitado.

Devolve: number. a + (b - a) * t

Exemplo

lua
local x = caffeine.math.lerp(0, 10, 0.25)

inverseLerp#

Lua: caffeine.math.inverseLerp

text
inverseLerp(a, b, v) -> number

O inverso de lerp; o resultado não é limitado.

ParâmetrosTipoDescrição
anumberInício.
bnumberFim.
vnumberValor.

Devolve: number. Posição de v entre a e b; 0 se a e b forem iguais.

Exemplo

lua
local t = caffeine.math.inverseLerp(0, 10, 5)

remap#

Lua: caffeine.math.remap

text
remap(v, inLo, inHi, outLo, outHi) -> number

Mapeia um valor de um intervalo para outro.

ParâmetrosTipoDescrição
vnumberValor.
inLonumberInício do intervalo de entrada.
inHinumberFim do intervalo de entrada.
outLonumberInício do intervalo de saída.
outHinumberFim do intervalo de saída.

Devolve: number. Valor remapeado (não limitado).

Exemplo

lua
local pct = caffeine.math.remap(hp, 0, 100, 0, 1)

smoothstep#

Lua: caffeine.math.smoothstep

text
smoothstep(e0, e1, v) -> number

Interpolação suave de Hermite entre dois limites.

ParâmetrosTipoDescrição
e0numberLimite inferior.
e1numberLimite superior.
vnumberValor.

Devolve: number. Valor suave entre 0 e 1.

Exemplo

lua
local s = caffeine.math.smoothstep(0, 1, t)

approach#

Lua: caffeine.math.approach

text
approach(cur, target, step) -> number

Move um valor para um alvo em no máximo step.

ParâmetrosTipoDescrição
curnumberValor atual.
targetnumberValor alvo.
stepnumberMudança máxima; usa-se o valor absoluto.

Devolve: number. Novo valor, nunca além do alvo.

Exemplo

lua
speed = caffeine.math.approach(speed, 0, 20 * caffeine.time.delta())

sign#

Lua: caffeine.math.sign

text
sign(v) -> number

Sinal de um número.

ParâmetrosTipoDescrição
vnumberValor.

Devolve: number. -1, 0 ou 1.

Exemplo

lua
local s = caffeine.math.sign(-3)

radians#

Lua: caffeine.math.radians

text
radians(deg) -> number

Converte graus em radianos.

ParâmetrosTipoDescrição
degnumberGraus.

Devolve: number. Radianos.

Exemplo

lua
local r = caffeine.math.radians(90)

degrees#

Lua: caffeine.math.degrees

text
degrees(rad) -> number

Converte radianos em graus.

ParâmetrosTipoDescrição
radnumberRadianos.

Devolve: number. Graus.

Exemplo

lua
local d = caffeine.math.degrees(caffeine.math.pi)