| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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:`CullInstance<class_CullInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Node that instances a :ref:`MultiMesh<class_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 trees in a forest or grass strands).
- Tutorials
- ---------
- - :doc:`../tutorials/performance/vertex_animation/animating_thousands_of_fish`
- - :doc:`../tutorials/3d/using_multi_mesh_instance`
- - :doc:`../tutorials/performance/using_multimesh`
- Properties
- ----------
- +-----------------------------------+--------------------------------------------------------------+
- | :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance_property_multimesh>` |
- +-----------------------------------+--------------------------------------------------------------+
- 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``.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
