class_proximitygroup.rst 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the ProximityGroup.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_ProximityGroup:
  5. ProximityGroup
  6. ==============
  7. **Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. General purpose proximity-detection node.
  12. Member Functions
  13. ----------------
  14. +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`broadcast<class_ProximityGroup_broadcast>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` parameters **)** |
  16. +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Vector3<class_vector3>` | :ref:`get_grid_radius<class_ProximityGroup_get_grid_radius>` **(** **)** const |
  18. +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_dispatch_mode<class_ProximityGroup_set_dispatch_mode>` **(** :ref:`int<class_int>` mode **)** |
  20. +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_grid_radius<class_ProximityGroup_set_grid_radius>` **(** :ref:`Vector3<class_vector3>` radius **)** |
  22. +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_group_name<class_ProximityGroup_set_group_name>` **(** :ref:`String<class_string>` name **)** |
  24. +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  25. Signals
  26. -------
  27. - **broadcast** **(** :ref:`String<class_string>` name, :ref:`Array<class_array>` parameters **)**
  28. Member Variables
  29. ----------------
  30. - :ref:`Vector3<class_vector3>` **grid_radius**
  31. Description
  32. -----------
  33. General purpose proximity-detection node.
  34. Member Function Description
  35. ---------------------------
  36. .. _class_ProximityGroup_broadcast:
  37. - void **broadcast** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` parameters **)**
  38. .. _class_ProximityGroup_get_grid_radius:
  39. - :ref:`Vector3<class_vector3>` **get_grid_radius** **(** **)** const
  40. .. _class_ProximityGroup_set_dispatch_mode:
  41. - void **set_dispatch_mode** **(** :ref:`int<class_int>` mode **)**
  42. .. _class_ProximityGroup_set_grid_radius:
  43. - void **set_grid_radius** **(** :ref:`Vector3<class_vector3>` radius **)**
  44. .. _class_ProximityGroup_set_group_name:
  45. - void **set_group_name** **(** :ref:`String<class_string>` name **)**