Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 3.3
Branches Tags
godot-docs
/
classes
/
class_meshlibrary.rst

class_meshlibrary.rst 13 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the MeshLibrary.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_MeshLibrary:
    8. 

  8. 

  9. MeshLibrary
    10. 

  10. ===========
    11. 

  11. 

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

  13. 

  14. Library of meshes.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. 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>`.
    20. 

  20. 

  21. Tutorials
    22. 

  22. ---------
    23. 

  23. 

  24. - `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`_
    25. 

  25. 

  26. - `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | void                                        | :ref:`clear<class_MeshLibrary_method_clear>` **(** **)**                                                                                                               |
    33. 

  33. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | void                                        | :ref:`create_item<class_MeshLibrary_method_create_item>` **(** :ref:`int<class_int>` id **)**                                                                          |
    35. 

  35. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`int<class_int>`                       | :ref:`find_item_by_name<class_MeshLibrary_method_find_item_by_name>` **(** :ref:`String<class_String>` name **)** |const|                                              |
    37. 

  37. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`PoolIntArray<class_PoolIntArray>`     | :ref:`get_item_list<class_MeshLibrary_method_get_item_list>` **(** **)** |const|                                                                                       |
    39. 

  39. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`Mesh<class_Mesh>`                     | :ref:`get_item_mesh<class_MeshLibrary_method_get_item_mesh>` **(** :ref:`int<class_int>` id **)** |const|                                                              |
    41. 

  41. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`String<class_String>`                 | :ref:`get_item_name<class_MeshLibrary_method_get_item_name>` **(** :ref:`int<class_int>` id **)** |const|                                                              |
    43. 

  43. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`NavigationMesh<class_NavigationMesh>` | :ref:`get_item_navmesh<class_MeshLibrary_method_get_item_navmesh>` **(** :ref:`int<class_int>` id **)** |const|                                                        |
    45. 

  45. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`Transform<class_Transform>`           | :ref:`get_item_navmesh_transform<class_MeshLibrary_method_get_item_navmesh_transform>` **(** :ref:`int<class_int>` id **)** |const|                                    |
    47. 

  47. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`Texture<class_Texture>`               | :ref:`get_item_preview<class_MeshLibrary_method_get_item_preview>` **(** :ref:`int<class_int>` id **)** |const|                                                        |
    49. 

  49. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`Array<class_Array>`                   | :ref:`get_item_shapes<class_MeshLibrary_method_get_item_shapes>` **(** :ref:`int<class_int>` id **)** |const|                                                          |
    51. 

  51. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`int<class_int>`                       | :ref:`get_last_unused_item_id<class_MeshLibrary_method_get_last_unused_item_id>` **(** **)** |const|                                                                   |
    53. 

  53. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | void                                        | :ref:`remove_item<class_MeshLibrary_method_remove_item>` **(** :ref:`int<class_int>` id **)**                                                                          |
    55. 

  55. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | void                                        | :ref:`set_item_mesh<class_MeshLibrary_method_set_item_mesh>` **(** :ref:`int<class_int>` id, :ref:`Mesh<class_Mesh>` mesh **)**                                        |
    57. 

  57. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | void                                        | :ref:`set_item_name<class_MeshLibrary_method_set_item_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_String>` name **)**                                    |
    59. 

  59. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | void                                        | :ref:`set_item_navmesh<class_MeshLibrary_method_set_item_navmesh>` **(** :ref:`int<class_int>` id, :ref:`NavigationMesh<class_NavigationMesh>` navmesh **)**           |
    61. 

  61. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | void                                        | :ref:`set_item_navmesh_transform<class_MeshLibrary_method_set_item_navmesh_transform>` **(** :ref:`int<class_int>` id, :ref:`Transform<class_Transform>` navmesh **)** |
    63. 

  63. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | void                                        | :ref:`set_item_preview<class_MeshLibrary_method_set_item_preview>` **(** :ref:`int<class_int>` id, :ref:`Texture<class_Texture>` texture **)**                         |
    65. 

  65. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | void                                        | :ref:`set_item_shapes<class_MeshLibrary_method_set_item_shapes>` **(** :ref:`int<class_int>` id, :ref:`Array<class_Array>` shapes **)**                                |
    67. 

  67. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. 

  69. Method Descriptions
    70. 

  70. -------------------
    71. 

  71. 

  72. .. _class_MeshLibrary_method_clear:
    73. 

  73. 

  74. - void **clear** **(** **)**
    75. 

  75. 

  76. Clears the library.
    77. 

  77. 

  78. ----
    79. 

  79. 

  80. .. _class_MeshLibrary_method_create_item:
    81. 

  81. 

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

  83. 

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

  85. 

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

  87. 

  88. ----
    89. 

  89. 

  90. .. _class_MeshLibrary_method_find_item_by_name:
    91. 

  91. 

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

  93. 

  94. Returns the first item with the given name.
    95. 

  95. 

  96. ----
    97. 

  97. 

  98. .. _class_MeshLibrary_method_get_item_list:
    99. 

  99. 

  100. - :ref:`PoolIntArray<class_PoolIntArray>` **get_item_list** **(** **)** |const|
    101. 

  101. 

  102. Returns the list of item IDs in use.
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_MeshLibrary_method_get_item_mesh:
    107. 

  107. 

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

  109. 

  110. Returns the item's mesh.
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_MeshLibrary_method_get_item_name:
    115. 

  115. 

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

  117. 

  118. Returns the item's name.
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_MeshLibrary_method_get_item_navmesh:
    123. 

  123. 

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

  125. 

  126. Returns the item's navigation mesh.
    127. 

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_MeshLibrary_method_get_item_navmesh_transform:
    131. 

  131. 

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

  133. 

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

  135. 

  136. ----
    137. 

  137. 

  138. .. _class_MeshLibrary_method_get_item_preview:
    139. 

  139. 

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

  141. 

  142. 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:`Texture<class_Texture>` if no preview was manually set in a running project.
    143. 

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_MeshLibrary_method_get_item_shapes:
    147. 

  147. 

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

  149. 

  150. Returns an item's collision shapes.
    151. 

  151. 

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

  153. 

  154. ----
    155. 

  155. 

  156. .. _class_MeshLibrary_method_get_last_unused_item_id:
    157. 

  157. 

  158. - :ref:`int<class_int>` **get_last_unused_item_id** **(** **)** |const|
    159. 

  159. 

  160. Gets an unused ID for a new item.
    161. 

  161. 

  162. ----
    163. 

  163. 

  164. .. _class_MeshLibrary_method_remove_item:
    165. 

  165. 

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

  167. 

  168. Removes the item.
    169. 

  169. 

  170. ----
    171. 

  171. 

  172. .. _class_MeshLibrary_method_set_item_mesh:
    173. 

  173. 

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

  175. 

  176. Sets the item's mesh.
    177. 

  177. 

  178. ----
    179. 

  179. 

  180. .. _class_MeshLibrary_method_set_item_name:
    181. 

  181. 

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

  183. 

  184. Sets the item's name.
    185. 

  185. 

  186. 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>`.
    187. 

  187. 

  188. ----
    189. 

  189. 

  190. .. _class_MeshLibrary_method_set_item_navmesh:
    191. 

  191. 

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

  193. 

  194. Sets the item's navigation mesh.
    195. 

  195. 

  196. ----
    197. 

  197. 

  198. .. _class_MeshLibrary_method_set_item_navmesh_transform:
    199. 

  199. 

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

  201. 

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

  203. 

  204. ----
    205. 

  205. 

  206. .. _class_MeshLibrary_method_set_item_preview:
    207. 

  207. 

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

  209. 

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

  211. 

  212. ----
    213. 

  213. 

  214. .. _class_MeshLibrary_method_set_item_shapes:
    215. 

  215. 

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

  217. 

  218. Sets an item's collision shapes.
    219. 

  219. 

  220. 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>`.
    221. 

  221. 

  222. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    223. 

  223. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    224. 

  224. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    225.