IndicatorSetupReport | 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.

Represents a structured report of an IndicatorManager.setup_indicators() run. Holds the produced indicators plus diagnostic metadata that can be logged or asserted in tests.

Source: addons/grid_placement/placement/manager/components/indicator_setup_report.gd

Syntax

class IndicatorSetupReport extends RefCounted

Members

Name	Kind	Summary
`indicators`	Property	The indicators created during setup
`targeting_state`	Property	The targeting state being used for indicators to be created and tested against for placement and validation
`template`	Property	The template being used for instantiating indicators
`rules`	Property	The rules that were being evaluated in the creation of the indicators
`tile_positions`	Property	All distinct tile positions that were used for the creation of indicators
`position_rules_map`	Property	The mapping between tile positions and an array of TileCheckRules that were assigned for an indicator at those positions
`owner_shapes`	Property	List of owners and their attached collision shapes and polygons
`indicator_test_setups`	Property	Collision test setups for each collision shape / polygon 2D to be tested.
`issues`	Property	The issues that occured during setup, if any
`notes`	Property	Verbose diagnostic notes to detail what happened during indicator setup. These notes do not represent issues with the setup but may aid in debugging.
`get_indicators_issues`	Method
`issues`	Property
`indicator`	Property
`finalize`	Method
`add_issue`	Method
`has_issues`	Method
`is_successful`	Method
`add_note`	Method
`set_test_setups`	Method
`validate_setup_environment`	Method
`runtime_issues`	Property
`to_summary_string`	Method
`summary`	Property
`map`	Property
`positioner`	Property
`current_world_pos`	Property
`tile_pos`	Property
`aligned_world_pos`	Property
`position_diff`	Property
`map`	Property
`tiles`	Property
`indicator`	Property
`tile_pos`	Property

Source

addons/grid_placement/placement/manager/components/indicator_setup_report.gd

Plugin docs root:gdscript/plugins/grid_placement_dev/docs