diff options
| author | zacryol <60046681+zacryol@users.noreply.github.com> | 2022-03-21 09:13:32 -0600 |
|---|---|---|
| committer | zacryol <60046681+zacryol@users.noreply.github.com> | 2022-03-21 09:13:32 -0600 |
| commit | 21fc3cbe8139b150047f5598760d12c65da90007 (patch) | |
| tree | 735982aa2a72c6830e1c2b07b4fb2a7d748faacd | |
| parent | 16e96e52d3e27f0ea66b16ff29d8579751d5dfed (diff) | |
update _init() description
Specify details regarding required parameters.
| -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"> |