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.
Settings related to targeting tiles and the pathing that goes between them
Source: addons/grid_placement/systems/grid_targeting/grid_targeting_settings.gd
Syntax
class GridTargetingSettings extends PlacementResourceMembers
| Name | Kind | Summary |
|---|---|---|
limit_to_adjacent | Property | Emitted when the show_debug property changes value Note: Per-property legacy signals were removed; use notify_property_list_changed for change observation. When set, limits tile section to only the character adjacent tile that is in the direction of the cirspr location |
max_tile_distance | Property | The number of tiles distance away from the limit target (if one is set) that the pointer tile can be |
restrict_to_map_area | Property | 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 | Property | Whether to show debug information for targeting systems |
enable_mouse_input | Property | Toggle whether the GridPositioner2D will move with mouse input or not |
enable_keyboard_input | Property | Toggle whether the GridPositioner will move with keyboard input or not. You must define the positioner input actions defined in the PlacementActions resource |
enable_rotation_input | Property | Toggle whether the GridPositioner2D can rotate objects with rotation input (if a target object is present) When enabled, rotate_left and rotate_right actions will rotate the targeted object in 90-degree increments |
remain_active_in_off_mode | Property | Controls whether GridPositioner2D remains active during OFF mode When true: The positioner continues to respond to mouse/keyboard input and can move/recenter even when the targeting mode is set to OFF. Useful for demo scenes, level editors, or debug tools where the cursor should remain interactive outside of build mode. When false: The positioner ignores all input and positioning commands when in OFF mode, effectively disabling cursor movement and recentering until a different mode (MOVE, DEMOLISH, etc.) is activated. Default: false (positioner disabled in OFF mode for typical gameplay) |
manual_recenter_mode | Property | Manual recenter mode for GridPositioner2D input actions |
position_on_enable_policy | Property | Recenter policy on enable: choose where to place the positioner when input is (re)enabled NONE: Do nothing (no recenter) LAST_SHOWN: Use last known/cached world position if available; fallback to mouse/camera per input settings VIEW_CENTER: Center on the viewport/camera center MOUSE_CURSOR:Center on the mouse cursor (uses cached event world if available; may fallback to camera center) |
hide_on_handled | Property | Controls whether the grid positioner hides when mouse input is handled by UI. When [code]true[/code], the positioner will hide if: - Mouse input is enabled ([member enable_mouse_input] is [code]true[/code]) - A mouse event was consumed/handled by UI elements (not reaching the game world) When [code]false[/code] or when mouse input is disabled, the positioner remains visible regardless of UI mouse handling. [b]Note:[/b] This setting only applies when [member enable_mouse_input] is [code]true[/code]. If mouse input is disabled, [code]hide_on_handled[/code] has no effect. [b]Behavior Examples:[/b] - Mouse enabled + hide_on_handled=true + UI consumes mouse = Hidden - Mouse enabled + hide_on_handled=false + UI consumes mouse = Visible - Mouse disabled + hide_on_handled=true + any mouse state = Visible (ignored) |
region_size | Property | |
cell_shape | Property | |
diagonal_mode | Property | What moves are allowed in a single change of grid space for grid pathing |
default_compute_heuristic | Property | Formula for calculating AStarGrid2D movement cost When created, sets the default_default_compute_heuristic on the AStarGrid2D of the GridTargetingSystem |
default_estimate_heuristic | Property | Formula for calculating AStarGrid2D movement cost When created, sets the default_default_estimate_heuristic on the AStarGrid2D of the GridTargetingSystem |
get_editor_issues | Method | |
issues | Property | |
get_runtime_issues | Method |
Source
addons/grid_placement/systems/grid_targeting/grid_targeting_settings.gd
Plugin docs root:gdscript/plugins/grid_placement_dev/docs