godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Show default values in docs for GDScript built-in functions

This commit is contained in:
George Marques 2018-01-30 02:06:19 -02:00
parent 9f3138eea9
commit dca2ae78dd
No known key found for this signature in database
GPG Key ID: 046BD46A3201E43D
3 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
editor/doc/doc_data.cpp
View File

@ -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);
} }

4
modules/gdscript/gdscript_editor.cpp
View File

@ -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());
mi.default_arguments.push_back(Variant::STRING); 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
modules/gdscript/gdscript_functions.cpp
View File

@ -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;