HostDispatchResult | Grid Placement Docs

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.

Typed host-level contract for GridPlacementHost dispatch results. Wraps heterogeneous downstream service result objects (PlacementReport, TerrainDemolishData, ValidationResults, ManipulationData, etc.) behind a stable host-owned API so that tests and debugging code do not depend on raw service-specific types. Use [method is_successful] and [method get_issues] for the host-level outcome; use [member inner_result] only for diagnostics.

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

Syntax

class HostDispatchResult extends RefCounted

Members

Name	Kind	Summary
`inner_result`	Property	The original downstream service result (PlacementReport, TerrainDemolishData, etc.). Prefer the typed host API for test assertions; use this only for detailed diagnostics.
`is_successful`	Property	Whether the dispatch completed without errors.
`failure_summary`	Property	Human-readable failure summary when the dispatch failed. Aggregated from the inner result's issue/message properties.
`action_type`	Property	The action kind that was dispatched (BUILD, DEMOLISH, MOVE, etc.).
`is_empty`	Property	Whether this result represents a no-op (no dispatch occurred). True when the host aborted before reaching any service method.
`empty`	Method
`r`	Property
`get_issues`	Method
`get_surface_of`	Method
`get_snapped_y`	Method
`get_snapped_cell`	Method
`from_report`	Method
`issues`	Property
`msg`	Property
`from_demolish_data`	Method
`ok`	Property
`msg`	Property
`from_validation_results`	Method
`issues`	Property
`msg`	Property
`from_manipulation_data`	Method
`ok`	Property
`msg`	Property
`from_missing_dep`	Method

Source

addons/grid_placement/systems/host/host_dispatch_result.gd

Plugin docs root:gdscript/plugins/grid_placement_dev/docs