class_multimeshinstance.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  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_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. Property Descriptions
  22. ---------------------
  23. .. _class_MultiMeshInstance_multimesh:
  24. - :ref:`MultiMesh<class_MultiMesh>` **multimesh**
  25. +----------+----------------------+
  26. | *Setter* | set_multimesh(value) |
  27. +----------+----------------------+
  28. | *Getter* | get_multimesh() |
  29. +----------+----------------------+
  30. The :ref:`MultiMesh<class_MultiMesh>` resource that will be used and shared among all instances of the ``MultiMeshInstance``.