Net-Game/Library/PackageCache/com.unity.2d.tilemap.extras@13634da7dbe0/Documentation~/LineBrush.md

# Line Brush ![Line Brush Icon](images/LineBrushIcon.png)

__Contribution by :__  [CraigGraff](https://github.com/CraigGraff)

This Brush draws a line of Tiles onto a Tilemap. With this Brush selected, click once to set the starting point of the
line and click again at another position to set the ending point of the line. This Brush then draws a line of Tiles
between the two points.

Use this as an example to create custom Brush behavior to make painting more efficient.

## Properties

| Property              | Function                                                                                                    |
|-----------------------|-------------------------------------------------------------------------------------------------------------|
| __Line Start Active__ | Indicates whether the Line Brush has started drawing a line.                                                |
| __Fill Gaps__         | Ensures that there are orthogonal connections between all Tiles that connect the start and end of the line. |
| __Line Start__        | The current starting point of the line.                                                                     |

## Usage

Select the Line Brush, then click once on a cell of the Tilemap to set the starting point of the line, then click on a
second cell to set the ending point of the line. The Brush then draws the line of Tiles between the two set points. When
the Line Brush is active, a blue outline will indicate the starting point of the line.

![Scene View with Line Brush](images/LineBrush.png)

To have Tiles which are orthogonally connected from start to end, enable the __Fill Gaps__ property in the Brush Editor.

![Scene View with Line Brush with Fill Gaps](images/LineBrushFillGaps.png)

## Implementation

The Line Brush inherits from the Grid Brush and overrides the `Paint` method to implement the line painting
functionality.