Skip to content

Class

PlacementRuntime

Generated GDScript class reference for GridPlacement.PlacementRuntime.

Status
Current
Version
v6.1.0
Source updated
2026-09-24
Generated on
2026-09-23

Headless programmatic entry point for placement lifecycle commands. A backend (e.g. an external game's simulation host) calls [method execute] with a [PlacementCommand] and receives a [HostDispatchResult] whose inner [PlacementReport] carries one canonical, terminalized [PlacementLifecycleResult]. This path does NOT require an active UI session, a positioner node, or any preview — it drives the host-owned services directly so backend placement is deterministic and testable. The runtime resolves the session from the command or from the host's active/default session, then dispatches strictly on that session's [member PlacementSession.placement_coordinate_mode] and dimension. Correlation context is passed through opaquely. Commit targets per mode: [codeblock] 2D SMOOTH Vector2 world position; scene-free (SmoothPlacementService) 2D GRID Vector2i cell; runs the session's GRID rule pipeline, which seats on the session's GridPositioner2D and target map (scene required, no input or UI) 3D SMOOTH Vector3 world position (SmoothPlacementService3D) 3D GRID Vector3i cell; positioner-free (ObjectPlacementService3D) [/codeblock] A target of the wrong type, or a mode whose service is not configured, fails closed with a typed rejection; a command is never re-routed to the other coordinate mode.

Source: addons/grid_placement/placement/placement_runtime.gd

Syntax

class PlacementRuntime extends RefCounted

Members

NameKindSummary
executeMethod