| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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>`
- Node that instances a :ref:`MultiMesh<class_MultiMesh>` in 2D.
- Description
- -----------
- ``MultiMeshInstance2D`` is a specialized node to instance a :ref:`MultiMesh<class_MultiMesh>` resource in 2D.
- Usage is the same as :ref:`MultiMeshInstance3D<class_MultiMeshInstance3D>`.
- Properties
- ----------
- +-----------------------------------+------------------------------------------------------------------+
- | :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance2D_property_multimesh>` |
- +-----------------------------------+------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`normal_map<class_MultiMeshInstance2D_property_normal_map>` |
- +-----------------------------------+------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_MultiMeshInstance2D_property_texture>` |
- +-----------------------------------+------------------------------------------------------------------+
- Signals
- -------
- .. _class_MultiMeshInstance2D_signal_texture_changed:
- - **texture_changed** **(** **)**
- Emitted when the :ref:`texture<class_MultiMeshInstance2D_property_texture>` is changed.
- 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:`Texture2D<class_Texture2D>` **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>`.
- \ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page <http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates>`__ for a comparison of normal map coordinates expected by popular engines.
- ----
- .. _class_MultiMeshInstance2D_property_texture:
- - :ref:`Texture2D<class_Texture2D>` **texture**
- +----------+--------------------+
- | *Setter* | set_texture(value) |
- +----------+--------------------+
- | *Getter* | get_texture() |
- +----------+--------------------+
- The :ref:`Texture2D<class_Texture2D>` that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`. Can be accessed as ``TEXTURE`` in CanvasItem shader.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
