Add note in Callable documentation about methods of native types

- Adds a workaround/code example too.
- Fixes #58912 (the issue itself is not a bug, but the solution was to add a documentation entry about the "issue")
This commit is contained in:
Adam Scott 2023-06-15 09:54:17 -04:00
parent 7734146060
commit 810806e6b5
No known key found for this signature in database
GPG Key ID: 1352C2919D96DDDF

View File

@ -46,6 +46,17 @@
# Prints "Attack!", when the button_pressed signal is emitted.
button_pressed.connect(func(): print("Attack!"))
[/codeblock]
[b]Note:[/b] Methods of native types such as [Signal], [Array], or [Dictionary] are not of type [Callable] in order to avoid unnecessary overhead. If you need to pass those methods as [Callable], use a lambda function as a wrapper.
[codeblock]
func _init():
var my_dictionary = { "hello": "world" }
# This will not work, `clear` is not a callable.
create_tween().tween_callback(my_dictionary.clear)
# This will work, as lambdas are custom callables.
create_tween().tween_callback(func(): my_dictionary.clear())
[/codeblock]
</description>
<tutorials>
</tutorials>