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

Sync classref with current source

Browse Source 
Also fix binding of Basis.slerp
This commit is contained in:
Rémi Verschelde 2018-05-28 14:53:15 +02:00
parent ddc24347ba
commit 4c5dd51eb9
24 changed files with 407 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/variant_call.cpp
View File

@ -763,6 +763,7 @@ struct _VariantCall {
VCALL_PTR1R(Basis, xform_inv); VCALL_PTR1R(Basis, xform_inv);
VCALL_PTR0R(Basis, get_orthogonal_index); VCALL_PTR0R(Basis, get_orthogonal_index);
VCALL_PTR0R(Basis, orthonormalized); VCALL_PTR0R(Basis, orthonormalized);
VCALL_PTR2R(Basis, slerp);
VCALL_PTR0R(Transform, inverse); VCALL_PTR0R(Transform, inverse);
VCALL_PTR0R(Transform, affine_inverse); VCALL_PTR0R(Transform, affine_inverse);
@ -1803,6 +1804,7 @@ void register_variant_methods() {
ADDFUNC1R(BASIS, VECTOR3, Basis, xform, VECTOR3, "v", varray()); ADDFUNC1R(BASIS, VECTOR3, Basis, xform, VECTOR3, "v", varray());
ADDFUNC1R(BASIS, VECTOR3, Basis, xform_inv, VECTOR3, "v", varray()); ADDFUNC1R(BASIS, VECTOR3, Basis, xform_inv, VECTOR3, "v", varray());
ADDFUNC0R(BASIS, INT, Basis, get_orthogonal_index, varray()); ADDFUNC0R(BASIS, INT, Basis, get_orthogonal_index, varray());
ADDFUNC2R(BASIS, BASIS, Basis, slerp, BASIS, "b", REAL, "t", varray());
ADDFUNC0R(TRANSFORM, TRANSFORM, Transform, inverse, varray()); ADDFUNC0R(TRANSFORM, TRANSFORM, Transform, inverse, varray());
ADDFUNC0R(TRANSFORM, TRANSFORM, Transform, affine_inverse, varray()); ADDFUNC0R(TRANSFORM, TRANSFORM, Transform, affine_inverse, varray());

8
doc/classes/AnimationTreePlayer.xml
View File

@ -50,6 +50,14 @@
Returns the name of the [member master_player]'s [Animation] bound to this animation node. Returns the name of the [member master_player]'s [Animation] bound to this animation node.
</description> </description>
</method> </method>
<method name="animation_node_get_position" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="id" type="String">
</argument>
<description>
</description>
</method>
<method name="animation_node_set_animation"> <method name="animation_node_set_animation">
<return type="void"> <return type="void">
</return> </return>

2
doc/classes/ColorPickerButton.xml
View File

@ -11,7 +11,7 @@
<demos> <demos>
</demos> </demos>
<methods> <methods>
<method name="get_picker" qualifiers="const"> <method name="get_picker">
<return type="ColorPicker"> <return type="ColorPicker">
</return> </return>
<description> <description>

37
doc/classes/EditorInspector.xml Normal file
View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorInspector" inherits="ScrollContainer" category="Core" version="3.1">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<signals>
<signal name="object_id_selected">
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</signal>
<signal name="property_keyed">
<argument index="0" name="property" type="String">
</argument>
<description>
</description>
</signal>
<signal name="resource_selected">
<argument index="0" name="res" type="Object">
</argument>
<argument index="1" name="prop" type="String">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

95
doc/classes/EditorInspectorPlugin.xml Normal file
View File

@ -0,0 +1,95 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorInspectorPlugin" inherits="Reference" category="Core" version="3.1">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="add_custom_control">
<return type="void">
</return>
<argument index="0" name="control" type="Control">
</argument>
<description>
</description>
</method>
<method name="add_property_editor">
<return type="void">
</return>
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="editor" type="Control">
</argument>
<description>
</description>
</method>
<method name="add_property_editor_for_multiple_properties">
<return type="void">
</return>
<argument index="0" name="label" type="String">
</argument>
<argument index="1" name="properties" type="PoolStringArray">
</argument>
<argument index="2" name="editor" type="Control">
</argument>
<description>
</description>
</method>
<method name="can_handle" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="object" type="Object">
</argument>
<description>
</description>
</method>
<method name="parse_begin" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="object" type="Object">
</argument>
<description>
</description>
</method>
<method name="parse_category" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="category" type="String">
</argument>
<description>
</description>
</method>
<method name="parse_end" qualifiers="virtual">
<return type="void">
</return>
<description>
</description>
</method>
<method name="parse_property" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="type" type="int">
</argument>
<argument index="2" name="path" type="String">
</argument>
<argument index="3" name="hint" type="int">
</argument>
<argument index="4" name="hint_text" type="String">
</argument>
<argument index="5" name="usage" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

26
doc/classes/EditorPlugin.xml
View File

@ -81,7 +81,7 @@
<method name="add_export_plugin"> <method name="add_export_plugin">
<return type="void"> <return type="void">
</return> </return>
<argument index="0" name="exporter" type="EditorExportPlugin"> <argument index="0" name="plugin" type="EditorExportPlugin">
</argument> </argument>
<description> <description>
</description> </description>
@ -94,6 +94,14 @@
<description> <description>
</description> </description>
</method> </method>
<method name="add_inspector_plugin">
<return type="void">
</return>
<argument index="0" name="plugin" type="EditorInspectorPlugin">
</argument>
<description>
</description>
</method>
<method name="add_scene_import_plugin"> <method name="add_scene_import_plugin">
<return type="void"> <return type="void">
</return> </return>
@ -135,6 +143,12 @@
This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object.
</description> </description>
</method> </method>
<method name="build" qualifiers="virtual">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="clear" qualifiers="virtual"> <method name="clear" qualifiers="virtual">
<return type="void"> <return type="void">
</return> </return>
@ -341,7 +355,7 @@
<method name="remove_export_plugin"> <method name="remove_export_plugin">
<return type="void"> <return type="void">
</return> </return>
<argument index="0" name="exporter" type="EditorExportPlugin"> <argument index="0" name="plugin" type="EditorExportPlugin">
</argument> </argument>
<description> <description>
</description> </description>
@ -354,6 +368,14 @@
<description> <description>
</description> </description>
</method> </method>
<method name="remove_inspector_plugin">
<return type="void">
</return>
<argument index="0" name="plugin" type="EditorInspectorPlugin">
</argument>
<description>
</description>
</method>
<method name="remove_scene_import_plugin"> <method name="remove_scene_import_plugin">
<return type="void"> <return type="void">
</return> </return>

111
doc/classes/EditorProperty.xml Normal file
View File

@ -0,0 +1,111 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorProperty" inherits="Container" category="Core" version="3.1">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_edited_object">
<return type="Object">
</return>
<description>
</description>
</method>
<method name="get_edited_property">
<return type="String">
</return>
<description>
</description>
</method>
<method name="update_property" qualifiers="virtual">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="checkable" type="bool" setter="set_checkable" getter="is_checkable">
</member>
<member name="checked" type="bool" setter="set_checked" getter="is_checked">
</member>
<member name="draw_red" type="bool" setter="set_draw_red" getter="is_draw_red">
</member>
<member name="keying" type="bool" setter="set_keying" getter="is_keying">
</member>
<member name="label" type="String" setter="set_label" getter="get_label">
</member>
<member name="read_only" type="bool" setter="set_read_only" getter="is_read_only">
</member>
</members>
<signals>
<signal name="multiple_properties_changed">
<argument index="0" name="properties" type="PoolStringArray">
</argument>
<argument index="1" name="value" type="Array">
</argument>
<description>
</description>
</signal>
<signal name="object_id_selected">
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="id" type="int">
</argument>
<description>
</description>
</signal>
<signal name="property_changed">
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="value" type="Nil">
</argument>
<description>
</description>
</signal>
<signal name="property_checked">
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="bool" type="String">
</argument>
<description>
</description>
</signal>
<signal name="property_keyed">
<argument index="0" name="property" type="String">
</argument>
<description>
</description>
</signal>
<signal name="property_keyed_with_value">
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="value" type="Nil">
</argument>
<description>
</description>
</signal>
<signal name="resource_selected">
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="resource" type="Object">
</argument>
<description>
</description>
</signal>
<signal name="selected">
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="focusable_idx" type="int">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

4
doc/classes/EditorSettings.xml
View File

@ -67,7 +67,7 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_project_settings_dir"> <method name="get_project_settings_dir" qualifiers="const">
<return type="String"> <return type="String">
</return> </return>
<description> <description>
@ -144,6 +144,8 @@
</description> </description>
</method> </method>
<method name="set_project_metadata"> <method name="set_project_metadata">
<return type="void">
</return>
<argument index="0" name="section" type="String"> <argument index="0" name="section" type="String">
</argument> </argument>
<argument index="1" name="key" type="String"> <argument index="1" name="key" type="String">

16
doc/classes/PhysicalBone.xml
View File

@ -9,12 +9,24 @@
<demos> <demos>
</demos> </demos>
<methods> <methods>
<method name="get_simulate_physics">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_simulating_physics"> <method name="is_simulating_physics">
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
</description> </description>
</method> </method>
<method name="is_static_body">
<return type="bool">
</return>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="body_offset" type="Transform" setter="set_body_offset" getter="get_body_offset"> <member name="body_offset" type="Transform" setter="set_body_offset" getter="get_body_offset">
@ -31,10 +43,6 @@
</member> </member>
<member name="mass" type="float" setter="set_mass" getter="get_mass"> <member name="mass" type="float" setter="set_mass" getter="get_mass">
</member> </member>
<member name="simulate_physics" type="bool" setter="set_simulate_physics" getter="get_simulate_physics">
</member>
<member name="static_body" type="bool" setter="set_static_body" getter="is_static_body">
</member>
<member name="weight" type="float" setter="set_weight" getter="get_weight"> <member name="weight" type="float" setter="set_weight" getter="get_weight">
</member> </member>
</members> </members>

22
doc/classes/Physics2DServer.xml
View File

@ -140,6 +140,18 @@
Removes a shape from an area. It does not delete the shape, so it can be reassigned later. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
</description> </description>
</method> </method>
<method name="area_set_area_monitor_callback">
<return type="void">
</return>
<argument index="0" name="area" type="RID">
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
</argument>
<description>
</description>
</method>
<method name="area_set_collision_layer"> <method name="area_set_collision_layer">
<return type="void"> <return type="void">
</return> </return>
@ -180,6 +192,16 @@
5: The shape index of the area where the object entered/exited. 5: The shape index of the area where the object entered/exited.
</description> </description>
</method> </method>
<method name="area_set_monitorable">
<return type="void">
</return>
<argument index="0" name="area" type="RID">
</argument>
<argument index="1" name="monitorable" type="bool">
</argument>
<description>
</description>
</method>
<method name="area_set_param"> <method name="area_set_param">
<return type="void"> <return type="void">
</return> </return>

22
doc/classes/PhysicsServer.xml
View File

@ -149,6 +149,18 @@
Removes a shape from an area. It does not delete the shape, so it can be reassigned later. Removes a shape from an area. It does not delete the shape, so it can be reassigned later.
</description> </description>
</method> </method>
<method name="area_set_area_monitor_callback">
<return type="void">
</return>
<argument index="0" name="area" type="RID">
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
</argument>
<description>
</description>
</method>
<method name="area_set_collision_layer"> <method name="area_set_collision_layer">
<return type="void"> <return type="void">
</return> </return>
@ -189,6 +201,16 @@
5: The shape index of the area where the object entered/exited. 5: The shape index of the area where the object entered/exited.
</description> </description>
</method> </method>
<method name="area_set_monitorable">
<return type="void">
</return>
<argument index="0" name="area" type="RID">
</argument>
<argument index="1" name="monitorable" type="bool">
</argument>
<description>
</description>
</method>
<method name="area_set_param"> <method name="area_set_param">
<return type="void"> <return type="void">
</return> </return>

40
doc/classes/Quat.xml
View File

@ -19,16 +19,19 @@
<method name="Quat"> <method name="Quat">
<return type="Quat"> <return type="Quat">
</return> </return>
<argument index="0" name="x" type="float"> <argument index="0" name="from" type="Basis">
</argument>
<argument index="1" name="y" type="float">
</argument>
<argument index="2" name="z" type="float">
</argument>
<argument index="3" name="w" type="float">
</argument> </argument>
<description> <description>
Returns a quaternion defined by these values. Returns the rotation matrix corresponding to the given quaternion.
</description>
</method>
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="euler" type="Vector3">
</argument>
<description>
Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle).
</description> </description>
</method> </method>
<method name="Quat"> <method name="Quat">
@ -45,19 +48,16 @@
<method name="Quat"> <method name="Quat">
<return type="Quat"> <return type="Quat">
</return> </return>
<argument index="0" name="euler" type="Vector3"> <argument index="0" name="x" type="float">
</argument>
<argument index="1" name="y" type="float">
</argument>
<argument index="2" name="z" type="float">
</argument>
<argument index="3" name="w" type="float">
</argument> </argument>
<description> <description>
Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). Returns a quaternion defined by these values.
</description>
</method>
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="from" type="Basis">
</argument>
<description>
Returns the rotation matrix corresponding to the given quaternion.
</description> </description>
</method> </method>
<method name="cubic_slerp"> <method name="cubic_slerp">
@ -129,7 +129,7 @@
<method name="set_axis_angle"> <method name="set_axis_angle">
<argument index="0" name="axis" type="Vector3"> <argument index="0" name="axis" type="Vector3">
</argument> </argument>
<argument index="1" name="phi" type="float"> <argument index="1" name="angle" type="float">
</argument> </argument>
<description> <description>
Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector.

4
doc/classes/Range.xml
View File

@ -29,6 +29,10 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="allow_greater" type="bool" setter="set_allow_greater" getter="is_greater_allowed">
</member>
<member name="allow_lesser" type="bool" setter="set_allow_lesser" getter="is_lesser_allowed">
</member>
<member name="exp_edit" type="bool" setter="set_exp_ratio" getter="is_ratio_exp"> <member name="exp_edit" type="bool" setter="set_exp_ratio" getter="is_ratio_exp">
If [code]true[/code] and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly. If [code]true[/code] and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly.
</member> </member>

4
doc/classes/ScrollContainer.xml
View File

@ -42,4 +42,8 @@
</signals> </signals>
<constants> <constants>
</constants> </constants>
<theme_items>
<theme_item name="bg" type="StyleBox">
</theme_item>
</theme_items>
</class> </class>

8
doc/classes/ShaderMaterial.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ShaderMaterial" inherits="Material" category="Core" version="3.1"> <class name="ShaderMaterial" inherits="Material" category="Core" version="3.1">
<brief_description> <brief_description>
A material that uses a custom [Shader] program A material that uses a custom [Shader] program.
</brief_description> </brief_description>
<description> <description>
A material that uses a custom [Shader] program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader. A material that uses a custom [Shader] program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader.
@ -17,7 +17,7 @@
<argument index="0" name="param" type="String"> <argument index="0" name="param" type="String">
</argument> </argument>
<description> <description>
Returns the current value set for this material of a uniform in the shader Returns the current value set for this material of a uniform in the shader.
</description> </description>
</method> </method>
<method name="set_shader_param"> <method name="set_shader_param">
@ -28,13 +28,13 @@
<argument index="1" name="value" type="Variant"> <argument index="1" name="value" type="Variant">
</argument> </argument>
<description> <description>
Changes the value set for this material of a uniform in the shader Changes the value set for this material of a uniform in the shader.
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="shader" type="Shader" setter="set_shader" getter="get_shader"> <member name="shader" type="Shader" setter="set_shader" getter="get_shader">
The [Shader] program used to render this material The [Shader] program used to render this material.
</member> </member>
</members> </members>
<constants> <constants>

10
doc/classes/Skeleton.xml
View File

@ -147,14 +147,20 @@
<description> <description>
</description> </description>
</method> </method>
<method name="physical_bones_simulation"> <method name="physical_bones_start_simulation">
<return type="void"> <return type="void">
</return> </return>
<argument index="0" name="start" type="bool"> <argument index="0" name="bones" type="Array" default="[ ]">
</argument> </argument>
<description> <description>
</description> </description>
</method> </method>
<method name="physical_bones_stop_simulation">
<return type="void">
</return>
<description>
</description>
</method>
<method name="set_bone_custom_pose"> <method name="set_bone_custom_pose">
<return type="void"> <return type="void">
</return> </return>

28
doc/classes/String.xml
View File

@ -643,6 +643,20 @@
Returns the right side of the string from a given position. Returns the right side of the string from a given position.
</description> </description>
</method> </method>
<method name="rsplit">
<return type="PoolStringArray">
</return>
<argument index="0" name="divisor" type="String">
</argument>
<argument index="1" name="allow_empty" type="bool" default="True">
</argument>
<argument index="2" name="maxsplit" type="int" default="0">
</argument>
<description>
Splits the string by a [code]divisor[/code] string and returns an array of the substrings, starting from right. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",".
If [code]maxsplit[/code] is specified, then it is number of splits to do, default is 0 which splits all the items.
</description>
</method>
<method name="rstrip"> <method name="rstrip">
<return type="String"> <return type="String">
</return> </return>
@ -688,20 +702,6 @@
If [code]maxsplit[/code] is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) If [code]maxsplit[/code] is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements)
</description> </description>
</method> </method>
<method name="rsplit">
<return type="PoolStringArray">
</return>
<argument index="0" name="divisor" type="String">
</argument>
<argument index="1" name="allow_empty" type="bool" default="True">
</argument>
<argument index="2" name="maxsplit" type="int" default="0">
</argument>
<description>
Splits the string by a [code]divisor[/code] string and returns an array of the substrings, starting from right. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",".
If [code]maxsplit[/code] is specified, then it is number of splits to do, default is 0 which splits all the items.
</description>
</method>
<method name="split_floats"> <method name="split_floats">
<return type="PoolRealArray"> <return type="PoolRealArray">
</return> </return>

2
doc/classes/TextEdit.xml
View File

@ -386,7 +386,7 @@
<member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed"> <member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed">
If [code]true[/code], enables text wrapping when it goes beyond he edge of what is visible. If [code]true[/code], enables text wrapping when it goes beyond he edge of what is visible.
</member> </member>
<member name="wrap_lines" type="bool" setter="set_wrap" getter="is_wrapping"> <member name="wrap_enabled" type="bool" setter="set_wrap_enabled" getter="is_wrap_enabled">
</member> </member>
</members> </members>
<signals> <signals>

4
doc/classes/TileSet.xml
View File

@ -450,7 +450,9 @@
<constants> <constants>
<constant name="BITMASK_2X2" value="0" enum="BitmaskMode"> <constant name="BITMASK_2X2" value="0" enum="BitmaskMode">
</constant> </constant>
<constant name="BITMASK_3X3" value="1" enum="BitmaskMode"> <constant name="BITMASK_3X3_MINIMAL" value="1" enum="BitmaskMode">
</constant>
<constant name="BITMASK_3X3" value="2" enum="BitmaskMode">
</constant> </constant>
<constant name="BIND_TOPLEFT" value="1" enum="AutotileBindings"> <constant name="BIND_TOPLEFT" value="1" enum="AutotileBindings">
</constant> </constant>