mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
classref: Sync with current master branch (705b7a0)
This commit is contained in:
Godot Organization
+38
-38
@@ -146,7 +146,7 @@ Signals
|
||||
|
||||
.. rst-class:: classref-signal
|
||||
|
||||
**cell_size_changed**\ (\ cell_size\: :ref:`Vector3<class_Vector3>`\ )
|
||||
**cell_size_changed**\ (\ cell_size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_GridMap_signal_cell_size_changed>`
|
||||
|
||||
Emitted when :ref:`cell_size<class_GridMap_property_cell_size>` changes.
|
||||
|
||||
@@ -158,7 +158,7 @@ Emitted when :ref:`cell_size<class_GridMap_property_cell_size>` changes.
|
||||
|
||||
.. rst-class:: classref-signal
|
||||
|
||||
**changed**\ (\ )
|
||||
**changed**\ (\ ) :ref:`🔗<class_GridMap_signal_changed>`
|
||||
|
||||
Emitted when the :ref:`MeshLibrary<class_MeshLibrary>` of this GridMap changes.
|
||||
|
||||
@@ -175,7 +175,7 @@ Constants
|
||||
|
||||
.. rst-class:: classref-constant
|
||||
|
||||
**INVALID_CELL_ITEM** = ``-1``
|
||||
**INVALID_CELL_ITEM** = ``-1`` :ref:`🔗<class_GridMap_constant_INVALID_CELL_ITEM>`
|
||||
|
||||
Invalid cell item that can be used in :ref:`set_cell_item<class_GridMap_method_set_cell_item>` to clear cells (or represent an empty cell in :ref:`get_cell_item<class_GridMap_method_get_cell_item>`).
|
||||
|
||||
@@ -192,7 +192,7 @@ Property Descriptions
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`bool<class_bool>` **bake_navigation** = ``false``
|
||||
:ref:`bool<class_bool>` **bake_navigation** = ``false`` :ref:`🔗<class_GridMap_property_bake_navigation>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -209,7 +209,7 @@ If ``true``, this GridMap creates a navigation region for each cell that uses a
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`bool<class_bool>` **cell_center_x** = ``true``
|
||||
:ref:`bool<class_bool>` **cell_center_x** = ``true`` :ref:`🔗<class_GridMap_property_cell_center_x>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -226,7 +226,7 @@ If ``true``, grid items are centered on the X axis.
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`bool<class_bool>` **cell_center_y** = ``true``
|
||||
:ref:`bool<class_bool>` **cell_center_y** = ``true`` :ref:`🔗<class_GridMap_property_cell_center_y>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -243,7 +243,7 @@ If ``true``, grid items are centered on the Y axis.
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`bool<class_bool>` **cell_center_z** = ``true``
|
||||
:ref:`bool<class_bool>` **cell_center_z** = ``true`` :ref:`🔗<class_GridMap_property_cell_center_z>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -260,7 +260,7 @@ If ``true``, grid items are centered on the Z axis.
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`int<class_int>` **cell_octant_size** = ``8``
|
||||
:ref:`int<class_int>` **cell_octant_size** = ``8`` :ref:`🔗<class_GridMap_property_cell_octant_size>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -277,7 +277,7 @@ The size of each octant measured in number of cells. This applies to all three a
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`float<class_float>` **cell_scale** = ``1.0``
|
||||
:ref:`float<class_float>` **cell_scale** = ``1.0`` :ref:`🔗<class_GridMap_property_cell_scale>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -296,7 +296,7 @@ This does not affect the size of the grid cells themselves, only the items in th
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`Vector3<class_Vector3>` **cell_size** = ``Vector3(2, 2, 2)``
|
||||
:ref:`Vector3<class_Vector3>` **cell_size** = ``Vector3(2, 2, 2)`` :ref:`🔗<class_GridMap_property_cell_size>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -315,7 +315,7 @@ This does not affect the size of the meshes. See :ref:`cell_scale<class_GridMap_
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`int<class_int>` **collision_layer** = ``1``
|
||||
:ref:`int<class_int>` **collision_layer** = ``1`` :ref:`🔗<class_GridMap_property_collision_layer>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -334,7 +334,7 @@ GridMaps act as static bodies, meaning they aren't affected by gravity or other
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`int<class_int>` **collision_mask** = ``1``
|
||||
:ref:`int<class_int>` **collision_mask** = ``1`` :ref:`🔗<class_GridMap_property_collision_mask>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -351,7 +351,7 @@ The physics layers this GridMap detects collisions in. See `Collision layers and
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`float<class_float>` **collision_priority** = ``1.0``
|
||||
:ref:`float<class_float>` **collision_priority** = ``1.0`` :ref:`🔗<class_GridMap_property_collision_priority>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -368,7 +368,7 @@ The priority used to solve colliding when occurring penetration. The higher the
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`MeshLibrary<class_MeshLibrary>` **mesh_library**
|
||||
:ref:`MeshLibrary<class_MeshLibrary>` **mesh_library** :ref:`🔗<class_GridMap_property_mesh_library>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -385,7 +385,7 @@ The assigned :ref:`MeshLibrary<class_MeshLibrary>`.
|
||||
|
||||
.. rst-class:: classref-property
|
||||
|
||||
:ref:`PhysicsMaterial<class_PhysicsMaterial>` **physics_material**
|
||||
:ref:`PhysicsMaterial<class_PhysicsMaterial>` **physics_material** :ref:`🔗<class_GridMap_property_physics_material>`
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
@@ -407,7 +407,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **clear**\ (\ )
|
||||
|void| **clear**\ (\ ) :ref:`🔗<class_GridMap_method_clear>`
|
||||
|
||||
Clear all cells.
|
||||
|
||||
@@ -419,7 +419,7 @@ Clear all cells.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **clear_baked_meshes**\ (\ )
|
||||
|void| **clear_baked_meshes**\ (\ ) :ref:`🔗<class_GridMap_method_clear_baked_meshes>`
|
||||
|
||||
Clears all baked meshes. See :ref:`make_baked_meshes<class_GridMap_method_make_baked_meshes>`.
|
||||
|
||||
@@ -431,7 +431,7 @@ Clears all baked meshes. See :ref:`make_baked_meshes<class_GridMap_method_make_b
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`RID<class_RID>` **get_bake_mesh_instance**\ (\ idx\: :ref:`int<class_int>`\ )
|
||||
:ref:`RID<class_RID>` **get_bake_mesh_instance**\ (\ idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_GridMap_method_get_bake_mesh_instance>`
|
||||
|
||||
Returns :ref:`RID<class_RID>` of a baked mesh with the given ``idx``.
|
||||
|
||||
@@ -443,7 +443,7 @@ Returns :ref:`RID<class_RID>` of a baked mesh with the given ``idx``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Array<class_Array>` **get_bake_meshes**\ (\ )
|
||||
:ref:`Array<class_Array>` **get_bake_meshes**\ (\ ) :ref:`🔗<class_GridMap_method_get_bake_meshes>`
|
||||
|
||||
Returns an array of :ref:`ArrayMesh<class_ArrayMesh>`\ es and :ref:`Transform3D<class_Transform3D>` references of all bake meshes that exist within the current GridMap.
|
||||
|
||||
@@ -455,7 +455,7 @@ Returns an array of :ref:`ArrayMesh<class_ArrayMesh>`\ es and :ref:`Transform3D<
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Basis<class_Basis>` **get_basis_with_orthogonal_index**\ (\ index\: :ref:`int<class_int>`\ ) |const|
|
||||
:ref:`Basis<class_Basis>` **get_basis_with_orthogonal_index**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_GridMap_method_get_basis_with_orthogonal_index>`
|
||||
|
||||
Returns one of 24 possible rotations that lie along the vectors (x,y,z) with each component being either -1, 0, or 1. For further details, refer to the Godot source code.
|
||||
|
||||
@@ -467,7 +467,7 @@ Returns one of 24 possible rotations that lie along the vectors (x,y,z) with eac
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_cell_item**\ (\ position\: :ref:`Vector3i<class_Vector3i>`\ ) |const|
|
||||
:ref:`int<class_int>` **get_cell_item**\ (\ position\: :ref:`Vector3i<class_Vector3i>`\ ) |const| :ref:`🔗<class_GridMap_method_get_cell_item>`
|
||||
|
||||
The :ref:`MeshLibrary<class_MeshLibrary>` item index located at the given grid coordinates. If the cell is empty, :ref:`INVALID_CELL_ITEM<class_GridMap_constant_INVALID_CELL_ITEM>` will be returned.
|
||||
|
||||
@@ -479,7 +479,7 @@ The :ref:`MeshLibrary<class_MeshLibrary>` item index located at the given grid c
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Basis<class_Basis>` **get_cell_item_basis**\ (\ position\: :ref:`Vector3i<class_Vector3i>`\ ) |const|
|
||||
:ref:`Basis<class_Basis>` **get_cell_item_basis**\ (\ position\: :ref:`Vector3i<class_Vector3i>`\ ) |const| :ref:`🔗<class_GridMap_method_get_cell_item_basis>`
|
||||
|
||||
Returns the basis that gives the specified cell its orientation.
|
||||
|
||||
@@ -491,7 +491,7 @@ Returns the basis that gives the specified cell its orientation.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_cell_item_orientation**\ (\ position\: :ref:`Vector3i<class_Vector3i>`\ ) |const|
|
||||
:ref:`int<class_int>` **get_cell_item_orientation**\ (\ position\: :ref:`Vector3i<class_Vector3i>`\ ) |const| :ref:`🔗<class_GridMap_method_get_cell_item_orientation>`
|
||||
|
||||
The orientation of the cell at the given grid coordinates. ``-1`` is returned if the cell is empty.
|
||||
|
||||
@@ -503,7 +503,7 @@ The orientation of the cell at the given grid coordinates. ``-1`` is returned if
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **get_collision_layer_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const|
|
||||
:ref:`bool<class_bool>` **get_collision_layer_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_GridMap_method_get_collision_layer_value>`
|
||||
|
||||
Returns whether or not the specified layer of the :ref:`collision_layer<class_GridMap_property_collision_layer>` is enabled, given a ``layer_number`` between 1 and 32.
|
||||
|
||||
@@ -515,7 +515,7 @@ Returns whether or not the specified layer of the :ref:`collision_layer<class_Gr
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **get_collision_mask_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const|
|
||||
:ref:`bool<class_bool>` **get_collision_mask_value**\ (\ layer_number\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_GridMap_method_get_collision_mask_value>`
|
||||
|
||||
Returns whether or not the specified layer of the :ref:`collision_mask<class_GridMap_property_collision_mask>` is enabled, given a ``layer_number`` between 1 and 32.
|
||||
|
||||
@@ -527,7 +527,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask<class_Gri
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Array<class_Array>` **get_meshes**\ (\ ) |const|
|
||||
:ref:`Array<class_Array>` **get_meshes**\ (\ ) |const| :ref:`🔗<class_GridMap_method_get_meshes>`
|
||||
|
||||
Returns an array of :ref:`Transform3D<class_Transform3D>` and :ref:`Mesh<class_Mesh>` references corresponding to the non-empty cells in the grid. The transforms are specified in local space.
|
||||
|
||||
@@ -539,7 +539,7 @@ Returns an array of :ref:`Transform3D<class_Transform3D>` and :ref:`Mesh<class_M
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`RID<class_RID>` **get_navigation_map**\ (\ ) |const|
|
||||
:ref:`RID<class_RID>` **get_navigation_map**\ (\ ) |const| :ref:`🔗<class_GridMap_method_get_navigation_map>`
|
||||
|
||||
Returns the :ref:`RID<class_RID>` of the navigation map this GridMap node uses for its cell baked navigation meshes.
|
||||
|
||||
@@ -553,7 +553,7 @@ This function returns always the map set on the GridMap node and not the map on
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **get_orthogonal_index_from_basis**\ (\ basis\: :ref:`Basis<class_Basis>`\ ) |const|
|
||||
:ref:`int<class_int>` **get_orthogonal_index_from_basis**\ (\ basis\: :ref:`Basis<class_Basis>`\ ) |const| :ref:`🔗<class_GridMap_method_get_orthogonal_index_from_basis>`
|
||||
|
||||
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index (in the range from 0 to 23) of the point best representing the orientation of the object. For further details, refer to the Godot source code.
|
||||
|
||||
@@ -565,7 +565,7 @@ This function considers a discretization of rotations into 24 points on unit sph
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Array<class_Array>`\[:ref:`Vector3i<class_Vector3i>`\] **get_used_cells**\ (\ ) |const|
|
||||
:ref:`Array<class_Array>`\[:ref:`Vector3i<class_Vector3i>`\] **get_used_cells**\ (\ ) |const| :ref:`🔗<class_GridMap_method_get_used_cells>`
|
||||
|
||||
Returns an array of :ref:`Vector3<class_Vector3>` with the non-empty cell coordinates in the grid map.
|
||||
|
||||
@@ -577,7 +577,7 @@ Returns an array of :ref:`Vector3<class_Vector3>` with the non-empty cell coordi
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Array<class_Array>`\[:ref:`Vector3i<class_Vector3i>`\] **get_used_cells_by_item**\ (\ item\: :ref:`int<class_int>`\ ) |const|
|
||||
:ref:`Array<class_Array>`\[:ref:`Vector3i<class_Vector3i>`\] **get_used_cells_by_item**\ (\ item\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_GridMap_method_get_used_cells_by_item>`
|
||||
|
||||
Returns an array of all cells with the given item index specified in ``item``.
|
||||
|
||||
@@ -589,7 +589,7 @@ Returns an array of all cells with the given item index specified in ``item``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Vector3i<class_Vector3i>` **local_to_map**\ (\ local_position\: :ref:`Vector3<class_Vector3>`\ ) |const|
|
||||
:ref:`Vector3i<class_Vector3i>` **local_to_map**\ (\ local_position\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`🔗<class_GridMap_method_local_to_map>`
|
||||
|
||||
Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node3D.to_local<class_Node3D_method_to_local>` before passing it to this method. See also :ref:`map_to_local<class_GridMap_method_map_to_local>`.
|
||||
|
||||
@@ -601,7 +601,7 @@ Returns the map coordinates of the cell containing the given ``local_position``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **make_baked_meshes**\ (\ gen_lightmap_uv\: :ref:`bool<class_bool>` = false, lightmap_uv_texel_size\: :ref:`float<class_float>` = 0.1\ )
|
||||
|void| **make_baked_meshes**\ (\ gen_lightmap_uv\: :ref:`bool<class_bool>` = false, lightmap_uv_texel_size\: :ref:`float<class_float>` = 0.1\ ) :ref:`🔗<class_GridMap_method_make_baked_meshes>`
|
||||
|
||||
Bakes lightmap data for all meshes in the assigned :ref:`MeshLibrary<class_MeshLibrary>`.
|
||||
|
||||
@@ -613,7 +613,7 @@ Bakes lightmap data for all meshes in the assigned :ref:`MeshLibrary<class_MeshL
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Vector3<class_Vector3>` **map_to_local**\ (\ map_position\: :ref:`Vector3i<class_Vector3i>`\ ) |const|
|
||||
:ref:`Vector3<class_Vector3>` **map_to_local**\ (\ map_position\: :ref:`Vector3i<class_Vector3i>`\ ) |const| :ref:`🔗<class_GridMap_method_map_to_local>`
|
||||
|
||||
Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node3D.to_global<class_Node3D_method_to_global>`. See also :ref:`local_to_map<class_GridMap_method_local_to_map>`.
|
||||
|
||||
@@ -625,7 +625,7 @@ Returns the position of a grid cell in the GridMap's local coordinate space. To
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **resource_changed**\ (\ resource\: :ref:`Resource<class_Resource>`\ )
|
||||
|void| **resource_changed**\ (\ resource\: :ref:`Resource<class_Resource>`\ ) :ref:`🔗<class_GridMap_method_resource_changed>`
|
||||
|
||||
**Deprecated:** Use :ref:`Resource.changed<class_Resource_signal_changed>` instead.
|
||||
|
||||
@@ -639,7 +639,7 @@ This method does nothing.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **set_cell_item**\ (\ position\: :ref:`Vector3i<class_Vector3i>`, item\: :ref:`int<class_int>`, orientation\: :ref:`int<class_int>` = 0\ )
|
||||
|void| **set_cell_item**\ (\ position\: :ref:`Vector3i<class_Vector3i>`, item\: :ref:`int<class_int>`, orientation\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_GridMap_method_set_cell_item>`
|
||||
|
||||
Sets the mesh index for the cell referenced by its grid coordinates.
|
||||
|
||||
@@ -655,7 +655,7 @@ Optionally, the item's orientation can be passed. For valid orientation values,
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ )
|
||||
|void| **set_collision_layer_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_GridMap_method_set_collision_layer_value>`
|
||||
|
||||
Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer<class_GridMap_property_collision_layer>`, given a ``layer_number`` between 1 and 32.
|
||||
|
||||
@@ -667,7 +667,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ )
|
||||
|void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int<class_int>`, value\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_GridMap_method_set_collision_mask_value>`
|
||||
|
||||
Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask<class_GridMap_property_collision_mask>`, given a ``layer_number`` between 1 and 32.
|
||||
|
||||
@@ -679,7 +679,7 @@ Based on ``value``, enables or disables the specified layer in the :ref:`collisi
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID<class_RID>`\ )
|
||||
|void| **set_navigation_map**\ (\ navigation_map\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_GridMap_method_set_navigation_map>`
|
||||
|
||||
Sets the :ref:`RID<class_RID>` of the navigation map this GridMap node should use for its cell baked navigation meshes.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user