github_url:	hide

MeshLibrary

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

Library of meshes.

Description

A library of meshes. Contains a list of :ref:`Mesh<class_Mesh>` resources, each with a name and ID. Each item can also include collision and navigation shapes. This resource is used in :ref:`GridMap<class_GridMap>`.

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:`PackedInt32Array<class_PackedInt32Array>`	: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:`Texture2D<class_Texture2D>`	: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:`Texture2D<class_Texture2D>` texture )
void	:ref:`set_item_shapes<class_MeshLibrary_method_set_item_shapes>` ( :ref:`int<class_int>` id, :ref:`Array<class_Array>` shapes )

Method Descriptions

• void clear ( )

Clears the library.

---

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

Creates a new item in the library with the given ID.

You can get an unused ID from :ref:`get_last_unused_item_id<class_MeshLibrary_method_get_last_unused_item_id>`.

---

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

Returns the first item with the given name.

---

• :ref:`PackedInt32Array<class_PackedInt32Array>` get_item_list ( ) const

Returns the list of item IDs in use.

---

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

Returns the item's mesh.

---

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

Returns the item's name.

---

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

Returns the item's navigation mesh.

---

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

Returns the transform applied to the item's navigation mesh.

---

• :ref:`Texture2D<class_Texture2D>` get_item_preview ( :ref:`int<class_int>` id ) const

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<class_MeshLibrary_method_set_item_preview>`. Returns an empty :ref:`Texture2D<class_Texture2D>` if no preview was manually set in a running project.

---

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

Returns an item's collision shapes.

The array consists of each :ref:`Shape<class_Shape>` followed by its :ref:`Transform<class_Transform>`.

---

• :ref:`int<class_int>` get_last_unused_item_id ( ) const

Gets an unused ID for a new item.

---

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

Removes the item.

---

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

Sets the item's mesh.

---

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

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<class_MeshLibrary_method_find_item_by_name>`.

---

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

Sets the item's navigation mesh.

---

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

Sets the transform to apply to the item's navigation mesh.

---

• void set_item_preview ( :ref:`int<class_int>` id, :ref:`Texture2D<class_Texture2D>` texture )

Sets a texture to use as the item's preview icon in the editor.

---

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

Sets an item's collision shapes.

The array should consist of :ref:`Shape<class_Shape>` objects, each followed by a :ref:`Transform<class_Transform>` that will be applied to it. For shapes that should not have a transform, use :ref:`Transform.IDENTITY<class_Transform_constant_IDENTITY>`.