API reference

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

C

classMapLevelRuntime

@codexo/exojs-tilemap / tilemap / stable

One loaded level and everything that load produced. Created by MapWorldRuntime.loadLevel; destroying it unloads the level. There is nothing else to release afterwards - the map, the spawned objects and the level's asset claims all end here.

6
props
1
methods
0
events
Import
import { MapLevelRuntime } from '@codexo/exojs-tilemap'

One loaded level and everything that load produced.

Created by MapWorldRuntime.loadLevel; destroying it unloads the level. There is nothing else to release afterwards - the map, the spawned objects and the level's asset claims all end here.

Methods1
destroy(): void
Unload the level: destroy the spawned objects (reverse spawn order), then the map, then release the level's asset claims. Idempotent. The scope goes last because everything before it may still be reading a texture the scope keeps resident.
Properties6
id: string
MapLevel.id of the loaded level.
level: MapLevelImmutable metadata for one level of a MapWorld - everything needed to decide whether to load it, without loading it.
Metadata of the loaded level.
map: TileMapA generic, format-independent tile map. Owns a finite grid of TileLayers and a shared set of TileSets. Tile data is stored in compact chunked arrays - no per-t…
The level's runtime map, owned by this runtime.
scope: LoaderScopeAn owner of asset claims with an explicit lifetime. Assets acquired through a scope stay resident for as long as that scope holds them, and are freed when it r…
The level's asset scope. Released last, after everything that could hold an asset is gone.
spawns: MapSpawnSessionThe objects one spawn produced, and their shared lifetime. A session is handed out by import('./MapObjectSpawner').MapObjectSpawner.spawn and owns every result…<Result> | null
What the level's spawner produced, or null when the load ran without one.
destroyed: boolean
Whether this level has been unloaded.
Source
packages/exojs-tilemap/src/MapWorldRuntime.ts