class_multimeshinstance.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_MultiMeshInstance:
  4. MultiMeshInstance
  5. =================
  6. **Inherits:** :ref:`GeometryInstance<class_geometryinstance>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Node that instances a :ref:`MultiMesh<class_multimesh>`.
  11. Member Functions
  12. ----------------
  13. +------------------------------+-----------------------------------------------------------------------------------------------------------------+
  14. | :ref:`Object<class_object>` | :ref:`get_multimesh<class_MultiMeshInstance_get_multimesh>` **(** **)** const |
  15. +------------------------------+-----------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_multimesh<class_MultiMeshInstance_set_multimesh>` **(** :ref:`Object<class_object>` multimesh **)** |
  17. +------------------------------+-----------------------------------------------------------------------------------------------------------------+
  18. Description
  19. -----------
  20. MultiMeshInstance is a :ref:`Node<class_node>` that takes a :ref:`MultiMesh<class_multimesh>` resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances).
  21. Member Function Description
  22. ---------------------------
  23. .. _class_MultiMeshInstance_get_multimesh:
  24. - :ref:`Object<class_object>` **get_multimesh** **(** **)** const
  25. Return the :ref:`MultiMesh<class_multimesh>` that is used for instancing.
  26. .. _class_MultiMeshInstance_set_multimesh:
  27. - void **set_multimesh** **(** :ref:`Object<class_object>` multimesh **)**
  28. Set the :ref:`MultiMesh<class_multimesh>` to be instance.