GridTargetingSettings

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

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

Source File: addons/grid_building/systems/grid_targeting/grid_targeting_settings.gd

Extends: GBResource

Exported Properties

  • Property: limit_to_adjacent = false

    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

  • Property: 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

  • Property: show_debug : bool = false : - Whether to show debug information for targeting systems

  • Property: enable_mouse_input : bool = true - Toggle whether the GridPositioner2D will move with mouse input or not

  • Property: enable_keyboard_input : bool = false

    Toggle whether the GridPositioner will move with keyboard input or not. You must define the positioner input actions defined in the GBActions resource

  • Property: enable_rotation_input : bool = false

    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

  • Property: remain_active_in_off_mode : bool = false

    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)

  • Property: manual_recenter_mode: [GBEnums](./gb-enums/).CenteringMode = GBEnums.CenteringMode.CENTER_ON_SCREEN - Manual recenter mode for GridPositioner2D input actions

  • Property: position_on_enable_policy: RecenterOnEnablePolicy = RecenterOnEnablePolicy.MOUSE_CURSOR

  • Property: hide_on_handled : bool = true

    Controls whether the grid positioner hides when mouse input is handled by UI.

    When true, the positioner will hide if:

    • Mouse input is enabled (enable_mouse_input is true)
    • A mouse event was consumed/handled by UI elements (not reaching the game world)

    When false or when mouse input is disabled, the positioner remains visible regardless of UI mouse handling.

    Note: This setting only applies when enable_mouse_input is true. If mouse input is disabled, hide_on_handled has no effect.

    Behavior Examples:

    • 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)

  • Property: region_size = Vector2i(50, 50): # Testing size

  • Property: cell_shape = AStarGrid2D.CellShape.CELL_SHAPE_SQUARE:

  • Property: diagonal_mode = AStarGrid2D.DiagonalMode.DIAGONAL_MODE_ALWAYS : - What moves are allowed in a single change of grid space for grid pathing

  • Property: 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

  • Property: 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

Properties

  • Property: max_tile_distance : int = 3

    The number of tiles distance away from the limit target (if one is set) that the pointer tile can be

Public Methods

get_editor_issues

1

get_editor_issues() -> Array[String]

get_runtime_issues

1

get_runtime_issues() -> Array[String]