useGameboardPatrolState
useGameboardPatrolState(
entity): {lastPathKeys:string[];reason:string|undefined;status:GameboardPatrolStatus;targetKey:string; } |undefined
Defined in: src/react/react.ts:951
Read live patrol route progress for one actor entity.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity | null | undefined
Returns
Section titled “Returns”Type Literal
Section titled “Type Literal”{ lastPathKeys: string[]; reason: string | undefined; status: GameboardPatrolStatus; targetKey: string; }
lastPathKeys
Section titled “lastPathKeys”lastPathKeys:
string[]
Last requested movement path tile keys.
reason
Section titled “reason”reason:
string|undefined
Blocked or paused reason.
status
Section titled “status”status:
GameboardPatrolStatus
Current patrol status.
targetKey
Section titled “targetKey”targetKey:
string=''
Current target waypoint tile key.
undefined