Skip to content

Commit

Permalink
update _init() description
Browse files Browse the repository at this point in the history
Specify details regarding required parameters.

(cherry picked from commit 21fc3cb)
  • Loading branch information
zacryol authored and akien-mga committed Mar 22, 2022
1 parent e822145 commit 3fe37f9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/classes/Object.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
<method name="_init" qualifiers="virtual">
<return type="void" />
<description>
Called when the object is initialized.
Called when the object is initialized in memory. Can be defined to take in parameters, that are passed in when constructing.
[b]Note:[/b] If [method _init] is defined with required parameters, then explicit construction is the only valid means of creating an Object of the class. If any other means (such as [method PackedScene.instance]) is used, then initialization will fail.
</description>
</method>
<method name="_notification" qualifiers="virtual">
Expand Down

0 comments on commit 3fe37f9

Please sign in to comment.