| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114 |
- :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>`
- General-purpose proximity detection node.
- Description
- -----------
- General-purpose proximity detection node.
- Properties
- ----------
- +-------------------------------------------------------+-------------------------------------------------------------------+------------------------+
- | :ref:`DispatchMode<enum_ProximityGroup_DispatchMode>` | :ref:`dispatch_mode<class_ProximityGroup_property_dispatch_mode>` | ``0`` |
- +-------------------------------------------------------+-------------------------------------------------------------------+------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`grid_radius<class_ProximityGroup_property_grid_radius>` | ``Vector3( 1, 1, 1 )`` |
- +-------------------------------------------------------+-------------------------------------------------------------------+------------------------+
- | :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**
- Property Descriptions
- ---------------------
- .. _class_ProximityGroup_property_dispatch_mode:
- - :ref:`DispatchMode<enum_ProximityGroup_DispatchMode>` **dispatch_mode**
- +-----------+--------------------------+
- | *Default* | ``0`` |
- +-----------+--------------------------+
- | *Setter* | set_dispatch_mode(value) |
- +-----------+--------------------------+
- | *Getter* | get_dispatch_mode() |
- +-----------+--------------------------+
- ----
- .. _class_ProximityGroup_property_grid_radius:
- - :ref:`Vector3<class_Vector3>` **grid_radius**
- +-----------+------------------------+
- | *Default* | ``Vector3( 1, 1, 1 )`` |
- +-----------+------------------------+
- | *Setter* | set_grid_radius(value) |
- +-----------+------------------------+
- | *Getter* | get_grid_radius() |
- +-----------+------------------------+
- ----
- .. _class_ProximityGroup_property_group_name:
- - :ref:`String<class_String>` **group_name**
- +-----------+-----------------------+
- | *Default* | ``""`` |
- +-----------+-----------------------+
- | *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 **)**
- .. |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.)`
|
