Add optional 'default' argument to get_meta()

godotengine · Mar 22, 2022 · 3eb7fc4 · 3eb7fc4
1 parent 9433c1d
commit 3eb7fc4
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/core/object/object.cpp b/core/object/object.cpp
@@ -922,8 +922,14 @@ void Object::set_meta(const StringName &p_name, const Variant &p_value) {
 	metadata[p_name] = p_value;
 }
 
-Variant Object::get_meta(const StringName &p_name) const {
-	ERR_FAIL_COND_V_MSG(!metadata.has(p_name), Variant(), "The object does not have any 'meta' values with the key '" + p_name + "'.");
+Variant Object::get_meta(const StringName &p_name, const Variant &p_default) const {
+	if (!metadata.has(p_name)) {
+		if (p_default != Variant()) {
+			return p_default;
+		} else {
+			ERR_FAIL_V_MSG(Variant(), "The object does not have any 'meta' values with the key '" + p_name + "'.");
+		}
+	}
 	return metadata[p_name];
 }
 
@@ -1529,7 +1535,7 @@ void Object::_bind_methods() {
 
 	ClassDB::bind_method(D_METHOD("set_meta", "name", "value"), &Object::set_meta);
 	ClassDB::bind_method(D_METHOD("remove_meta", "name"), &Object::remove_meta);
-	ClassDB::bind_method(D_METHOD("get_meta", "name"), &Object::get_meta);
+	ClassDB::bind_method(D_METHOD("get_meta", "name", "default"), &Object::get_meta, DEFVAL(Variant()));
 	ClassDB::bind_method(D_METHOD("has_meta", "name"), &Object::has_meta);
 	ClassDB::bind_method(D_METHOD("get_meta_list"), &Object::_get_meta_list_bind);
 

diff --git a/core/object/object.h b/core/object/object.h
@@ -761,7 +761,7 @@ class Object {
 	bool has_meta(const StringName &p_name) const;
 	void set_meta(const StringName &p_name, const Variant &p_value);
 	void remove_meta(const StringName &p_name);
-	Variant get_meta(const StringName &p_name) const;
+	Variant get_meta(const StringName &p_name, const Variant &p_default = Variant()) const;
 	void get_meta_list(List<StringName> *p_list) const;
 
 #ifdef TOOLS_ENABLED

diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml
@@ -366,8 +366,10 @@
 		<method name="get_meta" qualifiers="const">
 			<return type="Variant" />
 			<argument index="0" name="name" type="StringName" />
+			<argument index="1" name="default" type="Variant" default="null" />
 			<description>
 				Returns the object's metadata entry for the given [code]name[/code].
+				Throws error if the entry does not exist, unless [code]default[/code] is not [code]null[/code] (in which case the default value will be returned).
 			</description>
 		</method>
 		<method name="get_meta_list" qualifiers="const">