useMovementAgent
useMovementAgent(
entity): {movementBudget:number;profileId:GameboardMovementProfileId;remainingMovement:number; } |undefined
Defined in: src/react/react.ts:906
Read movement agent metadata for one moving placement.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity | null | undefined
Returns
Section titled “Returns”Type Literal
Section titled “Type Literal”{ movementBudget: number; profileId: GameboardMovementProfileId; remainingMovement: number; }
movementBudget
Section titled “movementBudget”movementBudget:
number=6
Maximum movement budget.
profileId
Section titled “profileId”profileId:
GameboardMovementProfileId
Movement profile id used by this agent.
remainingMovement
Section titled “remainingMovement”remainingMovement:
number=6
Remaining movement budget in the current cycle.
undefined