Class LineBrush

This Brush helps draw lines of Tiles onto a Tilemap. Use this as an example to modify brush painting behaviour to making painting quicker with less actions.

Inheritance

object

Object

ScriptableObject

GridBrushBase

GridBrush

LineBrush

Inherited Members

GridBrush.size

GridBrush.pivot

GridBrush.cells

GridBrush.cellCount

GridBrush.canChangeZPosition

GridBrush.lastPickedCellLayout

GridBrush.lastPickedCellSwizzle

GridBrush.lastPickedCellSize

GridBrush.lastPickedCellGap

GridBrush.Init(Vector3Int)

GridBrush.Init(Vector3Int, Vector3Int)

GridBrush.Erase(GridLayout, GameObject, Vector3Int)

GridBrush.BoxFill(GridLayout, GameObject, BoundsInt)

GridBrush.BoxErase(GridLayout, GameObject, BoundsInt)

GridBrush.FloodFill(GridLayout, GameObject, Vector3Int)

GridBrush.Rotate(GridBrushBase.RotationDirection, GridLayout.CellLayout)

GridBrush.Flip(GridBrushBase.FlipAxis, GridLayout.CellLayout)

GridBrush.Pick(GridLayout, GameObject, BoundsInt, Vector3Int)

GridBrush.Reset()

GridBrush.UpdateSizeAndPivot(Vector3Int, Vector3Int)

GridBrush.SetTile(Vector3Int, TileBase)

GridBrush.SetMatrix(Vector3Int, Matrix4x4)

GridBrush.SetColor(Vector3Int, Color)

GridBrush.GetCellIndex(Vector3Int)

GridBrush.GetCellIndex(int, int, int)

GridBrush.GetCellIndex(int, int, int, int, int, int)

GridBrush.GetCellIndexWrapAround(int, int, int)

GridBrush.GetHashCode()

GridBrushBase.Select(GridLayout, GameObject, BoundsInt)

GridBrushBase.Move(GridLayout, GameObject, BoundsInt, BoundsInt)

GridBrushBase.ChangeZPosition(int)

GridBrushBase.ResetZPosition()

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.Tilemaps

Assembly: Unity.2D.Tilemap.Extras.Editor.dll

Syntax

[HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.tilemap.extras@latest/index.html?subfolder=/manual/LineBrush.html")]
[CustomGridBrush(true, false, false, "Line Brush")]
public class LineBrush : GridBrush

Fields

fillGaps

Ensures that there are orthogonal connections of Tiles from the start of the line to the end.

Declaration

public bool fillGaps

Field Value

Type	Description
bool

lineStart

The current starting point of the line.

Declaration

public Vector3Int lineStart

Field Value

Type	Description
Vector3Int

lineStartActive

Whether the Line Brush has started drawing a line.

Declaration

[NonSerialized]
public bool lineStartActive

Field Value

Type	Description
bool

Properties

IsMoving

Indicates whether the brush is currently moving something using the "Move selection with active brush" tool.

Declaration

public bool IsMoving { get; }

Property Value

Type	Description
bool

Methods

GetPointsOnLine(Vector2Int, Vector2Int)

Gets an enumerable for all the cells directly between two points http://ericw.ca/notes/bresenhams-line-algorithm-in-csharp.html

Declaration

public static IEnumerable<Vector2Int> GetPointsOnLine(Vector2Int p1, Vector2Int p2)

Parameters

Type	Name	Description
Vector2Int	p1	A starting point of a line
Vector2Int	p2	An ending point of a line

Returns

Type	Description
IEnumerable<Vector2Int>	Gets an enumerable for all the cells directly between two points

GetPointsOnLine(Vector2Int, Vector2Int, bool)

Enumerates all the points between the start and end position which are linked diagonally or orthogonally.

Declaration

public static IEnumerable<Vector2Int> GetPointsOnLine(Vector2Int startPos, Vector2Int endPos, bool fillGaps)

Parameters

Type	Name	Description
Vector2Int	startPos	Start position of the line.
Vector2Int	endPos	End position of the line.
bool	fillGaps	Fills any gaps between the start and end position so that all points are linked only orthogonally.

Returns

Type	Description
IEnumerable<Vector2Int>	Returns an IEnumerable which enumerates all the points between the start and end position which are linked diagonally or orthogonally.

MoveEnd(GridLayout, GameObject, BoundsInt)

Ends the movement of tiles and GameObjects to a given position within the selected layers.

Declaration

public override void MoveEnd(GridLayout grid, GameObject brushTarget, BoundsInt position)

Parameters

Type	Name	Description
GridLayout	grid	Grid used for layout.
GameObject	brushTarget	Target of the Move operation. By default the currently selected GameObject.
BoundsInt	position	The coordinates of the cell to move data to.

Overrides

GridBrush.MoveEnd(GridLayout, GameObject, BoundsInt)

MoveStart(GridLayout, GameObject, BoundsInt)

Starts the movement of tiles and GameObjects from a given position within the selected layers.

Declaration

public override void MoveStart(GridLayout grid, GameObject brushTarget, BoundsInt position)

Parameters

Type	Name	Description
GridLayout	grid	Grid used for layout.
GameObject	brushTarget	Target of the Move operation. By default the currently selected GameObject.
BoundsInt	position	The coordinates of the cell to move data from.

Overrides

GridBrush.MoveStart(GridLayout, GameObject, BoundsInt)

Paint(GridLayout, GameObject, Vector3Int)

Paints tiles and GameObjects into a given position within the selected layers. The LineBrush overrides this to provide line painting functionality. The first paint action sets the starting point of the line. The next paint action sets the ending point of the line and paints Tile from start to end.

Declaration

public override void Paint(GridLayout grid, GameObject brushTarget, Vector3Int position)

Parameters

Type	Name	Description
GridLayout	grid	Grid used for layout.
GameObject	brushTarget	Target of the paint operation. By default the currently selected GameObject.
Vector3Int	position	The coordinates of the cell to paint data to.

Overrides

GridBrush.Paint(GridLayout, GameObject, Vector3Int)