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
Tree: def522830a
Branches Tags
godot-docs
/
classes
/
class_meshlibrary.rst

class_meshlibrary.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159 
  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. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

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

  18. 

  19. Library of meshes.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                                        | :ref:`clear<class_MeshLibrary_method_clear>` **(** **)**                                                                                                               |
    26. 

  26. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

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

  28. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

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

  30. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`PoolIntArray<class_PoolIntArray>`     | :ref:`get_item_list<class_MeshLibrary_method_get_item_list>` **(** **)** const                                                                                         |
    32. 

  32. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

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

  34. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

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

  36. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

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

  38. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

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

  40. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

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

  42. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

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

  44. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`int<class_int>`                       | :ref:`get_last_unused_item_id<class_MeshLibrary_method_get_last_unused_item_id>` **(** **)** const                                                                     |
    46. 

  46. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

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

  48. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

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

  50. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

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

  52. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

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

  54. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

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

  56. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

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

  58. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

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

  60. +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. 

  62. Description
    63. 

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

  64. 

  65. Library of meshes. Contains a list of :ref:`Mesh<class_Mesh>` resources, each with name and ID. This resource is used in :ref:`GridMap<class_GridMap>`.
    66. 

  66. 

  67. Method Descriptions
    68. 

  68. -------------------
    69. 

  69. 

  70. .. _class_MeshLibrary_method_clear:
    71. 

  71. 

  72. - void **clear** **(** **)**
    73. 

  73. 

  74. Clear the library.
    75. 

  75. 

  76. .. _class_MeshLibrary_method_create_item:
    77. 

  77. 

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

  79. 

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

  81. 

  82. .. _class_MeshLibrary_method_find_item_by_name:
    83. 

  83. 

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

  85. 

  86. .. _class_MeshLibrary_method_get_item_list:
    87. 

  87. 

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

  89. 

  90. Returns the list of items.
    91. 

  91. 

  92. .. _class_MeshLibrary_method_get_item_mesh:
    93. 

  93. 

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

  95. 

  96. Returns the mesh of the item.
    97. 

  97. 

  98. .. _class_MeshLibrary_method_get_item_name:
    99. 

  99. 

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

  101. 

  102. Returns the name of the item.
    103. 

  103. 

  104. .. _class_MeshLibrary_method_get_item_navmesh:
    105. 

  105. 

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

  107. 

  108. .. _class_MeshLibrary_method_get_item_navmesh_transform:
    109. 

  109. 

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

  111. 

  112. .. _class_MeshLibrary_method_get_item_preview:
    113. 

  113. 

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

  115. 

  116. .. _class_MeshLibrary_method_get_item_shapes:
    117. 

  117. 

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

  119. 

  120. .. _class_MeshLibrary_method_get_last_unused_item_id:
    121. 

  121. 

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

  123. 

  124. Gets an unused id for a new item.
    125. 

  125. 

  126. .. _class_MeshLibrary_method_remove_item:
    127. 

  127. 

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

  129. 

  130. Removes the item.
    131. 

  131. 

  132. .. _class_MeshLibrary_method_set_item_mesh:
    133. 

  133. 

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

  135. 

  136. Sets the mesh of the item.
    137. 

  137. 

  138. .. _class_MeshLibrary_method_set_item_name:
    139. 

  139. 

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

  141. 

  142. Sets the name of the item.
    143. 

  143. 

  144. .. _class_MeshLibrary_method_set_item_navmesh:
    145. 

  145. 

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

  147. 

  148. .. _class_MeshLibrary_method_set_item_navmesh_transform:
    149. 

  149. 

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

  151. 

  152. .. _class_MeshLibrary_method_set_item_preview:
    153. 

  153. 

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

  155. 

  156. .. _class_MeshLibrary_method_set_item_shapes:
    157. 

  157. 

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

  159.