Skip to content

Class

PlacementPositioning2DUtils

Generated GDScript class reference for GridPlacement.PlacementPositioning2DUtils.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

PlacementPositioning2DUtils Static utility functions for 2D grid-based positioning and tile movement operations. This class provides pure functions for common 2D game positioning tasks including:

  • Converting between world coordinates, viewport coordinates, and tile coordinates
  • Moving nodes to tile centers with proper alignment
  • Viewport-to-world coordinate transformations using Camera2D
  • Distance-limited movement with adjacency constraints
  • Direction vector normalization for tile-based movement All functions are static and depend only on provided parameters, making them highly testable and reusable. Extracted from GridPositioner2D to reduce class coupling and improve maintainability. [b]⭐ CAMERA2D REQUIRED[/b]
  • Add a Camera2D node to your scene before using Grid Building operations. World coordinate calculations from mouse position depend on Camera2D for accurate positioning. [b]Requirements:[/b] Designed for 2D games using TileMapLayer and Camera2D nodes.

Source: addons/grid_placement/utils/placement_positioning_2d_utils.gd

Syntax

class PlacementPositioning2DUtils extends RefCounted

Members

NameKindSummary
successPropertyInternal explicit projection result shared by runtime and validator paths. World origin is therefore a normal successful value rather than a sentinel.
world_positionProperty
errorProperty
get_tile_from_global_positionMethod
move_to_tile_centerMethod
move_to_closest_valid_tile_centerMethod
limit_tile_to_max_distanceMethod
is_region_validMethod
snap_tile_to_regionMethod
get_tile_from_node_positionMethod
move_node_by_tilesMethod
convert_screen_to_world_positionMethod
viewport_center_to_world_positionMethod
move_node_to_tile_at_viewport_centerMethod
direction_to_tile_deltaMethod