class_visualshadernodeparticleemitter.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParticleEmitter.xml.
  6. .. _class_VisualShaderNodeParticleEmitter:
  7. VisualShaderNodeParticleEmitter
  8. ===============================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`VisualShaderNodeParticleBoxEmitter<class_VisualShaderNodeParticleBoxEmitter>`, :ref:`VisualShaderNodeParticleMeshEmitter<class_VisualShaderNodeParticleMeshEmitter>`, :ref:`VisualShaderNodeParticleRingEmitter<class_VisualShaderNodeParticleRingEmitter>`, :ref:`VisualShaderNodeParticleSphereEmitter<class_VisualShaderNodeParticleSphereEmitter>`
  11. A base class for particle emitters.
  12. Properties
  13. ----------
  14. +-------------------------+------------------------------------------------------------------------+-----------+
  15. | :ref:`bool<class_bool>` | :ref:`mode_2d<class_VisualShaderNodeParticleEmitter_property_mode_2d>` | ``false`` |
  16. +-------------------------+------------------------------------------------------------------------+-----------+
  17. Property Descriptions
  18. ---------------------
  19. .. _class_VisualShaderNodeParticleEmitter_property_mode_2d:
  20. - :ref:`bool<class_bool>` **mode_2d**
  21. +-----------+--------------------+
  22. | *Default* | ``false`` |
  23. +-----------+--------------------+
  24. | *Setter* | set_mode_2d(value) |
  25. +-----------+--------------------+
  26. | *Getter* | is_mode_2d() |
  27. +-----------+--------------------+
  28. If ``true``, the result of this emitter is projected to 2D space. By default it is ``false`` and meant for use in 3D space.
  29. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  30. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  31. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  32. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  33. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  34. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`