Skip to content

Class

BrushCoordinator

Generated GDScript class reference for GridPlacement.BrushCoordinator.

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.

Scene-free brush lifecycle coordinator. Owns BrushState and coordinates the start/complete/anchor/commit/cancel/paint sequence for terrain brushes, mirroring TerrainPlacementService2D and PlacementInputHandler (instance + configure) so behavior is swappable per-game by subclass. Paint outcomes are emitted by the terrain service. The coordinator emits the pending-fill preview cue after anchoring, without claiming a paint outcome. Usage: var coord := BrushCoordinator.new() coord.configure(states, terrain_service) coord.set_brush_shape(PlacementEnums.ObjectTool.LINE) coord.start_terrain_brush_drag() var report := coord.complete_terrain_brush()

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

Syntax

class BrushCoordinator extends BrushServiceContract

Members

NameKindSummary
brush_statePropertyOwned BrushState; PlacementInputHandler reads drag/pending flags to resolve InputIntents.
max_brush_cellsPropertyPer-action cell cap forwarded to BrushShapeGenerator; synced from PlacementSettings.
configureMethod
set_statesMethod
set_brush_shapeMethod
start_terrain_brush_dragMethod
complete_terrain_brushMethod
complete_terrain_brush_dryMethod
anchor_pending_terrainMethod
commit_pendingMethod
cancel_pendingMethod
start_object_line_dragMethod
complete_object_line_dragMethod
is_object_line_draggingMethod
start_demolish_boxMethod
update_demolish_boxMethod
complete_demolish_boxMethod
is_demolish_box_activeMethod
get_demolish_rectMethod
is_any_drag_activeMethod
cancel_allMethod
is_terrain_draggingMethod
is_pendingMethod
get_brush_shapeMethod
get_drag_startMethod
get_pending_cellsMethod
get_object_line_drag_startMethod
get_brush_stateMethod
paint_with_current_brushMethod
set_terrain_contextMethod
supported_dimensionsMethod
get_runtime_issuesMethod
set_session_brush_stateMethod