Files
godot-docs/classes/class_multimeshinstance2d.rst
2019-06-11 10:56:26 +02:00

76 lines
2.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the MultiMeshInstance2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_MultiMeshInstance2D:
MultiMeshInstance2D
===================
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Node that instances a :ref:`MultiMesh<class_MultiMesh>` in 2D.
Properties
----------
+-----------------------------------+------------------------------------------------------------------+
| :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance2D_property_multimesh>` |
+-----------------------------------+------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`normal_map<class_MultiMeshInstance2D_property_normal_map>` |
+-----------------------------------+------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`texture<class_MultiMeshInstance2D_property_texture>` |
+-----------------------------------+------------------------------------------------------------------+
Description
-----------
``MultiMeshInstance2D`` is a specialized node to instance a :ref:`MultiMesh<class_MultiMesh>` resource in 2D.
Usage is the same as :ref:`MultiMeshInstance<class_MultiMeshInstance>`.
Property Descriptions
---------------------
.. _class_MultiMeshInstance2D_property_multimesh:
- :ref:`MultiMesh<class_MultiMesh>` **multimesh**
+----------+----------------------+
| *Setter* | set_multimesh(value) |
+----------+----------------------+
| *Getter* | get_multimesh() |
+----------+----------------------+
The :ref:`MultiMesh<class_MultiMesh>` that will be drawn by the ``MultiMeshInstance2D``.
.. _class_MultiMeshInstance2D_property_normal_map:
- :ref:`Texture<class_Texture>` **normal_map**
+----------+-----------------------+
| *Setter* | set_normal_map(value) |
+----------+-----------------------+
| *Getter* | get_normal_map() |
+----------+-----------------------+
The normal map that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`.
.. _class_MultiMeshInstance2D_property_texture:
- :ref:`Texture<class_Texture>` **texture**
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
The :ref:`Texture<class_Texture>` that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`. Can be accessed as ``TEXTURE`` in CanvasItem shader.