class_proximitygroup.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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. | void | :ref:`set_dispatch_mode<class_ProximityGroup_set_dispatch_mode>` **(** :ref:`int<class_int>` mode **)** |
  18. +-------+-----------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_group_name<class_ProximityGroup_set_group_name>` **(** :ref:`String<class_string>` name **)** |
  20. +-------+-----------------------------------------------------------------------------------------------------------------------------------------+
  21. Signals
  22. -------
  23. .. _class_ProximityGroup_broadcast:
  24. - **broadcast** **(** :ref:`String<class_string>` name, :ref:`Array<class_array>` parameters **)**
  25. Member Variables
  26. ----------------
  27. .. _class_ProximityGroup_grid_radius:
  28. - :ref:`Vector3<class_vector3>` **grid_radius**
  29. Description
  30. -----------
  31. General purpose proximity-detection node.
  32. Member Function Description
  33. ---------------------------
  34. .. _class_ProximityGroup_broadcast:
  35. - void **broadcast** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` parameters **)**
  36. .. _class_ProximityGroup_set_dispatch_mode:
  37. - void **set_dispatch_mode** **(** :ref:`int<class_int>` mode **)**
  38. .. _class_ProximityGroup_set_group_name:
  39. - void **set_group_name** **(** :ref:`String<class_string>` name **)**