Skip to content

Class

PlaceModeMachine

Generated GDScript class reference for GridPlacement.PlaceModeMachine.

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.

Manages placement mode state as a proper state machine. Replaces the overlapping BuildMode and PlaceSubmode enums, eliminating the mode-flap bug class caused by inconsistent state combinations and the "no place-pending value" hack. States: IDLE — Not placing anything. Maps to ModeState.OFF ROUTER — PLACE mode active, waiting for tool/category selection OBJECT — Actively placing an object (scene_entry selected) TERRAIN — Actively painting terrain (terrain name selected) Two-way sync with ModeState: Out: IDLE → OFF, all others → PLACE (canonical) In: non-PLACE modes force IDLE (MOVE/DEMOLISH/INFO/OFF) Scene-free (extends RefCounted). Directly unit-testable.

Source: addons/grid_placement/systems/building/place_mode_machine.gd

Syntax

class PlaceModeMachine extends RefCounted

Members

NameKindSummary
state_changedSignalPlacement mode states. Emitted when placement state changes.
current_stateProperty
set_mode_stateMethod
enter_idleMethod
enter_routerMethod
enter_objectMethod
enter_terrainMethod
is_activeMethod
is_routerMethod
is_placing_objectMethod
is_painting_terrainMethod