Procedural
Auxiliares de ruído determinístico, streaming de chunks e geração de terreno para mundos procedurais.
Namespace: caffeine.procedural
hash#
Lua: caffeine.procedural.hash
hash(x, z, seed, salt) -> number
Hash determinístico de uma célula, semente e sal.
| Parâmetros | Tipo | Descrição |
|---|---|---|
x | number | X inteiro. |
z | number | Z inteiro. |
seed | number | Semente. |
salt | number | Sal adicional. |
Devolve: number. Valor de hash (chamado hash01 no motor).
Exemplo
local r = caffeine.procedural.hash(3, 4, 42, 0)
noise2d#
Lua: caffeine.procedural.noise2d
noise2d(x, z, seed) -> number
Ruído de valor 2D.
| Parâmetros | Tipo | Descrição |
|---|---|---|
x | number | Coordenada X. |
z | number | Coordenada Z. |
seed | number | Semente. |
Devolve: number. Valor de ruído.
Exemplo
local n = caffeine.procedural.noise2d(1.5, 2.5, 42)
fbm2d#
Lua: caffeine.procedural.fbm2d
fbm2d(x, z, seed, octaves, lacunarity, persistence) -> number
Ruído fractal Brownian motion 2D.
| Parâmetros | Tipo | Descrição |
|---|---|---|
x | number | Coordenada X. |
z | number | Coordenada Z. |
seed | number | Semente. |
octaves | number | Número de oitavas. |
lacunarity | number | Multiplicador de frequência por oitava. |
persistence | number | Multiplicador de amplitude por oitava. |
Devolve: number. Valor de ruído.
Exemplo
local h = caffeine.procedural.fbm2d(x * 0.02, z * 0.02, 42, 5, 2.0, 0.5)
worldToChunk#
Lua: caffeine.procedural.worldToChunk
worldToChunk(worldCoord, chunkSize) -> number
Converte uma coordenada do mundo num índice de chunk.
| Parâmetros | Tipo | Descrição |
|---|---|---|
worldCoord | number | Coordenada do mundo. |
chunkSize | number | Tamanho do chunk em unidades do mundo. |
Devolve: number. Índice do chunk.
Exemplo
local cx = caffeine.procedural.worldToChunk(pos.x, 64)
findTerrain#
Lua: caffeine.procedural.findTerrain
findTerrain() -> number
Procura a entidade de terreno.
Devolve: number. Id da entidade de terreno, ou 0 se não houver.
Exemplo
local t = caffeine.procedural.findTerrain()
getFocusChunk#
Lua: caffeine.procedural.getFocusChunk
getFocusChunk(directorId, chunkSize, focusId) -> table
Devolve o chunk onde está a entidade de foco.
| Parâmetros | Tipo | Descrição |
|---|---|---|
directorId | number | Id da entidade diretora do mundo procedural. |
chunkSize | number | Tamanho do chunk, usado se o diretor não tiver definições procedurais. |
focusId | number | Id da entidade de foco. Opcional. |
Devolve: table. Tabela com cx e cz (0, 0 se indisponível).
Exemplo
local c = caffeine.procedural.getFocusChunk(dir, 64, player)
print(c.cx, c.cz)
isChunkLoaded#
Lua: caffeine.procedural.isChunkLoaded
isChunkLoaded(directorId, cx, cz) -> boolean
Verifica se um chunk está carregado para o diretor.
| Parâmetros | Tipo | Descrição |
|---|---|---|
directorId | number | Id da entidade diretora do mundo procedural. |
cx | number | Índice X do chunk. |
cz | number | Índice Z do chunk. |
Devolve: boolean. true se o chunk estiver carregado.
Exemplo
print(caffeine.procedural.isChunkLoaded(dir, 0, 0))
unloadChunk#
Lua: caffeine.procedural.unloadChunk
unloadChunk(directorId, cx, cz)
Descarrega um chunk do diretor.
| Parâmetros | Tipo | Descrição |
|---|---|---|
directorId | number | Id da entidade diretora do mundo procedural. |
cx | number | Índice X do chunk. |
cz | number | Índice Z do chunk. |
Devolve: nada
Exemplo
caffeine.procedural.unloadChunk(dir, 0, 0)
stream#
Lua: caffeine.procedural.stream
stream(directorId, terrainId, cx, cz, preset)
Faz streaming de chunks em redor do chunk indicado, adicionando definições procedurais ao diretor se necessário.
| Parâmetros | Tipo | Descrição |
|---|---|---|
directorId | number | Id da entidade diretora do mundo procedural. |
terrainId | number | Id da entidade de terreno. Opcional. |
cx | number | Índice X do chunk. |
cz | number | Índice Z do chunk. |
preset | string | Nome do preset. Opcional. |
Devolve: nada
Exemplo
caffeine.procedural.stream(dir, caffeine.procedural.findTerrain(), 0, 0)
generateTerrainChunk#
Lua: caffeine.procedural.generateTerrainChunk
generateTerrainChunk(terrainId, cx, cz, seed, preset)
Gera um chunk de terreno.
| Parâmetros | Tipo | Descrição |
|---|---|---|
terrainId | number | Id da entidade de terreno. |
cx | number | Índice X do chunk. |
cz | number | Índice Z do chunk. |
seed | number | Semente. |
preset | string | Nome do preset. Opcional. |
Devolve: nada
Exemplo
caffeine.procedural.generateTerrainChunk(terrain, 0, 0, 42)
spawnCube#
Lua: caffeine.procedural.spawnCube
spawnCube(directorId, cx, cz, x, y, z, sx, sy, sz) -> number
Cria uma entidade cubo marcada com o diretor e o chunk.
| Parâmetros | Tipo | Descrição |
|---|---|---|
directorId | number | Id da entidade diretora do mundo procedural. |
cx | number | Índice X do chunk. |
cz | number | Índice Z do chunk. |
x | number | X no mundo. |
y | number | Y no mundo. |
z | number | Z no mundo. |
sx | number | Escala X. |
sy | number | Escala Y. |
sz | number | Escala Z. |
Devolve: number. Id da nova entidade, ou 0 se não houver mundo.
Exemplo
local c = caffeine.procedural.spawnCube(dir, 0, 0, 1, 0.5, 1, 1, 1, 1)
fillTerrainNoise#
Lua: caffeine.procedural.fillTerrainNoise
fillTerrainNoise(terrainId, seed, amplitude)
Preenche o heightmap do terreno com ruído fractal.
| Parâmetros | Tipo | Descrição |
|---|---|---|
terrainId | number | Id da entidade de terreno. |
seed | number | Semente. |
amplitude | number | Multiplicador de altura; os resultados são limitados a 0..1. |
Devolve: nada
Exemplo
caffeine.procedural.fillTerrainNoise(terrain, 42, 1.0)