Skip to content

Commit 50ac10f

Browse files
committed
Merge pull request #111830 from KoBeWi/documentation_on_multiple_levels
Add multilevel notes to methods
2 parents 04625b0 + 6640380 commit 50ac10f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/classes/Object.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@
7373
}
7474
[/csharp]
7575
[/codeblocks]
76+
[b]Note:[/b] Unlike other virtual methods, this method is called automatically for every script that overrides it. This means that the base implementation should not be called via [code]super[/code] in GDScript or its equivalents in other languages. The bottom-most sub-class will be called first, with subsequent calls ascending the class hierarchy. The call chain will stop on the first class that returns a non-[code]null[/code] value.
7677
</description>
7778
</method>
7879
<method name="_get_property_list" qualifiers="virtual">
@@ -185,6 +186,7 @@
185186
[/codeblocks]
186187
[b]Note:[/b] This method is intended for advanced purposes. For most common use cases, the scripting languages offer easier ways to handle properties. See [annotation @GDScript.@export], [annotation @GDScript.@export_enum], [annotation @GDScript.@export_group], etc. If you want to customize exported properties, use [method _validate_property].
187188
[b]Note:[/b] If the object's script is not [annotation @GDScript.@tool], this method will not be called in the editor.
189+
[b]Note:[/b] Unlike other virtual methods, this method is called automatically for every script that overrides it. This means that the base implementation should not be called via [code]super[/code] in GDScript or its equivalents in other languages. The bottom-most sub-class will be called first, with subsequent calls ascending the class hierarchy.
188190
</description>
189191
</method>
190192
<method name="_init" qualifiers="virtual">
@@ -265,7 +267,7 @@
265267
[/csharp]
266268
[/codeblocks]
267269
[b]Note:[/b] The base [Object] defines a few notifications ([constant NOTIFICATION_POSTINITIALIZE] and [constant NOTIFICATION_PREDELETE]). Inheriting classes such as [Node] define a lot more notifications, which are also received by this method.
268-
[b]Note:[/b] Unlike other virtual methods, this method is called automatically for every script that overrides it. This means that the base implementation should not be called via [code]super[/code] in GDScript or its equivalents in other languages.
270+
[b]Note:[/b] Unlike other virtual methods, this method is called automatically for every script that overrides it. This means that the base implementation should not be called via [code]super[/code] in GDScript or its equivalents in other languages. The bottom-most sub-class will be called first, with subsequent calls ascending the class hierarchy.
269271
</description>
270272
</method>
271273
<method name="_property_can_revert" qualifiers="virtual">
@@ -274,6 +276,7 @@
274276
<description>
275277
Override this method to customize the given [param property]'s revert behavior. Should return [code]true[/code] if the [param property] has a custom default value and is revertible in the Inspector dock. Use [method _property_get_revert] to specify the [param property]'s default value.
276278
[b]Note:[/b] This method must return consistently, regardless of the current value of the [param property].
279+
[b]Note:[/b] Unlike other virtual methods, this method is called automatically for every script that overrides it. This means that the base implementation should not be called via [code]super[/code] in GDScript or its equivalents in other languages. The bottom-most sub-class will be called first, with subsequent calls ascending the class hierarchy. The call chain will stop on the first class that returns [code]true[/code].
277280
</description>
278281
</method>
279282
<method name="_property_get_revert" qualifiers="virtual">
@@ -282,6 +285,7 @@
282285
<description>
283286
Override this method to customize the given [param property]'s revert behavior. Should return the default value for the [param property]. If the default value differs from the [param property]'s current value, a revert icon is displayed in the Inspector dock.
284287
[b]Note:[/b] [method _property_can_revert] must also be overridden for this method to be called.
288+
[b]Note:[/b] Unlike other virtual methods, this method is called automatically for every script that overrides it. This means that the base implementation should not be called via [code]super[/code] in GDScript or its equivalents in other languages. The bottom-most sub-class will be called first, with subsequent calls ascending the class hierarchy. The call chain will stop on the first class that returns a non-[code]null[/code] value.
285289
</description>
286290
</method>
287291
<method name="_set" qualifiers="virtual">
@@ -336,6 +340,7 @@
336340
}
337341
[/csharp]
338342
[/codeblocks]
343+
[b]Note:[/b] Unlike other virtual methods, this method is called automatically for every script that overrides it. This means that the base implementation should not be called via [code]super[/code] in GDScript or its equivalents in other languages. The bottom-most sub-class will be called first, with subsequent calls ascending the class hierarchy. The call chain will stop on the first class that returns [code]true[/code].
339344
</description>
340345
</method>
341346
<method name="_to_string" qualifiers="virtual">

0 commit comments

Comments
 (0)