godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #96066 from AThousandShips/is_null_doc 

[Doc] Clarify `is_null` methods of `Callable` and `Signal`
This commit is contained in:
Rémi Verschelde 2024-08-26 22:45:50 +02:00
parent 4a947f0811 5b91040ba6
commit a8516b8c3b
No known key found for this signature in database
GPG Key ID: C3336907360768E1
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/Callable.xml
View File

@ -203,7 +203,8 @@
<method name="is_null" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if this [Callable] has no target to call the method on.
Returns [code]true[/code] if this [Callable] has no target to call the method on. Equivalent to [code]callable == Callable()[/code].
[b]Note:[/b] This is [i]not[/i] the same as [code]not is_valid()[/code] and using [code]not is_null()[/code] will [i]not[/i] guarantee that this callable can be called. Use [method is_valid] instead.
</description>
</method>
<method name="is_standard" qualifiers="const">

2
doc/classes/Signal.xml
View File

@ -119,7 +119,7 @@
<method name="is_null" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if the signal's name does not exist in its object, or the object is not valid.
Returns [code]true[/code] if this [Signal] has no object and the signal name is empty. Equivalent to [code]signal == Signal()[/code].
</description>
</method>
</methods>