Create a new class inheriting from GridBrushBase
(or any useful sub-classes 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 GridErase
allows the Brush to remove items from the target GridFloodFill
allows the Brush to fill items onto the target GridRotate
rotates the items set in the Brush.Flip
flips the items set in the Brush.Create instances of your new class using ScriptableObject.CreateInstance<(Your Brush Class>()
. You may convert this new instance to an Asset in the Editor in order to use it repeatedly by calling AssetDatabase.CreateAsset()
.
You can also make a custom editor for your brush. This works the same way as custom editors for scriptable objects. The following are the main methods you would want to override when creating a custom editor:
OnPaintInspectorGUI
to have an inspectorA Unity window that displays information about the currently selected GameObject, Asset or Project Settings, alowing you to inspect and edit the values. More infoOnPaintSceneGUI
to add additional behaviour 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 in the Palette window.When created, the Scriptable Brush is listed in the Brushes Dropdown 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 AssetsAny media or data that can be used in your game or Project. An asset may come from a file created outside of Unity, such as a 3D model, an audio file or an image. You can also create some asset types in Unity, such as an Animator Controller, an Audio Mixer or a Render Texture. More info
See in Glossary in your project. These Brush Assets are listed separately in the Brush dropdown.
You can add a CustomGridBrush
attribute to your Scriptable Brush class. This allows you to configure the behaviour of the Brush in the Palette window. The CustomGridBrush
attribute has the following properties:
HideAssetInstances
- Setting this to true hides all copies of created Brush Assets in the Palette window. Set this if you only want the default instance to show up in the Brush dropdown in the Palette window.HideDefaultInstances
- Setting this to true hides the default instance of the Brush in the Palette window. Set this if you only want created Assets to show up in the Brush dropdown in the Palette window.DefaultBrush
- Setting this to true sets 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 up. Only set one Scriptable Brush to be the Default Brush!DefaultName
- Setting this makes the Brush dropdown use this as the name for the Brush instead of the name of the class of the Brush.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?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
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:
Thanks for helping to make the Unity documentation better!
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.