GameboardMovementPathRequestOptions
Defined in: src/movement/movement.ts:101
Options for requesting a path for a movement agent.
Extends
Section titled “Extends”Properties
Section titled “Properties”allowOutOfRangePath?
Section titled “allowOutOfRangePath?”
optionalallowOutOfRangePath?:boolean
Defined in: src/movement/movement.ts:103
Keep a found path even when it exceeds the current budget.
ignorePlacementIds?
Section titled “ignorePlacementIds?”
optionalignorePlacementIds?: readonlystring[]
Defined in: src/movement/movement.ts:85
Placement ids ignored during pathing.
Inherited from
Section titled “Inherited from”GameboardMovementOptions.ignorePlacementIds
movementBudget?
Section titled “movementBudget?”
optionalmovementBudget?:number
Defined in: src/movement/movement.ts:83
Movement budget override.
Inherited from
Section titled “Inherited from”GameboardMovementOptions.movementBudget
navigation?
Section titled “navigation?”
optionalnavigation?:GameboardNavigationProfile
Defined in: src/movement/movement.ts:87
Navigation profile overrides merged over the movement profile.
Inherited from
Section titled “Inherited from”GameboardMovementOptions.navigation
profile?
Section titled “profile?”
optionalprofile?:GameboardMovementProfileInput
Defined in: src/movement/movement.ts:79
Movement profile id or inline profile.
Inherited from
Section titled “Inherited from”GameboardMovementOptions.profile
profiles?
Section titled “profiles?”
optionalprofiles?:GameboardMovementProfileRegistry
Defined in: src/movement/movement.ts:81
Registry used to resolve profile ids.