class_multimeshinstance.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the MultiMeshInstance.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_MultiMeshInstance:
  5. MultiMeshInstance
  6. =================
  7. **Inherits:** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Node that instances a :ref:`MultiMesh<class_MultiMesh>`.
  12. Properties
  13. ----------
  14. +-----------------------------------+--------------------------------------------------------------+
  15. | :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance_property_multimesh>` |
  16. +-----------------------------------+--------------------------------------------------------------+
  17. Description
  18. -----------
  19. ``MultiMeshInstance`` is a specialized node to instance :ref:`GeometryInstance<class_GeometryInstance>`\ s based on a :ref:`MultiMesh<class_MultiMesh>` resource.
  20. 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).
  21. Tutorials
  22. ---------
  23. - :doc:`../tutorials/3d/vertex_animation/animating_thousands_of_fish`
  24. - :doc:`../tutorials/3d/using_multi_mesh_instance`
  25. Property Descriptions
  26. ---------------------
  27. .. _class_MultiMeshInstance_property_multimesh:
  28. - :ref:`MultiMesh<class_MultiMesh>` **multimesh**
  29. +----------+----------------------+
  30. | *Setter* | set_multimesh(value) |
  31. +----------+----------------------+
  32. | *Getter* | get_multimesh() |
  33. +----------+----------------------+
  34. The :ref:`MultiMesh<class_MultiMesh>` resource that will be used and shared among all instances of the ``MultiMeshInstance``.