Chris' Tutorials
Docs/Grid Placement

Class

PlacementEnums

Generated GDScript class reference for GridPlacement.PlacementEnums.

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.

Centralized enums used across the Grid Building plugin. Collects shared enum types (modes, actions, statuses, tile types) used by systems, UI, and tests.

Source: addons/grid_placement/placement_enums.gd

Syntax

class PlacementEnums

Members

NameKindSummary
BuildTypeFieldDefines what building operation is being performed PLACE is the canonical name for placement mode (5.2+) BUILD is kept for backward compatibility (legacy name for PLACE) Defines what moves are allowed for purposes like AStarGrid2D pathing Actions that can be taken within the placement system PLACE is the canonical name for placement action (5.1+) BUILD is kept for backward compatibility (legacy name for PLACE) Axis a flip transform was applied along. Discriminator for the single [signal ManipulationParent.flipped] signal so consumers connect once and branch on the axis instead of wiring two separate signals. Type of placement operation being performed PlacementType is the canonical name (5.1+) BuildType is kept for backward compatibility (legacy name for PlacementType) @deprecated Use PlacementType instead. BuildType is a backward-compatible alias.
is_placement_modeMethod
mode_to_stringMethod
projection_method_to_stringMethod
PREVIEWFieldMetadata keys used by PlacementContainer / PlacementStates / preview factories to attach information to scene-tree nodes via [code]Node.set_meta()[/code]. Centralizing the keys here is the single source of truth for cross-module meta key usage. Marks a node as a placement preview (terrain preview, drag preview, indicator preview, etc.). Read by the demo world loader to skip preview nodes during save/load and by indicator cleanup paths to free preview-owned collision shapes.

Source

addons/grid_placement/placement_enums.gd

Plugin docs root:gdscript/plugins/grid_placement_dev/docs