godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/gridmap/doc_classes/GridMap.xml

228 lines
6.9 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 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update header version for 3.0-beta
2017-11-24 08:16:52 +00:00
<class name="GridMap" inherits="Spatial" category="Core" version="3.0-beta">
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 20:42:36 +00:00
<brief_description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00: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 20:42:36 +00:00
</brief_description>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
GridMap lets you place meshes on a grid interactively. It works both from the editor and can help you create in-game level editors.
GridMaps use a [MeshLibrary] which contain a list of tiles: meshes with materials plus optional collisions and extra elements.
A GridMap contains a collection of cells. Each grid cell refers to a [MeshLibrary] item. All cells in the map have the same dimensions.
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.
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 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="clear">
<return type="void">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00: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 20:42:36 +00:00
</description>
</method>
<method name="get_cell_item" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
The [MeshLibrary] item index located at the grid-based X, Y and Z coordinates. If the cell is empty, [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 20:42:36 +00:00
</description>
</method>
<method name="get_cell_item_orientation" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is retuned 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 20:42:36 +00:00
</description>
</method>
<method name="get_cell_size" qualifiers="const">
<return type="Vector3">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
The dimensions of the grid's 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 20:42:36 +00:00
</description>
</method>
<method name="get_center_x" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Returns whether or not grid items are centered on the X axis.
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 20:42:36 +00:00
</description>
</method>
<method name="get_center_y" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Returns whether or not grid items are centered on the Y axis.
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 20:42:36 +00:00
</description>
</method>
<method name="get_center_z" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Returns whether or not grid items are centered on the Z axis.
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 20:42:36 +00:00
</description>
</method>
<method name="get_meshes">
<return type="Array">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Array of [Transform] and [Mesh] references corresponding to the non empty cells in the grid. The transforms are specified in world 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 20:42:36 +00:00
</description>
</method>
<method name="get_octant_size" qualifiers="const">
<return type="int">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
The size of each octant measured in number of cells. This applies to all three axis.
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 20:42:36 +00:00
</description>
</method>
<method name="get_theme" qualifiers="const">
<return type="MeshLibrary">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
The assigned [MeshLibrary].
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 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 21:54:43 +00:00
<method name="get_used_cells" qualifiers="const">
<return type="Array">
</return>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
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 21:54:43 +00:00
</description>
</method>
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<method name="map_to_world" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<description>
</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 20:42:36 +00:00
<method name="resource_changed">
<return type="void">
</return>
<argument index="0" name="resource" type="Resource">
</argument>
<description>
</description>
</method>
<method name="set_cell_item">
<return type="void">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<argument index="3" name="item" type="int">
</argument>
<argument index="4" name="orientation" type="int" default="0">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Set the mesh index for the cell referenced by its grid-based X, Y and Z coordinates.
A negative item index will clear the cell.
Optionally, the item's orientation can be passed.
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 20:42:36 +00:00
</description>
</method>
<method name="set_cell_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector3">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Sets the height, width and depth of the grid's 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 20:42:36 +00:00
</description>
</method>
<method name="set_center_x">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Set grid items to be centered on the X axis. By default it is enabled.
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 20:42:36 +00:00
</description>
</method>
<method name="set_center_y">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Set grid items to be centered on the Y axis. By default it is enabled.
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 20:42:36 +00:00
</description>
</method>
<method name="set_center_z">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Set grid items to be centered on the Z axis. By default it is enabled.
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 20:42:36 +00:00
</description>
</method>
<method name="set_clip">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<argument index="1" name="clipabove" type="bool" default="true">
</argument>
<argument index="2" name="floor" type="int" default="0">
</argument>
<argument index="3" name="axis" type="int" enum="Vector3.Axis" default="0">
</argument>
<description>
</description>
</method>
<method name="set_octant_size">
<return type="void">
</return>
<argument index="0" name="size" type="int">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Sets the size for each octant measured in number of cells. This applies to all three axis.
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 20:42:36 +00:00
</description>
</method>
<method name="set_theme">
<return type="void">
</return>
<argument index="0" name="theme" type="MeshLibrary">
</argument>
<description>
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00:00
Sets the collection of meshes for the map.
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 20:42:36 +00:00
</description>
</method>
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<method name="world_to_map" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="pos" type="Vector3">
</argument>
<description>
</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 20:42:36 +00:00
</methods>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="INVALID_CELL_ITEM" value="-1">
[DOCS] Document GridMap [ci skip]
2017-10-08 10:14:09 +00: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 20:42:36 +00:00
</constant>
</constants>
</class>