SnakeBot/node_modules/pathfinding/docs/user-guide/diagonal-movement.md

# Diagonal Movement
To disable diagonal movement you need to configure the finder. The finder takes
a configuration object with an option called `diagonalMovement`. Setting this
option to `DiagonalMovement.Never` will disable diagonal movement completely.
Let us try it.

```javascript
var finder = new PF.AStarFinder({
    diagonalMovement: PF.DiagonalMovement.Never
});
```

See that the path is straight now:

![Screenshot](user-guide/images/DiagonalMovementDisabled.png)

The `diagonalMovement` option can take any of the following values:

* Always
* Never
* IfAtMostOneObstacle
* OnlyWhenNoObstacles

To understand them consider the following four simple maps labelled A, B, C and
D. A has no obstacles for diagonal movement from green to orange cell, B and C
have one obstacle and D has two obstacles.

![Screenshot](user-guide/images/DiagonalMaps.png)

## Always
With this option PathFinding.js will always find a diagonal path, irrespective
of the obstacles when moving diagonally.

![Screenshot](user-guide/images/AllMapsWithAPath.png)

## Never
With this option PathFinding.js will only find straight paths and will never
find any diagonal paths.

![Screenshot](user-guide/images/AllMapsWithStraightPaths.png)

## IfAtMostOneObstacle
With this option PathFinding.js will find diagonal paths only if there is at
most one obstacle for the diagonal path.

![Screenshot](user-guide/images/DiagonalPathsForAtMostOneObstacle.png)

## OnlyWhenNoObstacles
With this option PathFinding.js will find diagonal paths only if there are no
obstacles for the diagonal path.

![Screenshot](user-guide/images/DiagonalPathsForOnlyWhenNoObstacles.png)