Create a new class inheriting from GridBrushBase
(or any useful subclasses of GridBrushBase
like GridBrush
). Override any required methods for your new Brush class. The following are the usual methods you would override:
Paint
allows the Brush to add items onto the target Grid.Erase
allows the Brush to remove items from the target Grid.FloodFill
allows the Brush to fill items onto the target Grid.Rotate
― ブラシ内に設定されたアイテムを回転させます。Flip
― ブラシ内に設定されたアイテムをフリップします。ScriptableObject.CreateInstance<(Your Brush Class>()
を使用して、新しく作成したクラスのインスタンスを作成してください。 AssetDatabase.CreateAsset()
を呼び出せば、この新しいインスタンスをエディター内でアセットに変換でき、繰り返し使用することができるようになります。
ブラシ用にカスタムエディターを作成することもできます。これは、スクリプタブル オブジェクト用のカスタムエディターと同じように機能します。カスタムエディターを作成する場合にオーバーライドするメソッドの主要なものは以下の通りです。
OnPaintInspectorGUI
to have an Inspector window appear on the Palette when the Brush is selected to provide additional behaviour when painting.OnPaintSceneGUI
to add additional behaviours when painting on the SceneView
.validTargets
to have a custom list of targets which the Brush can interact with. This list of targets is shown as a dropdown list in the Palette window.When created, the Scriptable Brush is listed in the Brushes dropdown menu in the Palette window. By default, an instance of the Scriptable Brush script is instantiated and stored in the Library folder of your project. Any modifications to the brush properties are stored in that instance. If you want to have multiple copies of that Brush with different properties, you can instantiate the Brush as Assets in your project. These Brush Assets are listed separately in the Brush dropdown menu.
You can add a CustomGridBrush
attribute to your Scriptable Brush class. This allows you to configure the behavior of the Brush in the Palette window. The CustomGridBrush
attribute has the following properties:
HideAssetInstances
- Set this to true to hide all copies of created Brush Assets in the Palette window. This is useful when you want only the default instance to show up in the Brush dropdown menu in the Tile Palette window.HideDefaultInstances
- Set this to true to hide the default instance of the Brush in the Palette window. This is useful when you want only created Assets to show up in the Brush dropdown menu in the Tile Palette window.DefaultBrush
- Set this to true to set the default instance of the Brush as the default Brush in the project. This makes this Brush the default selected Brush whenever the project starts. Note: Only set one Scriptable Brush as the Default Brush. Setting more than one Default Brush may cause your Scriptable Brushes to behave incorrectly.DefaultName
- Set a name to this to have the Brush dropdown menu use the set name as the name for the Brush instead of the name of the Brush’s class.If you want your Scriptable Brush class to use only certain tools, you can add a BrushTools
attribute to your class with a list of compatible TilemapEditorTools
types. This ensures that your Scriptable Brush only activates with these specific tools from the Tile Palette toolbar.
Note: Remember to save your project to ensure that your new Brush Assets are saved!
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.