Browse Source

Merge pull request #16176 from vnen/gdscript-default-args

Show default values in docs for GDScript built-in functions
Rémi Verschelde 7 years ago
parent
commit
11441e1556

+ 8 - 0
editor/doc/doc_data.cpp

@@ -611,6 +611,14 @@ void DocData::generate(bool p_basic_types) {
 
 
 					ArgumentDoc ad;
 					ArgumentDoc ad;
 					argument_doc_from_arginfo(ad, mi.arguments[i]);
 					argument_doc_from_arginfo(ad, mi.arguments[i]);
+
+					int darg_idx = i - (mi.arguments.size() - mi.default_arguments.size());
+
+					if (darg_idx >= 0) {
+						Variant default_arg = E->get().default_arguments[darg_idx];
+						ad.default_value = default_arg.get_construct_string();
+					}
+
 					md.arguments.push_back(ad);
 					md.arguments.push_back(ad);
 				}
 				}
 
 

+ 2 - 2
modules/gdscript/gdscript_editor.cpp

@@ -369,8 +369,8 @@ void GDScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const
 		mi.name = "yield";
 		mi.name = "yield";
 		mi.arguments.push_back(PropertyInfo(Variant::OBJECT, "object"));
 		mi.arguments.push_back(PropertyInfo(Variant::OBJECT, "object"));
 		mi.arguments.push_back(PropertyInfo(Variant::STRING, "signal"));
 		mi.arguments.push_back(PropertyInfo(Variant::STRING, "signal"));
-		mi.default_arguments.push_back(Variant::NIL);
-		mi.default_arguments.push_back(Variant::STRING);
+		mi.default_arguments.push_back(Variant());
+		mi.default_arguments.push_back(String());
 		mi.return_val = PropertyInfo(Variant::OBJECT, "", PROPERTY_HINT_RESOURCE_TYPE, "GDScriptFunctionState");
 		mi.return_val = PropertyInfo(Variant::OBJECT, "", PROPERTY_HINT_RESOURCE_TYPE, "GDScriptFunctionState");
 		p_functions->push_back(mi);
 		p_functions->push_back(mi);
 	}
 	}

+ 2 - 0
modules/gdscript/gdscript_functions.cpp

@@ -1760,12 +1760,14 @@ MethodInfo GDScriptFunctions::get_info(Function p_func) {
 		case COLOR8: {
 		case COLOR8: {
 
 
 			MethodInfo mi("Color8", PropertyInfo(Variant::INT, "r8"), PropertyInfo(Variant::INT, "g8"), PropertyInfo(Variant::INT, "b8"), PropertyInfo(Variant::INT, "a8"));
 			MethodInfo mi("Color8", PropertyInfo(Variant::INT, "r8"), PropertyInfo(Variant::INT, "g8"), PropertyInfo(Variant::INT, "b8"), PropertyInfo(Variant::INT, "a8"));
+			mi.default_arguments.push_back(255);
 			mi.return_val.type = Variant::COLOR;
 			mi.return_val.type = Variant::COLOR;
 			return mi;
 			return mi;
 		} break;
 		} break;
 		case COLORN: {
 		case COLORN: {
 
 
 			MethodInfo mi("ColorN", PropertyInfo(Variant::STRING, "name"), PropertyInfo(Variant::REAL, "alpha"));
 			MethodInfo mi("ColorN", PropertyInfo(Variant::STRING, "name"), PropertyInfo(Variant::REAL, "alpha"));
+			mi.default_arguments.push_back(1.0f);
 			mi.return_val.type = Variant::COLOR;
 			mi.return_val.type = Variant::COLOR;
 			return mi;
 			return mi;
 		} break;
 		} break;