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 TilemapEditorTool
class.
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 TilemapEditorTool
will 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 TilemapEditorTool
can be activated at the current time. Use this to validate whether the prerequisites for activating your TilemapEditorTool
are available.
The custom TilemapEditorTool
can 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 GridBrush
has a BrushTool
attribute with the type of your custom TilemapEditorTool
.
TilemapEditorTool page added in 2021.2 .
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.