diff options
| author | Devin <beastmodeiswhatiam@gmail.com> | 2023-04-26 08:43:36 -0500 |
|---|---|---|
| committer | Max Hilbrunner <m.hilbrunner@gmail.com> | 2023-05-29 16:09:16 +0200 |
| commit | cdc2e6d872ac818c98b9259b4d2a5b8cf9188abe (patch) | |
| tree | af28bc51c6c2f0c0340b698cb82010daa63eb5ca | |
| parent | 437041a983a81f9768673dc5374f644634f940f9 (diff) | |
| download | redot-engine-cdc2e6d872ac818c98b9259b4d2a5b8cf9188abe.tar.gz | |
Updated Object's class reference documentation for set_meta to indicate metadata's name must be a valid identifier
| -rw-r--r-- | doc/classes/Object.xml | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 0a52df1e49..f68a5ea474 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -599,7 +599,8 @@ <param index="1" name="default" type="Variant" default="null" /> <description> Returns the object's metadata value for the given entry [param name]. If the entry does not exist, returns [param default]. If [param default] is [code]null[/code], an error is also generated. - [b]Note:[/b] Metadata that has a [param name] starting with an underscore ([code]_[/code]) is considered editor-only. Editor-only metadata is not displayed in the Inspector dock and should not be edited. + [b]Note:[/b] A metadata's [param name] must be a valid identifier as per [method StringName.is_valid_identifier] method. + [b]Note:[/b] Metadata that has a [param name] starting with an underscore ([code]_[/code]) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method. </description> </method> <method name="get_meta_list" qualifiers="const"> @@ -661,6 +662,7 @@ <param index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if a metadata entry is found with the given [param name]. See also [method get_meta], [method set_meta] and [method remove_meta]. + [b]Note:[/b] A metadata's [param name] must be a valid identifier as per [method StringName.is_valid_identifier] method. [b]Note:[/b] Metadata that has a [param name] starting with an underscore ([code]_[/code]) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method. </description> </method> @@ -788,7 +790,8 @@ <param index="0" name="name" type="StringName" /> <description> Removes the given entry [param name] from the object's metadata. See also [method has_meta], [method get_meta] and [method set_meta]. - [b]Note:[/b] Metadata that has a [param name] starting with an underscore ([code]_[/code]) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited. + [b]Note:[/b] A metadata's [param name] must be a valid identifier as per [method StringName.is_valid_identifier] method. + [b]Note:[/b] Metadata that has a [param name] starting with an underscore ([code]_[/code]) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method. </description> </method> <method name="set"> @@ -887,7 +890,8 @@ <description> Adds or changes the entry [param name] inside the object's metadata. The metadata [param value] can be any [Variant], although some types cannot be serialized correctly. If [param value] is [code]null[/code], the entry is removed. This is the equivalent of using [method remove_meta]. See also [method has_meta] and [method get_meta]. - [b]Note:[/b] Metadata that has a [param name] starting with an underscore ([code]_[/code]) is considered editor-only. Editor-only metadata is not displayed in the Inspector dock and should not be edited. + [b]Note:[/b] A metadata's [param name] must be a valid identifier as per [method StringName.is_valid_identifier] method. + [b]Note:[/b] Metadata that has a [param name] starting with an underscore ([code]_[/code]) is considered editor-only. Editor-only metadata is not displayed in the Inspector and should not be edited, although it can still be found by this method. </description> </method> <method name="set_script"> |