Interface PathfindingOptions

Configuration object for pathfinding.

interface PathfindingOptions {
    calculateClosestToTarget?: boolean;
    collisionGroups?: string[];
    considerCosts?: boolean;
    ignoreBlockedTarget?: boolean;
    ignoreLayers?: boolean;
    ignoreMapBounds?: boolean;
    ignoreTiles?: boolean;
    ignoredChars?: string[];
    isPositionAllowed?: IsPositionAllowedFn;
    maxPathLength?: number;
    numberOfDirections?: NumberOfDirections;
    pathHeight?: number;
    pathWidth?: number;
    shortestPathAlgorithm?: ShortestPathAlgorithmType;
}

Properties

calculateClosestToTarget? collisionGroups? considerCosts? ignoreBlockedTarget? ignoreLayers? ignoreMapBounds? ignoreTiles? ignoredChars? isPositionAllowed? maxPathLength? numberOfDirections? pathHeight? pathWidth? shortestPathAlgorithm?

Properties

Optional calculateClosestToTarget

calculateClosestToTarget?: boolean

If true, PathfindingResult.closestToTarget is calculated. Otherwise it is ignored in some algorithms and will not be set in PathfindingResult. Depending on the used pathfinding algorithm (like for BIDIRECTIONAL_SEARCH) it can be faster if it is disabled. It will not be ignored in algorithms where it does not come with a performance penalty (like BFS).

Default

true

Optional collisionGroups

collisionGroups?: string[]

The collision groups to consider for pathfinding.

Optional considerCosts

considerCosts?: boolean

Only considered by A* algorithm. If set to true, pathfinding will consider costs. Costs are set via tile properties.

Default

false

Optional ignoreBlockedTarget

ignoreBlockedTarget?: boolean

If set to true, pathfinding will find a path, even if the target is blocked. This is a common use case if you want to find the shortest path to a blocking character.

Optional ignoreLayers

ignoreLayers?: boolean

If set to true, pathfinding will only be performed on the char layer of the start position. If you don't use char layers, activating this setting can improve pathfinding performance.

Default

false

Optional ignoreMapBounds

ignoreMapBounds?: boolean

If set to true, map boundaries are ignored. By default, positions outside of the boundaries of the tilemap are considered to be blocking, even if PathfindingOptions.ignoreTiles is set to false.

Optional ignoreTiles

ignoreTiles?: boolean

If set to true, tile collisions will be ignored.

Optional ignoredChars

ignoredChars?: string[]

Set of characters to ignore at collision checking.

Optional isPositionAllowed

isPositionAllowed?: IsPositionAllowedFn

Function to specify whether a certain position is allowed for pathfinding. If the function returns false, the tile will be consindered as blocked.

It can be used to restrict pathfinding to specific regions.

Beware that this method can become a performance bottleneck easily. So be careful and keep it as efficient as possible. An asymptotic runtime complexity of O(1) is recommended.

Optional maxPathLength

maxPathLength?: number

If this is set, the algorithm will stop once it reaches a path length of this value. This is useful to avoid running out of memory on large or infinite maps.

Optional numberOfDirections

numberOfDirections?: NumberOfDirections

The number of directions to consider.

Optional pathHeight

pathHeight?: number

Consecutive tiles in y-dimension that need to fit in the path. This is useful for characters that span over multiple tiles.

Optional pathWidth

pathWidth?: number

Consecutive tiles in x-dimension that need to fit in the path. This is useful for characters that span over multiple tiles.

Optional shortestPathAlgorithm

shortestPathAlgorithm?: ShortestPathAlgorithmType

Algorithm used for Pathfinding.

Settings

Member Visibility

Theme

On This Page

calculateClosestToTargetcollisionGroupsconsiderCostsignoreBlockedTargetignoreLayersignoreMapBoundsignoreTilesignoredCharsisPositionAllowedmaxPathLengthnumberOfDirectionspathHeightpathWidthshortestPathAlgorithm