useGameboardMovementActions
useGameboardMovementActions():
object
Defined in: src/react/react.ts:416
Bind movement actions for starting, advancing, and completing placement paths.
Returns
Section titled “Returns”advance
Section titled “advance”advance: (
placement,options) =>GameboardMovementAdvanceResult
Advance one placement along its requested path.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
options?
Section titled “options?”AdvanceGameboardMovementOptions = {}
Returns
Section titled “Returns”GameboardMovementAdvanceResult
clear: (
placement) =>Entity
Clear active movement path state for a placement.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
Returns
Section titled “Returns”Entity
reachable
Section titled “reachable”reachable: (
placement,options) =>GameboardReachableTile[]
Return tiles reachable by one movement agent.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
options?
Section titled “options?”Returns
Section titled “Returns”requestMove
Section titled “requestMove”requestMove: (
placement,destination,options) =>GameboardMovementRequestResult
Request movement to a destination.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
destination
Section titled “destination”string | HexCoordinates
options?
Section titled “options?”GameboardMovementPathRequestOptions = {}
Returns
Section titled “Returns”GameboardMovementRequestResult
resetBudget
Section titled “resetBudget”resetBudget: (
placement?,options) => readonlyEntity[]
Reset movement budget for one or all movement agents.
Parameters
Section titled “Parameters”placement?
Section titled “placement?”string | Entity
options?
Section titled “options?”Returns
Section titled “Returns”readonly Entity[]
runSystem
Section titled “runSystem”runSystem: (
options) =>GameboardMovementAdvanceResult[]
Advance all active movement agents.
Parameters
Section titled “Parameters”options?
Section titled “options?”AdvanceGameboardMovementOptions = {}
Returns
Section titled “Returns”GameboardMovementAdvanceResult[]
setAgent
Section titled “setAgent”setAgent: (
placement,options) =>Entity
Add or update a movement agent on a placement.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
options?
Section titled “options?”SetGameboardMovementAgentOptions = {}
Returns
Section titled “Returns”Entity