API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceChunkStreamerOptions

@codexo/exojs-tilemap / tilemap / stable

Options for a ChunkStreamer. All optional.

3
props
0
methods
0
events
Import
import { ChunkStreamerOptions } from '@codexo/exojs-tilemap'

Options for a ChunkStreamer. All optional.

Properties3
loadRadius?: number
Chunks within this many chunk-units (Chebyshev distance to the visible chunk range) of the view are loaded. Default 1.
maxChunkLoadsPerFrame?: number
Maximum number of new chunk loads issued per ChunkStreamer.update call, after the very first call (which loads the entire initial wanted set unbudgeted, so the starting view never pops in). Default 8.
unloadRadius?: number
Own-resident chunks beyond this many chunk-units of the view are evicted. Must be >= loadRadius - the gap between the two is deliberate hysteresis that prevents load/unload thrashing when the view sits near a chunk boundary. Default 2.
Source
packages/exojs-tilemap/src/ChunkStreamer.ts