Skip to content

Class

TerrainPersistence

Generated GDScript class reference for GridPlacement.TerrainPersistence.

Status
Current
Version
v6.3.0
Source updated
2026-10-29
Generated on
2026-10-29

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

Utility for saving and loading painted terrain cells on TileMapLayer nodes. Terrain paint data (set via TileMapLayer.set_cells_terrain_connect()) is ephemeral — it lives only on the live TileMapLayer and is lost on scene reload. This class provides save_terrain() and 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 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") Authority contract: these save/load helpers are a convenience for plugin placement bookkeeping. The game owns its save file and must not persist the same terrain fact authoritatively in two places; do not call both this helper and the game save for the same terrain.

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

Syntax

class TerrainPersistence extends RefCounted

Members

NameKindSummary
save_terrainMethod
load_terrainMethod
save_all_terrainMethod
load_all_terrainMethod