class_multimeshinstance.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  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. Member Functions
  13. ----------------
  14. +------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`MultiMesh<class_multimesh>` | :ref:`get_multimesh<class_MultiMeshInstance_get_multimesh>` **(** **)** const |
  16. +------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_multimesh<class_MultiMeshInstance_set_multimesh>` **(** :ref:`MultiMesh<class_multimesh>` multimesh **)** |
  18. +------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  19. Member Variables
  20. ----------------
  21. - :ref:`MultiMesh<class_multimesh>` **multimesh**
  22. Description
  23. -----------
  24. 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).
  25. Member Function Description
  26. ---------------------------
  27. .. _class_MultiMeshInstance_get_multimesh:
  28. - :ref:`MultiMesh<class_multimesh>` **get_multimesh** **(** **)** const
  29. Return the :ref:`MultiMesh<class_multimesh>` that is used for instancing.
  30. .. _class_MultiMeshInstance_set_multimesh:
  31. - void **set_multimesh** **(** :ref:`MultiMesh<class_multimesh>` multimesh **)**
  32. Set the :ref:`MultiMesh<class_multimesh>` to be instanced.