Terrain3D

https://terrain3d.readthedocs.io/en/stable/
Admin
Terrain3D is a high-performance, editable terrain system designed for the Godot 4 game engine.
Tokens:156,839
Snippets:1,185
Trust Score:8.3
Update:5 hours ago
Show doc for...
Tokens:
Raw
### Install clang-format hooks

Source: https://terrain3d.readthedocs.io/en/stable/docs/contributing.html

Copy the provided hooks into .git/hooks or run the install script to enable automatic formatting on commit.

```bash
python tools/install-hooks.py
```

--------------------------------

### Install documentation modules with pip

Source: https://terrain3d.readthedocs.io/en/stable/docs/contributing.html

Install the required Python modules for building documentation: docutils, myst-parser, sphinx, sphinx-rtd-theme, and sphinx-rtd-dark-mode.

```bash
pip install docutils myst-parser sphinx sphinx-rtd-theme sphinx-rtd-dark-mode
```

--------------------------------

### Instantiate and call Terrain3D via ClassDB (C#)

Source: https://terrain3d.readthedocs.io/en/stable/docs/programming_languages.html

C# example using ClassDB.Instantiate to create Terrain3D and Terrain3DAssets, then set properties and call methods.

```C#
var terrain = ClassDB.Instantiate("Terrain3D");
terrain.AsGodotObject().Set("assets", ClassDB.Instantiate("Terrain3DAssets"));
terrain.AsGodotObject().Call("set_show_region_grid", true);
```

--------------------------------

### start_operation

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3deditor.html

Starts an operation at the given position.

```APIDOC
## start_operation

### Description
Starts an operation at the given position.

### Method
start_operation

### Signature
void start_operation(position: Vector3)

### Parameters
- **position** (Vector3) - Required - The position where the operation starts.

### Returns
void
```

--------------------------------

### operate(position: Vector3, camera_direction: float)

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3deditor.html

Start brushing.

```APIDOC
## operate(position: Vector3, camera_direction: float)

### Description
Start brushing.

### Method
void

### Parameters
- **position** (Vector3) - Required - The position to start brushing.
- **camera_direction** (float) - Required - The camera direction.
```

--------------------------------

### Run documentation build script

Source: https://terrain3d.readthedocs.io/en/stable/docs/contributing.html

Run the build_docs.sh script from the doc folder to generate XML, RST, and HTML documentation. This script requires prior setup of paths to Godot and make_rst.py.

```bash
./build_docs.sh
```

--------------------------------

### Instantiate and call Terrain3D (GDScript)

Source: https://terrain3d.readthedocs.io/en/stable/docs/programming_languages.html

Creates a Terrain3D instance, assigns assets, and prints the version. Refer to the CodeGenerated.tscn demo for full setup.

```GDScript
var terrain: Terrain3D = Terrain3D.new()
terrain.assets = Terrain3DAssets.new()
print(terrain.get_version())
```

--------------------------------

### Avoid sub branches: nested if example

Source: https://terrain3d.readthedocs.io/en/stable/docs/tips_technical.html

Example of a nested if statement that may cause performance issues. Test with FPS counter to measure impact.

```glsl
uniform bool auto_shader;
if (height > 256) {
   if (auto_shader) {
     albedo = snow_color;
   }
}
```

--------------------------------

### Detect Terrain3D installation with EditorInterface.is_plugin_enabled (GDScript)

Source: https://terrain3d.readthedocs.io/en/stable/docs/programming_languages.html

Checks if the Terrain3D plugin is enabled in the editor. Use this to verify installation before using Terrain3D features.

```GDScript
print("Terrain3D installed: ", EditorInterface.is_plugin_enabled("terrain_3d"))
```

--------------------------------

### See all scons build options

Source: https://terrain3d.readthedocs.io/en/stable/docs/building_from_source.html

Display all available build options. The first command shows Godot custom build options, the second shows SCons application options.

```bash
# Godot custom build options
scons --help

# Scons application options
scons -H
```

--------------------------------

### Detect Terrain3D installation with GetEditorInterface().IsPluginEnabled (C#)

Source: https://terrain3d.readthedocs.io/en/stable/docs/programming_languages.html

C# equivalent to check if the Terrain3D plugin is enabled. Use this in C# scripts to verify installation.

```C#
GetEditorInterface().IsPluginEnabled("terrain_3d")
```

--------------------------------

### start_operation(position: Vector3)

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3deditor.html

Begin a sculpting or painting operation. Prepares to create an undo/redo commit.

```APIDOC
## start_operation(position: Vector3)

### Description
Begin a sculpting or painting operation. Prepares to create an undo/redo commit.

### Method
void

### Parameters
- **position** (Vector3) - Required - The position where the operation starts.
```

--------------------------------

### Apply weighting and send emissive to GPU in fragment()

Source: https://terrain3d.readthedocs.io/en/stable/docs/tips_technical.html

Find this in fragment(), before the final }, apply the weighting and send it to the GPU.

```glsl
	// normalize accumulated values back to 0.0 - 1.0 range.
	float weight_inv = 1.0 / total_weight;
	mat.albedo_height *= weight_inv;
	...
	mat.emissive *= weight_inv;
	EMISSION = mat.emissive * emissive_strength;
```

--------------------------------

### append_region

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dinstancer.html

Appends new transforms to the existing data within a region location. The mesh_id should already be setup as a Terrain3DMeshAsset in the asset dock.

```APIDOC
## append_region

### Description
Appends new transforms to the existing data within a region location. The mesh_id should already be setup as a Terrain3DMeshAsset in the asset dock. Update will regenerate the MultiMeshInstances. Disable for bulk adding, then call at the end.

### Method
void

### Parameters
- region (Terrain3DRegion) - Required - The region object.
- mesh_id (int) - Required - The mesh asset ID.
- transforms (Array[Transform3D]) - Required - Array of transforms to append.
- colors (PackedColorArray) - Required - Array of colors for the instances.
- update (bool) - Optional - Default: true. If true, regenerates the MultiMeshInstances.

```

--------------------------------

### append_location

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dinstancer.html

Appends new transforms to the existing data within a region location. The mesh_id should already be setup as a Terrain3DMeshAsset in the asset dock.

```APIDOC
## append_location

### Description
Appends new transforms to the existing data within a region location. The mesh_id should already be setup as a Terrain3DMeshAsset in the asset dock. Update will regenerate the MultiMeshInstances. Disable for bulk adding, then call at the end.

### Method
void

### Parameters
- region_location (Vector2i) - Required - The region location.
- mesh_id (int) - Required - The mesh asset ID.
- transforms (Array[Transform3D]) - Required - Array of transforms to append.
- colors (PackedColorArray) - Required - Array of colors for the instances.
- update (bool) - Optional - Default: true. If true, regenerates the MultiMeshInstances.

```

--------------------------------

### Initialize and update the godot-cpp submodule

Source: https://terrain3d.readthedocs.io/en/stable/docs/building_from_source.html

Run these commands from the Terrain3D directory to initialize and update the godot-cpp submodule. The output shows the submodule being registered and checked out to a specific commit hash (9d1c396c54fc3bdfcc7da4f3abcb52b14f6cce8f).

```bash
$ cd Terrain3D

Terrain3D$ git submodule init
Submodule 'godot-cpp' (https://github.com/godotengine/godot-cpp.git) registered for path 'godot-cpp'

Terrain3D$ git submodule update
Cloning into 'C:/GD/Terrain3D/godot-cpp'...
Submodule path 'godot-cpp': checked out '9d1c396c54fc3bdfcc7da4f3abcb52b14f6cce8f'

```

--------------------------------

### Instance Terrain3DUtil for shorter alias

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dutil.html

Shows how to create an instance of Terrain3DUtil to use a shorter alias for calling its static functions, such as as_float().

```gdscript
var util := Terrain3DUtil.new()
var my_float: float = util.as_float(my_int)
```

--------------------------------

### Avoid sub branches: arithmetic alternative

Source: https://terrain3d.readthedocs.io/en/stable/docs/tips_technical.html

Equivalent to the nested if example but avoids sub-branching by always calculating. If auto_shader is true, the line becomes albedo = 0.*albedo + 1.*snow_color.

```glsl
uniform bool auto_shader;
if (height > 256) {
  albedo = float(!auto_shader)*albedo + float(auto_shader)*snow_color;
}
```

--------------------------------

### View formatted file with clang-format

Source: https://terrain3d.readthedocs.io/en/stable/docs/contributing.html

Displays the formatted version of the specified files without modifying them on disk.

```bash
clang-format <filenames>
```

--------------------------------

### Run Terrain3D demo and editor with debug messages from command line

Source: https://terrain3d.readthedocs.io/en/stable/docs/troubleshooting.html

Use these commands to run the Terrain3D demo or editor with debug logging enabled. Adjust file paths to your system; the console executable is not needed when running in a terminal. The --terrain3d-debug flag accepts ERROR, INFO, DEBUG, or EXTREME.

```bash
# To run the demo with debug messages
cd /c/gd/Terrain3D/project
/c/gd/bin/Godot_v4.1.3-stable_win64.exe --terrain3d-debug=DEBUG

# To run the editor with debug messages
/c/gd/bin/Godot_v4.1.3-stable_win64.exe -e --terrain3d-debug=DEBUG
```

--------------------------------

### Query height at any position with get_height()

Source: https://terrain3d.readthedocs.io/en/stable/docs/collision.html

Use this snippet to get the terrain height at a known X, Z position. Returns NAN if the position is a hole or outside of regions. Ideal for a single lookup.

```gdscript
     var height: float = terrain.data.get_height(global_position)
```

--------------------------------

### Build Terrain3D extension with scons

Source: https://terrain3d.readthedocs.io/en/stable/docs/building_from_source.html

Commands to build the debug library by default, and both debug and release versions sequentially. The output shows a successful build message.

```bash
Terrain3D/godot-cpp$ cd ..

# To build the debug library
Terrain3D$ scons

# To build both debug and release versions sequentially (bash command line)
Terrain3D$ scons && scons target=template_release
```

```bash
Creating library project\addons\terrain_3d\bin\libterrain.windows.debug.x86_64.lib and object project\addons\terrain_3d\bin\libterrain.windows.debug.x86_64.exp
scons: done building targets.
```

--------------------------------

### add_multimesh

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dinstancer.html

Allows procedural placement of meshes, or importing from another MultiMeshInstancer placement tool. The specified mesh_id should already be setup as a Terrain3DMeshAsset in the asset dock. This function extracts the instance transforms and colors from a multimesh and passes it to add_transforms().

```APIDOC
## add_multimesh

### Description
Allows procedural placement of meshes, or importing from another MultiMeshInstancer placement tool. The specified mesh_id should already be setup as a Terrain3DMeshAsset in the asset dock. This function extracts the instance transforms and colors from a multimesh and passes it to add_transforms(). Update will regenerate the MultiMeshInstances. Disable for bulk adding, then call at the end.

### Method
void

### Parameters
- mesh_id (int) - Required - The mesh asset ID.
- multimesh (MultiMesh) - Required - The MultiMesh containing instance transforms and colors.
- transform (Transform3D) - Optional - Default: Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0).
- update (bool) - Optional - Default: true. If true, regenerates the MultiMeshInstances.

```

--------------------------------

### create_mesh_thumbnails

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dassets.html

Generates mesh asset preview thumbnails for the asset dock.

```APIDOC
## create_mesh_thumbnails

### Description
Generates mesh asset preview thumbnails for the asset dock, stored within each mesh asset. Specify id -1 to generate all.

### Method
create_mesh_thumbnails

### Parameters
- **id** (int) - Optional - Default: -1 - The ID of the mesh asset to generate a thumbnail for, or -1 for all.
- **size** (Vector2i) - Optional - Default: Vector2i(128, 128) - The size of the thumbnail.

### Returns
void
```

--------------------------------

### add_transforms

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dinstancer.html

Allows procedural placement of meshes. The mesh_id should already be setup as a Terrain3DMeshAsset in the asset dock. You provide the array of Transform3Ds and optional Colors, which will be parsed into our data storage. This function adds the Terrain3DMeshAsset.height_offset to the transform along its local Y axis.

```APIDOC
## add_transforms

### Description
Allows procedural placement of meshes. The mesh_id should already be setup as a Terrain3DMeshAsset in the asset dock. You provide the array of Transform3Ds and optional Colors, which will be parsed into our data storage. This function adds the Terrain3DMeshAsset.height_offset to the transform along its local Y axis. Update will regenerate the MultiMeshInstances. Disable for bulk adding, then call at the end.

### Method
void

### Parameters
- mesh_id (int) - Required - The mesh asset ID.
- transforms (Array[Transform3D]) - Required - Array of transforms for the instances.
- colors (PackedColorArray) - Optional - Default: PackedColorArray().
- update (bool) - Optional - Default: true. If true, regenerates the MultiMeshInstances.

```

--------------------------------

### Apply clang-format in place

Source: https://terrain3d.readthedocs.io/en/stable/docs/contributing.html

Modifies the specified files in place to conform to the clang-format style.

```bash
clang-format -i <filenames>
```

--------------------------------

### get_intersection GPU mode usage with await

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3d.html

Shows how to call get_intersection in GPU mode twice, waiting for the frame to be drawn between calls, to get a valid intersection point. The first call returns an invalid value, so a second call is needed after awaiting RenderingServer.frame_post_draw.

```gdscript
var target_point = terrain.get_intersection(camera_pos, camera_dir, true)
await RenderingServer.frame_post_draw
target_point = terrain.get_intersection(camera_pos, camera_dir, true)
```

--------------------------------

### Raycast to detect Terrain3D height (GDScript)

Source: https://terrain3d.readthedocs.io/en/stable/docs/collision.html

Use this raycast to detect terrain height when you don't know the X, Z of the collision point. It handles both Game modes (collider is Terrain3D) and Editor modes (collider is a StaticBody child of Terrain3D). The example excludes the calling node and prints the hit node.

```GDScript
	var space_state: PhysicsDirectSpaceState3D = get_world_3d().direct_space_state
	var query := PhysicsRayQueryParameters3D.create(position, position + Vector3(0, -500, 0))
	query.exclude = [ self ]
	var result: Dictionary = space_state.intersect_ray(query)
	if result:
		var node: Node = result["collider"]
		# Change node to StaticBody parent in `Editor` collision modes
		if node is StaticBody3D and node.get_parent() is Terrain3D:
			node = node.get_parent()
		# Detect Terrain3D with `is`, since printing the node returns `[Wrapped:0]`
		if node is Terrain3D:
			print("Hit: Terrain3D") 
		else:
			print("Hit: ", node)
```

--------------------------------

### add_instances()

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dinstancer.html

A feature rich function designed for hand editing via Terrain3DEditor.

```APIDOC
## add_instances()

### Description
A feature rich function designed for hand editing via Terrain3DEditor.

### Method
add_instances()

### Parameters
- **instances** (Array) - Required - Array of instance data.

### Returns
void
```

--------------------------------

### add_instances(global_position: Vector3, params: Dictionary)

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dinstancer.html

Adds instances at a global position using parameters from a dictionary.

```APIDOC
## add_instances(global_position: Vector3, params: Dictionary)

### Description
Adds instances at the specified global position using the provided parameters.

### Method
add_instances

### Parameters
- **global_position** (Vector3) - Required - The global position where instances are added.
- **params** (Dictionary) - Required - A dictionary of parameters controlling the instance placement.

### Returns
void
```

--------------------------------

### add_instances

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dinstancer.html

Used by Terrain3DEditor to place instances given many brush parameters. It uses the brush position and additional parameters such as asset_id, size, strength, fixed_scale, random_scale, fixed_spin, random_spin, fixed_tilt, random_tilt, align_to_normal, height_offset, random_height, vertex_color, random_hue, random_darken.

```APIDOC
## add_instances

### Description
Used by Terrain3DEditor to place instances given many brush parameters. In addition to the brush position, it also uses the following parameters: asset_id, size, strength, fixed_scale, random_scale, fixed_spin, random_spin, fixed_tilt, random_tilt, align_to_normal, height_offset, random_height, vertex_color, random_hue, random_darken. All of these settings are set in the editor through tool_settings.gd.

### Method
void

### Parameters
- global_position (Vector3) - Required - The brush position.
- params (Dictionary) - Required - Dictionary containing brush parameters.

```

--------------------------------

### show_grey

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dmaterial.html

Controls whether the albedo is set to 0.2 grey.

```APIDOC
## Property: show_grey

### Description
Controls whether the albedo is set to 0.2 grey.

### Type
bool

### Default Value
false

### Methods
- void set_show_grey(value: bool)
- bool get_show_grey()

```

--------------------------------

### set_maps(maps: Array[Image])

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dregion.html

Expects an array with three images in it, and assigns them to the height, control, and color maps.

```APIDOC
## set_maps(maps: Array[Image])

### Description
Expects an array with three images in it, and assigns them to the height, control, and color maps.

### Method
void

### Signature
void set_maps(maps: Array[Image])

### Parameters
- **maps** (Array[Image]) - Required - Array of three images to assign to height, control, and color maps.
```

--------------------------------

### See clang-format changes with git-clang-format

Source: https://terrain3d.readthedocs.io/en/stable/docs/contributing.html

Shows the diff of what changes would be made by clang-format without applying them.

```bash
git-clang-format --diff <filenames>
```

--------------------------------

### Build with debug symbols using scons dev_build=yes

Source: https://terrain3d.readthedocs.io/en/stable/docs/building_from_source.html

Build the extension with debug symbols. Useful for debugging the source code.

```bash
scons dev_build=yes
```

--------------------------------

### Manually specify target platform with scons platform=linux

Source: https://terrain3d.readthedocs.io/en/stable/docs/building_from_source.html

Build the extension for a specific target platform. The comment shows the supported platforms: linux, macos, windows, android, ios, javascript.

```bash
# platform: Target platform (linux|macos|windows|android|ios|javascript)

scons platform=linux
```

--------------------------------

### Clone Terrain3D repository with git

Source: https://terrain3d.readthedocs.io/en/stable/docs/building_from_source.html

Clones the Terrain3D repository from GitHub. The output shows the cloning progress and prompts for a passphrase if required.

```bash
$ git clone git@github.com:TokisanGames/Terrain3D.git

Cloning into 'Terrain3D'...
Enter passphrase for key:
remote: Enumerating objects: 125, done.
remote: Counting objects: 100% (125/125), done.
remote: Compressing objects: 100% (79/79), done.
remote: Total 125 (delta 56), reused 94 (delta 36), pack-reused 0
Receiving objects: 100% (125/125), 42.20 KiB | 194.00 KiB/s, done.
Resolving deltas: 100% (56/56), done.
```

--------------------------------

### create_mesh_thumbnails

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dassets.html

Creates thumbnails for mesh assets.

```APIDOC
## create_mesh_thumbnails

### Description
Creates thumbnails for mesh assets.

### Method
void create_mesh_thumbnails(id: int = -1, size: Vector2i = Vector2i(128, 128))

### Parameters
- **id** (int) - Optional - The ID of the mesh asset to create a thumbnail for. If -1, creates thumbnails for all meshes.
- **size** (Vector2i) - Optional - The size of the thumbnail. Default is Vector2i(128, 128).
```

--------------------------------

### WorldBackground Enumeration

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dmaterial.html

Enumeration for world background options.

```APIDOC
## WorldBackground Enumeration

### Description
Defines how the terrain behaves outside of defined regions.

### Values
- **NONE** = 0 - Outside of the defined regions, hide the mesh.
- **FLAT** = 1 - Outside of the defined regions, show a flat terrain.
- **NOISE** = 2 - Outside of the defined regions, generate visual-only hills.
```

--------------------------------

### save

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dmaterial.html

Saves the material to a file at the given path.

```APIDOC
## save

### Description
Saves the material to a file at the given path.

### Method
Error save(path: String = "")

### Parameters
- **path** (String) - Optional - The file path to save to. Defaults to an empty string.

### Returns
- **Error** - The result of the save operation.
```

--------------------------------

### get_maps() const

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dregion.html

Returns an Array of Image with height, control, and color maps.

```APIDOC
## get_maps() const

### Description
Returns an Array of Image with height, control, and color maps.

### Method
Array[Image]

### Signature
Array[Image] get_maps() const
```

--------------------------------

### Enable backlighting in shader

Source: https://terrain3d.readthedocs.io/en/stable/docs/tips_environment.html

Add a backlight uniform and set BACKLIGHT in the fragment function to allow light from the front side to shine through the back face.

```gdshader
uniform vec3 backlight : source_color = vec3(.5, .5, .5);

void fragment() {
	BACKLIGHT = backlight.rgb;
}
```

--------------------------------

### load_image

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dutil.html

Loads a file from disk and returns an Image. Supports EXR, R16/RAW, PNG, or a ResourceLoader format.

```APIDOC
## load_image

### Description
Loads a file from disk and returns an Image. Supports EXR, R16/RAW, PNG, or a ResourceLoader format (jpg, res, tres, etc).

### Method
static

### Signature
`Image` **load_image**(file_name: `String`, cache_mode: `int` = 0, r16_height_range: `Vector2` = Vector2(0, 255), r16_size: `Vector2i` = Vector2i(0, 0)) static

### Parameters
- **file_name** (`String`) - Required - The file name on disk to load.
- **cache_mode** (`int`) - Optional - Send this flag to the resource loader to force caching or not. Defaults to 0.
- **r16_height_range** (`Vector2`) - Optional - Heights for R16 format. x=Min & y=Max value ranges. Required for R16 import. Defaults to Vector2(0, 255).
- **r16_size** (`Vector2i`) - Optional - Image dimensions for R16 format. Default (0,0) auto detects size, assuming square images. Required for non-square R16. Defaults to Vector2i(0, 0).

### Returns
- **Image** - The loaded image.
```

--------------------------------

### Fetch latest tags for godot-cpp

Source: https://terrain3d.readthedocs.io/en/stable/docs/building_from_source.html

Run this command in the godot-cpp directory to update the submodule and fetch the latest tags. The output shows new tags such as godot-4.0.1-stable and godot-4.0.2-stable being added.

```bash
Terrain3D/godot-cpp$ git fetch
From https://github.com/godotengine/godot-cpp
 * [new tag]         godot-4.0.1-stable -> godot-4.0.1-stable
 * [new tag]         godot-4.0.2-stable -> godot-4.0.2-stable

```

--------------------------------

### Build Terrain3D iOS libraries with scons

Source: https://terrain3d.readthedocs.io/en/stable/docs/platforms.html

Build the iOS debug and release libraries using scons. The resulting binaries must be placed where identified in terrain.gdextension.

```bash
scons platform=ios target=template_debug
scons platform=ios target=template_release
```

--------------------------------

### get_data() const

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dregion.html

Returns all data in this region in a dictionary.

```APIDOC
## get_data() const

### Description
Returns all data in this region in a dictionary.

### Method
Dictionary

### Signature
Dictionary get_data() const
```

--------------------------------

### load_directory(directory: String)

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3ddata.html

Loads all terrain regions from the specified directory.

```APIDOC
## load_directory(directory: String)

### Description
Loads all terrain regions from the specified directory.

### Method
load_directory

### Parameters
- **directory** (String) - Required - The directory path from which to load regions.

### Returns
- **void** - No return value.
```

--------------------------------

### show_instancer_grid

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dmaterial.html

Controls whether the 32x32m instancer grid is overlaid on the terrain.

```APIDOC
## Property: show_instancer_grid

### Description
Controls whether the 32x32m instancer grid is overlaid on the terrain, which shows how the instancer data is partitioned. Press 2 with the mouse in the viewport to toggle.

### Type
bool

### Default Value
false

### Methods
- void set_show_instancer_grid(value: bool)
- bool get_show_instancer_grid()

```

--------------------------------

### save

Source: https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dassets.html

Saves the asset data to a file.

```APIDOC
## save

### Description
Saves the asset data to a file.

### Method
Error save(path: String = "")

### Parameters
- **path** (String) - Optional - The file path to save to. If empty, uses the default path.

### Returns
- **Error** - The result of the save operation.
```
Tokens:
Raw