Skip to content
Grid Building Docs

GridTargetingSettings

Summary

Section titled “Summary”

Settings related to targeting tiles and the pathing that goes between them

Properties

Section titled “Properties”
limit_to_adjacent = false

Emitted when the show_debug property changes value (All legacy per-property signals removed; use notify_property_list_changed for any change observers.)

When set, limits tile section to only the character adjacent tile that is in the direction of the cirspr location

restrict_to_map_area = false

Makes it so the cursor can only move to areas with valid tiles on the target map layer or can move freely with snapping when false

show_debug: bool = false

Whether to show debug information for targeting systems

cell_shape = AStarGrid2D.CellShape.CELL_SHAPE_SQUARE
diaganol_mode = AStarGrid2D.DiagonalMode.DIAGONAL_MODE_ALWAYS

What moves are allowed in a single change of grid space for grid pathing

default_compute_heuristic = AStarGrid2D.HEURISTIC_EUCLIDEAN

Formula for calculating AStarGrid2D movement cost When created, sets the default_default_compute_heuristic on the AStarGrid2D of the GridTargetingSystem

default_estimate_heuristic = AStarGrid2D.HEURISTIC_EUCLIDEAN

Formula for calculating AStarGrid2D movement cost When created, sets the default_default_estimate_heuristic on the AStarGrid2D of the GridTargetingSystem

hide_on_handled: bool = true

If this is true, when mouse input is consumed by UI under the cursor then the positioner and all child objects will hide until the mouse is over the game world again

Methods

Section titled “Methods”
get_editor_issues( ) -> Array[String]
get_runtime_issues( ) -> Array[String]

Source

Section titled “Source”

addons/grid_building/systems/grid_targeting/grid_targeting_settings.gd

This page was auto-generated from GDScript source. Edit the source file to improve documentation.

Generated on 2025-09-07