2
0

class_proximitygroup.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ProximityGroup.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ProximityGroup:
  6. ProximityGroup
  7. ==============
  8. **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. General purpose proximity-detection node.
  13. Properties
  14. ----------
  15. +-------------------------------------------------------+-------------------------------------------------------------------+
  16. | :ref:`DispatchMode<enum_ProximityGroup_DispatchMode>` | :ref:`dispatch_mode<class_ProximityGroup_property_dispatch_mode>` |
  17. +-------------------------------------------------------+-------------------------------------------------------------------+
  18. | :ref:`Vector3<class_Vector3>` | :ref:`grid_radius<class_ProximityGroup_property_grid_radius>` |
  19. +-------------------------------------------------------+-------------------------------------------------------------------+
  20. | :ref:`String<class_String>` | :ref:`group_name<class_ProximityGroup_property_group_name>` |
  21. +-------------------------------------------------------+-------------------------------------------------------------------+
  22. Methods
  23. -------
  24. +------+------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`broadcast<class_ProximityGroup_method_broadcast>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` parameters **)** |
  26. +------+------------------------------------------------------------------------------------------------------------------------------------------------+
  27. Signals
  28. -------
  29. .. _class_ProximityGroup_signal_broadcast:
  30. - **broadcast** **(** :ref:`String<class_String>` group_name, :ref:`Array<class_Array>` parameters **)**
  31. Enumerations
  32. ------------
  33. .. _enum_ProximityGroup_DispatchMode:
  34. .. _class_ProximityGroup_constant_MODE_PROXY:
  35. .. _class_ProximityGroup_constant_MODE_SIGNAL:
  36. enum **DispatchMode**:
  37. - **MODE_PROXY** = **0**
  38. - **MODE_SIGNAL** = **1**
  39. Description
  40. -----------
  41. General purpose proximity-detection node.
  42. Property Descriptions
  43. ---------------------
  44. .. _class_ProximityGroup_property_dispatch_mode:
  45. - :ref:`DispatchMode<enum_ProximityGroup_DispatchMode>` **dispatch_mode**
  46. +----------+--------------------------+
  47. | *Setter* | set_dispatch_mode(value) |
  48. +----------+--------------------------+
  49. | *Getter* | get_dispatch_mode() |
  50. +----------+--------------------------+
  51. ----
  52. .. _class_ProximityGroup_property_grid_radius:
  53. - :ref:`Vector3<class_Vector3>` **grid_radius**
  54. +----------+------------------------+
  55. | *Setter* | set_grid_radius(value) |
  56. +----------+------------------------+
  57. | *Getter* | get_grid_radius() |
  58. +----------+------------------------+
  59. ----
  60. .. _class_ProximityGroup_property_group_name:
  61. - :ref:`String<class_String>` **group_name**
  62. +----------+-----------------------+
  63. | *Setter* | set_group_name(value) |
  64. +----------+-----------------------+
  65. | *Getter* | get_group_name() |
  66. +----------+-----------------------+
  67. Method Descriptions
  68. -------------------
  69. .. _class_ProximityGroup_method_broadcast:
  70. - void **broadcast** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` parameters **)**