Caffeine

Map

Reference World Last updated: Lua 1 · Dryad 0

Hooks for map surface chunk requests.

All namespaces

Namespace: caffeine.map

onChunkRequest#

Lua: caffeine.map.onChunkRequest

text
onChunkRequest(callback) -> number

Registers a handler for the mapChunkRequest event raised when a map surface requests a chunk.

ParametersTypeDescription
callbackfunctionCalled with a payload table: `surfaceEntityId`, `chunkX`, `chunkY`, `worldMinX`, `worldMinY`, `chunkSize`.

Returns: number. Event handler handle.

Example

lua
caffeine.map.onChunkRequest(function(req)
  print(req.chunkX, req.chunkY)
end)