Version: 2021.2
Other useful classes


The TilemapEditorTool is an inheritable class that defines editor tools for the Tile Palette window. To create a new editor tool for the Tile Palette window, create a new class inheriting from TilemapEditorTool. Override any required methods for your new TilemapEditorToolclass.

You can override the following methods from TilemapEditorTool:

protected abstract string tooltipStringFormat { get; }

Define this to show the tooltip for your TilemapEditorTool. The shortcut for your TilemapEditorToolwill be passed in to this and formatted for the final tooltip.

protected abstract string shortcutId { get; }

Define this to assign a Shortcut Id for identifying your keyboard shortcut for your tool.

public virtual GUIContent toolbarIcon { get; }

Define this to show the icon for your TilemapEditorTool. If this is not defined, the toolbarA row of buttons and basic controls at the top of the Unity Editor that allows you to interact with the Editor in various ways (e.g. scaling, translation). More info
See in Glossary
displays the Tool Mode icon.

public virtual bool HandleTool(bool isHotControl, GridLayout gridLayout, GameObject brushTarget, Vector3Int gridMousePosition)

Override this to determine any custom behavior for handling your TilemapEditorTool. The following parameters are passed into the method for additional information:

Name Function
isHotControl Whether the tool is a hot control under UnityGUI (refer to GUIUtility.hotControl for more information).
gridLayout The GridLayout being handled by the Tool.
brushTarget The GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary
being handled by the Tool.
gridMousePosition The Grid Cell position where the mouse cursor currently is.

public override bool IsAvailable()

Whether your TilemapEditorToolcan be activated at the current time. Use this to validate whether the prerequisites for activating your TilemapEditorToolare available.

The custom TilemapEditorToolcan be added as a default tool in the Tile Palette using the Tile Palette Preferences or as a tool for specific Grid Brushes when your GridBrushhas a BrushToolattribute with the type of your custom TilemapEditorTool.

TilemapEditorTool page added in 2021.2 .

Other useful classes