:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshLibrary.xml. .. _class_MeshLibrary: MeshLibrary =========== **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Library of meshes. .. rst-class:: classref-introduction-group Description ----------- A library of meshes. Contains a list of :ref:`Mesh` resources, each with a name and ID. Each item can also include collision and navigation shapes. This resource is used in :ref:`GridMap`. .. rst-class:: classref-introduction-group Tutorials --------- - `3D Kinematic Character Demo `__ - `3D Platformer Demo `__ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`create_item`\ (\ id\: :ref:`int`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_item_by_name`\ (\ name\: :ref:`String`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_item_list`\ (\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Mesh` | :ref:`get_item_mesh`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_item_mesh_transform`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_name`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_navigation_layers`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NavigationMesh` | :ref:`get_item_navigation_mesh`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_item_navigation_mesh_transform`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_item_preview`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_item_shapes`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_unused_item_id`\ (\ ) |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_item`\ (\ id\: :ref:`int`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_mesh`\ (\ id\: :ref:`int`, mesh\: :ref:`Mesh`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_mesh_transform`\ (\ id\: :ref:`int`, mesh_transform\: :ref:`Transform3D`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_name`\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_navigation_layers`\ (\ id\: :ref:`int`, navigation_layers\: :ref:`int`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_navigation_mesh`\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`NavigationMesh`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_navigation_mesh_transform`\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`Transform3D`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_preview`\ (\ id\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_item_shapes`\ (\ id\: :ref:`int`, shapes\: :ref:`Array`\ ) | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_MeshLibrary_method_clear: .. rst-class:: classref-method |void| **clear**\ (\ ) :ref:`🔗` Clears the library. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_create_item: .. rst-class:: classref-method |void| **create_item**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Creates a new item in the library with the given ID. You can get an unused ID from :ref:`get_last_unused_item_id`. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_find_item_by_name: .. rst-class:: classref-method :ref:`int` **find_item_by_name**\ (\ name\: :ref:`String`\ ) |const| :ref:`🔗` Returns the first item with the given name, or ``-1`` if no item is found. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_list: .. rst-class:: classref-method :ref:`PackedInt32Array` **get_item_list**\ (\ ) |const| :ref:`🔗` Returns the list of item IDs in use. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_mesh: .. rst-class:: classref-method :ref:`Mesh` **get_item_mesh**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the item's mesh. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_mesh_transform: .. rst-class:: classref-method :ref:`Transform3D` **get_item_mesh_transform**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the transform applied to the item's mesh. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_name: .. rst-class:: classref-method :ref:`String` **get_item_name**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the item's name. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_navigation_layers: .. rst-class:: classref-method :ref:`int` **get_item_navigation_layers**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the item's navigation layers bitmask. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_navigation_mesh: .. rst-class:: classref-method :ref:`NavigationMesh` **get_item_navigation_mesh**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the item's navigation mesh. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_navigation_mesh_transform: .. rst-class:: classref-method :ref:`Transform3D` **get_item_navigation_mesh_transform**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the transform applied to the item's navigation mesh. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_preview: .. rst-class:: classref-method :ref:`Texture2D` **get_item_preview**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` 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 :ref:`set_item_preview`. Returns an empty :ref:`Texture2D` if no preview was manually set in a running project. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_item_shapes: .. rst-class:: classref-method :ref:`Array` **get_item_shapes**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns an item's collision shapes. The array consists of each :ref:`Shape3D` followed by its :ref:`Transform3D`. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_get_last_unused_item_id: .. rst-class:: classref-method :ref:`int` **get_last_unused_item_id**\ (\ ) |const| :ref:`🔗` Gets an unused ID for a new item. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_remove_item: .. rst-class:: classref-method |void| **remove_item**\ (\ id\: :ref:`int`\ ) :ref:`🔗` Removes the item. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_set_item_mesh: .. rst-class:: classref-method |void| **set_item_mesh**\ (\ id\: :ref:`int`, mesh\: :ref:`Mesh`\ ) :ref:`🔗` Sets the item's mesh. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_set_item_mesh_transform: .. rst-class:: classref-method |void| **set_item_mesh_transform**\ (\ id\: :ref:`int`, mesh_transform\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform to apply to the item's mesh. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_set_item_name: .. rst-class:: classref-method |void| **set_item_name**\ (\ id\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` Sets the item's name. This name is shown in the editor. It can also be used to look up the item later using :ref:`find_item_by_name`. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_set_item_navigation_layers: .. rst-class:: classref-method |void| **set_item_navigation_layers**\ (\ id\: :ref:`int`, navigation_layers\: :ref:`int`\ ) :ref:`🔗` Sets the item's navigation layers bitmask. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_set_item_navigation_mesh: .. rst-class:: classref-method |void| **set_item_navigation_mesh**\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`NavigationMesh`\ ) :ref:`🔗` Sets the item's navigation mesh. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_set_item_navigation_mesh_transform: .. rst-class:: classref-method |void| **set_item_navigation_mesh_transform**\ (\ id\: :ref:`int`, navigation_mesh\: :ref:`Transform3D`\ ) :ref:`🔗` Sets the transform to apply to the item's navigation mesh. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_set_item_preview: .. rst-class:: classref-method |void| **set_item_preview**\ (\ id\: :ref:`int`, texture\: :ref:`Texture2D`\ ) :ref:`🔗` Sets a texture to use as the item's preview icon in the editor. .. rst-class:: classref-item-separator ---- .. _class_MeshLibrary_method_set_item_shapes: .. rst-class:: classref-method |void| **set_item_shapes**\ (\ id\: :ref:`int`, shapes\: :ref:`Array`\ ) :ref:`🔗` Sets an item's collision shapes. The array should consist of :ref:`Shape3D` objects, each followed by a :ref:`Transform3D` that will be applied to it. For shapes that should not have a transform, use :ref:`Transform3D.IDENTITY`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`