Skip to content

Class

GridPlacementHost

Generated GDScript class reference for GridPlacement.GridPlacementHost.

Status
Draft
Version
v6.0
Updated
Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Host orchestrator for the Grid Building plugin. One Node, one _unhandled_input, one [PlacementServiceGroup]. The host owns infrastructure (input handler, mode machine) and a settings-driven service group; game-scoped [GridPlacementSettings] decide which domain services exist, and player-scoped [PlacementSession] state feeds them. The host also owns the session registry (split-screen) and intent dispatch.

Source: addons/grid_placement/systems/host/grid_placement_host.gd

Syntax

class GridPlacementHost extends Node

Members

NameKindSummary
grid_placement_bundlePropertyGame-scoped settings.
HostLifecycleEmitterFieldLifecycle-result emission, attempt-id minting, and telemetry recording (see host_lifecycle_emitter.gd). Extracted to keep this hotspot under its line ceiling; owns the bus, the allocator, and the diagnostic recorder, so the public methods below stay thin delegates.
get_lifecycle_busMethod
get_diagnostic_recordsMethod
record_preview_diagnosticMethod
record_decision_diagnosticMethod
get_latest_diagnostics_jsonMethod
clear_diagnosticsMethod
refresh_diagnostic_detailMethod
DEFAULT_MAX_BRUSH_CELLSField
find_host_fromMethod
register_sessionMethod
unregister_sessionMethod
get_session_for_controllerMethod
bind_scene_consumersMethod
watch_scene_consumersMethod
HostSceneConsumerBinderFieldScene-consumer binding collaborator (bind/watch bookkeeping + typed dispatch).
HostSessionRetireFieldSession retirement collaborator (cancel live gestures, layer stash, programmatic exit), extracted to keep this hotspot under its line ceiling. Owns state + behavior + lifecycle; the two public API methods below stay thin delegates.
get_active_sessionsMethod
get_session_registry_countMethod
configureMethod
collect_startup_diagnosticsMethod
report_startup_diagnosticsMethod
get_smooth_coordinatorMethod
HostSurfacePreview2DField2D surface-preview collaborator (shared stacking-socket ledger + the per-frame seat), extracted to keep this hotspot under its line ceiling.
get_surface_registry_2dMethod
is_readyMethod
get_runtime_issuesMethod
get_sessionMethod
get_settingsMethod
get_actionsMethod
get_templatesMethod
get_runtime_checksMethod
get_input_handlerMethod
get_last_dispatch_resultMethod
dispatch_smooth_placementMethod
get_smooth_occupancy_registry_2dMethod
get_smooth_occupancy_registry_3dMethod
get_placement_world_registry_3dMethod
get_placement_world_registryMethod
get_lifecycle_allocatorMethod
get_placement_world_idMethod
get_placement_session_idMethod
snapshot_lifecycleMethod
restore_lifecycleMethod
set_object_placement_service_3dMethod
get_object_placement_service_3dMethod
get_object_placement_service_3d_for_sessionMethod
get_smooth_placement_service_3dMethod
get_smooth_placement_service_2dMethod
get_place_machineMethod
cancel_all_dragsMethod
enter_terrain_modeMethod
sync_brush_shape_to_terrainMethod
targetingProperty
owns_sessionMethod
select_placeable_for_sessionMethod
machineProperty
object_serviceProperty
deselect_placeable_for_sessionMethod
deselect_placeableMethod
exit_placement_for_sessionMethod
select_terrain_for_sessionMethod
enter_place_router_for_sessionMethod
set_brush_shape_for_sessionMethod
get_brush_shape_for_sessionMethod
get_brush_state_for_sessionMethod
is_painting_terrain_for_sessionMethod
get_terrain_service_for_sessionMethod
get_terrain_preview_cells_for_sessionMethod
positionerProperty
stateProperty
current_cellProperty
max_cellsProperty
tile_shapeProperty
estimateProperty
set_brush_shapeMethod
get_terrain_serviceMethod
get_manipulation_serviceMethod
get_grid_targeting_serviceMethod