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

Rotorz.Tile Namespace

This namespace contains classes and components that provide the fundamental functionality of tile systems, brushes and tilesets. The contents of this namespace can be used to interact with tile systems at runtime, or even to create a custom in-game level designer.

Classes

AliasBrush
An alias brush targets an existing brush allowing the user to override certain properties and remap materials.
AutotileBrush
Autotile brushes make it easier for artists to design 2D tiles that connect with one another. This type of brush is particularly useful for creating things like walls, paths, platforms, etc.
AutotileTileset
Autotile tilesets are created automatically and are paired with an atlas texture that is an expanded form of the input autotile artwork.
Brush
A brush is a template that defines how tiles can be painted and maintained on a tile system. Brushes are typically used in conjunction with tools when using the editor, however it is useful to note that brushes can also be orchestrated by custom scripts at runtime.
BrushOrientation
Describes one orientation of an oriented brush.
BrushPropertyAttribute
This attribute can be applied to brush properties in custom scripts to specify whether alias or master brushes can be selected when using brush picker interface via the inspector.
Chunk
A chunk is a sub-grid of tiles which forms part of an overall tile system. The size of a chunk is specified when creating a tile system though can be changed via the tile system inspector.
CoalescableBrushExtensions
Extension methods for the ICoalescableBrush interface.
CustomImmediatePreview
Can be extended to provide a custom immediate preview implementation which can then be attached to the root-most component of a tile prefab to override immediate preview of oriented brushes.
DefaultRuntimeObjectFactory
The default object factory that is used to create and destroy tile game objects at runtime.
EmptyBrush
Empty tiles do not have any visual representation, game object or components. These can be useful when creating oriented tiles that require gaps (inner orientation, for example). A master brush "Empty Variation" is provided for this very purpose.
ImmediatePreviewUtility
Utility class to assist with the drawing of immediate in-editor tile previews.
MaterialMappingExtensions
Extension methods for IMaterialMappings interface.
OrientationUtility
Tile orientation utility functions.
OrientedBrush
Oriented tile brush.
PaintingUtility
Utility functions for painting tiles, lines of tiles, circles and squares. The editor tools included with this extension use this class to paint tiles though this class can also be used by custom scripts at runtime.
PlopGroup
Automatically added to container object when plopped objects are grouped.
PlopInstance
Automatically added to objects which are plopped using the plop tool making it easy to identify whether an object was plopped.
ProceduralMesh
Procedural mesh component is automatically attached to chunks when procedural 2D tiles are painted.
ProductInfo
Product information.
ReduceColliderOptions
Options which are considered when reducing colliders.
ReduceColliderUtility
Utility class provides functionality for optimizing 2D and 3D box colliders within tiles for the specified tile system. Behaviour can be customized on a per tile system basis by altering TileSystem.ReduceColliders.
StrippingUtility
Functionality for stripping unwanted aspects of a tile system.
TileData
Data that describes a painted tile.
Tileset
A tileset allows tileset brushes to paint procedural or non-procedural tiles using an atlas texture that contains multiple tiles.
TilesetBrush
Tileset brushes can paint tiles from a tileset.
TileSystem
Main tile system component which allows you to interact with a tile system using runtime or editor scripts.
TileSystemUtility
Utility functionality for tile systems.

Structures

ChunkCreatedEventArgs
Arguments for ChunkCreatedEventHandler event handlers.
PaintingArgs
A selection of arguments which can be used to influence the way in which tiles are painted when using the PaintingUtility class.
TileIndex
Two-dimensional index of tile in a tile system.
TilePaintedEventArgs
Arguments for TilePaintedEventHandler event handlers.
TileTraceHit
Provides details about tile trace hit result.
WillEraseTileEventArgs
Arguments for WillEraseTileEventHandler event handlers.

Interfaces

IBrushContext
Context of tile that is being painted using a brush.
ICoalescableBrush
Interface for a brush which has support for coalescing rules.
IDesignableObject
Represents an object which can be selected in the designer window.
IHistoryObject
Represents an object which can be recorded in history.
IMaterialMappings
Interface that can be implemented by brushes for material mapping capabilities.
IObjectFactory
Interface for an object creator which can be implemented and utilised to override the way in which game objects are created and destroyed.
IObjectFactoryContext
Interface to describe the context in which an object is being instantiated or destroyed.
ITilesetMetrics
Metrics of a tileset.

Delegates

ChunkCreatedEventHandler
Represents the method that will handle the ChunkCreated event.
TilePaintedEventHandler
Represents the method that will handle the TilePainted event.
TileSystemDelegate
Delegate for tile system.
TileTraceDelegate
Represents a method that is used to find tile when using TileSystem.TileTraceCustom.
WillEraseTileEventHandler
Represents the method that will handle the WillEraseTile event.

Enumerations

AutotileLayout
Style of autotile layout.
BrushNozzle
Shape of brush nozzle.
BrushVisibility
The visibility of a brush.
BuildCombineMethod
Method of combining to perform upon build.
Coalesce
Indicates a method of coalescing which are used by brushes that support orientation including oriented brushes and autotile brushes.
ColliderType
Identifies a type of collider.
FallbackMode
Specifies how to handle undefined orientations.
InheritYesNo
A value of yes or no that can be optionally inherited.
KeepSeparateColliderFlag
Suggests whether colliders should be kept separate under certain scenarios.
RefreshFlags
Bit mask that defines how tiles should be refreshed.
RepairAction
Action to take for broken and/or dirty tiles.
ScaleMode
Indicates the way in which a painted tile is scaled.
StrippingPreset
Identifies desired level of stripping.
TileFacing
Direction that tiles will face upon being painted.
TileTraceDirection
Direction in which to trace tiles.