Version: 2021.2
스크립트 가능한 타일 예제
GridBrushBase

스크립트 가능한 브러시

스크립트 가능한 브러시 생성

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()을 호출하여 인스턴스를 반복적으로 사용할 수 있습니다.

브러시의 커스텀 에디터도 만들 수 있습니다. 이 에디터는 스크립트 가능한 오브젝트의 커스텀 에디터와 동일한 방법으로 사용할 수 있습니다. 커스텀 에디터를 생성할 때 오버라이드할 수 있는 주요 메서드는 다음과 같습니다.

  • You can override OnPaintInspectorGUI to have an Inspector window appear on the Palette when the Brush is selected to provide additional behaviour when painting.
  • You can also override OnPaintSceneGUI to add additional behaviours when painting on the SceneView.
  • You can also override 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!

스크립트 가능한 타일 예제
GridBrushBase