Rotorz Tile System Icon
Rotorz Tile System for Unity
API Reference
Available on the Unity Asset Store
TOC

TilesetBrush Class

Tileset brushes can paint tiles from a tileset.
public class TilesetBrush : Brush
public class TilesetBrush extends Brush

Refer to Tileset Brushes section of user guide for further information.

Methods

ApplyTransforms(IBrushContext, TileData, Brush)
Apply transforms to newly painted tile and orientate against tile system.
Awake()
Invoked when brush first becomes active.
(Inherited from Brush.)
CalculateManualOffset(IBrushContext, TileData, Transform, Vector3, Quaternion, Vector3, Brush)
Calculates offset from actual tile position and where tile would normally be positioned by brush. This is used to preserve manually tweaked offsets when tiles are refreshed.
CountTileVariations(Int32)
Count the number of tile variations.
(Inherited from Brush.)
CreateNonProceduralTile(IBrushContext, TileData, Boolean)
Create non-procedural tile.
CreateProceduralTile(IBrushContext, TileData, Boolean)
Create procedural tile.
CreateTile(IBrushContext, TileData)
Create visual representation of tile.
Cycle(TileSystem, TileIndex, Int32)
Cycle through tile variations.
(Inherited from Brush.)
Cycle(TileSystem, Int32, Int32, Int32)
Cycle through tile variations.
(Inherited from Brush.)
CycleWithSimpleRotation(TileSystem, TileIndex, Int32, Int32)
Cycle through tile variations and/or rotation indices.
(Inherited from Brush.)
CycleWithSimpleRotation(TileSystem, Int32, Int32, Int32, Int32)
Cycle through tile variations and/or rotation indices.
(Inherited from Brush.)
DrawImmediateTilePreview(IBrushContext, Material, TileData, Brush)
Helper method to draw immediate preview of tileset tile.
GetNthMaterial(Int32)
Gets the nth material from available renderers.
(Inherited from Brush.)
GetTransformMatrix(TileSystem, TileIndex, Int32, Transform)
Gets matrix that describes transformation of tile painted using brush in local space of tile system.
(Inherited from Brush.)
GetTransformMatrix(TileSystem, Int32, Int32, Int32, Transform)
Gets matrix that describes transformation of tile painted using brush in local space of tile system.
(Inherited from Brush.)
GetUserFlag(Int32)
Get state of custom user flag.
(Inherited from Brush.)
OnAfterDeserialize()
See Unity documentation OnAfterDeserialize() for further information regarding this method.
(Inherited from Brush.)
OnBeforeSerialize()
See Unity documentation OnBeforeSerialize() for further information regarding this method.
(Inherited from Brush.)
OnDrawImmediatePreview(IBrushContext, TileData, Material, Brush)
Draws preview of tile using the Unity graphics or gizmos class.
Paint(TileSystem, TileIndex)
Paint tile using brush.
(Inherited from Brush.)
Paint(TileSystem, TileIndex, Int32)
Paint tile using brush.
(Inherited from Brush.)
Paint(TileSystem, Int32, Int32)
Paint tile using brush.
(Inherited from Brush.)
Paint(TileSystem, Int32, Int32, Int32)
Paint tile using brush.
(Inherited from Brush.)
PaintWithSimpleRotation(TileSystem, TileIndex, Int32)
Paint tile with simple rotation transformation.
(Inherited from Brush.)
PaintWithSimpleRotation(TileSystem, TileIndex, Int32, Int32)
Paint tile with simple rotation transformation.
(Inherited from Brush.)
PaintWithSimpleRotation(TileSystem, Int32, Int32, Int32)
Paint tile with simple rotation transformation.
(Inherited from Brush.)
PaintWithSimpleRotation(TileSystem, Int32, Int32, Int32, Int32)
Paint tile with simple rotation transformation.
(Inherited from Brush.)
PickRandomVariationIndex(Int32)
Get random tile variation.
(Inherited from Brush.)
PostProcessTile(IBrushContext, TileData)
Post process newly painted tile.
PrepareTileData(IBrushContext, TileData, Int32)
Prepare tile data.
Refresh(TileSystem, TileIndex, RefreshFlags)
Refresh a tile.
(Inherited from Brush.)
Refresh(TileSystem, Int32, Int32, RefreshFlags)
Refresh a tile.
(Inherited from Brush.)
SetUserFlag(Int32, Boolean)
Set state of custom user flag.
(Inherited from Brush.)

Fields

addCollider
Indicates whether box colliders should be added to painted tiles.
alwaysAddContainer
Indicates whether empty container object should be created despite not being needed by brush. Container objects are named "tile" and can be seen in tile system hierarchy.
applyPrefabTransform
Indicates when prefab transform should be used to transform painted tiles.
(Inherited from Brush.)
applySimpleRotationToAttachment
Indicates whether simple tile rotation should be applied to attached objects.
attachPrefab
A prefab game object that should be added to painted tiles.
colliderType
The type of collider associated with brush.
customPreviewDesignTime
Indicates whether custom preview should be used at design time.
(Inherited from Brush.)
customPreviewImage
Allows custom preview image to be assigned to brush.
(Inherited from Brush.)
disableImmediatePreview
Indicates whether immediate preview should be disabled for this brush.
(Inherited from Brush.)
forceLegacySideways
Indicates if legacy behaviour should be assumed when painting tiles on tile systems that have sideways facing tiles.
(Inherited from Brush.)
group
Group that brush belong to.
(Inherited from Brush.)
layer
Layer to assign to game objects that are attached to painted tiles.
(Inherited from Brush.)
overrideLayer
Indicates whether brush should override the layer of game objects that are attached to painted tiles when applicable.
(Inherited from Brush.)
overrideTag
Indicates whether brush should override the tag of game objects that are attached to painted tiles when applicable.
(Inherited from Brush.)
overrideTransforms
Indicates if this brush should override the transforms of target brushes.
(Inherited from Brush.)
scaleMode
Indicates how painted tiles should be scaled.
(Inherited from Brush.)
tag
Tag to assign to game objects that are attached to painted tiles.
(Inherited from Brush.)
tileIndex
Zero-based index of tile in tileset.
transformScale
Scale to apply when transforming painted tiles.
(Inherited from Brush.)
visibility
Visibility of brush in user interfaces.
(Inherited from Brush.)

Properties

CanOverrideTagAndLayer
Gets a value indicating whether layer and tag properties can be overridden by this Brush.
CanPreserveTransform
Gets a value indicating whether transform of attached game object can be preserved when refreshing tiles.
(Inherited from Brush.)
CategoryId
Gets or sets identifier of the category that the brush belongs to.
(Inherited from Brush.)
DesignableType
Gets user friendly name of designable type.
IsProcedural
Gets a value indicating whether brush creates procedural or non-procedural tiles.
PerformsAutomaticOrientation
Gets a value indicating whether brush automatically orientates tiles.
Smooth
Gets or sets a value that indicates whether the normals of tiles painted using brush should be smoothed when tile system is built.
(Inherited from Brush.)
SolidFlag
Gets or sets a value indicating whether painted tiles should be flagged as solid.
(Inherited from Brush.)
Static
Gets or sets a value that indicates if brush is static.
(Inherited from Brush.)
Tileset
Gets tileset that brush belongs to.
UseWireIndicatorInEditor
Gets a value indicating whether to use wireframe cursor when painting in the editor. When false an alternative representation can be used instead.

Remarks

This kind of brush is ideal for painting 2D tiles.

Colliders and prefabs can be attached to painted tiles, though this functionality should not be used too excessively to avoid poor performance (this is relative to the number of tiles you expect to paint in a scene).

Tileset brushes can be presented using a procedurally generated mesh, or alternatively using individual pre-generated tile meshes. There are use cases for both, however procedural meshes tend to offer better performance.

Tileset brushes are contained within Tileset assets which make the transition between procedural and non-procedural brushes relatively straightforward. Pre-generated non-procedural meshes are acceses via the tileset asset and are not directly referenced by tileset brushes.

Inheritance Hierarchy

System.Object
  Object
    ScriptableObject
      Rotorz.Tile.Brush
        Rotorz.Tile.TilesetBrush
          Rotorz.Tile.AutotileBrush

See Also

Reference