class_gpuparticlescollisionbox3d.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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/GPUParticlesCollisionBox3D.xml.
  6. .. _class_GPUParticlesCollisionBox3D:
  7. GPUParticlesCollisionBox3D
  8. ==========================
  9. **Inherits:** :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Box-shaped 3D particle collision shape affecting :ref:`GPUParticles3D<class_GPUParticles3D>` nodes.
  11. Description
  12. -----------
  13. Box-shaped 3D particle collision shape affecting :ref:`GPUParticles3D<class_GPUParticles3D>` nodes.
  14. \ **Note:** :ref:`ParticlesMaterial.collision_enabled<class_ParticlesMaterial_property_collision_enabled>` must be ``true`` on the :ref:`GPUParticles3D<class_GPUParticles3D>`'s process material for collision to work.
  15. \ **Note:** Particle collision only affects :ref:`GPUParticles3D<class_GPUParticles3D>`, not :ref:`CPUParticles3D<class_CPUParticles3D>`.
  16. Properties
  17. ----------
  18. +-------------------------------+-------------------------------------------------------------------+----------------------+
  19. | :ref:`Vector3<class_Vector3>` | :ref:`extents<class_GPUParticlesCollisionBox3D_property_extents>` | ``Vector3(1, 1, 1)`` |
  20. +-------------------------------+-------------------------------------------------------------------+----------------------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_GPUParticlesCollisionBox3D_property_extents:
  24. - :ref:`Vector3<class_Vector3>` **extents**
  25. +-----------+----------------------+
  26. | *Default* | ``Vector3(1, 1, 1)`` |
  27. +-----------+----------------------+
  28. | *Setter* | set_extents(value) |
  29. +-----------+----------------------+
  30. | *Getter* | get_extents() |
  31. +-----------+----------------------+
  32. The collision box's extents in 3D units.
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  36. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  37. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  38. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`