Files
godot-docs/classes/class_multimeshinstance.rst
2018-01-18 22:02:30 +01:00

34 lines
1.2 KiB
ReStructuredText

.. 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>`.
Member Variables
----------------
.. _class_MultiMeshInstance_multimesh:
- :ref:`MultiMesh<class_multimesh>` **multimesh** - The :ref:`MultiMesh<class_multimesh>` resource that will be used and shared among all instances of the ``MultiMeshInstance``.
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).