godot-docs/classes/class_gpuparticlescollisionheightfield3d.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GPUParticlesCollisionHeightField3D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_GPUParticlesCollisionHeightField3D:

GPUParticlesCollisionHeightField3D
==================================

**Inherits:** :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`



Properties
----------

+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>`                                         | :ref:`extents<class_GPUParticlesCollisionHeightField3D_property_extents>`                                   | ``Vector3(1, 1, 1)`` |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>`                                               | :ref:`follow_camera_enabled<class_GPUParticlesCollisionHeightField3D_property_follow_camera_enabled>`       | ``false``            |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+
| :ref:`float<class_float>`                                             | :ref:`follow_camera_push_ratio<class_GPUParticlesCollisionHeightField3D_property_follow_camera_push_ratio>` | ``0.1``              |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+
| :ref:`Resolution<enum_GPUParticlesCollisionHeightField3D_Resolution>` | :ref:`resolution<class_GPUParticlesCollisionHeightField3D_property_resolution>`                             | ``2``                |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+
| :ref:`UpdateMode<enum_GPUParticlesCollisionHeightField3D_UpdateMode>` | :ref:`update_mode<class_GPUParticlesCollisionHeightField3D_property_update_mode>`                           | ``0``                |
+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+----------------------+

Enumerations
------------

.. _enum_GPUParticlesCollisionHeightField3D_Resolution:

.. _class_GPUParticlesCollisionHeightField3D_constant_RESOLUTION_256:

.. _class_GPUParticlesCollisionHeightField3D_constant_RESOLUTION_512:

.. _class_GPUParticlesCollisionHeightField3D_constant_RESOLUTION_1024:

.. _class_GPUParticlesCollisionHeightField3D_constant_RESOLUTION_2048:

.. _class_GPUParticlesCollisionHeightField3D_constant_RESOLUTION_4096:

.. _class_GPUParticlesCollisionHeightField3D_constant_RESOLUTION_8192:

.. _class_GPUParticlesCollisionHeightField3D_constant_RESOLUTION_MAX:

enum **Resolution**:

- **RESOLUTION_256** = **0**

- **RESOLUTION_512** = **1**

- **RESOLUTION_1024** = **2**

- **RESOLUTION_2048** = **3**

- **RESOLUTION_4096** = **4**

- **RESOLUTION_8192** = **5**

- **RESOLUTION_MAX** = **6**

----

.. _enum_GPUParticlesCollisionHeightField3D_UpdateMode:

.. _class_GPUParticlesCollisionHeightField3D_constant_UPDATE_MODE_WHEN_MOVED:

.. _class_GPUParticlesCollisionHeightField3D_constant_UPDATE_MODE_ALWAYS:

enum **UpdateMode**:

- **UPDATE_MODE_WHEN_MOVED** = **0**

- **UPDATE_MODE_ALWAYS** = **1**

Property Descriptions
---------------------

.. _class_GPUParticlesCollisionHeightField3D_property_extents:

- :ref:`Vector3<class_Vector3>` **extents**

+-----------+----------------------+
| *Default* | ``Vector3(1, 1, 1)`` |
+-----------+----------------------+
| *Setter*  | set_extents(value)   |
+-----------+----------------------+
| *Getter*  | get_extents()        |
+-----------+----------------------+

----

.. _class_GPUParticlesCollisionHeightField3D_property_follow_camera_enabled:

- :ref:`bool<class_bool>` **follow_camera_enabled**

+-----------+---------------------------------+
| *Default* | ``false``                       |
+-----------+---------------------------------+
| *Setter*  | set_follow_camera_mode(value)   |
+-----------+---------------------------------+
| *Getter*  | is_follow_camera_mode_enabled() |
+-----------+---------------------------------+

----

.. _class_GPUParticlesCollisionHeightField3D_property_follow_camera_push_ratio:

- :ref:`float<class_float>` **follow_camera_push_ratio**

+-----------+-------------------------------------+
| *Default* | ``0.1``                             |
+-----------+-------------------------------------+
| *Setter*  | set_follow_camera_push_ratio(value) |
+-----------+-------------------------------------+
| *Getter*  | get_follow_camera_push_ratio()      |
+-----------+-------------------------------------+

----

.. _class_GPUParticlesCollisionHeightField3D_property_resolution:

- :ref:`Resolution<enum_GPUParticlesCollisionHeightField3D_Resolution>` **resolution**

+-----------+-----------------------+
| *Default* | ``2``                 |
+-----------+-----------------------+
| *Setter*  | set_resolution(value) |
+-----------+-----------------------+
| *Getter*  | get_resolution()      |
+-----------+-----------------------+

----

.. _class_GPUParticlesCollisionHeightField3D_property_update_mode:

- :ref:`UpdateMode<enum_GPUParticlesCollisionHeightField3D_UpdateMode>` **update_mode**

+-----------+------------------------+
| *Default* | ``0``                  |
+-----------+------------------------+
| *Setter*  | set_update_mode(value) |
+-----------+------------------------+
| *Getter*  | get_update_mode()      |
+-----------+------------------------+

.. |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.)`