Skip to content

Class

PreviewFactory

Generated GDScript class reference for GridPlacement.PreviewFactory.

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.

Creates and prepares 2D object preview nodes from scene entries.

Source: addons/grid_placement/systems/building/components/preview_factory.gd

Syntax

class PreviewFactory extends RefCounted

Members

NameKindSummary
WARNING_INVALID_ENTRYField
GHOST_MODULATE_ALPHAFieldGhost transparency for 2D object previews. The preview renders ABOVE the validity overlays (preview_instance_z_index over indicator_z_index), so an opaque ghost hides the per-cell valid/fail colors beneath the art. Matches the 2D terrain ghost alpha (TerrainPreview.preview_self_modulate).
resolve_placement_dependenciesMethod
get_runtime_issuesMethod
instance_previewMethod
root_scriptProperty
validation_issuesProperty
new_instanceProperty
desired_nameProperty
preview_hostProperty
existing_childProperty
ghost_modulateProperty
child_namesProperty
collision_nodesProperty