API reference

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

I

interfaceMapObjectSpawnerOptions

@codexo/exojs-tilemap / tilemap / stable

Options for MapObjectSpawner.

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

Options for MapObjectSpawner.

Properties2
identify?: (object: MapObjectDescriptorA format-neutral view of one map object, as handed to a import('./MapObjectSpawner').MapObjectFactory. The descriptor is what game code writes against: it reso…, context: Context) => null | string
Picks the factory key for an object, or returns null to treat it as unknown. Defaults to MapObjectDescriptor.kind. This is where project-specific dispatch policy lives - keying on a property, a name prefix, or a compound key: ts identify: object => ${object.kind}:${object.properties.variant}
unknown?: UnknownMapObjectPolicyWhat to do with an object no factory is registered for.
What to do with an object no factory matched. Defaults to 'ignore', because maps legitimately carry editor markers, decoration and metadata objects that no game entity corresponds to. Use 'error' for a map format the project fully controls and wants validated.
Source
packages/exojs-tilemap/src/MapObjectSpawner.ts