Skip to content
ct

Class

HostDispatchResult

Generated GDScript class reference for GridPlacement.HostDispatchResult.

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.

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

NameKindSummary
inner_resultPropertyThe original downstream service result (PlacementReport, TerrainDemolishData, etc.). Prefer the typed host API for test assertions; use this only for detailed diagnostics.
is_successfulPropertyWhether the dispatch completed without errors.
failure_summaryPropertyHuman-readable failure summary when the dispatch failed. Aggregated from the inner result's issue/message properties.
action_typePropertyThe action kind that was dispatched (BUILD, DEMOLISH, MOVE, etc.).
is_emptyPropertyWhether this result represents a no-op (no dispatch occurred). True when the host aborted before reaching any service method.
emptyMethod
rProperty
get_issuesMethod
get_surface_ofMethod
get_snapped_yMethod
get_snapped_cellMethod
from_reportMethod
issuesProperty
msgProperty
from_demolish_dataMethod
okProperty
msgProperty
from_validation_resultsMethod
issuesProperty
msgProperty
from_manipulation_dataMethod
okProperty
msgProperty
from_missing_depMethod