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

doc: Sync classref with current source

This commit is contained in:
Rémi Verschelde 2019-05-15 12:51:58 +02:00
parent 27a3557a75
commit 30da18c01a
9 changed files with 42 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/@GDScript.xml
View File

@ -259,12 +259,12 @@
</description>
</method>
<method name="decimals">
<return type="float">
<return type="int">
</return>
<argument index="0" name="step" type="float">
</argument>
<description>
Deprecated alias for "[method step_decimals]".
Deprecated alias for "[method step_decimals]".
</description>
</method>
<method name="dectime">
@ -1020,7 +1020,7 @@
</description>
</method>
<method name="step_decimals">
<return type="float">
<return type="int">
</return>
<argument index="0" name="step" type="float">
</argument>

6
doc/classes/BaseButton.xml
View File

@ -57,6 +57,9 @@
<member name="group" type="ButtonGroup" setter="set_button_group" getter="get_button_group">
[ButtonGroup] associated to the button.
</member>
<member name="keep_pressed_outside" type="bool" setter="set_keep_pressed_outside" getter="is_keep_pressed_outside">
If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it. Default value: [code]false[/code].
</member>
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active).
</member>
@ -69,9 +72,6 @@
<member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode">
If [code]true[/code], the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.
</member>
<member name="keep_pressed_outside" type="bool" setter="set_keep_pressed_outside" getter="is_keep_pressed_outside">
If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it. Default value: [code]false[/code].
</member>
</members>
<signals>
<signal name="button_down">

4
doc/classes/CheckButton.xml
View File

@ -41,8 +41,12 @@
</theme_item>
<theme_item name="off" type="Texture">
</theme_item>
<theme_item name="off_disabled" type="Texture">
</theme_item>
<theme_item name="on" type="Texture">
</theme_item>
<theme_item name="on_disabled" type="Texture">
</theme_item>
<theme_item name="pressed" type="StyleBox">
</theme_item>
</theme_items>

10
doc/classes/Font.xml
View File

@ -77,6 +77,16 @@
Return the size of a string, taking kerning and advance into account.
</description>
</method>
<method name="get_wordwrap_string_size" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="string" type="String">
</argument>
<argument index="1" name="p_width" type="float">
</argument>
<description>
</description>
</method>
<method name="has_outline" qualifiers="const">
<return type="bool">
</return>

6
doc/classes/FuncRef.xml
View File

@ -17,6 +17,12 @@
Calls the referenced function previously set by [method set_function] or [method @GDScript.funcref].
</description>
</method>
<method name="is_valid" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_function">
<return type="void">
</return>

2
doc/classes/MultiMesh.xml
View File

@ -59,7 +59,7 @@
<method name="set_as_bulk_array">
<return type="void">
</return>
<argument index="0" name="arg0" type="PoolRealArray">
<argument index="0" name="array" type="PoolRealArray">
</argument>
<description>
Set all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.

4
doc/classes/OptionButton.xml
View File

@ -202,14 +202,14 @@
</members>
<signals>
<signal name="item_focused">
<argument index="0" name="ID" type="int">
<argument index="0" name="id" type="int">
</argument>
<description>
This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument.
</description>
</signal>
<signal name="item_selected">
<argument index="0" name="ID" type="int">
<argument index="0" name="id" type="int">
</argument>
<description>
This signal is emitted when the current item was changed by the user. Index of the item selected is passed as argument.

4
doc/classes/PopupMenu.xml
View File

@ -527,14 +527,14 @@
</members>
<signals>
<signal name="id_focused">
<argument index="0" name="ID" type="int">
<argument index="0" name="id" type="int">
</argument>
<description>
This event is emitted when user navigated to an item of some id using [code]ui_up[/code] or [code]ui_down[/code] action.
</description>
</signal>
<signal name="id_pressed">
<argument index="0" name="ID" type="int">
<argument index="0" name="id" type="int">
</argument>
<description>
This event is emitted when an item of some id is pressed or its accelerator is activated.

22
doc/classes/VisualServer.xml
View File

@ -2003,17 +2003,6 @@
<description>
</description>
</method>
<method name="light_set_use_gi">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Sets whether GI probes capture light information from this light.
</description>
</method>
<method name="light_set_color">
<return type="void">
</return>
@ -2096,6 +2085,17 @@
<description>
</description>
</method>
<method name="light_set_use_gi">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description>
Sets whether GI probes capture light information from this light.
</description>
</method>
<method name="lightmap_capture_create">
<return type="RID">
</return>