Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-10 14:12:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

classref: Sync with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2017-10-21 12:02:08 +02:00
parent 722a2bb9db
commit 8652c1d5b1
15 changed files with 2137 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/@Global Scope.xml
View File

@ -29,6 +29,8 @@
<member name="Geometry" type="Geometry" setter="" getter="">
[Geometry] singleton
</member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
</member>
<member name="IP" type="IP" setter="" getter="">
[IP] singleton
</member>

4
doc/classes/EditorScript.xml
View File

@ -4,7 +4,7 @@
Base script that can be used to add extension functions to the editor.
</brief_description>
<description>
Scripts extending this class and implementing its [code]_run()[/code] method can be executed from the Script Editor's [code]File -> Run[/code] menu option (or by pressing [code]CTRL+Shift+X[/code]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using [EditorPlugin]\ s instead. Note that extending scripts need to have [code]tool mode[/code] enabled.
Scripts extending this class and implementing its [code]_run()[/code] method can be executed from the Script Editor's [code]File -&gt; Run[/code] menu option (or by pressing [code]CTRL+Shift+X[/code]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using [EditorPlugin]\ s instead. Note that extending scripts need to have [code]tool mode[/code] enabled.
Example script:
[codeblock]
tool
@ -24,7 +24,7 @@
<return type="void">
</return>
<description>
This method is executed by the Editor when [code]File -> Run[/code] is used.
This method is executed by the Editor when [code]File -&gt; Run[/code] is used.
</description>
</method>
<method name="add_root_node">

4
doc/classes/GraphEdit.xml
View File

@ -228,8 +228,6 @@
<constants>
</constants>
<theme_items>
<theme_item name="SnapGrid" type="Texture">
</theme_item>
<theme_item name="bezier_len_neg" type="int">
</theme_item>
<theme_item name="bezier_len_pos" type="int">
@ -246,5 +244,7 @@
</theme_item>
<theme_item name="reset" type="Texture">
</theme_item>
<theme_item name="snap" type="Texture">
</theme_item>
</theme_items>
</class>

21
doc/classes/PhysicsServer.xml
View File

@ -376,14 +376,15 @@
</argument>
<description>
Returns the physics layer or layers a body can collide with.
- </description>
- </method>
- <method name="body_get_direct_state">
- <return type="PhysicsDirectBodyState">
- </return>
- <argument index="0" name="body" type="RID">
- </argument>
- <description>
-
</description>
</method>
<method name="body_get_direct_state">
<return type="PhysicsDirectBodyState">
</return>
<argument index="0" name="body" type="RID">
</argument>
<description>
Returns the [PhysicsDirectBodyState] of the body.
</description>
</method>
@ -534,7 +535,7 @@
<argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxisLock">
</argument>
<description>
Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality.
Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality.
</description>
</method>
<method name="body_set_axis_velocity">
@ -746,7 +747,7 @@
</argument>
<argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag">
</argument>
<description>
<description>
Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants).
</description>
</method>

15
doc/classes/PluginScript.xml Normal file
View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PluginScript" inherits="Script" category="Core" version="3.0.alpha.custom_build">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<constants>
</constants>
</class>

16
doc/classes/RichTextLabel.xml
View File

@ -102,6 +102,12 @@
<description>
</description>
</method>
<method name="is_overriding_selected_font_color" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_scroll_active" qualifiers="const">
<return type="bool">
</return>
@ -247,6 +253,14 @@
<description>
</description>
</method>
<method name="set_override_selected_font_color">
<return type="void">
</return>
<argument index="0" name="override" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_percent_visible">
<return type="void">
</return>
@ -330,6 +344,8 @@
</member>
<member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode">
</member>
<member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color">
</member>
<member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible">
</member>
<member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters">

8
doc/classes/SceneTree.xml
View File

@ -313,7 +313,7 @@
</argument>
<argument index="2" name="minsize" type="Vector2">
</argument>
<argument index="3" name="shrink" type="int" default="1">
<argument index="3" name="shrink" type="float" default="1">
</argument>
<description>
</description>
@ -352,6 +352,12 @@
<description>
</description>
</signal>
<signal name="node_added">
<argument index="0" name="node" type="Object">
</argument>
<description>
</description>
</signal>
<signal name="node_configuration_warning_changed">
<argument index="0" name="node" type="Object">
</argument>

2
doc/classes/StyleBoxFlat.xml
View File

@ -202,7 +202,7 @@
</argument>
<argument index="1" name="radius_top_right" type="int">
</argument>
<argument index="2" name="radius_botton_right" type="int">
<argument index="2" name="radius_bottom_right" type="int">
</argument>
<argument index="3" name="radius_bottom_left" type="int">
</argument>

16
doc/classes/TextEdit.xml
View File

@ -239,6 +239,12 @@
Returns true if highlight all occurrences is enabled.
</description>
</method>
<method name="is_overriding_selected_font_color" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_selection_active" qualifiers="const">
<return type="bool">
</return>
@ -343,6 +349,14 @@
Set the maximum amount of characters editable.
</description>
</method>
<method name="set_override_selected_font_color">
<return type="void">
</return>
<argument index="0" name="override" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_readonly">
<return type="void">
</return>
@ -421,6 +435,8 @@
</member>
<member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled">
</member>
<member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color">
</member>
<member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled">
</member>
<member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled">

66
doc/classes/VisualScriptBuiltinFunc.xml
View File

@ -114,97 +114,101 @@
<constant name="MATH_LERP" value="26">
Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code].
</constant>
<constant name="MATH_DECTIME" value="27">
<constant name="MATH_INVERSE_LERP" value="27">
</constant>
<constant name="MATH_RANGE_LERP" value="28">
</constant>
<constant name="MATH_DECTIME" value="29">
Return the result of 'value' decreased by 'step' * 'amount'.
</constant>
<constant name="MATH_RANDOMIZE" value="28">
<constant name="MATH_RANDOMIZE" value="30">
Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
</constant>
<constant name="MATH_RAND" value="29">
<constant name="MATH_RAND" value="31">
Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function.
</constant>
<constant name="MATH_RANDF" value="30">
<constant name="MATH_RANDF" value="32">
Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication.
</constant>
<constant name="MATH_RANDOM" value="31">
<constant name="MATH_RANDOM" value="33">
Return a random floating-point value between the two inputs.
</constant>
<constant name="MATH_SEED" value="32">
<constant name="MATH_SEED" value="34">
Set the seed for the random number generator.
</constant>
<constant name="MATH_RANDSEED" value="33">
<constant name="MATH_RANDSEED" value="35">
Return a random value from the given seed, along with the new seed.
</constant>
<constant name="MATH_DEG2RAD" value="34">
<constant name="MATH_DEG2RAD" value="36">
Convert the input from degrees to radians.
</constant>
<constant name="MATH_RAD2DEG" value="35">
<constant name="MATH_RAD2DEG" value="37">
Convert the input from radians to degrees.
</constant>
<constant name="MATH_LINEAR2DB" value="36">
<constant name="MATH_LINEAR2DB" value="38">
Convert the input from linear volume to decibel volume.
</constant>
<constant name="MATH_DB2LINEAR" value="37">
<constant name="MATH_DB2LINEAR" value="39">
Convert the input from decibel volume to linear volume.
</constant>
<constant name="LOGIC_MAX" value="38">
<constant name="LOGIC_MAX" value="40">
Return the greater of the two numbers, also known as their maximum.
</constant>
<constant name="LOGIC_MIN" value="39">
<constant name="LOGIC_MIN" value="41">
Return the lesser of the two numbers, also known as their minimum.
</constant>
<constant name="LOGIC_CLAMP" value="40">
<constant name="LOGIC_CLAMP" value="42">
Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)`
</constant>
<constant name="LOGIC_NEAREST_PO2" value="41">
<constant name="LOGIC_NEAREST_PO2" value="43">
Return the nearest power of 2 to the input.
</constant>
<constant name="OBJ_WEAKREF" value="42">
<constant name="OBJ_WEAKREF" value="44">
Create a [WeakRef] from the input.
</constant>
<constant name="FUNC_FUNCREF" value="43">
<constant name="FUNC_FUNCREF" value="45">
Create a [FuncRef] from the input.
</constant>
<constant name="TYPE_CONVERT" value="44">
<constant name="TYPE_CONVERT" value="46">
Convert between types.
</constant>
<constant name="TYPE_OF" value="45">
<constant name="TYPE_OF" value="47">
Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned.
</constant>
<constant name="TYPE_EXISTS" value="46">
<constant name="TYPE_EXISTS" value="48">
Checks if a type is registered in the [ClassDB].
</constant>
<constant name="TEXT_CHAR" value="47">
<constant name="TEXT_CHAR" value="49">
Return a character with the given ascii value.
</constant>
<constant name="TEXT_STR" value="48">
<constant name="TEXT_STR" value="50">
Convert the input to a string.
</constant>
<constant name="TEXT_PRINT" value="49">
<constant name="TEXT_PRINT" value="51">
Print the given string to the output window.
</constant>
<constant name="TEXT_PRINTERR" value="50">
<constant name="TEXT_PRINTERR" value="52">
Print the given string to the standard error output.
</constant>
<constant name="TEXT_PRINTRAW" value="51">
<constant name="TEXT_PRINTRAW" value="53">
Print the given string to the standard output, without adding a newline.
</constant>
<constant name="VAR_TO_STR" value="52">
<constant name="VAR_TO_STR" value="54">
Serialize a [Variant] to a string.
</constant>
<constant name="STR_TO_VAR" value="53">
<constant name="STR_TO_VAR" value="55">
Deserialize a [Variant] from a string serialized using [VAR_TO_STR].
</constant>
<constant name="VAR_TO_BYTES" value="54">
<constant name="VAR_TO_BYTES" value="56">
Serialize a [Variant] to a [PoolByteArray].
</constant>
<constant name="BYTES_TO_VAR" value="55">
<constant name="BYTES_TO_VAR" value="57">
Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES].
</constant>
<constant name="COLORN" value="56">
<constant name="COLORN" value="58">
Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
</constant>
<constant name="FUNC_MAX" value="57">
<constant name="FUNC_MAX" value="59">
The maximum value the [member function] property can have.
</constant>
</constants>

2
doc/classes/VisualScriptSequence.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Executes a series of Sequence ports.
Executes a series of Sequence ports.
</brief_description>
<description>
Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item.

2006
doc/classes/VisualServer.xml
View File

File diff suppressed because it is too large Load Diff

9
modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml
View File

@ -11,15 +11,6 @@
<demos>
</demos>
<methods>
<method name="set_gdnative_library">
<return type="void">
</return>
<argument index="0" name="library" type="GDNativeLibrary">
</argument>
<description>
Bind this GDNative library to our interface. The library must be a GDNative ARVR Interface for this to work.
</description>
</method>
</methods>
<constants>
</constants>

6
modules/gdnative/doc_classes/GDNative.xml
View File

@ -12,11 +12,11 @@
<method name="call_native">
<return type="Variant">
</return>
<argument index="0" name="procedure_name" type="String">
<argument index="0" name="calling_type" type="String">
</argument>
<argument index="1" name="arguments" type="String">
<argument index="1" name="procedure_name" type="String">
</argument>
<argument index="2" name="arg2" type="Array">
<argument index="2" name="arguments" type="Array">
</argument>
<description>
</description>

20
modules/gridmap/doc_classes/GridMap.xml
View File

@ -103,6 +103,18 @@
Array of [Vector3] with the non empty cell coordinates in the grid map.
</description>
</method>
<method name="map_to_world" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<description>
</description>
</method>
<method name="resource_changed">
<return type="void">
</return>
@ -198,6 +210,14 @@
Sets the collection of meshes for the map.
</description>
</method>
<method name="world_to_map" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="pos" type="Vector3">
</argument>
<description>
</description>
</method>
</methods>
<constants>
<constant name="INVALID_CELL_ITEM" value="-1" enum="">