diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-03-22 07:19:58 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-22 07:19:58 +0100 |
| commit | 7d1c72217628ab043f87d1de1d604b5a94f390e3 (patch) | |
| tree | 3c0ea8a8eae63689e919dbe54364c9d92dab72bd /doc | |
| parent | 6cba2143dee0118036ed7b6a79c81011a10d9080 (diff) | |
| parent | 21fc3cbe8139b150047f5598760d12c65da90007 (diff) | |
Merge pull request #59388 from zacryol/init_update_description
update `_init()` description regarding required parameters
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Object.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index a57101b62d..d09f3a2b0d 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -53,7 +53,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.instantiate]) is used, then initialization will fail. </description> </method> <method name="_notification" qualifiers="virtual"> |