diff options
| author | Yuri Sizov <11782833+YuriSizov@users.noreply.github.com> | 2023-05-29 17:06:32 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-29 17:06:32 +0200 |
| commit | 5edcf4f3c74561a526412ab3bf47233b75f33016 (patch) | |
| tree | cf35bbdfb002b48e41525474329b8cda00122c54 | |
| parent | 2f57da290796fbba7c141240bef22baf21615888 (diff) | |
| parent | cdc2e6d872ac818c98b9259b4d2a5b8cf9188abe (diff) | |
| download | redot-engine-5edcf4f3c74561a526412ab3bf47233b75f33016.tar.gz | |
Merge pull request #77614 from mhilbrunner/class_ref_documentation_object_set_meta
Docs: Update Object's class reference regarding meta data
| -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 e74a5af5a3..79b58a1364 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"> |