asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2019-06-01 12:34:29 +02:00
parent c34636cbc4
commit cfb9709c10
8 changed files with 44 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
doc/classes/Animation.xml
View file

@ -536,6 +536,19 @@
Set the interpolation type of a given track, from the INTERPOLATION_* enum.
</description>
</method>
<method name="track_set_key_time">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="time" type="float">
</argument>
<description>
Set the time of an existing key.
</description>
</method>
<method name="track_set_key_transition">
<return type="void">
</return>
@ -562,19 +575,6 @@
Set the value of an existing key.
</description>
</method>
<method name="track_set_key_time">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="time" type="float">
</argument>
<description>
Set the time of an existing key.
</description>
</method>
<method name="track_set_path">
<return type="void">
</return>

4
doc/classes/EditorPlugin.xml
View file

@ -525,6 +525,10 @@
</constant>
<constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="9" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_PROJECT_SETTING_TAB_LEFT" value="10" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_PROJECT_SETTING_TAB_RIGHT" value="11" enum="CustomControlContainer">
</constant>
<constant name="DOCK_SLOT_LEFT_UL" value="0" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_LEFT_BL" value="1" enum="DockSlot">

6
doc/classes/PopupMenu.xml
View file

@ -515,6 +515,9 @@
</method>
</methods>
<members>
<member name="allow_search" type="bool" setter="set_allow_search" getter="get_allow_search">
If [code]true[/code], allows to navigate [PopupMenu] with letter keys. Default value: [code]false[/code].
</member>
<member name="hide_on_checkable_item_selection" type="bool" setter="set_hide_on_checkable_item_selection" getter="is_hide_on_checkable_item_selection">
</member>
<member name="hide_on_item_selection" type="bool" setter="set_hide_on_item_selection" getter="is_hide_on_item_selection">
@ -524,9 +527,6 @@
<member name="submenu_popup_delay" type="float" setter="set_submenu_popup_delay" getter="get_submenu_popup_delay">
Sets the delay time for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. Default value: [code]0.3[/code] seconds.
</member>
<member name="allow_search" type="bool" setter="set_allow_search" getter="get_allow_search">
If [code]true[/code], allows to navigate [PopupMenu] with letter keys. Default value: [code]false[/code].
</member>
</members>
<signals>
<signal name="id_focused">

2
doc/classes/ProjectSettings.xml
View file

@ -410,6 +410,8 @@
<member name="editor/active" type="bool" setter="" getter="">
Internal editor setting, don't touch.
</member>
<member name="editor/search_in_file_extensions" type="PoolStringArray" setter="" getter="">
</member>
<member name="gui/common/default_scroll_deadzone" type="int" setter="" getter="">
</member>
<member name="gui/common/swap_ok_cancel" type="bool" setter="" getter="">

12
doc/classes/TileSet.xml
View file

@ -10,6 +10,18 @@
<tutorials>
</tutorials>
<methods>
<method name="_forward_atlas_subtile_selection" qualifiers="virtual">
<return type="Vector2">
</return>
<argument index="0" name="atlastile_id" type="int">
</argument>
<argument index="1" name="tilemap" type="Object">
</argument>
<argument index="2" name="tile_location" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="_forward_subtile_selection" qualifiers="virtual">
<return type="Vector2">
</return>

6
doc/classes/TreeItem.xml
View file

@ -163,8 +163,11 @@
<method name="get_next_visible">
<return type="TreeItem">
</return>
<argument index="0" name="wrap" type="bool" default="false">
</argument>
<description>
Returns the next visible TreeItem in the tree.
If [code]wrap[/code] is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns [code]null[/code].
</description>
</method>
<method name="get_parent">
@ -184,8 +187,11 @@
<method name="get_prev_visible">
<return type="TreeItem">
</return>
<argument index="0" name="wrap" type="bool" default="false">
</argument>
<description>
Returns the previous visible TreeItem in the tree.
If [code]wrap[/code] is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns [code]null[/code].
</description>
</method>
<method name="get_range" qualifiers="const">

4
doc/classes/Vector2.xml
View file

@ -188,9 +188,9 @@
<method name="move_toward">
<return type="Vector2">
</return>
<argument index="0" name="b" type="Vector2">
<argument index="0" name="to" type="Vector2">
</argument>
<argument index="1" name="t" type="float">
<argument index="1" name="delta" type="float">
</argument>
<description>
Moves the vector toward [code]to[/code] by the fixed [code]delta[/code] amount.

4
doc/classes/Vector3.xml
View file

@ -178,9 +178,9 @@
<method name="move_toward">
<return type="Vector3">
</return>
<argument index="0" name="b" type="Vector3">
<argument index="0" name="to" type="Vector3">
</argument>
<argument index="1" name="t" type="float">
<argument index="1" name="delta" type="float">
</argument>
<description>
Moves the vector toward [code]to[/code] by the fixed [code]delta[/code] amount.