Clarify EngineDebugger and EditorDebugger* documentation

This commit is contained in:
Danil Alexeev
2024-10-21 11:36:59 +03:00
parent 44fa552343
commit be41e6f84e
4 changed files with 30 additions and 9 deletions

View File

@ -113,7 +113,8 @@
<param index="1" name="callable" type="Callable" />
<description>
Registers a message capture with given [param name]. If [param name] is "my_message" then messages starting with "my_message:" will be called with the given callable.
Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code].
The callable must accept a message string and a data array as argument. The callable should return [code]true[/code] if the message is recognized.
[b]Note:[/b] The callable will receive the message with the prefix stripped, unlike [method EditorDebuggerPlugin._capture]. See the [EditorDebuggerPlugin] description for an example.
</description>
</method>
<method name="register_profiler">