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

api.monsters

Members

api.monsters.get()

api.monsters.get(query: MonsterQuery): Effect.Effect<LiveMonster | null>
Name Type Required Default Description
query MonsterQuery

Returns: LiveMonster | null

Errors: never

api.monsters.getAll()

api.monsters.getAll(): Effect.Effect<readonly LiveMonster[]>

Returns: readonly LiveMonster[]

Errors: never

api.monsters.getAvailable()

Gets monsters in the current cell that are alive and can be targeted for combat. Hidden monsters are included.

api.monsters.getAvailable(): Effect.Effect<readonly LiveMonster[]>

Returns: readonly LiveMonster[]

Errors: never

api.monsters.isAvailable()

Checks whether a monster in the current cell is alive and can be targeted for combat. Hidden monsters count as available.

api.monsters.isAvailable(query: MonsterQuery): Effect.Effect<boolean>
Name Type Required Default Description
query MonsterQuery

Returns: boolean

Errors: never

Type preview
Open page

Last updated on September 26, 2026

Was this page helpful?