Settings for the placement cursor: how it moves, where it may go, and the pathing grid used to limit its range.
Source: addons/grid_placement/systems/grid_targeting/grid_targeting_settings.gd
Syntax
class GridTargetingSettings extends PlacementResourceMembers
| Name | Kind | Summary |
|---|---|---|
limit_to_adjacent | Property | When on, the cursor stays within max_tile_distance tiles of the player character (the PlacementOwner's root). For mouse movement in 2D, restrict_to_map_area must also be on. |
max_tile_distance | Property | How many tiles from the player character the cursor may go, when limit_to_adjacent is on. |
restrict_to_map_area | Property | When on, the cursor can only move onto cells that have a tile on the target map. When off, it moves freely and snaps to the grid. |
enable_mouse_input | Property | Whether the 2D cursor follows the mouse. |
enable_keyboard_input | Property | Whether the 2D cursor can be moved with the keyboard. Needs the cursor actions in PlacementActions to exist in the Input Map. |
remain_active_in_off_mode | Property | When on, the 2D cursor keeps following input while placement is off. Useful for level editors or debug tools. When off (default), the cursor stops moving until a mode such as build or move is entered. |
manual_recenter_mode | Property | Where the PlacementActions.positioner_center action moves the cursor: the center of the screen or the mouse position. |
position_on_enable_policy | Property | Where the cursor goes when it becomes active: - NONE: stays where it is. - LAST_SHOWN: where it was last shown, else the mouse or screen center. - VIEW_CENTER: the center of the screen. - MOUSE_CURSOR: the mouse position, else the screen center. Where the 2D cursor goes when it becomes active. See RecenterOnEnablePolicy. |
hide_on_handled | Property | When on, the 2D cursor hides while the mouse is over UI that handles it, such as a button. Only applies when enable_mouse_input is on. |
region_size | Property | Size, in cells, of the pathing grid used by limit_to_adjacent. |
cell_shape | Property | Cell shape of the pathing grid. Match your TileSet. |
diagonal_mode | Property | Whether pathing can move diagonally. |
default_compute_heuristic | Property | How the pathing grid measures the cost between cells. |
default_estimate_heuristic | Property | How the pathing grid estimates the remaining distance to the target. |
get_editor_issues | Method |