useGameboardPatrolActions
useGameboardPatrolActions():
object
Defined in: src/react/react.ts:440
Bind patrol actions for attaching patrol agents and route state.
Returns
Section titled “Returns”advance
Section titled “advance”advance: (
placement,options) =>GameboardPatrolAdvanceResult
Advance one patrol agent.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
options?
Section titled “options?”AdvanceGameboardPatrolOptions = {}
Returns
Section titled “Returns”clear: (
placement) =>Entity
Remove patrol traits from a placement.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
Returns
Section titled “Returns”Entity
read: () =>
GameboardPatrolSnapshot[]
Read all patrol snapshots.
Returns
Section titled “Returns”run: (
options) =>GameboardPatrolAdvanceResult[]
Advance every patrol agent in the world.
Parameters
Section titled “Parameters”options?
Section titled “options?”AdvanceGameboardPatrolOptions = {}
Returns
Section titled “Returns”GameboardPatrolAdvanceResult[]
set: (
placement,options) =>Entity
Attach or replace a patrol agent.
Parameters
Section titled “Parameters”placement
Section titled “placement”string | Entity
options
Section titled “options”SetGameboardPatrolAgentOptions
Returns
Section titled “Returns”Entity