grid-engine
    Preparing search index...

    Interface PathfindingOptions

    Configuration object for pathfinding.

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

    Properties

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

    Properties

    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).

    true
    collisionGroups?: string[]

    The collision groups to consider for pathfinding.

    considerCosts?: boolean

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

    false
    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.

    ignoredChars?: string[]

    Set of characters to ignore at collision checking.

    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.

    false
    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.

    ignoreTiles?: boolean

    If set to true, tile collisions will be ignored.

    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.

    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.

    numberOfDirections?: NumberOfDirections

    The number of directions to consider.

    pathHeight?: number

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

    pathWidth?: number

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

    shortestPathAlgorithm?: ShortestPathAlgorithmType

    Algorithm used for Pathfinding.

    Settings

    Member Visibility

    On This Page

    Properties