TERRAFORGE Documentation
  • WELCOME!
    • πŸ‘‹Hello!
    • 🏷️Supported Unity Versions & RPs
    • πŸ—ΊοΈRoadmap
    • πŸ–οΈChangelogs
    • 😎Support & Community
    • πŸ‘½FAQs
  • GETTING STARTED
    • πŸ”ŒInstallation & Setup
    • πŸŽ–οΈCreating New Terrains with TerraForge 2
    • β›΅Demos & Samples
  • HOW IT WORKS
    • 🧾Documentation & Code
    • πŸ—»Terrain Generator
    • ⛰️Terrains Grid Generator
    • πŸŒ‹Biomes Settings
    • 🏝️Terrain Painter
    • πŸ˜‡TerraForge Helper
    • βš™οΈGlobal Settings
    • πŸ“₯Save Biome Settings
    • πŸ“‡Load Biome Settings
    • πŸ’ͺRuntime Scripting API
Powered by GitBook
On this page
  • Opening the Window
  • Interface Overview
  • How to Use
  • Quick Script Overview
  • Additional Notes
  1. HOW IT WORKS

Global Settings

The Global Settings window in TerraForge 2 allows you to configure and manage various global parameters and assets used throughout the TerraForge system.

PreviousTerraForge HelperNextSave Biome Settings

Last updated 10 months ago

Opening the Window

To access the Global Settings window, navigate to: Tools > TerraForge 2 > Global Settings in the Unity Editor menu bar.


Interface Overview

The window is divided into sections, each managing different aspects of the global settings:

  1. Editor GUI Settings

    • Enable Caution and Confirmation Windows

      • Type: Toggle

      • Description: Toggle this option to enable or disable caution and confirmation dialogs within the editor.

  2. Generation Settings

    • Delay Between Automatic Generating Operations

      • Type: Slider

      • Range: 100 to 1000

      • Description: Adjust the delay between automatic generation operations to manage performance and responsiveness.

    • Path to Save TerrainData in the Editor

      • Type: Text Field

      • Description: Define the path where terrainData will be saved in the editor.

  3. Object References

    • Default Terrain

      • Type: Object Field

      • Description: Assign the default TerraForge terrain prefab.

    • Default Terrain For Grid

      • Type: Object Field

      • Description: Assign the default TerraForge terrain prefab for grid generation.

    • Biome Preview Terrain

      • Type: Object Field

      • Description: Assign the prefab used for biome previews.

    • Default Terrain Grid

      • Type: Object Field

      • Description: Assign the default terrain grid prefab.

    • Default TerrainData

      • Type: Object Field

      • Description: Assign the default TerraForge terrain data.

    • Biome Preview TerrainData

      • Type: Object Field

      • Description: Assign the terrain data for biome previews.

    • Hydraulic Erosion ComputeShader

      • Type: Object Field

      • Description: Assign the compute shader used for hydraulic erosion.

  4. Auto Assign Objects

    • Type: Button

    • Description: Automatically finds and assigns default assets for the settings.


How to Use

  1. Adjust Settings

    • Configure editor GUI settings and generation delays.

    • Assign the necessary GameObject and TerrainData references.

  2. Auto Assign Assets

    • Click the Auto Assign Objects button to automatically load and assign default assets from the Resources folder.

  3. Save Changes

    • Changes are automatically saved, but you can force save by clicking outside the editor window or making additional changes.


Quick Script Overview

  • TerraForgeGlobalSettings.cs

    • Purpose: Defines the global settings used by TerraForge and provides a singleton instance for accessing these settings.

    • Key Properties: Includes settings for confirmation dialogs, delays, prefabs, and shaders.

    • Methods: Provides a singleton access point and a method for reloading the settings.

  • TerraForgeSettingsWindow.cs

    • Purpose: Implements the editor window for managing global settings.


Additional Notes

  • Automatic Assignment: The Auto Assign feature helps to quickly set up your global settings by loading assets from the Resources folder, ensuring that all necessary references are correctly assigned.

  • Resource Management: Ensure that all referenced assets are correctly placed in the Resources folder to avoid missing references.

βš™οΈ