Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_enginedebugger.rst

class_enginedebugger.rst 9.3 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EngineDebugger.xml.
    7. 

  7. 

  8. .. _class_EngineDebugger:
    9. 

  9. 

  10. EngineDebugger
    11. 

  11. ==============
    12. 

  12. 

  13. **Inherits:** :ref:`Object<class_Object>`
    14. 

  14. 

  15. Exposes the internal debugger.
    16. 

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

  20. ``EngineDebugger`` handles the communication between the editor and the running game. It is active in the running game. Messages can be sent/received through it. It also manages the profilers.
    21. 

  21. 

  22. Methods
    23. 

  23. -------
    24. 

  24. 

  25. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`bool<class_bool>` | :ref:`has_capture<class_EngineDebugger_method_has_capture>` **(** :ref:`StringName<class_StringName>` name **)**                                                                                 |
    27. 

  27. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`bool<class_bool>` | :ref:`has_profiler<class_EngineDebugger_method_has_profiler>` **(** :ref:`StringName<class_StringName>` name **)**                                                                               |
    29. 

  29. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`bool<class_bool>` | :ref:`is_active<class_EngineDebugger_method_is_active>` **(** **)**                                                                                                                              |
    31. 

  31. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`bool<class_bool>` | :ref:`is_profiling<class_EngineDebugger_method_is_profiling>` **(** :ref:`StringName<class_StringName>` name **)**                                                                               |
    33. 

  33. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | void                    | :ref:`profiler_add_frame_data<class_EngineDebugger_method_profiler_add_frame_data>` **(** :ref:`StringName<class_StringName>` name, :ref:`Array<class_Array>` data **)**                         |
    35. 

  35. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | void                    | :ref:`profiler_enable<class_EngineDebugger_method_profiler_enable>` **(** :ref:`StringName<class_StringName>` name, :ref:`bool<class_bool>` enable, :ref:`Array<class_Array>` arguments=[] **)** |
    37. 

  37. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | void                    | :ref:`register_message_capture<class_EngineDebugger_method_register_message_capture>` **(** :ref:`StringName<class_StringName>` name, :ref:`Callable<class_Callable>` callable **)**             |
    39. 

  39. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | void                    | :ref:`register_profiler<class_EngineDebugger_method_register_profiler>` **(** :ref:`StringName<class_StringName>` name, :ref:`EngineProfiler<class_EngineProfiler>` profiler **)**               |
    41. 

  41. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                    | :ref:`send_message<class_EngineDebugger_method_send_message>` **(** :ref:`String<class_String>` message, :ref:`Array<class_Array>` data **)**                                                    |
    43. 

  43. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                    | :ref:`unregister_message_capture<class_EngineDebugger_method_unregister_message_capture>` **(** :ref:`StringName<class_StringName>` name **)**                                                   |
    45. 

  45. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | void                    | :ref:`unregister_profiler<class_EngineDebugger_method_unregister_profiler>` **(** :ref:`StringName<class_StringName>` name **)**                                                                 |
    47. 

  47. +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. 

  49. Method Descriptions
    50. 

  50. -------------------
    51. 

  51. 

  52. .. _class_EngineDebugger_method_has_capture:
    53. 

  53. 

  54. - :ref:`bool<class_bool>` **has_capture** **(** :ref:`StringName<class_StringName>` name **)**
    55. 

  55. 

  56. Returns ``true`` if a capture with the given name is present otherwise ``false``.
    57. 

  57. 

  58. ----
    59. 

  59. 

  60. .. _class_EngineDebugger_method_has_profiler:
    61. 

  61. 

  62. - :ref:`bool<class_bool>` **has_profiler** **(** :ref:`StringName<class_StringName>` name **)**
    63. 

  63. 

  64. Returns ``true`` if a profiler with the given name is present otherwise ``false``.
    65. 

  65. 

  66. ----
    67. 

  67. 

  68. .. _class_EngineDebugger_method_is_active:
    69. 

  69. 

  70. - :ref:`bool<class_bool>` **is_active** **(** **)**
    71. 

  71. 

  72. Returns ``true`` if the debugger is active otherwise ``false``.
    73. 

  73. 

  74. ----
    75. 

  75. 

  76. .. _class_EngineDebugger_method_is_profiling:
    77. 

  77. 

  78. - :ref:`bool<class_bool>` **is_profiling** **(** :ref:`StringName<class_StringName>` name **)**
    79. 

  79. 

  80. Returns ``true`` if a profiler with the given name is present and active otherwise ``false``.
    81. 

  81. 

  82. ----
    83. 

  83. 

  84. .. _class_EngineDebugger_method_profiler_add_frame_data:
    85. 

  85. 

  86. - void **profiler_add_frame_data** **(** :ref:`StringName<class_StringName>` name, :ref:`Array<class_Array>` data **)**
    87. 

  87. 

  88. Calls the ``add`` callable of the profiler with given ``name`` and ``data``.
    89. 

  89. 

  90. ----
    91. 

  91. 

  92. .. _class_EngineDebugger_method_profiler_enable:
    93. 

  93. 

  94. - void **profiler_enable** **(** :ref:`StringName<class_StringName>` name, :ref:`bool<class_bool>` enable, :ref:`Array<class_Array>` arguments=[] **)**
    95. 

  95. 

  96. Calls the ``toggle`` callable of the profiler with given ``name`` and ``arguments``. Enables/Disables the same profiler depending on ``enable`` argument.
    97. 

  97. 

  98. ----
    99. 

  99. 

  100. .. _class_EngineDebugger_method_register_message_capture:
    101. 

  101. 

  102. - void **register_message_capture** **(** :ref:`StringName<class_StringName>` name, :ref:`Callable<class_Callable>` callable **)**
    103. 

  103. 

  104. Registers a message capture with given ``name``. If ``name`` is "my_message" then messages starting with "my_message:" will be called with the given callable.
    105. 

  105. 

  106. Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return ``true`` otherwise ``false``.
    107. 

  107. 

  108. ----
    109. 

  109. 

  110. .. _class_EngineDebugger_method_register_profiler:
    111. 

  111. 

  112. - void **register_profiler** **(** :ref:`StringName<class_StringName>` name, :ref:`EngineProfiler<class_EngineProfiler>` profiler **)**
    113. 

  113. 

  114. Registers a profiler with the given ``name``. See :ref:`EngineProfiler<class_EngineProfiler>` for more information.
    115. 

  115. 

  116. ----
    117. 

  117. 

  118. .. _class_EngineDebugger_method_send_message:
    119. 

  119. 

  120. - void **send_message** **(** :ref:`String<class_String>` message, :ref:`Array<class_Array>` data **)**
    121. 

  121. 

  122. Sends a message with given ``message`` and ``data`` array.
    123. 

  123. 

  124. ----
    125. 

  125. 

  126. .. _class_EngineDebugger_method_unregister_message_capture:
    127. 

  127. 

  128. - void **unregister_message_capture** **(** :ref:`StringName<class_StringName>` name **)**
    129. 

  129. 

  130. Unregisters the message capture with given ``name``.
    131. 

  131. 

  132. ----
    133. 

  133. 

  134. .. _class_EngineDebugger_method_unregister_profiler:
    135. 

  135. 

  136. - void **unregister_profiler** **(** :ref:`StringName<class_StringName>` name **)**
    137. 

  137. 

  138. Unregisters a profiler with given ``name``.
    139. 

  139. 

  140. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    141. 

  141. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    142. 

  142. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    143. 

  143. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    144. 

  144. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    145. 

  145. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    146.