asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/MeshLibrary.xml

188 lines
5.4 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" ?>
Update docs to version 4.0
2020-02-01 02:03:48 +01:00
<class name="MeshLibrary" inherits="Resource" version="4.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
<brief_description>
Library of meshes.
</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
A library of meshes. Contains a list of [Mesh] resources, each with a name and ID. Each item can also include collision and navigation shapes. This resource is used in [GridMap].
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>
</tutorials>
<methods>
<method name="clear">
<return type="void">
</return>
<description>
Mention `MeshLibrary.get_item_preview()` not working in running project
2019-09-24 16:05:49 +02:00
Clears the library.
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="create_item">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<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
Creates a new item in the library with the given ID.
You can get an unused ID from [method get_last_unused_item_id].
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="find_item_by_name" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
</argument>
<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 the first item with the given name.
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="get_item_list" qualifiers="const">
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 18:10:58 +01:00
<return type="PackedInt32Array">
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
</return>
<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 the list of item IDs in use.
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="get_item_mesh" qualifiers="const">
<return type="Mesh">
</return>
<argument index="0" name="id" type="int">
</argument>
<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 the item's mesh.
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="get_item_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="id" type="int">
</argument>
<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 the item's name.
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="get_item_navmesh" qualifiers="const">
<return type="NavigationMesh">
</return>
<argument index="0" name="id" type="int">
</argument>
<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 the item's navigation mesh.
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
2019-04-15 14:49:41 +02:00
<method name="get_item_navmesh_transform" qualifiers="const">
<return type="Transform">
</return>
<argument index="0" name="id" type="int">
</argument>
<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 the transform applied to the item's navigation mesh.
doc: Sync classref with current source
2019-04-15 14:49:41 +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="get_item_preview" qualifiers="const">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<return type="Texture2D">
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
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
Allow using `MeshLibrary.get_item_preview()` in non-editor builds again This closes #36268.
2020-02-17 00:01:52 +01:00
When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using [method set_item_preview]. Returns an empty [Texture2D] if no preview was manually set in a running project.
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="get_item_shapes" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="id" type="int">
</argument>
<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 item's collision shapes.
The array consists of each [Shape] followed by its [Transform].
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="get_last_unused_item_id" qualifiers="const">
<return type="int">
</return>
<description>
Mention `MeshLibrary.get_item_preview()` not working in running project
2019-09-24 16:05:49 +02:00
Gets an unused ID for a new 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
</description>
</method>
<method name="remove_item">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Removes the 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
</description>
</method>
<method name="set_item_mesh">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="mesh" type="Mesh">
</argument>
<description>
Mention `MeshLibrary.get_item_preview()` not working in running project
2019-09-24 16:05:49 +02:00
Sets the item's mesh.
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_item_name">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="name" type="String">
</argument>
<description>
Mention `MeshLibrary.get_item_preview()` not working in running project
2019-09-24 16:05:49 +02:00
Sets the item's name.
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 name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name].
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_item_navmesh">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="navmesh" type="NavigationMesh">
</argument>
<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
Sets the item's navigation mesh.
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
2019-04-15 14:49:41 +02:00
<method name="set_item_navmesh_transform">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="navmesh" type="Transform">
</argument>
<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
Sets the transform to apply to the item's navigation mesh.
doc: Sync classref with current source
2019-04-15 14:49:41 +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="set_item_preview">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<argument index="1" name="texture" type="Texture2D">
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
</argument>
<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
Sets a texture to use as the item's preview icon in the editor.
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_item_shapes">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="shapes" type="Array">
</argument>
<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
Sets an item's collision shapes.
The array should consist of [Shape] objects, each followed by a [Transform] that will be applied to it. For shapes that should not have a transform, use [constant Transform.IDENTITY].
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>
</methods>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink