Class

BrushServiceContract

Generated GDScript class reference for GridPlacement.BrushServiceContract.

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.

Adapter/contract interface for the brush lifecycle (6.0.0-S). 6.0.0-210/211: the host and the service group must NOT hold a concrete BrushCoordinator reference when running in 3D mode (a 2D-only component), but the 2D brush flow remains unchanged when the contract IS satisfied. Concrete implementations override supported_dimensions() to declare 2D-only or 2D+3D capability. The factory refuses to wire a 2D-only brush into a 3D group rather than crashing at runtime.

Source: addons/grid_placement/services/contracts/brush_service_contract.gd

Syntax

class BrushServiceContract extends RefCounted

Members

Name	Kind	Summary
`DIMENSION_2D`	Field	Capability flag for 2D brush support. Always 0 for 3D-only impls.
`supported_dimensions`	Method
`configure`	Method
`set_states`	Method
`get_runtime_issues`	Method