GridBrushBase

Description

Base class for authoring data on a grid with grid painting tools like paint, erase, pick, select and fill.

Inheriting this class and/or creating brush asset instances from your inherited class, you can create custom brushes which react to high level grid events like paint, erase, pick, select and fill.

using UnityEngine;

// Paints two Prefabs in checkerboard pattern
[CreateAssetMenu]
public class CheckerboardBrush : GridBrushBase
{
    public GameObject prefabA;
    public GameObject prefabB;

    public override void Paint(GridLayout grid, GameObject brushTarget, Vector3Int position)
    {
        bool evenCell = Mathf.Abs(position.y + position.x) % 2 > 0;
        GameObject toBeInstantiated = evenCell ? prefabA : prefabB;

        if (toBeInstantiated != null)
        {
            GameObject newInstance = Instantiate(toBeInstantiated, grid.CellToWorld(position), Quaternion.identity);
            newInstance.transform.SetParent(brushTarget.transform);
        }
    }
}

Public Functions