godot-docs/classes/class_gpuparticlesattractor3d.rst

:github_url: hide

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

.. _class_GPUParticlesAttractor3D:

GPUParticlesAttractor3D
=======================

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

**Inherited By:** :ref:`GPUParticlesAttractorBox3D<class_GPUParticlesAttractorBox3D>`, :ref:`GPUParticlesAttractorSphere3D<class_GPUParticlesAttractorSphere3D>`, :ref:`GPUParticlesAttractorVectorField3D<class_GPUParticlesAttractorVectorField3D>`



Properties
----------

+---------------------------+------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`attenuation<class_GPUParticlesAttractor3D_property_attenuation>`       | ``1.0``        |
+---------------------------+------------------------------------------------------------------------------+----------------+
| :ref:`int<class_int>`     | :ref:`cull_mask<class_GPUParticlesAttractor3D_property_cull_mask>`           | ``4294967295`` |
+---------------------------+------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`directionality<class_GPUParticlesAttractor3D_property_directionality>` | ``0.0``        |
+---------------------------+------------------------------------------------------------------------------+----------------+
| :ref:`float<class_float>` | :ref:`strength<class_GPUParticlesAttractor3D_property_strength>`             | ``1.0``        |
+---------------------------+------------------------------------------------------------------------------+----------------+

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

.. _class_GPUParticlesAttractor3D_property_attenuation:

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

+-----------+------------------------+
| *Default* | ``1.0``                |
+-----------+------------------------+
| *Setter*  | set_attenuation(value) |
+-----------+------------------------+
| *Getter*  | get_attenuation()      |
+-----------+------------------------+

----

.. _class_GPUParticlesAttractor3D_property_cull_mask:

- :ref:`int<class_int>` **cull_mask**

+-----------+----------------------+
| *Default* | ``4294967295``       |
+-----------+----------------------+
| *Setter*  | set_cull_mask(value) |
+-----------+----------------------+
| *Getter*  | get_cull_mask()      |
+-----------+----------------------+

----

.. _class_GPUParticlesAttractor3D_property_directionality:

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

+-----------+---------------------------+
| *Default* | ``0.0``                   |
+-----------+---------------------------+
| *Setter*  | set_directionality(value) |
+-----------+---------------------------+
| *Getter*  | get_directionality()      |
+-----------+---------------------------+

----

.. _class_GPUParticlesAttractor3D_property_strength:

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

+-----------+---------------------+
| *Default* | ``1.0``             |
+-----------+---------------------+
| *Setter*  | set_strength(value) |
+-----------+---------------------+
| *Getter*  | get_strength()      |
+-----------+---------------------+

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