godot-docs/classes/class_meshlibrary.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the MeshLibrary.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_MeshLibrary:

MeshLibrary
===========

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Library of meshes.

Methods
-------

+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`clear<class_MeshLibrary_method_clear>` **(** **)**                                                                                                               |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`create_item<class_MeshLibrary_method_create_item>` **(** :ref:`int<class_int>` id **)**                                                                          |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                       | :ref:`find_item_by_name<class_MeshLibrary_method_find_item_by_name>` **(** :ref:`String<class_String>` name **)** const                                                |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>`     | :ref:`get_item_list<class_MeshLibrary_method_get_item_list>` **(** **)** const                                                                                         |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Mesh<class_Mesh>`                     | :ref:`get_item_mesh<class_MeshLibrary_method_get_item_mesh>` **(** :ref:`int<class_int>` id **)** const                                                                |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                 | :ref:`get_item_name<class_MeshLibrary_method_get_item_name>` **(** :ref:`int<class_int>` id **)** const                                                                |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NavigationMesh<class_NavigationMesh>` | :ref:`get_item_navmesh<class_MeshLibrary_method_get_item_navmesh>` **(** :ref:`int<class_int>` id **)** const                                                          |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_Transform>`           | :ref:`get_item_navmesh_transform<class_MeshLibrary_method_get_item_navmesh_transform>` **(** :ref:`int<class_int>` id **)** const                                      |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>`               | :ref:`get_item_preview<class_MeshLibrary_method_get_item_preview>` **(** :ref:`int<class_int>` id **)** const                                                          |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`                   | :ref:`get_item_shapes<class_MeshLibrary_method_get_item_shapes>` **(** :ref:`int<class_int>` id **)** const                                                            |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                       | :ref:`get_last_unused_item_id<class_MeshLibrary_method_get_last_unused_item_id>` **(** **)** const                                                                     |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`remove_item<class_MeshLibrary_method_remove_item>` **(** :ref:`int<class_int>` id **)**                                                                          |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`set_item_mesh<class_MeshLibrary_method_set_item_mesh>` **(** :ref:`int<class_int>` id, :ref:`Mesh<class_Mesh>` mesh **)**                                        |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`set_item_name<class_MeshLibrary_method_set_item_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                                    |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`set_item_navmesh<class_MeshLibrary_method_set_item_navmesh>` **(** :ref:`int<class_int>` id, :ref:`NavigationMesh<class_NavigationMesh>` navmesh **)**           |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`set_item_navmesh_transform<class_MeshLibrary_method_set_item_navmesh_transform>` **(** :ref:`int<class_int>` id, :ref:`Transform<class_Transform>` navmesh **)** |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`set_item_preview<class_MeshLibrary_method_set_item_preview>` **(** :ref:`int<class_int>` id, :ref:`Texture<class_Texture>` texture **)**                         |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                        | :ref:`set_item_shapes<class_MeshLibrary_method_set_item_shapes>` **(** :ref:`int<class_int>` id, :ref:`Array<class_Array>` shapes **)**                                |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Description
-----------

Library of meshes. Contains a list of :ref:`Mesh<class_Mesh>` resources, each with name and ID. Useful for GridMap or painting Terrain.

Method Descriptions
-------------------

.. _class_MeshLibrary_method_clear:

- void **clear** **(** **)**

Clear the library.

.. _class_MeshLibrary_method_create_item:

- void **create_item** **(** :ref:`int<class_int>` id **)**

Create a new item in the library, supplied an id.

.. _class_MeshLibrary_method_find_item_by_name:

- :ref:`int<class_int>` **find_item_by_name** **(** :ref:`String<class_String>` name **)** const

.. _class_MeshLibrary_method_get_item_list:

- :ref:`PoolIntArray<class_PoolIntArray>` **get_item_list** **(** **)** const

Return the list of items.

.. _class_MeshLibrary_method_get_item_mesh:

- :ref:`Mesh<class_Mesh>` **get_item_mesh** **(** :ref:`int<class_int>` id **)** const

Return the mesh of the item.

.. _class_MeshLibrary_method_get_item_name:

- :ref:`String<class_String>` **get_item_name** **(** :ref:`int<class_int>` id **)** const

Return the name of the item.

.. _class_MeshLibrary_method_get_item_navmesh:

- :ref:`NavigationMesh<class_NavigationMesh>` **get_item_navmesh** **(** :ref:`int<class_int>` id **)** const

.. _class_MeshLibrary_method_get_item_navmesh_transform:

- :ref:`Transform<class_Transform>` **get_item_navmesh_transform** **(** :ref:`int<class_int>` id **)** const

.. _class_MeshLibrary_method_get_item_preview:

- :ref:`Texture<class_Texture>` **get_item_preview** **(** :ref:`int<class_int>` id **)** const

.. _class_MeshLibrary_method_get_item_shapes:

- :ref:`Array<class_Array>` **get_item_shapes** **(** :ref:`int<class_int>` id **)** const

.. _class_MeshLibrary_method_get_last_unused_item_id:

- :ref:`int<class_int>` **get_last_unused_item_id** **(** **)** const

Get an unused id for a new item.

.. _class_MeshLibrary_method_remove_item:

- void **remove_item** **(** :ref:`int<class_int>` id **)**

Remove the item.

.. _class_MeshLibrary_method_set_item_mesh:

- void **set_item_mesh** **(** :ref:`int<class_int>` id, :ref:`Mesh<class_Mesh>` mesh **)**

Set the mesh of the item.

.. _class_MeshLibrary_method_set_item_name:

- void **set_item_name** **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**

Set the name of the item.

.. _class_MeshLibrary_method_set_item_navmesh:

- void **set_item_navmesh** **(** :ref:`int<class_int>` id, :ref:`NavigationMesh<class_NavigationMesh>` navmesh **)**

.. _class_MeshLibrary_method_set_item_navmesh_transform:

- void **set_item_navmesh_transform** **(** :ref:`int<class_int>` id, :ref:`Transform<class_Transform>` navmesh **)**

.. _class_MeshLibrary_method_set_item_preview:

- void **set_item_preview** **(** :ref:`int<class_int>` id, :ref:`Texture<class_Texture>` texture **)**

.. _class_MeshLibrary_method_set_item_shapes:

- void **set_item_shapes** **(** :ref:`int<class_int>` id, :ref:`Array<class_Array>` shapes **)**