summaryrefslogtreecommitdiff
path: root/doc/classes/Object.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-07-27 09:59:02 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-07-27 10:03:46 +0200
commit4275e6aad53c0662c208c899ebcadd1d7b3cbbaa (patch)
treeef13644cd9af9fd22a1f6da59e5b3c452117925a /doc/classes/Object.xml
parent1ab0644532521443d0594549da432d89b9d535a4 (diff)
Improve the Object, Reference and Resource class documentations
Diffstat (limited to 'doc/classes/Object.xml')
-rw-r--r--doc/classes/Object.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml
index 3d8c2c5eb0..ca6b624359 100644
--- a/doc/classes/Object.xml
+++ b/doc/classes/Object.xml
@@ -17,8 +17,10 @@
[/codeblock]
The [code]in[/code] operator will evaluate to [code]true[/code] as long as the key exists, even if the value is [code]null[/code].
Objects also receive notifications. Notifications are a simple way to notify the object about different events, so they can all be handled together. See [method _notification].
+ [b]Note:[/b] Unlike references to a [Reference], references to an Object stored in a variable can become invalid without warning. Therefore, it's recommended to use [Reference] for data classes instead of [Object].
</description>
<tutorials>
+ <link title="When and how to avoid using nodes for everything">https://docs.godotengine.org/en/latest/getting_started/workflow/best_practices/node_alternatives.html</link>
</tutorials>
<methods>
<method name="_get" qualifiers="virtual">
@@ -518,7 +520,7 @@
One-shot connections disconnect themselves after emission.
</constant>
<constant name="CONNECT_REFERENCE_COUNTED" value="8" enum="ConnectFlags">
- Connect a signal as reference counted. This means that a given signal can be connected several times to the same target, and will only be fully disconnected once no references are left.
+ Connect a signal as reference-counted. This means that a given signal can be connected several times to the same target, and will only be fully disconnected once no references are left.
</constant>
</constants>
</class>