浏览代码

Merge pull request #59388 from zacryol/init_update_description

update `_init()` description regarding required parameters
Rémi Verschelde 3 年之前
父节点
当前提交
7d1c722176
共有 1 个文件被更改,包括 2 次插入1 次删除
  1. 2 1
      doc/classes/Object.xml

+ 2 - 1
doc/classes/Object.xml

@@ -53,7 +53,8 @@
 		<method name="_init" qualifiers="virtual">
 		<method name="_init" qualifiers="virtual">
 			<return type="void" />
 			<return type="void" />
 			<description>
 			<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.instantiate]) is used, then initialization will fail.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="_notification" qualifiers="virtual">
 		<method name="_notification" qualifiers="virtual">