Scripting Overview

advanced scripting

Terrain Grid System 2 · Scripting Support (C#)

Namespace: TGS · Main component: TerrainGridSystem

This section contains the full public API reference for Terrain Grid System 2, split into subpages for readability.

API Subpages

Getting Started

using TGS;

TerrainGridSystem tgs = TerrainGridSystem.instance;
// or:
// TerrainGridSystem tgs = GetComponent<TerrainGridSystem>();

Examples

Cell click highlight

using UnityEngine;
using TGS;

public class TGSDemo : MonoBehaviour {
    void Start() {
        var tgs = TerrainGridSystem.instance;
        tgs.OnCellClick += (grid, cellIndex, buttonIndex) => {
            grid.CellToggleRegionSurface(cellIndex, true, Color.yellow);
        };
    }
}

Pathfinding

using System.Collections.Generic;
using UnityEngine;
using TGS;

public class TGSPathDemo : MonoBehaviour {
    void Start() {
        var tgs = TerrainGridSystem.instance;
        tgs.cells[10].canCross = false;
        List<int> path = tgs.FindPath(0, 50);
        if (path != null) {
            foreach (int idx in path) tgs.CellFlash(idx, Color.green, 1f);
        }
    }
}
Was this page helpful?