Skip to content

Class

PreviewBuilder

Generated GDScript class reference for GridPlacement.PreviewBuilder.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

PreviewBuilder Purpose Manages the visual preview instance used during building placement. The class requires the core runtime objects up-front: PlacementSettings, the GridTargetingState, PlacementState, and a PlacementLogger. These are accepted in the constructor so the caller is explicit about required dependencies. In addition, resolve_placement_dependencies(container) exists to refresh or update dependencies from a PlacementSession if the container changes during runtime (rare for tests but supported). The GridTargetingState is treated as the single source of truth for the positioner — the preview will always query the latest positioner when creating the preview.

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

Syntax

class PreviewBuilder extends PlacementInjectable

Members

NameKindSummary
from_containerMethod
resolve_placement_dependenciesMethod
get_runtime_issuesMethod
initializeMethod
create_previewMethod
get_previewMethod
clear_previewMethod
align_to_gridMethod
update_positionMethod
has_active_previewMethod