maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Sync classref with current source

Browse source 
And various fixes to bindings, hyperlinks and an uninitialized variable.
This commit is contained in:
Rémi Verschelde 2019-09-27 22:16:32 +02:00
parent 5966c6b646
commit d0e45e78a4
12 changed files with 55 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Crypto.xml
View file

@ -41,7 +41,7 @@
<argument index="0" name="size" type="int">
</argument>
<description>
Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.acccept_stream].
Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream].
</description>
</method>
<method name="generate_self_signed_certificate">

2
doc/classes/CryptoKey.xml
View file

@ -5,7 +5,7 @@
</brief_description>
<description>
The CryptoKey class represents a cryptographic key. Keys can be loaded and saved like any other [Resource].
They can be used to generate a self-signed [X509Certificate] via [method Crypto.generate_self_signed] and as private key in [method StreamPeerSSL.accept_stream] along with the appropriate certificate.
They can be used to generate a self-signed [X509Certificate] via [method Crypto.generate_self_signed_certificate] and as private key in [method StreamPeerSSL.accept_stream] along with the appropriate certificate.
</description>
<tutorials>
</tutorials>

2
doc/classes/Font.xml
View file

@ -82,7 +82,7 @@
</return>
<argument index="0" name="string" type="String">
</argument>
<argument index="1" name="p_width" type="float">
<argument index="1" name="width" type="float">
</argument>
<description>
</description>

19
doc/classes/Skeleton.xml
View file

@ -54,6 +54,15 @@
Returns the amount of bones in the skeleton.
</description>
</method>
<method name="get_bone_custom_pose" qualifiers="const">
<return type="Transform">
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
<description>
Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose.
</description>
</method>
<method name="get_bone_global_pose" qualifiers="const">
<return type="Transform">
</return>
@ -161,6 +170,16 @@
<description>
</description>
</method>
<method name="set_bone_custom_pose">
<return type="void">
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
<argument index="1" name="custom_pose" type="Transform">
</argument>
<description>
</description>
</method>
<method name="set_bone_disable_rest">
<return type="void">
</return>

4
doc/classes/TreeItem.xml
View file

@ -89,8 +89,10 @@
</return>
<argument index="0" name="column" type="int">
</argument>
<argument index="1" name="button_idx" type="int">
</argument>
<description>
Returns the tooltip for the button in column [code]column[/code].
Returns the tooltip string for the button at index [code]button_idx[/code] in column [code]column[/code].
</description>
</method>
<method name="get_cell_mode" qualifiers="const">

2
doc/classes/X509Certificate.xml
View file

@ -5,7 +5,7 @@
</brief_description>
<description>
The X509Certificate class represents an X509 certificate. Certificates can be loaded and saved like any other [Resource].
They can be used as the server certificate in [StreamPeerSSL.accept_stream] (along with the proper [CryptoKey]), and to specify the only certificate that should be accepted when connecting to an SSL server via [StreamPeerSSL.connect_to_stream].
They can be used as the server certificate in [method StreamPeerSSL.accept_stream] (along with the proper [CryptoKey]), and to specify the only certificate that should be accepted when connecting to an SSL server via [method StreamPeerSSL.connect_to_stream].
</description>
<tutorials>
</tutorials>

2
modules/visual_script/config.py
View file

@ -11,6 +11,7 @@ def get_doc_classes():
"VisualScriptBuiltinFunc",
"VisualScriptClassConstant",
"VisualScriptComment",
"VisualScriptComposeArray",
"VisualScriptCondition",
"VisualScriptConstant",
"VisualScriptConstructor",
@ -28,6 +29,7 @@ def get_doc_classes():
"VisualScriptIndexSet",
"VisualScriptInputAction",
"VisualScriptIterator",
"VisualScriptLists",
"VisualScriptLocalVarSet",
"VisualScriptLocalVar",
"VisualScriptMathConstant",

32
modules/visual_script/doc_classes/VisualScriptLists.xml
View file

@ -12,11 +12,11 @@
<method name="add_input_data_port">
<return type="void">
</return>
<argument index="0" name="p_type" type="int" enum="Variant.Type">
<argument index="0" name="type" type="int" enum="Variant.Type">
</argument>
<argument index="1" name="p_name" type="String">
<argument index="1" name="name" type="String">
</argument>
<argument index="2" name="p_index" type="int">
<argument index="2" name="index" type="int">
</argument>
<description>
</description>
@ -24,11 +24,11 @@
<method name="add_output_data_port">
<return type="void">
</return>
<argument index="0" name="p_type" type="int" enum="Variant.Type">
<argument index="0" name="type" type="int" enum="Variant.Type">
</argument>
<argument index="1" name="p_name" type="String">
<argument index="1" name="name" type="String">
</argument>
<argument index="2" name="p_index" type="int">
<argument index="2" name="index" type="int">
</argument>
<description>
</description>
@ -36,7 +36,7 @@
<method name="remove_input_data_port">
<return type="void">
</return>
<argument index="0" name="p_index" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
@ -44,7 +44,7 @@
<method name="remove_output_data_port">
<return type="void">
</return>
<argument index="0" name="p_index" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
@ -52,9 +52,9 @@
<method name="set_input_data_port_name">
<return type="void">
</return>
<argument index="0" name="p_index" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="p_name" type="String">
<argument index="1" name="name" type="String">
</argument>
<description>
</description>
@ -62,9 +62,9 @@
<method name="set_input_data_port_type">
<return type="void">
</return>
<argument index="0" name="p_index" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="p_type" type="int" enum="Variant.Type">
<argument index="1" name="type" type="int" enum="Variant.Type">
</argument>
<description>
</description>
@ -72,9 +72,9 @@
<method name="set_output_data_port_name">
<return type="void">
</return>
<argument index="0" name="p_index" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="p_name" type="String">
<argument index="1" name="name" type="String">
</argument>
<description>
</description>
@ -82,9 +82,9 @@
<method name="set_output_data_port_type">
<return type="void">
</return>
<argument index="0" name="p_index" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="p_type" type="int" enum="Variant.Type">
<argument index="1" name="type" type="int" enum="Variant.Type">
</argument>
<description>
</description>

16
modules/visual_script/visual_script_nodes.cpp
View file

@ -700,15 +700,15 @@ VisualScriptLists::VisualScriptLists() {
}
void VisualScriptLists::_bind_methods() {
ClassDB::bind_method(D_METHOD("add_input_data_port"), &VisualScriptLists::add_input_data_port);
ClassDB::bind_method(D_METHOD("set_input_data_port_name"), &VisualScriptLists::set_input_data_port_name);
ClassDB::bind_method(D_METHOD("set_input_data_port_type"), &VisualScriptLists::set_input_data_port_type);
ClassDB::bind_method(D_METHOD("remove_input_data_port"), &VisualScriptLists::remove_input_data_port);
ClassDB::bind_method(D_METHOD("add_input_data_port", "type", "name", "index"), &VisualScriptLists::add_input_data_port);
ClassDB::bind_method(D_METHOD("set_input_data_port_name", "index", "name"), &VisualScriptLists::set_input_data_port_name);
ClassDB::bind_method(D_METHOD("set_input_data_port_type", "index", "type"), &VisualScriptLists::set_input_data_port_type);
ClassDB::bind_method(D_METHOD("remove_input_data_port", "index"), &VisualScriptLists::remove_input_data_port);
ClassDB::bind_method(D_METHOD("add_output_data_port"), &VisualScriptLists::add_output_data_port);
ClassDB::bind_method(D_METHOD("set_output_data_port_name"), &VisualScriptLists::set_output_data_port_name);
ClassDB::bind_method(D_METHOD("set_output_data_port_type"), &VisualScriptLists::set_output_data_port_type);
ClassDB::bind_method(D_METHOD("remove_output_data_port"), &VisualScriptLists::remove_output_data_port);
ClassDB::bind_method(D_METHOD("add_output_data_port", "type", "name", "index"), &VisualScriptLists::add_output_data_port);
ClassDB::bind_method(D_METHOD("set_output_data_port_name", "index", "name"), &VisualScriptLists::set_output_data_port_name);
ClassDB::bind_method(D_METHOD("set_output_data_port_type", "index", "type"), &VisualScriptLists::set_output_data_port_type);
ClassDB::bind_method(D_METHOD("remove_output_data_port", "index"), &VisualScriptLists::remove_output_data_port);
}
//////////////////////////////////////////

1
scene/gui/rich_text_effect.cpp
View file

@ -119,6 +119,7 @@ CharFXTransform::CharFXTransform() {
offset = Point2();
color = Color();
character = 0;
elapsed_time = 0.0f;
}
CharFXTransform::~CharFXTransform() {

2
scene/gui/tree.cpp
View file

@ -800,7 +800,7 @@ void TreeItem::_bind_methods() {
ClassDB::bind_method(D_METHOD("add_button", "column", "button", "button_idx", "disabled", "tooltip"), &TreeItem::add_button, DEFVAL(-1), DEFVAL(false), DEFVAL(""));
ClassDB::bind_method(D_METHOD("get_button_count", "column"), &TreeItem::get_button_count);
ClassDB::bind_method(D_METHOD("get_button_tooltip", "column"), &TreeItem::get_button_tooltip);
ClassDB::bind_method(D_METHOD("get_button_tooltip", "column", "button_idx"), &TreeItem::get_button_tooltip);
ClassDB::bind_method(D_METHOD("get_button", "column", "button_idx"), &TreeItem::get_button);
ClassDB::bind_method(D_METHOD("set_button", "column", "button_idx", "button"), &TreeItem::set_button);
ClassDB::bind_method(D_METHOD("erase_button", "column", "button_idx"), &TreeItem::erase_button);

2
scene/resources/font.cpp
View file

@ -96,7 +96,7 @@ void Font::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_height"), &Font::get_height);
ClassDB::bind_method(D_METHOD("is_distance_field_hint"), &Font::is_distance_field_hint);
ClassDB::bind_method(D_METHOD("get_string_size", "string"), &Font::get_string_size);
ClassDB::bind_method(D_METHOD("get_wordwrap_string_size", "string", "p_width"), &Font::get_wordwrap_string_size);
ClassDB::bind_method(D_METHOD("get_wordwrap_string_size", "string", "width"), &Font::get_wordwrap_string_size);
ClassDB::bind_method(D_METHOD("has_outline"), &Font::has_outline);
ClassDB::bind_method(D_METHOD("draw_char", "canvas_item", "position", "char", "next", "modulate", "outline"), &Font::draw_char, DEFVAL(-1), DEFVAL(Color(1, 1, 1)), DEFVAL(false));
ClassDB::bind_method(D_METHOD("update_changes"), &Font::update_changes);