Chris' Tutorials
Docs/Grid Placement

Class

BrushServiceContract

Generated GDScript class reference for GridPlacement.BrushServiceContract.

StatusDraft
Versionv6.0
UpdatedDevelopment docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.

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

Source

addons/grid_placement/services/contracts/brush_service_contract.gd

Plugin docs root:gdscript/plugins/grid_placement_dev/docs