2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-04-26 13:14:51 +02:00
<class name= "MeshLibrary" inherits= "Resource" version= "3.4" >
2017-09-12 22:42:36 +02:00
<brief_description >
Library of meshes.
</brief_description>
<description >
2019-11-30 01:21:34 +01:00
A library of meshes. Contains a list of [Mesh] resources, each with a name and ID. Each item can also include collision and navigation shapes. This resource is used in [GridMap].
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2020-10-01 10:34:47 +02:00
<link title= "3D Kinematic Character Demo" > https://godotengine.org/asset-library/asset/126</link>
<link title= "3D Platformer Demo" > https://godotengine.org/asset-library/asset/125</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "clear" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2017-09-12 22:42:36 +02:00
<description >
2019-09-24 16:05:49 +02:00
Clears the library.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "create_item" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "id" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Creates a new item in the library with the given ID.
You can get an unused ID from [method get_last_unused_item_id].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "find_item_by_name" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
<argument index= "0" name= "name" type= "String" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Returns the first item with the given name.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_item_list" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "PoolIntArray" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Returns the list of item IDs in use.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_item_mesh" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Mesh" />
<argument index= "0" name= "id" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Returns the item's mesh.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_item_name" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "String" />
<argument index= "0" name= "id" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Returns the item's name.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_item_navmesh" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "NavigationMesh" />
<argument index= "0" name= "id" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Returns the item's navigation mesh.
2017-09-12 22:42:36 +02:00
</description>
</method>
2019-04-15 14:49:41 +02:00
<method name= "get_item_navmesh_transform" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Transform" />
<argument index= "0" name= "id" type= "int" />
2019-04-15 14:49:41 +02:00
<description >
2019-11-30 01:21:34 +01:00
Returns the transform applied to the item's navigation mesh.
2019-04-15 14:49:41 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_item_preview" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Texture" />
<argument index= "0" name= "id" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2020-02-17 00:01:52 +01:00
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 [method set_item_preview]. Returns an empty [Texture] if no preview was manually set in a running project.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_item_shapes" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Array" />
<argument index= "0" name= "id" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Returns an item's collision shapes.
The array consists of each [Shape] followed by its [Transform].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_last_unused_item_id" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-09-24 16:05:49 +02:00
Gets an unused ID for a new item.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "remove_item" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "id" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Removes the item.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_item_mesh" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "id" type= "int" />
<argument index= "1" name= "mesh" type= "Mesh" />
2017-09-12 22:42:36 +02:00
<description >
2019-09-24 16:05:49 +02:00
Sets the item's mesh.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_item_name" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "id" type= "int" />
<argument index= "1" name= "name" type= "String" />
2017-09-12 22:42:36 +02:00
<description >
2019-09-24 16:05:49 +02:00
Sets the item's name.
2019-11-30 01:21:34 +01:00
This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_item_navmesh" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "id" type= "int" />
<argument index= "1" name= "navmesh" type= "NavigationMesh" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Sets the item's navigation mesh.
2017-09-12 22:42:36 +02:00
</description>
</method>
2019-04-15 14:49:41 +02:00
<method name= "set_item_navmesh_transform" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "id" type= "int" />
<argument index= "1" name= "navmesh" type= "Transform" />
2019-04-15 14:49:41 +02:00
<description >
2019-11-30 01:21:34 +01:00
Sets the transform to apply to the item's navigation mesh.
2019-04-15 14:49:41 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "set_item_preview" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "id" type= "int" />
<argument index= "1" name= "texture" type= "Texture" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Sets a texture to use as the item's preview icon in the editor.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_item_shapes" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "id" type= "int" />
<argument index= "1" name= "shapes" type= "Array" />
2017-09-12 22:42:36 +02:00
<description >
2019-11-30 01:21:34 +01:00
Sets an item's collision shapes.
The array should consist of [Shape] objects, each followed by a [Transform] that will be applied to it. For shapes that should not have a transform, use [constant Transform.IDENTITY].
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<constants >
</constants>
</class>