Skip to content
Lucent
Esc
↑↓navigate↵open
On this page

api.map

Members

api.map.getCellPads()

api.map.getCellPads(): Effect.Effect<readonly string[]>

Returns: readonly string[]

Errors: never

api.map.getCells()

api.map.getCells(): Effect.Effect<readonly string[]>

Returns: readonly string[]

Errors: never

api.map.getId()

api.map.getId(): Effect.Effect<number>

Returns: number

Errors: never

api.map.getMapItem()

api.map.getMapItem(itemId: number): Effect.Effect<void>
Name Type Required Default Description
itemId number

Returns: void

Errors: never

api.map.getName()

api.map.getName(): Effect.Effect<string>

Returns: string

Errors: never

api.map.getRoomNumber()

api.map.getRoomNumber(): Effect.Effect<number>

Returns: number

Errors: never

api.map.isLoaded()

api.map.isLoaded(): Effect.Effect<boolean>

Returns: boolean

Errors: never

api.map.loadSwf()

api.map.loadSwf(swf: string): Effect.Effect<void>
Name Type Required Default Description
swf string

Returns: void

Errors: never

api.map.reload()

api.map.reload(): Effect.Effect<void>

Returns: void

Errors: never

api.map.setSpawnPoint()

Sets the spawn point, using the current cell or pad when omitted.

api.map.setSpawnPoint(options?: CellPositionOptions): Effect.Effect<void>
Name Type Required Default Description
options CellPositionOptions

Returns: void

Errors: never

Type preview
Open page

Last updated on September 26, 2026

Was this page helpful?