.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/AStarGrid2D.xml. .. _class_AStarGrid2D: AStarGrid2D =========== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`CellShape` | :ref:`cell_shape` | ``0`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`Vector2` | :ref:`cell_size` | ``Vector2(1, 1)`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`Heuristic` | :ref:`default_compute_heuristic` | ``0`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`Heuristic` | :ref:`default_estimate_heuristic` | ``0`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`DiagonalMode` | :ref:`diagonal_mode` | ``0`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`bool` | :ref:`jumping_enabled` | ``false`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`Vector2` | :ref:`offset` | ``Vector2(0, 0)`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`Rect2i` | :ref:`region` | ``Rect2i(0, 0, 0, 0)`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ | :ref:`Vector2i` | :ref:`size` | ``Vector2i(0, 0)`` | +----------------------------------------------------+------------------------------------------------------------------------------------------+------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_compute_cost` **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_estimate_cost` **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fill_solid_region` **(** :ref:`Rect2i` region, :ref:`bool` solid=true **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fill_weight_scale_region` **(** :ref:`Rect2i` region, :ref:`float` weight_scale **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i[]` | :ref:`get_id_path` **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id, :ref:`bool` allow_partial_path=false **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`get_point_path` **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id, :ref:`bool` allow_partial_path=false **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`Vector2i` id **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`Vector2i` id **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_dirty` **(** **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_in_bounds` **(** :ref:`int` x, :ref:`int` y **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_in_boundsv` **(** :ref:`Vector2i` id **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_point_solid` **(** :ref:`Vector2i` id **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_solid` **(** :ref:`Vector2i` id, :ref:`bool` solid=true **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_weight_scale` **(** :ref:`Vector2i` id, :ref:`float` weight_scale **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update` **(** **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AStarGrid2D_Heuristic: .. rst-class:: classref-enumeration enum **Heuristic**: .. _class_AStarGrid2D_constant_HEURISTIC_EUCLIDEAN: .. rst-class:: classref-enumeration-constant :ref:`Heuristic` **HEURISTIC_EUCLIDEAN** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_HEURISTIC_MANHATTAN: .. rst-class:: classref-enumeration-constant :ref:`Heuristic` **HEURISTIC_MANHATTAN** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_HEURISTIC_OCTILE: .. rst-class:: classref-enumeration-constant :ref:`Heuristic` **HEURISTIC_OCTILE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_HEURISTIC_CHEBYSHEV: .. rst-class:: classref-enumeration-constant :ref:`Heuristic` **HEURISTIC_CHEBYSHEV** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_HEURISTIC_MAX: .. rst-class:: classref-enumeration-constant :ref:`Heuristic` **HEURISTIC_MAX** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_AStarGrid2D_DiagonalMode: .. rst-class:: classref-enumeration enum **DiagonalMode**: .. _class_AStarGrid2D_constant_DIAGONAL_MODE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`DiagonalMode` **DIAGONAL_MODE_ALWAYS** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_DIAGONAL_MODE_NEVER: .. rst-class:: classref-enumeration-constant :ref:`DiagonalMode` **DIAGONAL_MODE_NEVER** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_DIAGONAL_MODE_AT_LEAST_ONE_WALKABLE: .. rst-class:: classref-enumeration-constant :ref:`DiagonalMode` **DIAGONAL_MODE_AT_LEAST_ONE_WALKABLE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_DIAGONAL_MODE_ONLY_IF_NO_OBSTACLES: .. rst-class:: classref-enumeration-constant :ref:`DiagonalMode` **DIAGONAL_MODE_ONLY_IF_NO_OBSTACLES** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_DIAGONAL_MODE_MAX: .. rst-class:: classref-enumeration-constant :ref:`DiagonalMode` **DIAGONAL_MODE_MAX** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_AStarGrid2D_CellShape: .. rst-class:: classref-enumeration enum **CellShape**: .. _class_AStarGrid2D_constant_CELL_SHAPE_SQUARE: .. rst-class:: classref-enumeration-constant :ref:`CellShape` **CELL_SHAPE_SQUARE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_CELL_SHAPE_ISOMETRIC_RIGHT: .. rst-class:: classref-enumeration-constant :ref:`CellShape` **CELL_SHAPE_ISOMETRIC_RIGHT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_CELL_SHAPE_ISOMETRIC_DOWN: .. rst-class:: classref-enumeration-constant :ref:`CellShape` **CELL_SHAPE_ISOMETRIC_DOWN** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AStarGrid2D_constant_CELL_SHAPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`CellShape` **CELL_SHAPE_MAX** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AStarGrid2D_property_cell_shape: .. rst-class:: classref-property :ref:`CellShape` **cell_shape** = ``0`` .. rst-class:: classref-property-setget - void **set_cell_shape** **(** :ref:`CellShape` value **)** - :ref:`CellShape` **get_cell_shape** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_property_cell_size: .. rst-class:: classref-property :ref:`Vector2` **cell_size** = ``Vector2(1, 1)`` .. rst-class:: classref-property-setget - void **set_cell_size** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_cell_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_property_default_compute_heuristic: .. rst-class:: classref-property :ref:`Heuristic` **default_compute_heuristic** = ``0`` .. rst-class:: classref-property-setget - void **set_default_compute_heuristic** **(** :ref:`Heuristic` value **)** - :ref:`Heuristic` **get_default_compute_heuristic** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_property_default_estimate_heuristic: .. rst-class:: classref-property :ref:`Heuristic` **default_estimate_heuristic** = ``0`` .. rst-class:: classref-property-setget - void **set_default_estimate_heuristic** **(** :ref:`Heuristic` value **)** - :ref:`Heuristic` **get_default_estimate_heuristic** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_property_diagonal_mode: .. rst-class:: classref-property :ref:`DiagonalMode` **diagonal_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_diagonal_mode** **(** :ref:`DiagonalMode` value **)** - :ref:`DiagonalMode` **get_diagonal_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_property_jumping_enabled: .. rst-class:: classref-property :ref:`bool` **jumping_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_jumping_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_jumping_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_property_offset: .. rst-class:: classref-property :ref:`Vector2` **offset** = ``Vector2(0, 0)`` .. rst-class:: classref-property-setget - void **set_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_property_region: .. rst-class:: classref-property :ref:`Rect2i` **region** = ``Rect2i(0, 0, 0, 0)`` .. rst-class:: classref-property-setget - void **set_region** **(** :ref:`Rect2i` value **)** - :ref:`Rect2i` **get_region** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_property_size: .. rst-class:: classref-property :ref:`Vector2i` **size** = ``Vector2i(0, 0)`` .. rst-class:: classref-property-setget - void **set_size** **(** :ref:`Vector2i` value **)** - :ref:`Vector2i` **get_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AStarGrid2D_private_method__compute_cost: .. rst-class:: classref-method :ref:`float` **_compute_cost** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_private_method__estimate_cost: .. rst-class:: classref-method :ref:`float` **_estimate_cost** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_clear: .. rst-class:: classref-method void **clear** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_fill_solid_region: .. rst-class:: classref-method void **fill_solid_region** **(** :ref:`Rect2i` region, :ref:`bool` solid=true **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_fill_weight_scale_region: .. rst-class:: classref-method void **fill_weight_scale_region** **(** :ref:`Rect2i` region, :ref:`float` weight_scale **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_get_id_path: .. rst-class:: classref-method :ref:`Vector2i[]` **get_id_path** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id, :ref:`bool` allow_partial_path=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_get_point_path: .. rst-class:: classref-method :ref:`PackedVector2Array` **get_point_path** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id, :ref:`bool` allow_partial_path=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_get_point_position: .. rst-class:: classref-method :ref:`Vector2` **get_point_position** **(** :ref:`Vector2i` id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_get_point_weight_scale: .. rst-class:: classref-method :ref:`float` **get_point_weight_scale** **(** :ref:`Vector2i` id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_is_dirty: .. rst-class:: classref-method :ref:`bool` **is_dirty** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_is_in_bounds: .. rst-class:: classref-method :ref:`bool` **is_in_bounds** **(** :ref:`int` x, :ref:`int` y **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_is_in_boundsv: .. rst-class:: classref-method :ref:`bool` **is_in_boundsv** **(** :ref:`Vector2i` id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_is_point_solid: .. rst-class:: classref-method :ref:`bool` **is_point_solid** **(** :ref:`Vector2i` id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_set_point_solid: .. rst-class:: classref-method void **set_point_solid** **(** :ref:`Vector2i` id, :ref:`bool` solid=true **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_set_point_weight_scale: .. rst-class:: classref-method void **set_point_weight_scale** **(** :ref:`Vector2i` id, :ref:`float` weight_scale **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AStarGrid2D_method_update: .. rst-class:: classref-method void **update** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`