Files
godot-docs/classes/class_multimeshinstance.rst
2019-07-29 21:15:14 +02:00

57 lines
1.8 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the MultiMeshInstance.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_MultiMeshInstance:
MultiMeshInstance
=================
**Inherits:** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Node that instances a :ref:`MultiMesh<class_MultiMesh>`.
Properties
----------
+-----------------------------------+--------------------------------------------------------------+
| :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance_property_multimesh>` |
+-----------------------------------+--------------------------------------------------------------+
Description
-----------
``MultiMeshInstance`` is a specialized node to instance :ref:`GeometryInstance<class_GeometryInstance>`\ s based on a :ref:`MultiMesh<class_MultiMesh>` resource.
This is useful to optimize the rendering of a high amount of instances of a given mesh (for example tree in a forest or grass strands).
Tutorials
---------
- :doc:`../tutorials/3d/vertex_animation/animating_thousands_of_fish`
- :doc:`../tutorials/3d/using_multi_mesh_instance`
Property Descriptions
---------------------
.. _class_MultiMeshInstance_property_multimesh:
- :ref:`MultiMesh<class_MultiMesh>` **multimesh**
+----------+----------------------+
| *Setter* | set_multimesh(value) |
+----------+----------------------+
| *Getter* | get_multimesh() |
+----------+----------------------+
The :ref:`MultiMesh<class_MultiMesh>` resource that will be used and shared among all instances of the ``MultiMeshInstance``.