class_visualshadernodeparticleemitter.rst 2.5 KB

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