Skip to content
ct

Class

TerrainPersistence

Generated GDScript class reference for GridPlacement.TerrainPersistence.

Status
Draft
Version
v6.0
Updated
Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Utility for saving and loading painted terrain cells on TileMapLayer nodes. Terrain paint data (set via [method TileMapLayer.set_cells_terrain_connect]) is ephemeral — it lives only on the live TileMapLayer and is lost on scene reload. This class provides [method save_terrain] and [method load_terrain] to serialize/deserialize terrain cell data so painted terrain survives across sessions. Each cell record captures (cell, terrain_set, terrain) — the three values needed to restore via [method TileMapLayer.set_cells_terrain_connect]. The TileSet is assumed to be the same resource used at paint time; terrain indices are scoped to that TileSet. Usage: # Save TerrainPersistence.save_terrain(tile_map, "user://terrain_save.res") # Load TerrainPersistence.load_terrain(tile_map, "user://terrain_save.res")

Source: addons/grid_placement/placement/terrain/terrain_persistence.gd

Syntax

class TerrainPersistence extends RefCounted

Members

NameKindSummary
save_terrainMethod
save_dataProperty
tile_dataProperty
terrain_setProperty
terrainProperty
resultProperty
load_terrainMethod
loadedProperty
save_dataProperty
save_all_terrainMethod
save_dataProperty
layer_pathProperty
tile_dataProperty
terrain_setProperty
resultProperty
load_all_terrainMethod
loadedProperty
save_dataProperty
map_by_pathProperty
cells_by_layerProperty
unlayered_cellsProperty
target_mapProperty
fallback_mapProperty
groupsProperty
keyProperty
groupProperty