Skip to content

Class

SceneSetupBuilder

Generated GDScript class reference for GridPlacement.SceneSetupBuilder.

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.

One-click starter setup builder for Grid Placement scenes. Creates the node hierarchy and starter resources for a chosen scene type without replacing existing nodes/resources. Reports created vs. preserved.

Source: addons/grid_placement/tools/scene_setup_builder.gd

Syntax

class SceneSetupBuilder extends RefCounted

Members

NameKindSummary
PANEL_TEMPLATEFieldThe full HUD the UI setup instances, and the theme applied when it ships with the templates. Both are template paths: a project can restyle the HUD or swap the theme without touching the setup.
ACTION_LOG_TEMPLATEField
TARGET_INFORMER_TEMPLATEField
MODE_SWITCH_BAR_TEMPLATEField
PANEL_THEMEField
TEMPLATES_ROOTFieldWhere the starter UI lives in a consumer project. Setup Scene writes the rig without it (plugin.tar.gz only); Setup UI needs templates.tar.gz extracted.
TEMPLATES_ARCHIVE_HINTField
is_3dMethod
build_sceneMethod
build_hierarchyMethod
entriesProperty
paletteProperty
entriesProperty
pathProperty
entryProperty
errProperty
build_uiMethod
templateProperty
nodeProperty
controlProperty
HUD_PANEL_HEIGHT_RATIOFieldShare of the viewport height the default panel may occupy. The rest of the right column stays clickable grid.
HUD_NARROW_WIDTHFieldBelow this viewport width the centred mode bar reaches the bottom-left action log (measured: 960x540, bar starts at x=311, log ends at x=396), so the log moves above the bar instead. 1280x720, 1920x1080 and 1366x768 clear it.