useGameboardActorActions
useGameboardActorActions():
object
Defined in: src/react/react.ts:424
Bind actor actions for registering, spawning, moving, and updating actors.
Returns
Section titled “Returns”collision
Section titled “collision”collision: (
actor,target,profile) =>GameboardActorCollisionReport
Inspect whether an actor can enter a target tile.
Parameters
Section titled “Parameters”string | Entity | undefined
target
Section titled “target”string | HexCoordinates
profile?
Section titled “profile?”GameboardActorCollisionProfile = {}
Returns
Section titled “Returns”command
Section titled “command”command: (
target,options) =>GameboardInteractionCommand
Plan a high-level interaction command from a target input.
Parameters
Section titled “Parameters”target
Section titled “target”GameboardInteractionTargetInput
options?
Section titled “options?”GameboardInteractionCommandOptions = {}
Returns
Section titled “Returns”interaction
Section titled “interaction”interaction: (
target,options) =>GameboardInteractionTargetReport
Resolve and inspect an interaction target.
Parameters
Section titled “Parameters”target
Section titled “target”GameboardInteractionTargetInput
options?
Section titled “options?”GameboardInteractionTargetOptions = {}
Returns
Section titled “Returns”GameboardInteractionTargetReport
move: (
actor,to,options) =>Entity
Move an actor to another tile.
Parameters
Section titled “Parameters”string | Entity
string | HexCoordinates
options?
Section titled “options?”MoveGameboardActorOptions = {}
Returns
Section titled “Returns”Entity
navigationProfile
Section titled “navigationProfile”navigationProfile: (
actor,options) =>GameboardNavigationProfile
Create an actor-aware navigation profile.
Parameters
Section titled “Parameters”string | Entity
options?
Section titled “options?”GameboardActorNavigationOptions = {}
Returns
Section titled “Returns”neighborhood
Section titled “neighborhood”neighborhood: (
center,options) =>GameboardNeighborhoodInspection
Inspect a radius of tiles around a center.
Parameters
Section titled “Parameters”center
Section titled “center”options?
Section titled “options?”GameboardNeighborhoodInspectionOptions = {}
Returns
Section titled “Returns”GameboardNeighborhoodInspection
read: () =>
GameboardActorSnapshot[]
Read all registered actors.
Returns
Section titled “Returns”register
Section titled “register”register: (
placement,options) =>Entity
Register an existing placement as an actor.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
options
Section titled “options”GameboardActorRegistrationOptions
Returns
Section titled “Returns”Entity
select
Section titled “select”select: (
options) =>GameboardActorSelection
Select actors with optional faction, team, tag, radius, and hostility filters.
Parameters
Section titled “Parameters”options?
Section titled “options?”GameboardActorSelectionOptions = {}
Returns
Section titled “Returns”spawn: (
options) =>Entity
Spawn a placement and register it as an actor.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Entity
targets
Section titled “targets”targets: (
options) =>GameboardActorTargetingReport
Select and path to candidate actor targets.
Parameters
Section titled “Parameters”options
Section titled “options”GameboardActorTargetingOptions
Returns
Section titled “Returns”tile: (
coordinates,options) =>GameboardTileInspection
Inspect one tile from an actor/gameplay perspective.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”string | HexCoordinates
options?
Section titled “options?”GameboardTileInspectionOptions = {}
Returns
Section titled “Returns”update
Section titled “update”update: (
actor,options) =>Entity
Update actor trait state while preserving omitted fields.
Parameters
Section titled “Parameters”string | Entity
options
Section titled “options”Returns
Section titled “Returns”Entity