Files
godot-docs/classes/class_multimeshinstance.rst
T
Rémi Verschelde 1204e3ea17 Add a warning header to each classref file
To tell potential contributors that they should NOT edit those files but instead should work on the class.xml source of the main Godot repo
2016-02-17 22:04:18 +01:00

48 lines
1.9 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_MultiMeshInstance:
MultiMeshInstance
=================
**Inherits:** :ref:`GeometryInstance<class_geometryinstance>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Node that instances a :ref:`MultiMesh<class_multimesh>`.
Member Functions
----------------
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_multimesh<class_MultiMeshInstance_set_multimesh>` **(** :ref:`Object<class_object>` multimesh **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_multimesh<class_MultiMeshInstance_get_multimesh>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
Description
-----------
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).
Member Function Description
---------------------------
.. _class_MultiMeshInstance_set_multimesh:
- void **set_multimesh** **(** :ref:`Object<class_object>` multimesh **)**
Set the :ref:`MultiMesh<class_multimesh>` to be instance.
.. _class_MultiMeshInstance_get_multimesh:
- :ref:`Object<class_object>` **get_multimesh** **(** **)** const
Return the :ref:`MultiMesh<class_multimesh>` that is used for instancing.