Skip to content

Class

IndicatorFactory2D

Generated GDScript class reference for GridPlacement.IndicatorFactory2D.

Status
Current
Version
v6.1.0
Source updated
2026-09-24
Generated on
2026-09-23

Creates and positions rule-check indicators for placement validation. Instances normally live under IndicatorManager, the scene-tree parent for rule-check indicators; manipulated objects belong under ManipulationParent. Collision results arrive as absolute tile positions and are converted to offsets relative to the test object, so indicators follow it when it moves. Guides: guides/placement-workflow.md, guides/custom-placement-rules.md

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

Syntax

class IndicatorFactory2D extends RefCounted

Members

NameKindSummary
clear_static_stateMethod
DEFAULT_Z_INDEXFieldDefault indicator z_index, below the placement preview ghost ([member PlacementSettings.preview_instance_z_index], default 200) so the object silhouette stays readable. Overridable via [member PlacementSettings.indicator_z_index].
generate_indicatorsMethod
indicatorsProperty
rulesProperty
indicatorProperty
target_mapProperty
positioner_tileProperty
target_tileProperty
create_indicatorMethod
indicatorProperty
shape_valProperty
template_keyProperty