Skip to content

Class

BrushServiceContract

Generated GDScript class reference for GridPlacement.BrushServiceContract.

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

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 [method 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

NameKindSummary
DIMENSION_2DFieldCapability flag for 2D brush support. Always 0 for 3D-only impls.
DIMENSION_3DFieldCapability flag for 3D brush support (deferred; no production 3D brush currently, but the contract reserves the bit so future work slots in).
supported_dimensionsMethod
configureMethod
set_statesMethod
get_runtime_issuesMethod