.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_ProximityGroup:

ProximityGroup
==============

**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

General purpose proximity-detection node.

Member Functions
----------------

+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`broadcast<class_ProximityGroup_broadcast>`  **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` parameters  **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`get_grid_radius<class_ProximityGroup_get_grid_radius>`  **(** **)** const                                                           |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dispatch_mode<class_ProximityGroup_set_dispatch_mode>`  **(** :ref:`int<class_int>` mode  **)**                                 |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_grid_radius<class_ProximityGroup_set_grid_radius>`  **(** :ref:`Vector3<class_vector3>` radius  **)**                           |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_group_name<class_ProximityGroup_set_group_name>`  **(** :ref:`String<class_string>` name  **)**                                 |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

-  **broadcast**  **(** :ref:`String<class_string>` name, :ref:`Array<class_array>` parameters  **)**

Member Variables
----------------

- :ref:`Vector3<class_vector3>` **grid_radius**

Description
-----------

General purpose proximity-detection node.

Member Function Description
---------------------------

.. _class_ProximityGroup_broadcast:

- void  **broadcast**  **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` parameters  **)**

.. _class_ProximityGroup_get_grid_radius:

- :ref:`Vector3<class_vector3>`  **get_grid_radius**  **(** **)** const

.. _class_ProximityGroup_set_dispatch_mode:

- void  **set_dispatch_mode**  **(** :ref:`int<class_int>` mode  **)**

.. _class_ProximityGroup_set_grid_radius:

- void  **set_grid_radius**  **(** :ref:`Vector3<class_vector3>` radius  **)**

.. _class_ProximityGroup_set_group_name:

- void  **set_group_name**  **(** :ref:`String<class_string>` name  **)**