API reference

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

I

interfaceTileColliderOptions

@codexo/exojs-tilemap-physics / tilemap-physics / stable

Options for a TileColliderStreamer. All optional.

10
props
0
methods
0
events
Import
import { TileColliderOptions } from '@codexo/exojs-tilemap-physics'

Options for a TileColliderStreamer. All optional.

Properties10
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 a source shape before any collider is built for it.
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…
Per-cell collision classification, for layers whose collision is authored per cell rather than per tile. On a bounded layer this makes the bridge cover the whole layer, including partitions that hold no tiles at all. Sampled while a partition is built and expected to answer identically for the lifetime of this bridge: changing what it returns does not invalidate colliders that already exist. Rebuild by recreating the bridge.
density?: number
Density; irrelevant while the bodies are static. Default 1.
filter?: Partial<CollisionFilterPer-collider collision filter. A pair is considered for collision only when each collider's mask includes the other's category. A non-zero group overrides cate…>
Category/mask/group filter; partials merge over the physics defaults.
friction?: number
Coulomb friction. Default 0.6.
isSensor?: boolean
Generate overlap events instead of contact response. Default false.
material?: TileColliderMaterialResolverPer-object collider settings, merged over the call-level defaults. Return `null` to accept the defaults unchanged. Called only while a chunk is being built or…
Per-object override of any of the above.
merge?: boolean
Merge adjacent whole-cell boxes sharing a type into larger rectangles. Default true. Merging never crosses a chunk boundary.
regionMode?: TileRegionModeHow a run of solid whole-cell tiles is turned into colliders. `'boxes'` keeps the merged rectangles as solid `BoxShape` colliders: the region has an interior,…
How solid whole-cell regions are represented. Default 'boxes'.
restitution?: number
Restitution / bounciness in [0, 1]. Default 0.
Source
packages/exojs-tilemap-physics/src/TileColliderStreamer.ts