Caffeine

Procedural

Reference World Última atualização: Lua 12 · Dryad 0

Auxiliares de ruído determinístico, streaming de chunks e geração de terreno para mundos procedurais.

Todos os namespaces

Namespace: caffeine.procedural

hash#

Lua: caffeine.procedural.hash

text
hash(x, z, seed, salt) -> number

Hash determinístico de uma célula, semente e sal.

ParâmetrosTipoDescrição
xnumberX inteiro.
znumberZ inteiro.
seednumberSemente.
saltnumberSal adicional.

Devolve: number. Valor de hash (chamado hash01 no motor).

Exemplo

lua
local r = caffeine.procedural.hash(3, 4, 42, 0)

noise2d#

Lua: caffeine.procedural.noise2d

text
noise2d(x, z, seed) -> number

Ruído de valor 2D.

ParâmetrosTipoDescrição
xnumberCoordenada X.
znumberCoordenada Z.
seednumberSemente.

Devolve: number. Valor de ruído.

Exemplo

lua
local n = caffeine.procedural.noise2d(1.5, 2.5, 42)

fbm2d#

Lua: caffeine.procedural.fbm2d

text
fbm2d(x, z, seed, octaves, lacunarity, persistence) -> number

Ruído fractal Brownian motion 2D.

ParâmetrosTipoDescrição
xnumberCoordenada X.
znumberCoordenada Z.
seednumberSemente.
octavesnumberNúmero de oitavas.
lacunaritynumberMultiplicador de frequência por oitava.
persistencenumberMultiplicador de amplitude por oitava.

Devolve: number. Valor de ruído.

Exemplo

lua
local h = caffeine.procedural.fbm2d(x * 0.02, z * 0.02, 42, 5, 2.0, 0.5)

worldToChunk#

Lua: caffeine.procedural.worldToChunk

text
worldToChunk(worldCoord, chunkSize) -> number

Converte uma coordenada do mundo num índice de chunk.

ParâmetrosTipoDescrição
worldCoordnumberCoordenada do mundo.
chunkSizenumberTamanho do chunk em unidades do mundo.

Devolve: number. Índice do chunk.

Exemplo

lua
local cx = caffeine.procedural.worldToChunk(pos.x, 64)

findTerrain#

Lua: caffeine.procedural.findTerrain

text
findTerrain() -> number

Procura a entidade de terreno.

Devolve: number. Id da entidade de terreno, ou 0 se não houver.

Exemplo

lua
local t = caffeine.procedural.findTerrain()

getFocusChunk#

Lua: caffeine.procedural.getFocusChunk

text
getFocusChunk(directorId, chunkSize, focusId) -> table

Devolve o chunk onde está a entidade de foco.

ParâmetrosTipoDescrição
directorIdnumberId da entidade diretora do mundo procedural.
chunkSizenumberTamanho do chunk, usado se o diretor não tiver definições procedurais.
focusIdnumberId da entidade de foco. Opcional.

Devolve: table. Tabela com cx e cz (0, 0 se indisponível).

Exemplo

lua
local c = caffeine.procedural.getFocusChunk(dir, 64, player)
print(c.cx, c.cz)

isChunkLoaded#

Lua: caffeine.procedural.isChunkLoaded

text
isChunkLoaded(directorId, cx, cz) -> boolean

Verifica se um chunk está carregado para o diretor.

ParâmetrosTipoDescrição
directorIdnumberId da entidade diretora do mundo procedural.
cxnumberÍndice X do chunk.
cznumberÍndice Z do chunk.

Devolve: boolean. true se o chunk estiver carregado.

Exemplo

lua
print(caffeine.procedural.isChunkLoaded(dir, 0, 0))

unloadChunk#

Lua: caffeine.procedural.unloadChunk

text
unloadChunk(directorId, cx, cz)

Descarrega um chunk do diretor.

ParâmetrosTipoDescrição
directorIdnumberId da entidade diretora do mundo procedural.
cxnumberÍndice X do chunk.
cznumberÍndice Z do chunk.

Devolve: nada

Exemplo

lua
caffeine.procedural.unloadChunk(dir, 0, 0)

stream#

Lua: caffeine.procedural.stream

text
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âmetrosTipoDescrição
directorIdnumberId da entidade diretora do mundo procedural.
terrainIdnumberId da entidade de terreno. Opcional.
cxnumberÍndice X do chunk.
cznumberÍndice Z do chunk.
presetstringNome do preset. Opcional.

Devolve: nada

Exemplo

lua
caffeine.procedural.stream(dir, caffeine.procedural.findTerrain(), 0, 0)

generateTerrainChunk#

Lua: caffeine.procedural.generateTerrainChunk

text
generateTerrainChunk(terrainId, cx, cz, seed, preset)

Gera um chunk de terreno.

ParâmetrosTipoDescrição
terrainIdnumberId da entidade de terreno.
cxnumberÍndice X do chunk.
cznumberÍndice Z do chunk.
seednumberSemente.
presetstringNome do preset. Opcional.

Devolve: nada

Exemplo

lua
caffeine.procedural.generateTerrainChunk(terrain, 0, 0, 42)

spawnCube#

Lua: caffeine.procedural.spawnCube

text
spawnCube(directorId, cx, cz, x, y, z, sx, sy, sz) -> number

Cria uma entidade cubo marcada com o diretor e o chunk.

ParâmetrosTipoDescrição
directorIdnumberId da entidade diretora do mundo procedural.
cxnumberÍndice X do chunk.
cznumberÍndice Z do chunk.
xnumberX no mundo.
ynumberY no mundo.
znumberZ no mundo.
sxnumberEscala X.
synumberEscala Y.
sznumberEscala Z.

Devolve: number. Id da nova entidade, ou 0 se não houver mundo.

Exemplo

lua
local c = caffeine.procedural.spawnCube(dir, 0, 0, 1, 0.5, 1, 1, 1, 1)

fillTerrainNoise#

Lua: caffeine.procedural.fillTerrainNoise

text
fillTerrainNoise(terrainId, seed, amplitude)

Preenche o heightmap do terreno com ruído fractal.

ParâmetrosTipoDescrição
terrainIdnumberId da entidade de terreno.
seednumberSemente.
amplitudenumberMultiplicador de altura; os resultados são limitados a 0..1.

Devolve: nada

Exemplo

lua
caffeine.procedural.fillTerrainNoise(terrain, 42, 1.0)