| github_url: | hide |
|---|
Inherits: :ref:`VisualShaderNodeParticleEmitter<class_VisualShaderNodeParticleEmitter>` < :ref:`VisualShaderNode<class_VisualShaderNode>` < :ref:`Resource<class_Resource>` < :ref:`RefCounted<class_RefCounted>` < :ref:`Object<class_Object>`
A visual shader node that makes particles emitted in a shape defined by a :ref:`Mesh<class_Mesh>`.
.. rst-class:: classref-introduction-group
:ref:`VisualShaderNodeParticleEmitter<class_VisualShaderNodeParticleEmitter>` that makes the particles emitted in a shape of the assigned :ref:`mesh<class_VisualShaderNodeParticleMeshEmitter_property_mesh>`. It will emit from the mesh's surfaces, either all or only the specified one.
.. rst-class:: classref-reftable-group
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-property
.. rst-class:: classref-property-setget
- void set_mesh ( :ref:`Mesh<class_Mesh>` value )
- :ref:`Mesh<class_Mesh>` get_mesh ( )
The :ref:`Mesh<class_Mesh>` that defines emission shape.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`int<class_int>` surface_index = 0
.. rst-class:: classref-property-setget
- void set_surface_index ( :ref:`int<class_int>` value )
- :ref:`int<class_int>` get_surface_index ( )
Index of the surface that emits particles. :ref:`use_all_surfaces<class_VisualShaderNodeParticleMeshEmitter_property_use_all_surfaces>` must be false for this to take effect.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`bool<class_bool>` use_all_surfaces = true
.. rst-class:: classref-property-setget
- void set_use_all_surfaces ( :ref:`bool<class_bool>` value )
- :ref:`bool<class_bool>` is_use_all_surfaces ( )
If true, the particles will emit from all surfaces of the mesh.