class_multimeshinstance.rst 1.8 KB

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