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

Merge pull request #2646 from vnen/array-reference

Browse Source 
Add missing Array class reference documentation
This commit is contained in:
Rémi Verschelde
2015-11-01 20:33:57 +01:00
parent 61ecb6a5e6 baa59c0670
commit ae3d4ac193
1 changed files with 250 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

225
doc/base/classes.xml
View File

@ -3766,6 +3766,7 @@
<argument index="0" name="value" type="var"> <argument index="0" name="value" type="var">
</argument> </argument>
<description> <description>
Append an element at the end of the array (alias of [method push_back]).
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
@ -3784,6 +3785,7 @@
<argument index="0" name="value" type="var"> <argument index="0" name="value" type="var">
</argument> </argument>
<description> <description>
Remove the first occurence of a value from the array.
</description> </description>
</method> </method>
<method name="find"> <method name="find">
@ -3792,6 +3794,7 @@
<argument index="0" name="value" type="var"> <argument index="0" name="value" type="var">
</argument> </argument>
<description> <description>
Searches the array for a value and returns its index or -1 if not found.
</description> </description>
</method> </method>
<method name="hash"> <method name="hash">
@ -3812,12 +3815,14 @@
</method> </method>
<method name="invert"> <method name="invert">
<description> <description>
Reverse the order of the elements in the array (so first element will now be the last).
</description> </description>
</method> </method>
<method name="is_shared"> <method name="is_shared">
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Get whether this is a shared array instance.
</description> </description>
</method> </method>
<method name="push_back"> <method name="push_back">
@ -3850,6 +3855,7 @@
</method> </method>
<method name="sort"> <method name="sort">
<description> <description>
Sort the array using natural order.
</description> </description>
</method> </method>
<method name="sort_custom"> <method name="sort_custom">
@ -3858,6 +3864,7 @@
<argument index="1" name="func" type="String"> <argument index="1" name="func" type="String">
</argument> </argument>
<description> <description>
Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise.
</description> </description>
</method> </method>
<method name="Array"> <method name="Array">
@ -10867,27 +10874,25 @@
</description> </description>
<methods> <methods>
<method name="call_func"> <method name="call_func">
<argument index="0" name="method" type="String"> <argument index="0" name="arg0" type="var" default="NULL">
</argument> </argument>
<argument index="1" name="arg0" type="var" default="NULL"> <argument index="1" name="arg1" type="var" default="NULL">
</argument> </argument>
<argument index="2" name="arg1" type="var" default="NULL"> <argument index="2" name="arg2" type="var" default="NULL">
</argument> </argument>
<argument index="3" name="arg2" type="var" default="NULL"> <argument index="3" name="arg3" type="var" default="NULL">
</argument> </argument>
<argument index="4" name="arg3" type="var" default="NULL"> <argument index="4" name="arg4" type="var" default="NULL">
</argument> </argument>
<argument index="5" name="arg4" type="var" default="NULL"> <argument index="5" name="arg5" type="var" default="NULL">
</argument> </argument>
<argument index="6" name="arg5" type="var" default="NULL"> <argument index="6" name="arg6" type="var" default="NULL">
</argument> </argument>
<argument index="7" name="arg6" type="var" default="NULL"> <argument index="7" name="arg7" type="var" default="NULL">
</argument> </argument>
<argument index="8" name="arg7" type="var" default="NULL"> <argument index="8" name="arg8" type="var" default="NULL">
</argument> </argument>
<argument index="9" name="arg8" type="var" default="NULL"> <argument index="9" name="arg9" type="var" default="NULL">
</argument>
<argument index="10" name="arg9" type="var" default="NULL">
</argument> </argument>
<description> <description>
</description> </description>
@ -11629,6 +11634,24 @@
</method> </method>
</methods> </methods>
<signals> <signals>
<signal name="delete_nodes_request">
<description>
</description>
</signal>
<signal name="duplicate_nodes_request">
<description>
</description>
</signal>
<signal name="popup_request">
<argument index="0" name="p_position" type="Vector2">
</argument>
<description>
</description>
</signal>
<signal name="_begin_node_move">
<description>
</description>
</signal>
<signal name="disconnection_request"> <signal name="disconnection_request">
<argument index="0" name="from" type="String"> <argument index="0" name="from" type="String">
</argument> </argument>
@ -11655,6 +11678,10 @@
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created.
</description> </description>
</signal> </signal>
<signal name="_end_node_move">
<description>
</description>
</signal>
</signals> </signals>
<constants> <constants>
</constants> </constants>
@ -11910,6 +11937,12 @@
</theme_item> </theme_item>
<theme_item name="frame" type="StyleBox"> <theme_item name="frame" type="StyleBox">
</theme_item> </theme_item>
<theme_item name="selectedframe" type="StyleBox">
</theme_item>
<theme_item name="defaultfocus" type="StyleBox">
</theme_item>
<theme_item name="defaultframe" type="StyleBox">
</theme_item>
</theme_items> </theme_items>
</class> </class>
<class name="GridContainer" inherits="Container" category="Core"> <class name="GridContainer" inherits="Container" category="Core">
@ -14292,6 +14325,22 @@
<constants> <constants>
</constants> </constants>
</class> </class>
<class name="InstancePlaceholder" inherits="Node" category="Core">
<brief_description>
</brief_description>
<description>
</description>
<methods>
<method name="replace_by_instance">
<argument index="0" name="custom_scene" type="PackedScene" default="NULL">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>
<class name="IntArray" category="Built-In Types"> <class name="IntArray" category="Built-In Types">
<brief_description> <brief_description>
Integer Array. Integer Array.
@ -18124,7 +18173,11 @@
<method name="find_node" qualifiers="const"> <method name="find_node" qualifiers="const">
<return type="Node"> <return type="Node">
</return> </return>
<argument index="0" name="mask" type="NodePath" default="true"> <argument index="0" name="mask" type="String">
</argument>
<argument index="1" name="recursive" type="bool" default="true">
</argument>
<argument index="2" name="owned" type="bool" default="true">
</argument> </argument>
<description> <description>
</description> </description>
@ -20171,7 +20224,7 @@
<method name="instance" qualifiers="const"> <method name="instance" qualifiers="const">
<return type="Node"> <return type="Node">
</return> </return>
<argument index="0" name="arg0" type="bool" default="false"> <argument index="0" name="gen_edit_state" type="bool" default="false">
</argument> </argument>
<description> <description>
</description> </description>
@ -20421,6 +20474,18 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_ignore_camera_zoom">
<argument index="0" name="arg0" type="bool">
</argument>
<description>
</description>
</method>
<method name="is_ignore_camera_zoom">
<return type="bool">
</return>
<description>
</description>
</method>
</methods> </methods>
<constants> <constants>
</constants> </constants>
@ -24688,6 +24753,18 @@
Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space. Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space.
</description> </description>
<methods> <methods>
<method name="set_softness">
<argument index="0" name="softness" type="float">
</argument>
<description>
</description>
</method>
<method name="get_softness" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
</methods> </methods>
<constants> <constants>
</constants> </constants>
@ -26292,6 +26369,18 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_type_mask">
<argument index="0" name="mask" type="int">
</argument>
<description>
</description>
</method>
<method name="get_type_mask" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
</methods> </methods>
<constants> <constants>
</constants> </constants>
@ -29446,6 +29535,28 @@
<description> <description>
</description> </description>
</method> </method>
<method name="default_set_value">
<argument index="0" name="shader_type" type="int">
</argument>
<argument index="1" name="id" type="int">
</argument>
<argument index="2" name="param_id" type="int">
</argument>
<argument index="3" name="value" type="var">
</argument>
<description>
</description>
</method>
<method name="default_get_value">
<argument index="0" name="shader_type" type="int">
</argument>
<argument index="1" name="id" type="int">
</argument>
<argument index="2" name="param_id" type="int">
</argument>
<description>
</description>
</method>
<method name="scalar_const_node_set_value"> <method name="scalar_const_node_set_value">
<argument index="0" name="shader_type" type="int"> <argument index="0" name="shader_type" type="int">
</argument> </argument>
@ -33549,6 +33660,12 @@
</method> </method>
</methods> </methods>
<signals> <signals>
<signal name="tab_close">
<argument index="0" name="tab" type="int">
</argument>
<description>
</description>
</signal>
<signal name="right_button_pressed"> <signal name="right_button_pressed">
<argument index="0" name="tab" type="int"> <argument index="0" name="tab" type="int">
</argument> </argument>
@ -33569,6 +33686,14 @@
</constant> </constant>
<constant name="ALIGN_RIGHT" value="2"> <constant name="ALIGN_RIGHT" value="2">
</constant> </constant>
<constant name="SHOW_ACTIVE_ONLY" value="1">
</constant>
<constant name="SHOW_ALWAYS" value="0">
</constant>
<constant name="SHOW_HOVER" value="2">
</constant>
<constant name="SHOW_NEVER" value="3">
</constant>
</constants> </constants>
<theme_items> <theme_items>
<theme_item name="label_valign_fg" type="int"> <theme_item name="label_valign_fg" type="int">
@ -34262,8 +34387,68 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_fill_mode">
<argument index="0" name="mode" type="int">
</argument>
<description>
</description>
</method>
<method name="get_fill_mode">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_radial_initial_angle">
<argument index="0" name="mode" type="float">
</argument>
<description>
</description>
</method>
<method name="get_radial_initial_angle">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_radial_center_offset">
<argument index="0" name="mode" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="get_radial_center_offset">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="set_fill_degrees">
<argument index="0" name="mode" type="float">
</argument>
<description>
</description>
</method>
<method name="get_fill_degrees">
<return type="float">
</return>
<description>
</description>
</method>
</methods> </methods>
<constants> <constants>
<constant name="FILL_LEFT_TO_RIGHT" value="0">
</constant>
<constant name="FILL_RIGHT_TO_LEFT" value="1">
</constant>
<constant name="FILL_TOP_TO_BOTTOM" value="2">
</constant>
<constant name="FILL_BOTTOM_TO_TOP" value="3">
</constant>
<constant name="FILL_CLOCKWISE" value="4">
</constant>
<constant name="FILL_COUNTER_CLOCKWISE" value="5">
</constant>
</constants> </constants>
</class> </class>
<class name="Theme" inherits="Resource" category="Core"> <class name="Theme" inherits="Resource" category="Core">
@ -37272,6 +37457,12 @@
<description> <description>
</description> </description>
</method> </method>
<method name="ceil">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="cross"> <method name="cross">
<return type="Vector3"> <return type="Vector3">
</return> </return>
@ -37323,6 +37514,12 @@
Return the dot product with b. Return the dot product with b.
</description> </description>
</method> </method>
<method name="floor">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="inverse"> <method name="inverse">
<return type="Vector3"> <return type="Vector3">
</return> </return>