asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/modules/gridmap/doc_classes/GridMap.xml

253 lines
13 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
<class name="GridMap" inherits="Node3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
[DOCS] Document GridMap [ci skip]
2017-10-08 12:14:09 +02:00
Node for 3D tile-based maps.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</brief_description>
<description>
Docs: GridMap and MeshLibrary The only methods left to document are resource_changed, set_clip, and the methods dealing with baked meshes.
2019-11-30 01:21:34 +01:00
GridMap lets you place meshes on a grid interactively. It works both from the editor and from scripts, which can help you create in-game level editors.
GridMaps use a [MeshLibrary] which contains a list of tiles. Each tile is a mesh with materials plus optional collision and navigation shapes.
A GridMap contains a collection of cells. Each grid cell refers to a tile in the [MeshLibrary]. All cells in the map have the same dimensions.
Internally, a GridMap is split into a sparse collection of octants for efficient rendering and physics processing. Every octant has the same dimensions and can contain several cells.
Document that GridMap doesn't support visual layers or cull masks See #40245.
2021-02-02 19:30:55 +01:00
[b]Note:[/b] GridMap doesn't extend [VisualInstance3D] and therefore can't be hidden or cull masked based on [member VisualInstance3D.layers]. If you make a light not affect the first layer, the whole GridMap won't be lit by the light in question.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 10:43:07 +01:00
<link title="Using gridmaps">$DOCS_URL/tutorials/3d/using_gridmaps.html</link>
Link to demos from within the class reference
2020-10-01 10:34:47 +02:00
<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
<link title="3D Kinematic Character Demo">https://godotengine.org/asset-library/asset/126</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</tutorials>
<methods>
<method name="clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 12:14:09 +02:00
Clear all cells.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
<method name="clear_baked_meshes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
<description>
Fill random docs
2022-11-21 03:48:36 +01:00
Clears all baked meshes. See [method make_baked_meshes].
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
</description>
</method>
<method name="get_bake_mesh_instance">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="idx" type="int" />
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
<description>
Fill random docs
2022-11-21 03:48:36 +01:00
Returns [RID] of a baked mesh with the given [param idx].
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
</description>
</method>
<method name="get_bake_meshes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
<description>
Update documentation for Transform3D
2020-05-03 10:27:36 +02:00
Returns an array of [ArrayMesh]es and [Transform3D] references of all bake meshes that exist within the current GridMap.
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
</description>
</method>
Expose Basis `set_orthogonal_index` method as a GridMap function
2022-01-27 06:44:36 +01:00
<method name="get_basis_with_orthogonal_index" qualifiers="const">
<return type="Basis" />
<param index="0" name="index" type="int" />
<description>
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.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="get_cell_item" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="position" type="Vector3i" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
doc: Sync classref with current source
2020-07-03 16:09:12 +02:00
The [MeshLibrary] item index located at the given grid coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Expose Basis `set_orthogonal_index` method as a GridMap function
2022-01-27 06:44:36 +01:00
<method name="get_cell_item_basis" qualifiers="const">
<return type="Basis" />
<param index="0" name="position" type="Vector3i" />
<description>
Fix typos with codespell Using codespell 2.3-dev from current git. And fix typo in `methods.py` for `vsproj=yes` option (still won't work though).
2022-09-30 14:23:36 +02:00
Returns the basis that gives the specified cell its orientation.
Expose Basis `set_orthogonal_index` method as a GridMap function
2022-01-27 06:44:36 +01:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="get_cell_item_orientation" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="position" type="Vector3i" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
doc: Sync classref with current source
2020-07-03 16:09:12 +02:00
The orientation of the cell at the given grid coordinates. [code]-1[/code] is returned if the cell is empty.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 01:01:38 +02:00
<method name="get_collision_layer_value" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="layer_number" type="int" />
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
<description>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 01:01:38 +02:00
Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32.
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
</description>
</method>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 01:01:38 +02:00
<method name="get_collision_mask_value" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="layer_number" type="int" />
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
<description>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 01:01:38 +02:00
Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32.
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
</description>
</method>
Consider gridmap collisions in navigation bake
2022-01-14 16:36:59 +01:00
<method name="get_meshes" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Array" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Rename TileMap/GridMap.`world_to_map` and opposite to `local_to_map` For both TileMap and GridMap: - `world_to_map` -> `local_to_map` - `map_to_world` -> `map_to_local` Also changes any mention of "world" in this context to "local" to avoid future confusion. Finally, updates the docs of both methods for consistency. In particular, adding a note on how to convert the returned values from local to global coordinates and vice versa.
2022-08-20 18:39:05 +02:00
Returns an array of [Transform3D] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in local space.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Add navigation layer bitmask helper functions Adds helper functions to work with the navigation layer bitmask.
2022-06-19 13:23:13 +02:00
<method name="get_navigation_layer_value" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="layer_number" type="int" />
Add navigation layer bitmask helper functions Adds helper functions to work with the navigation layer bitmask.
2022-06-19 13:23:13 +02:00
<description>
Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32.
</description>
</method>
Add GridMap function to change navigation map for baked navigation regions Adds function to change the navigation map for baked navigation regions. Before all cells with a baked navigation mesh were locked to the default navigation map of the world resource.
2022-09-07 13:51:32 +02:00
<method name="get_navigation_map" qualifiers="const">
<return type="RID" />
<description>
Returns the [RID] of the navigation map this GridMap node uses for its cell baked navigation meshes.
This function returns always the map set on the GridMap node and not the map on the NavigationServer. If the map is changed directly with the NavigationServer API the GridMap node will not be aware of the map change.
</description>
</method>
Expose Basis `set_orthogonal_index` method as a GridMap function
2022-01-27 06:44:36 +01:00
<method name="get_orthogonal_index_from_basis" qualifiers="const">
<return type="int" />
<param index="0" name="basis" type="Basis" />
<description>
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.
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<method name="get_used_cells" qualifiers="const">
Replace Array return types with TypedArray 2
2022-08-05 20:35:08 +02:00
<return type="Vector3i[]" />
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<description>
Docs: GridMap and MeshLibrary The only methods left to document are resource_changed, set_clip, and the methods dealing with baked meshes.
2019-11-30 01:21:34 +01:00
Returns an array of [Vector3] with the non-empty cell coordinates in the grid map.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</description>
</method>
Add GridMap.get_used_cells_by_item
2022-02-16 06:04:31 +01:00
<method name="get_used_cells_by_item" qualifiers="const">
Replace Array return types with TypedArray 2
2022-08-05 20:35:08 +02:00
<return type="Vector3i[]" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="item" type="int" />
Add GridMap.get_used_cells_by_item
2022-02-16 06:04:31 +01:00
<description>
Returns an array of all cells with the given item index specified in [code]item[/code].
</description>
</method>
Rename TileMap/GridMap.`world_to_map` and opposite to `local_to_map` For both TileMap and GridMap: - `world_to_map` -> `local_to_map` - `map_to_world` -> `map_to_local` Also changes any mention of "world" in this context to "local" to avoid future confusion. Finally, updates the docs of both methods for consistency. In particular, adding a note on how to convert the returned values from local to global coordinates and vice versa.
2022-08-20 18:39:05 +02:00
<method name="local_to_map" qualifiers="const">
<return type="Vector3i" />
<param index="0" name="local_position" type="Vector3" />
<description>
Returns the map coordinates of the cell containing the given [param local_position]. If [param local_position] is in global coordinates, consider using [method Node3D.to_local] before passing it to this method. See also [method map_to_local].
</description>
</method>
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
<method name="make_baked_meshes">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="gen_lightmap_uv" type="bool" default="false" />
<param index="1" name="lightmap_uv_texel_size" type="float" default="0.1" />
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
<description>
Fill random docs
2022-11-21 03:48:36 +01:00
Bakes lightmap data for all meshes in the assigned [MeshLibrary].
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
</description>
</method>
Rename TileMap/GridMap.`world_to_map` and opposite to `local_to_map` For both TileMap and GridMap: - `world_to_map` -> `local_to_map` - `map_to_world` -> `map_to_local` Also changes any mention of "world" in this context to "local" to avoid future confusion. Finally, updates the docs of both methods for consistency. In particular, adding a note on how to convert the returned values from local to global coordinates and vice versa.
2022-08-20 18:39:05 +02:00
<method name="map_to_local" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="map_position" type="Vector3i" />
classref: Sync with current source
2017-10-21 12:02:08 +02:00
<description>
Rename TileMap/GridMap.`world_to_map` and opposite to `local_to_map` For both TileMap and GridMap: - `world_to_map` -> `local_to_map` - `map_to_world` -> `map_to_local` Also changes any mention of "world" in this context to "local" to avoid future confusion. Finally, updates the docs of both methods for consistency. In particular, adding a note on how to convert the returned values from local to global coordinates and vice versa.
2022-08-20 18:39:05 +02:00
Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use [method Node3D.to_global]. See also [method map_to_local].
classref: Sync with current source
2017-10-21 12:02:08 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="resource_changed">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="resource" type="Resource" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Fill random docs
2022-11-21 03:48:36 +01:00
Notifies the [GridMap] about changed resource and recreates octant data.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="set_cell_item">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="position" type="Vector3i" />
<param index="1" name="item" type="int" />
<param index="2" name="orientation" type="int" default="0" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
doc: Sync classref with current source
2020-07-03 16:09:12 +02:00
Sets the mesh index for the cell referenced by its grid coordinates.
Docs: GridMap and MeshLibrary The only methods left to document are resource_changed, set_clip, and the methods dealing with baked meshes.
2019-11-30 01:21:34 +01:00
A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell.
Expose Basis `set_orthogonal_index` method as a GridMap function
2022-01-27 06:44:36 +01:00
Optionally, the item's orientation can be passed. For valid orientation values, see [method get_orthogonal_index_from_basis].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 01:01:38 +02:00
<method name="set_collision_layer_value">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" />
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
<description>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 01:01:38 +02:00
Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32.
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
</description>
</method>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 01:01:38 +02:00
<method name="set_collision_mask_value">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" />
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
<description>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-12 01:01:38 +02:00
Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32.
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
</description>
</method>
Add navigation layer bitmask helper functions Adds helper functions to work with the navigation layer bitmask.
2022-06-19 13:23:13 +02:00
<method name="set_navigation_layer_value">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" />
Add navigation layer bitmask helper functions Adds helper functions to work with the navigation layer bitmask.
2022-06-19 13:23:13 +02:00
<description>
Based on [code]value[/code], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [code]layer_number[/code] between 1 and 32.
</description>
</method>
Add GridMap function to change navigation map for baked navigation regions Adds function to change the navigation map for baked navigation regions. Before all cells with a baked navigation mesh were locked to the default navigation map of the world resource.
2022-09-07 13:51:32 +02:00
<method name="set_navigation_map">
<return type="void" />
<param index="0" name="navigation_map" type="RID" />
<description>
Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</methods>
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
<members>
Remove Navigation2D/3D nodes, and move the navigation map to the world resource
2021-03-08 09:47:18 +01:00
<member name="bake_navigation" type="bool" setter="set_bake_navigation" getter="is_baking_navigation" default="false">
If [code]true[/code], this GridMap bakes a navigation region.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="cell_center_x" type="bool" setter="set_center_x" getter="get_center_x" default="true">
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], grid items are centered on the X axis.
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="cell_center_y" type="bool" setter="set_center_y" getter="get_center_y" default="true">
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], grid items are centered on the Y axis.
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="cell_center_z" type="bool" setter="set_center_z" getter="get_center_z" default="true">
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01:00
If [code]true[/code], grid items are centered on the Z axis.
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="cell_octant_size" type="int" setter="set_octant_size" getter="get_octant_size" default="8">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The size of each octant measured in number of cells. This applies to all three axis.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="cell_scale" type="float" setter="set_cell_scale" getter="get_cell_scale" default="1.0">
Docs: GridMap and MeshLibrary The only methods left to document are resource_changed, set_clip, and the methods dealing with baked meshes.
2019-11-30 01:21:34 +01:00
The scale of the cell items.
This does not affect the size of the grid cells themselves, only the items in them. This can be used to make cell items overlap their neighbors.
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02:00
<member name="cell_size" type="Vector3" setter="set_cell_size" getter="get_cell_size" default="Vector3(2, 2, 2)">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The dimensions of the grid's cells.
Docs: GridMap and MeshLibrary The only methods left to document are resource_changed, set_clip, and the methods dealing with baked meshes.
2019-11-30 01:21:34 +01:00
This does not affect the size of the meshes. See [member cell_scale].
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1">
Docs: GridMap and MeshLibrary The only methods left to document are resource_changed, set_clip, and the methods dealing with baked meshes.
2019-11-30 01:21:34 +01:00
The physics layers this GridMap is in.
GridMaps act as static bodies, meaning they aren't affected by gravity or other forces. They only affect other physics bodies that collide with them.
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 10:43:07 +01:00
The physics layers this GridMap detects collisions in. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="mesh_library" type="MeshLibrary" setter="set_mesh_library" getter="get_mesh_library">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The assigned [MeshLibrary].
</member>
Allow Navigation to be more flexible
2021-03-15 12:45:28 +01:00
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
Add navigation layer bitmask helper functions Adds helper functions to work with the navigation layer bitmask.
2022-06-19 13:23:13 +02:00
A bitmask determining all navigation layers the GridMap generated navigation regions belong to. These navigation layers can be checked upon when requesting a path with [method NavigationServer3D.map_get_path].
Allow Navigation to be more flexible
2021-03-15 12:45:28 +01:00
</member>
Add physics material to GridMap
2021-12-17 01:47:17 +01:00
<member name="physics_material" type="PhysicsMaterial" setter="set_physics_material" getter="get_physics_material">
Overrides the default friction and bounce physics properties for the whole [GridMap].
</member>
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
</members>
doc: Sync classref with current source
2019-10-26 16:40:31 +02:00
<signals>
<signal name="cell_size_changed">
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="cell_size" type="Vector3" />
doc: Sync classref with current source
2019-10-26 16:40:31 +02:00
<description>
Docs: GridMap and MeshLibrary The only methods left to document are resource_changed, set_clip, and the methods dealing with baked meshes.
2019-11-30 01:21:34 +01:00
Emitted when [member cell_size] changes.
doc: Sync classref with current source
2019-10-26 16:40:31 +02:00
</description>
</signal>
</signals>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="INVALID_CELL_ITEM" value="-1">
[DOCS] Document GridMap [ci skip]
2017-10-08 12:14:09 +02:00
Invalid cell item that can be used in [method set_cell_item] to clear cells (or represent an empty cell in [method get_cell_item]).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constant>
</constants>
</class>
Reference in a new issue Copy permalink