Files
godot-docs/classes/class_gpuparticlescollisionbox3d.rst
2022-07-27 13:59:06 +02:00

56 lines
2.7 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GPUParticlesCollisionBox3D.xml.
.. _class_GPUParticlesCollisionBox3D:
GPUParticlesCollisionBox3D
==========================
**Inherits:** :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Box-shaped 3D particle collision shape affecting :ref:`GPUParticles3D<class_GPUParticles3D>` nodes.
Description
-----------
Box-shaped 3D particle collision shape affecting :ref:`GPUParticles3D<class_GPUParticles3D>` nodes.
\ **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.
\ **Note:** Particle collision only affects :ref:`GPUParticles3D<class_GPUParticles3D>`, not :ref:`CPUParticles3D<class_CPUParticles3D>`.
Properties
----------
+-------------------------------+-------------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_GPUParticlesCollisionBox3D_property_extents>` | ``Vector3(1, 1, 1)`` |
+-------------------------------+-------------------------------------------------------------------+----------------------+
Property Descriptions
---------------------
.. _class_GPUParticlesCollisionBox3D_property_extents:
- :ref:`Vector3<class_Vector3>` **extents**
+-----------+----------------------+
| *Default* | ``Vector3(1, 1, 1)`` |
+-----------+----------------------+
| *Setter* | set_extents(value) |
+-----------+----------------------+
| *Getter* | get_extents() |
+-----------+----------------------+
The collision box's extents in 3D units.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`