Class RandomBrush

This Brush helps to place random Tiles onto a Tilemap. Use this as an example to create brushes which store specific data per brush and to make brushes which randomize behaviour.

Inheritance

Object

GridBrush

RandomBrush

Inherited Members

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.MoveStart(GridLayout, GameObject, BoundsInt)

GridBrush.MoveEnd(GridLayout, GameObject, BoundsInt)

GridBrush.Reset()

GridBrush.UpdateSizeAndPivot(Vector3Int, Vector3Int)

GridBrush.SetTile(Vector3Int, TileBase)

GridBrush.SetMatrix(Vector3Int, Matrix4x4)

GridBrush.SetColor(Vector3Int, Color)

GridBrush.GetCellIndex(Vector3Int)

GridBrush.GetCellIndex(Int32, Int32, Int32)

GridBrush.GetCellIndex(Int32, Int32, Int32, Int32, Int32, Int32)

GridBrush.GetCellIndexWrapAround(Int32, Int32, Int32)

GridBrush.GetHashCode()

GridBrush.size

GridBrush.pivot

GridBrush.cells

GridBrush.cellCount

GridBrush.canChangeZPosition

Namespace: UnityEditor.Tilemaps

Syntax

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

Fields

addToRandomTiles

A flag to determine if picking will add to existing RandomTileSets

Declaration

public bool addToRandomTiles

Field Value

Type	Description
Boolean

pickRandomTiles

A flag to determine if picking will add new RandomTileSets

Declaration

public bool pickRandomTiles

Field Value

Type	Description
Boolean

randomTileSets

An array of RandomTileSets to choose from when randomizing

Declaration

public RandomBrush.RandomTileSet[] randomTileSets

Field Value

Type	Description
RandomBrush.RandomTileSet[]

randomTileSetSize

The size of a RandomTileSet

Declaration

public Vector3Int randomTileSetSize

Field Value

Type	Description
Vector3Int

Methods

Paint(GridLayout, GameObject, Vector3Int)

Paints RandomTileSets into a given position within the selected layers. The RandomBrush overrides this to provide randomized painting functionality.

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.

Pick(GridLayout, GameObject, BoundsInt, Vector3Int)

Picks RandomTileSets given the coordinates of the cells. The RandomBrush overrides this to provide picking functionality for RandomTileSets.

Declaration

public override void Pick(GridLayout gridLayout, GameObject brushTarget, BoundsInt bounds, Vector3Int pickStart)

Parameters

Type	Name	Description
GridLayout	gridLayout	Grid to pick data from.
GameObject	brushTarget	Target of the picking operation. By default the currently selected GameObject.
BoundsInt	bounds	The coordinates of the cells to paint data from.
Vector3Int	pickStart	Pivot of the picking brush.