Skip to content

Class

PlacementLifecycleBus

Generated GDScript class reference for GridPlacement.PlacementLifecycleBus.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

Plugin-owned signal bus for versioned placement lifecycle results. Grid Placement owns placement identity, geometry, occupancy, committed records, save/restore, and the typed [PlacementLifecycleResult]. This bus is the single emission point a host exposes so consumers (other hosts, telemetry, and external game integrations) can observe lifecycle results without Grid Placement interpreting any consumer-owned identity. See [PLACEMENT_LIFECYCLE_CONTRACT.md]. The bus is additive 6.0 surface: it never changes dispatch behavior, and emitting a result never mutates plugin or consumer state. Consumers connect to [signal lifecycle_result_emitted] and translate the result into their own envelope (mirroring the established plugin-bus pattern: one typed signal subscribers observe).

Source: addons/grid_placement/placement/placement_lifecycle_bus.gd

Syntax

class PlacementLifecycleBus extends RefCounted

Members

NameKindSummary
lifecycle_result_emittedSignalEmitted whenever the host records a [HostDispatchResult] that carries a non-null [PlacementLifecycleResult]. Fires once per recorded dispatch, including rejected, cancelled, and restored outcomes.
source_labelPropertyOptional human-readable source label (e.g. the owning host/session id) for diagnostics. Never part of the typed result contract.
emit_resultMethod