mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
110 lines
3.4 KiB
ReStructuredText
110 lines
3.4 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ProximityGroup.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _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.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------------------------------+-------------------------------------------------------------------+
|
|
| :ref:`DispatchMode<enum_ProximityGroup_DispatchMode>` | :ref:`dispatch_mode<class_ProximityGroup_property_dispatch_mode>` |
|
|
+-------------------------------------------------------+-------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`grid_radius<class_ProximityGroup_property_grid_radius>` |
|
|
+-------------------------------------------------------+-------------------------------------------------------------------+
|
|
| :ref:`String<class_String>` | :ref:`group_name<class_ProximityGroup_property_group_name>` |
|
|
+-------------------------------------------------------+-------------------------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`broadcast<class_ProximityGroup_method_broadcast>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` parameters **)** |
|
|
+------+------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_ProximityGroup_signal_broadcast:
|
|
|
|
- **broadcast** **(** :ref:`String<class_String>` group_name, :ref:`Array<class_Array>` parameters **)**
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_ProximityGroup_DispatchMode:
|
|
|
|
.. _class_ProximityGroup_constant_MODE_PROXY:
|
|
|
|
.. _class_ProximityGroup_constant_MODE_SIGNAL:
|
|
|
|
enum **DispatchMode**:
|
|
|
|
- **MODE_PROXY** = **0**
|
|
|
|
- **MODE_SIGNAL** = **1**
|
|
|
|
Description
|
|
-----------
|
|
|
|
General purpose proximity-detection node.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_ProximityGroup_property_dispatch_mode:
|
|
|
|
- :ref:`DispatchMode<enum_ProximityGroup_DispatchMode>` **dispatch_mode**
|
|
|
|
+----------+--------------------------+
|
|
| *Setter* | set_dispatch_mode(value) |
|
|
+----------+--------------------------+
|
|
| *Getter* | get_dispatch_mode() |
|
|
+----------+--------------------------+
|
|
|
|
----
|
|
|
|
.. _class_ProximityGroup_property_grid_radius:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **grid_radius**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_grid_radius(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_grid_radius() |
|
|
+----------+------------------------+
|
|
|
|
----
|
|
|
|
.. _class_ProximityGroup_property_group_name:
|
|
|
|
- :ref:`String<class_String>` **group_name**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_group_name(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | get_group_name() |
|
|
+----------+-----------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_ProximityGroup_method_broadcast:
|
|
|
|
- void **broadcast** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` parameters **)**
|
|
|