NEWS
COMMUNITY
STORE
LABS
ROKOJORI
NEWSLETTER
SIGN UPLOGIN
LOGOUTNEWS
COMMUNITY
STORE
LABS
AStarGrid2D is a variant of AStar2D that is specialized for partial 2D grids. It is simpler to use because it doesn't require you to manually create points and connect them together. This class also supports multiple types of heuristics, modes for diagonal movement, and a jumping mode to speed up calculations.
To use AStarGrid2D, you only need to set the region of the grid, optionally set the cell_size, and then call the update method:
To remove a point from the pathfinding grid, it must be set as "solid" with set_point_solid.
HEURISTIC_EUCLIDEAN = 0
The Euclidean heuristic to be used for the pathfinding using the following formula:
HEURISTIC_MANHATTAN = 1
The Manhattan heuristic to be used for the pathfinding using the following formula:
HEURISTIC_OCTILE = 2
The Octile heuristic to be used for the pathfinding using the following formula:
HEURISTIC_CHEBYSHEV = 3
The Chebyshev heuristic to be used for the pathfinding using the following formula:
HEURISTIC_MAX = 4
Represents the size of the Heuristic enum.
DIAGONAL_MODE_ALWAYS = 0
The pathfinding algorithm will ignore solid neighbors around the target cell and allow passing using diagonals.
DIAGONAL_MODE_NEVER = 1
The pathfinding algorithm will ignore all diagonals and the way will be always orthogonal.
DIAGONAL_MODE_AT_LEAST_ONE_WALKABLE = 2
The pathfinding algorithm will avoid using diagonals if at least two obstacles have been placed around the neighboring cells of the specific path segment.
DIAGONAL_MODE_ONLY_IF_NO_OBSTACLES = 3
The pathfinding algorithm will avoid using diagonals if any obstacle has been placed around the neighboring cells of the specific path segment.
DIAGONAL_MODE_MAX = 4
Represents the size of the DiagonalMode enum.
CELL_SHAPE_SQUARE = 0
Rectangular cell shape.
CELL_SHAPE_ISOMETRIC_RIGHT = 1
Diamond cell shape (for isometric look). Cell coordinates layout where the horizontal axis goes up-right, and the vertical one goes down-right.
CELL_SHAPE_ISOMETRIC_DOWN = 2
Diamond cell shape (for isometric look). Cell coordinates layout where the horizontal axis goes down-right, and the vertical one goes down-left.
CELL_SHAPE_MAX = 3
Represents the size of the CellShape enum.
The cell shape. Affects how the positions are placed in the grid. If changed, update needs to be called before finding the next path.
The size of the point cell which will be applied to calculate the resulting point position returned by get_point_path. If changed, update needs to be called before finding the next path.
The default Heuristic which will be used to calculate the cost between two points if _compute_cost was not overridden.
The default Heuristic which will be used to calculate the cost between the point and the end point if _estimate_cost was not overridden.
A specific DiagonalMode mode which will force the path to avoid or accept the specified diagonals.
Enables or disables jumping to skip up the intermediate points and speeds up the searching algorithm.
Note: Currently, toggling it on disables the consideration of weight scaling in pathfinding.
The offset of the grid which will be applied to calculate the resulting point position returned by get_point_path. If changed, update needs to be called before finding the next path.
The region of grid cells available for pathfinding. If changed, update needs to be called before finding the next path.
The size of the grid (number of cells of size cell_size on each axis). If changed, update needs to be called before finding the next path.
Deprecated. Use region instead.
Called when computing the cost between two connected points.
Note that this function is hidden in the default AStarGrid2D class.
Called when estimating the cost between a point and the path's ending point.
Note that this function is hidden in the default AStarGrid2D class.
Clears the grid and sets the region to Rect2i(0, 0, 0, 0).
Fills the given region on the grid with the specified value for the solid flag.
Note: Calling update is not needed after the call of this function.
Fills the given region on the grid with the specified value for the weight scale.
Note: Calling update is not needed after the call of this function.
Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path.
Returns an array with the points that are in the path found by AStarGrid2D between the given points. The array is ordered from the starting point to the ending point of the path.
Note: This method is not thread-safe. If called from a Thread, it will return an empty PackedVector3Array and will print an error message.
Returns the position of the point associated with the given id.
Returns the weight scale of the point associated with the given id.
Indicates that the grid parameters were changed and update needs to be called.
Returns true if the x and y is a valid grid coordinate (id), i.e. if it is inside region. Equivalent to region.has_point(Vector2i(x, y)).
Returns true if the id vector is a valid grid coordinate, i.e. if it is inside region. Equivalent to region.has_point(id).
Returns true if a point is disabled for pathfinding. By default, all points are enabled.
Disables or enables the specified point for pathfinding. Useful for making an obstacle. By default, all points are enabled.
Note: Calling update is not needed after the call of this function.
Sets the weight_scale for the point with the given id. The weight_scale is multiplied by the result of _compute_cost when determining the overall cost of traveling across a segment from a neighboring point to this point.
Note: Calling update is not needed after the call of this function.
Updates the internal state of the grid according to the parameters to prepare it to search the path. Needs to be called if parameters like region, cell_size or offset are changed. is_dirty will return true if this is the case and this needs to be called.
Note: All point data (solidity and weight scale) will be cleared.
