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.
This unreleased Grid Placement API reference is generated from addons/grid_placement during active development. It covers 252 public GDScript classes across 18 source categories. Class names, methods, and behavior may change before the final release — use this as a preview of what's coming, not as a stable integration target.
Addon Root
addons/grid_placement
Base
addons/grid_placement/base
- PlacementControl
- PlacementGameNode
- PlacementInjectable
- PlacementNode
- PlacementNode2D
- PlacementResource
- PlacementSystemBase
- PlacementSystemsComponent
Components
addons/grid_placement/components
- CursorSettings
- GBCursorChanger
- GBCursorSettings
- GBLevelContext
- Manipulatable
- PlaceableInstance
- PlacementCursorChanger
- PlacementLevelContext
- TargetHighlighter
Context
addons/grid_placement/context
Debug
addons/grid_placement/debug
Demo
addons/grid_placement/demo
Factories
addons/grid_placement/factories
Logging
addons/grid_placement/logging
Mode
addons/grid_placement/mode
Placeables
addons/grid_placement/placeables
Placement
addons/grid_placement/placement
- AdjacencyEvaluator
- AdjacencyRequiredRule
- AdjacentToCategoryRule
- CategoricalTag
- CollisionGeometryCalculator
- CollisionMapper2D
- CollisionMapper3D
- CollisionObjectResolver2D
- CollisionObjectResolver3D
- CollisionProcessor2D
- CollisionProcessor3D
- CollisionRuleSettings
- CollisionsCheckRule
- CollisionShapeProcessor
- CollisionShapeProcessor3D
- CollisionTestSetup2D
- CollisionUtilities2D
- CollisionUtilities3D
- ExistingCellRule
- GBPlacementRule
- GeometryCacheManager
- GeometryCacheManager3D
- IndicatorCollisionTestSetup
- IndicatorFactory2D
- IndicatorFactory3D
- IndicatorManager
- IndicatorService2D
- IndicatorService3D
- IndicatorSetupReport
- IndicatorSetupUtils
- IndicatorVisualSettings
- ManipulatableSettings
- NodeLocator
- NodeSearchLogic
- Placeable
- PlacementEntry
- PlacementProfile
- PlacementReport
- PlacementRule
- PlacementRuleValidationLogic
- PlacementSnapProfile3D
- PlacementValidationContext
- PlacementValidationPipeline
- PlacementValidationResult
- PlacementValidator
- PolygonIndicatorHeuristics
- PolygonTileMapper
- RectCollisionTestingSetup
- ResourceStack
- RuleCheckIndicator2D
- RuleCheckIndicator3D
- RuleCheckIndicatorLogic
- RuleResult
- RuleValidationLogic
- ScenePlacementEntry
- SpendByIdRule
- SpendCostRuleBase
- SpendMaterialsRuleById
- TerrainDemolishData
- TerrainPaintData
- TerrainPalette
- TerrainPersistence
- TerrainSaveData
- TestSetupFactory
- TileCheckRule
- TilePaintCollisionRule
- TilePaintRule
- TilePlacementEntry
- ValidationResults
- ValidPlacementRuleSettings
- ValidPlacementTileRule
- ValidPlacementTileRuleSettings
- WithinTilemapBoundsRule
Resources
addons/grid_placement/resources
- ActionLogSettings
- BuildCost
- GBActionLogSettings
- GBActions
- GBCompositionContainer
- GBConfig
- GBSettings
- GBTemplates
- GBVisualSettings
- GridPlacementBundle
- GridPlacementSettings
- PlacementActionHistory
- PlacementActionNames
- PlacementActions
- PlacementCatalog
- PlacementContainer
- PlacementSession
- PlacementStates
- PlacementTemplates
- PlacementVisualSettings
Services
addons/grid_placement/services
- BrushServiceContract
- CursorChangerService
- DragService
- IdRegistry
- ManipulationServiceContract
- PlacementInstantiatorService
- PlacementServiceGroup
- PlacementServiceGroupFactory
- TargetHighlighterService
- TargetingServiceContract
- TerrainServiceContract
Systems
addons/grid_placement/systems
- BrushCoordinator
- BrushShapeGenerator
- BrushState
- BuildingInstantiator
- BuildingSettings
- BuildingSystem
- CursorScreenResolver
- DemolishData
- Dimensions
- DragManager
- DragPathData
- GBHighlightSettings
- GBInjectorSystem
- GBManipulationState
- GBTargetingSettings
- GBTargetingState
- GridPlacementHost
- GridPositioner2D
- GridPositioner3D
- GridPositioner3DSpike
- GridPositionerUtils
- GridTargetingService
- GridTargetingService3D
- GridTargetingSettings
- GridTargetingState
- HighlightSettings
- HostDispatchResult
- ManipulationData
- ManipulationMessages
- ManipulationParent
- ManipulationParent3D
- ManipulationService2D
- ManipulationService3D
- ManipulationSettings
- ManipulationState
- ManipulationTransformCalculator
- MouseEventVisibilityResult
- NameDisplayer
- ObjectPlacementService3D
- ObjectPlacementSettings3D
- PlacementActionData
- PlacementAStarPathManager
- PlacementBuildOrchestrator
- PlacementInjectorSystem
- PlacementInputHandler
- PlacementInstantiator
- PlacementIntentRouter
- PlacementMouseInputStatus
- PlacementSettings
- PlacementState
- PlacementSystem
- PlaceModeMachine
- PositionerPolicy
- PreviewBuilder
- PreviewFactory
- RecenterPlan
- RefundCalculator
- Refunder
- RefundService
- TargetingArea2D
- TargetingArea3D
- TargetingShapeCast2D
- TargetingShapeCast3D
- TerrainBrushContext
- TerrainPlacementService2D
- TerrainPlacementService3D
- TerrainPreview
- TerrainTilePainter
UI
addons/grid_placement/ui
- BrushShapeIconButton
- BrushShapeIconDrawer
- BuildPanel
- GBActionLog
- GBTargetInfoSettings
- GridBuilderUIController
- PlaceableGrid
- PlaceableList
- PlaceableListEntry
- PlaceableSelectionLogic
- PlaceableSelectionUI
- PlaceableUIInteraction
- PlaceableView
- PlacementActionBar
- PlacementActionButton
- PlacementActionLog
- PlaceRouterUI
- TargetInformer
- TargetInfoSettings
- TerrainPaletteEntryView
- TerrainPaletteUI
User
addons/grid_placement/user
Utils
addons/grid_placement/utils
- CollisionGeometryUtils
- DefaultInputActionsHelper
- PhysicsMatchingUtils2D
- PlacementAssetResolver
- PlacementCamera2DValidator
- PlacementCameraUtils
- PlacementCollisionTileFilter
- PlacementDiagnostics
- PlacementGeometryMath
- PlacementGeometryUtils
- PlacementGridRotationUtils
- PlacementGridRotationUtils3D
- PlacementManipulationCopyUtils
- PlacementObjectUtils
- PlacementPositioning2DUtils
- PlacementPositioning3DUtils
- PlacementSearchUtils
- PlacementString
- PlacementValidation
- RuleFilters
Validation
addons/grid_placement/validation
Source
grid_placement_dev/godot/addons/grid_placement
Plugin docs root:gdscript/plugins/grid_placement_dev/docs