API reference

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

I

interfaceTileCollisionOptions

@codexo/exojs-tilemap / tilemap / stable

Options for buildTileCollisionGeometry.

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

Options for buildTileCollisionGeometry.

Properties4
accept?: (object: TileMapObjectA format-independent map object. The geometry kind is the discriminant; narrow on `kind` to read shape-specific fields. Template objects are not yet represente…, tx: number, ty: number) => boolean
Drop source shapes before any geometry is built (e.g. by a custom property). Return true to keep a shape. Default keeps all of them.
cells?: TileCellSourcePer-cell collision classification for a tile layer, independent of the tiles the layer renders. Returns the class/type string for the cell, or `null` when the…
Second occupancy source, consulted once per cell of the walked region in addition to the tiles' own collision shapes. Lets collision authored per cell rather than per tile reach the same geometry, without the layer having to render a tile there.
merge?: boolean
Merge adjacent whole-cell boxes that share a type into larger rectangles. Default true. With false, every whole-cell box becomes its own single-cell rectangle.
region?: TileRegionA half-open tile-coordinate rectangle covering `[x, x + width)` × `[y, y + height)`. Used to scope buildTileCollisionGeometry to part of a layer - a streamed c…
Tile-coordinate region to walk. Defaults to the bounding box of the layer's currently loaded chunks, so an unbounded (streamed) layer works without the caller computing anything - or, with cells on a bounded layer, to the layer's full tile extent.
Source
packages/exojs-tilemap/src/tileCollision.ts