class_gpuparticlesattractorbox3d.rst 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/GPUParticlesAttractorBox3D.xml.
  6. .. _class_GPUParticlesAttractorBox3D:
  7. GPUParticlesAttractorBox3D
  8. ==========================
  9. **Inherits:** :ref:`GPUParticlesAttractor3D<class_GPUParticlesAttractor3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Box-shaped 3D particle attractor affecting :ref:`GPUParticles3D<class_GPUParticles3D>` nodes.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Box-shaped 3D particle attractor affecting :ref:`GPUParticles3D<class_GPUParticles3D>` nodes.
  15. \ **Note:** Particle attractors only affect :ref:`GPUParticles3D<class_GPUParticles3D>`, not :ref:`CPUParticles3D<class_CPUParticles3D>`.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-------------------------------+-------------------------------------------------------------+----------------------+
  22. | :ref:`Vector3<class_Vector3>` | :ref:`size<class_GPUParticlesAttractorBox3D_property_size>` | ``Vector3(2, 2, 2)`` |
  23. +-------------------------------+-------------------------------------------------------------+----------------------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Property Descriptions
  28. ---------------------
  29. .. _class_GPUParticlesAttractorBox3D_property_size:
  30. .. rst-class:: classref-property
  31. :ref:`Vector3<class_Vector3>` **size** = ``Vector3(2, 2, 2)``
  32. .. rst-class:: classref-property-setget
  33. - void **set_size** **(** :ref:`Vector3<class_Vector3>` value **)**
  34. - :ref:`Vector3<class_Vector3>` **get_size** **(** **)**
  35. The attractor box's size in 3D units.
  36. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  37. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  38. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  39. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  40. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  41. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`