mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 03:18:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2020-10-09 15:04:15 +02:00
parent e9ff08692c
commit a33fe75050
No known key found for this signature in database
GPG Key ID: C3336907360768E1
10 changed files with 31 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/classes/Animation.xml
View File

@ -681,6 +681,17 @@
Returns the update mode of a value track.
</description>
</method>
<method name="value_track_interpolate" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="track_idx" type="int">
</argument>
<argument index="1" name="time_sec" type="float">
</argument>
<description>
Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track.
</description>
</method>
<method name="value_track_set_update_mode">
<return type="void">
</return>
@ -692,17 +703,6 @@
Sets the update mode (see [enum UpdateMode]) of a value track.
</description>
</method>
<method name="value_track_interpolate" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="track_idx" type="int">
</argument>
<argument index="1" name="time_sec" type="float">
</argument>
<description>
Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track.
</description>
</method>
</methods>
<members>
<member name="length" type="float" setter="set_length" getter="get_length" default="1.0">

1
doc/classes/ArrayMesh.xml
View File

@ -69,7 +69,6 @@
<argument index="2" name="blend_shapes" type="Array" default="[ ]">
</argument>
<argument index="3" name="lods" type="Dictionary" default="{
}">
</argument>
<argument index="4" name="compress_flags" type="int" default="31744">

2
doc/classes/Basis.xml
View File

@ -111,8 +111,6 @@
</return>
<argument index="0" name="b" type="Basis">
</argument>
<argument index="1" name="epsilon" type="float" default="1e-05">
</argument>
<description>
Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description>

6
doc/classes/CanvasItem.xml
View File

@ -607,9 +607,6 @@
<member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled" default="false">
If [code]true[/code], the object draws behind its parent.
</member>
<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level">
If [code]true[/code], the node will not inherit its transform from parent [CanvasItem]s.
</member>
<member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top">
If [code]true[/code], the object draws on top of its parent.
</member>
@ -619,6 +616,9 @@
<member name="texture_repeat" type="int" setter="set_texture_repeat" getter="get_texture_repeat" enum="CanvasItem.TextureRepeat" default="0">
The texture repeating mode to use on this [CanvasItem].
</member>
<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level" default="false">
If [code]true[/code], the node will not inherit its transform from parent [CanvasItem]s.
</member>
<member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false">
If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material.
</member>

16
doc/classes/FuncRef.xml
View File

@ -26,6 +26,13 @@
Calls the referenced function previously set in [member function] or [method @GDScript.funcref]. Contrarily to [method call_func], this method does not support a variable number of arguments but expects all parameters to be passed via a single [Array].
</description>
</method>
<method name="is_valid" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether the object still exists and has the function assigned.
</description>
</method>
<method name="set_instance">
<return type="void">
</return>
@ -35,16 +42,9 @@
The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary].
</description>
</method>
<method name="is_valid" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether the object still exists and has the function assigned.
</description>
</method>
</methods>
<members>
<member name="function" type="StringName" setter="set_function" getter="get_function">
<member name="function" type="StringName" setter="set_function" getter="get_function" default="@&quot;&quot;">
The name of the referenced function.
</member>
</members>

2
doc/classes/Node3D.xml
View File

@ -301,7 +301,7 @@
<member name="scale" type="Vector3" setter="set_scale" getter="get_scale" default="Vector3( 1, 1, 1 )">
Scale part of the local transformation.
</member>
<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level">
<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level" default="false">
If [code]true[/code], the node will not inherit its transformations from its parent. Node transformations are only in global space.
</member>
<member name="transform" type="Transform" setter="set_transform" getter="get_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">

4
doc/classes/ProjectSettings.xml
View File

@ -558,7 +558,7 @@
<member name="input_devices/pointing/emulate_touch_from_mouse" type="bool" setter="" getter="" default="false">
If [code]true[/code], sends touch input events when clicking or dragging the mouse.
</member>
<member name="input_devices/pointing/ios/touch_delay" type="float" setter="" getter="" default="0.150">
<member name="input_devices/pointing/ios/touch_delay" type="float" setter="" getter="" default="0.15">
Default delay for touch events. This only affects iOS devices.
</member>
<member name="layer_names/2d_physics/layer_1" type="String" setter="" getter="" default="&quot;&quot;">
@ -818,7 +818,7 @@
<member name="logging/file_logging/max_log_files" type="int" setter="" getter="" default="5">
Specifies the maximum amount of log files allowed (used for rotation).
</member>
<member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter="" default="1024">
<member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter="" default="4096">
Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here.
</member>
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">

7
doc/classes/RenderingServer.xml
View File

@ -583,6 +583,12 @@
Modulates all colors in the given canvas.
</description>
</method>
<method name="create_local_rendering_device" qualifiers="const">
<return type="RenderingDevice">
</return>
<description>
</description>
</method>
<method name="directional_light_create">
<return type="RID">
</return>
@ -1627,7 +1633,6 @@
<argument index="3" name="blend_shapes" type="Array" default="[ ]">
</argument>
<argument index="4" name="lods" type="Dictionary" default="{
}">
</argument>
<argument index="5" name="compress_format" type="int" default="31744">

6
doc/classes/VisualShaderNode.xml
View File

@ -57,12 +57,6 @@
Emitted when the node requests an editor refresh. Currently called only in setter of [member VisualShaderNodeTexture.source], [VisualShaderNodeTexture], and [VisualShaderNodeCubemap] (and their derivatives).
</description>
</signal>
<signal name="show_port_preview">
<argument index="0" name="port_id" type="int">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
<constant name="PORT_TYPE_SCALAR" value="0" enum="PortType">

2
modules/webrtc/doc_classes/WebRTCPeerConnection.xml
View File

@ -40,7 +40,6 @@
<argument index="0" name="label" type="String">
</argument>
<argument index="1" name="options" type="Dictionary" default="{
}">
</argument>
<description>
@ -82,7 +81,6 @@
<return type="int" enum="Error">
</return>
<argument index="0" name="configuration" type="Dictionary" default="{
}">
</argument>
<description>