doc: Fix wrong references found by Sphinx and new makerst.py

This commit is contained in:
Rémi Verschelde 2019-01-07 11:46:26 +01:00
parent 698728f1c2
commit a15620c83e
29 changed files with 46 additions and 42 deletions

View File

@ -69,7 +69,7 @@
<argument index="1" name="value" type="bool"> <argument index="1" name="value" type="bool">
</argument> </argument>
<description> <description>
Set/clear individual bits on the layer mask. This simplifies editing this [code]Area[code]'s layers. Set/clear individual bits on the layer mask. This simplifies editing this [code]Area[/code]'s layers.
</description> </description>
</method> </method>
<method name="set_collision_mask_bit"> <method name="set_collision_mask_bit">

View File

@ -7,7 +7,6 @@
Plays background audio. Plays background audio.
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/latest/learning/features/audio/index.html</link>
<link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
</tutorials> </tutorials>
<demos> <demos>

View File

@ -7,7 +7,6 @@
Plays audio that dampens with distance from screen center. Plays audio that dampens with distance from screen center.
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/latest/learning/features/audio/index.html</link>
<link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
</tutorials> </tutorials>
<demos> <demos>

View File

@ -7,7 +7,6 @@
Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space.
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/latest/learning/features/audio/index.html</link>
<link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
</tutorials> </tutorials>
<demos> <demos>

View File

@ -54,7 +54,7 @@
If [code]true[/code], the button is in disabled state and can't be clicked or toggled. If [code]true[/code], the button is in disabled state and can't be clicked or toggled.
</member> </member>
<member name="enabled_focus_mode" type="int" setter="set_enabled_focus_mode" getter="get_enabled_focus_mode" enum="Control.FocusMode"> <member name="enabled_focus_mode" type="int" setter="set_enabled_focus_mode" getter="get_enabled_focus_mode" enum="Control.FocusMode">
Focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [member disabled]). Focus access mode to use when switching between enabled/disabled (see [member Control.focus_mode] and [member disabled]).
</member> </member>
<member name="group" type="ButtonGroup" setter="set_button_group" getter="get_button_group"> <member name="group" type="ButtonGroup" setter="set_button_group" getter="get_button_group">
[ButtonGroup] associated to the button. [ButtonGroup] associated to the button.

View File

@ -9,7 +9,6 @@
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html</link>
<link>https://docs.godotengine.org/en/latest/tutorials/math/rotations.html</link>
</tutorials> </tutorials>
<demos> <demos>
</demos> </demos>

View File

@ -798,7 +798,7 @@
Sent when the node's [member theme] changes, right before Godot redraws the control. Happens when you call one of the [code]add_*_override[/code] methods. Sent when the node's [member theme] changes, right before Godot redraws the control. Happens when you call one of the [code]add_*_override[/code] methods.
</constant> </constant>
<constant name="NOTIFICATION_MODAL_CLOSE" value="46"> <constant name="NOTIFICATION_MODAL_CLOSE" value="46">
Sent when an open modal dialog closes. See [member show_modal]. Sent when an open modal dialog closes. See [method show_modal].
</constant> </constant>
<constant name="NOTIFICATION_SCROLL_BEGIN" value="47"> <constant name="NOTIFICATION_SCROLL_BEGIN" value="47">
Sent when this node is inside a [ScrollContainer] which has begun being scrolled. Sent when this node is inside a [ScrollContainer] which has begun being scrolled.

View File

@ -33,13 +33,13 @@
Can be used to fix special cases of self shadowing when objects are perpendicular to the light. Can be used to fix special cases of self shadowing when objects are perpendicular to the light.
</member> </member>
<member name="directional_shadow_split_1" type="float" setter="set_param" getter="get_param"> <member name="directional_shadow_split_1" type="float" setter="set_param" getter="get_param">
The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_*_SPLITS. The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is one of the [code]SHADOW_PARALLEL_*_SPLITS[/code] constants.
</member> </member>
<member name="directional_shadow_split_2" type="float" setter="set_param" getter="get_param"> <member name="directional_shadow_split_2" type="float" setter="set_param" getter="get_param">
The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_*_SPLITS. The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_3_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code].
</member> </member>
<member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param"> <member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param">
The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_4_SPLITS. The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_4_SPLITS[/code].
</member> </member>
</members> </members>
<constants> <constants>

View File

@ -7,7 +7,7 @@
Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. Also see [EditorScript] to add functions to the editor. Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. Also see [EditorScript] to add functions to the editor.
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/latest/development/plugins/index.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/plugins/editor/index.html</link>
</tutorials> </tutorials>
<demos> <demos>
</demos> </demos>

View File

@ -4,7 +4,7 @@
Custom gizmo for editing Spatial objects. Custom gizmo for editing Spatial objects.
</brief_description> </brief_description>
<description> <description>
Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by [method EditorPlugin.create_spatial_gizmo]. Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by [method EditorSpatialGizmoPlugin.create_gizmo].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -5,7 +5,7 @@
</brief_description> </brief_description>
<description> <description>
GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default.
It is greatly advised to enable low processor usage mode (see [method OS.set_low_processor_usage_mode]) when using GraphEdits. It is greatly advised to enable low processor usage mode (see [member OS.low_processor_usage_mode]) when using GraphEdits.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -24,7 +24,7 @@
</member> </member>
<member name="result" type="Variant" setter="set_result" getter="get_result"> <member name="result" type="Variant" setter="set_result" getter="get_result">
A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces ([code]{}[/code]) a [Dictionary] will be returned, if JSON source starts with braces ([code][][/code]) an [Array] will be returned. A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces ([code]{}[/code]) a [Dictionary] will be returned, if JSON source starts with braces ([code][][/code]) an [Array] will be returned.
[i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. [i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.[/i]
Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:[/i] Note that JSON objects do not preserve key order like Godot dictionaries, thus you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:[/i]
[codeblock] [codeblock]
var p = JSON.parse('["hello", "world", "!"]') var p = JSON.parse('["hello", "world", "!"]')

View File

@ -59,7 +59,7 @@
If [code]true[/code], the Light2D will cast shadows. Default value: [code]false[/code]. If [code]true[/code], the Light2D will cast shadows. Default value: [code]false[/code].
</member> </member>
<member name="shadow_filter" type="int" setter="set_shadow_filter" getter="get_shadow_filter" enum="Light2D.ShadowFilter"> <member name="shadow_filter" type="int" setter="set_shadow_filter" getter="get_shadow_filter" enum="Light2D.ShadowFilter">
Shadow filter type. Use SHADOW_FILTER_* constants to set [code]shadow_filter[/code]. Default value: [code]None[/code]. Shadow filter type. Use [enum Light2D.ShadowFilter] constants as values. Default value: [code]SHADOW_FILTER_NONE[/code].
</member> </member>
<member name="shadow_filter_smooth" type="float" setter="set_shadow_smooth" getter="get_shadow_smooth"> <member name="shadow_filter_smooth" type="float" setter="set_shadow_smooth" getter="get_shadow_smooth">
Smoothing value for shadows. Smoothing value for shadows.
@ -91,22 +91,22 @@
The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture.
</constant> </constant>
<constant name="SHADOW_FILTER_NONE" value="0" enum="ShadowFilter"> <constant name="SHADOW_FILTER_NONE" value="0" enum="ShadowFilter">
No filter applies to the shadow map. See [method shadow_filter]. No filter applies to the shadow map. See [member shadow_filter].
</constant> </constant>
<constant name="SHADOW_FILTER_PCF3" value="1" enum="ShadowFilter"> <constant name="SHADOW_FILTER_PCF3" value="1" enum="ShadowFilter">
Percentage closer filtering (3 samples) applies to the shadow map. See [method shadow_filter]. Percentage closer filtering (3 samples) applies to the shadow map. See [member shadow_filter].
</constant> </constant>
<constant name="SHADOW_FILTER_PCF5" value="2" enum="ShadowFilter"> <constant name="SHADOW_FILTER_PCF5" value="2" enum="ShadowFilter">
Percentage closer filtering (5 samples) applies to the shadow map. See [method shadow_filter]. Percentage closer filtering (5 samples) applies to the shadow map. See [member shadow_filter].
</constant> </constant>
<constant name="SHADOW_FILTER_PCF7" value="3" enum="ShadowFilter"> <constant name="SHADOW_FILTER_PCF7" value="3" enum="ShadowFilter">
Percentage closer filtering (7 samples) applies to the shadow map. See [method shadow_filter]. Percentage closer filtering (7 samples) applies to the shadow map. See [member shadow_filter].
</constant> </constant>
<constant name="SHADOW_FILTER_PCF9" value="4" enum="ShadowFilter"> <constant name="SHADOW_FILTER_PCF9" value="4" enum="ShadowFilter">
Percentage closer filtering (9 samples) applies to the shadow map. See [method shadow_filter]. Percentage closer filtering (9 samples) applies to the shadow map. See [member shadow_filter].
</constant> </constant>
<constant name="SHADOW_FILTER_PCF13" value="5" enum="ShadowFilter"> <constant name="SHADOW_FILTER_PCF13" value="5" enum="ShadowFilter">
Percentage closer filtering (13 samples) applies to the shadow map. See [method shadow_filter]. Percentage closer filtering (13 samples) applies to the shadow map. See [member shadow_filter].
</constant> </constant>
</constants> </constants>
</class> </class>

View File

@ -6,22 +6,22 @@
<description> <description>
There are two ways to create polygons. Either by using the [method add_outline] method or using the [method add_polygon] method. There are two ways to create polygons. Either by using the [method add_outline] method or using the [method add_polygon] method.
Using [method add_outline]: Using [method add_outline]:
[code] [codeblock]
var polygon = NavigationPolygon.new() var polygon = NavigationPolygon.new()
var outline = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) var outline = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
polygon.add_outline(outline) polygon.add_outline(outline)
polygon.make_polygons_from_outlines() polygon.make_polygons_from_outlines()
$NavigationPolygonInstance.navpoly = polygon $NavigationPolygonInstance.navpoly = polygon
[/code] [/codeblock]
Using [method add_polygon] and indices of the vertices array. Using [method add_polygon] and indices of the vertices array.
[code] [codeblock]
var polygon = NavigationPolygon.new() var polygon = NavigationPolygon.new()
var vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) var vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
polygon.set_vertices(vertices) polygon.set_vertices(vertices)
var indices = PoolIntArray(0, 3, 1) var indices = PoolIntArray(0, 3, 1)
polygon.add_polygon(indices) polygon.add_polygon(indices)
$NavigationPolygonInstance.navpoly = polygon $NavigationPolygonInstance.navpoly = polygon
[/code] [/codeblock]
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View File

@ -746,7 +746,7 @@
<description> <description>
Requests the OS to open a resource with the most appropriate program. For example. Requests the OS to open a resource with the most appropriate program. For example.
[code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the downloads folders of the user. [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the downloads folders of the user.
[code]OS.shell_open("http://godotengine.org")[/code] opens the default web browser on the official Godot website. [code]OS.shell_open("https://godotengine.org")[/code] opens the default web browser on the official Godot website.
</description> </description>
</method> </method>
<method name="show_virtual_keyboard"> <method name="show_virtual_keyboard">

View File

@ -18,7 +18,7 @@
node.add_child(rigid) node.add_child(rigid)
# change owner of rigid, but not of collision # change owner of rigid, but not of collision
rigid.set_owner(node) rigid.owner = node
var scene = PackedScene.new() var scene = PackedScene.new()
# only node and rigid are now packed # only node and rigid are now packed
@ -61,7 +61,7 @@
<argument index="0" name="path" type="Node"> <argument index="0" name="path" type="Node">
</argument> </argument>
<description> <description>
Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner]. Pack will ignore any sub-nodes not owned by given node. See [member Node.owner].
</description> </description>
</method> </method>
</methods> </methods>

View File

@ -1128,7 +1128,7 @@
This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks. This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks.
</constant> </constant>
<constant name="SHAPE_CONVEX_POLYGON" value="6" enum="ShapeType"> <constant name="SHAPE_CONVEX_POLYGON" value="6" enum="ShapeType">
This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form is a convex polygon. This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the [member CollisionPolygon2D.polygon] property, polygons modified with [method shape_set_data] do not verify that the points supplied form is a convex polygon.
</constant> </constant>
<constant name="SHAPE_CONCAVE_POLYGON" value="7" enum="ShapeType"> <constant name="SHAPE_CONCAVE_POLYGON" value="7" enum="ShapeType">
This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks. This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks.

View File

@ -773,7 +773,7 @@
<argument index="1" name="space" type="RID"> <argument index="1" name="space" type="RID">
</argument> </argument>
<description> <description>
Assigns a space to the body (see [method create_space]). Assigns a space to the body (see [method space_create]).
</description> </description>
</method> </method>
<method name="body_set_state"> <method name="body_set_state">

View File

@ -173,7 +173,7 @@
</member> </member>
<member name="application/config/custom_user_dir_name" type="String" setter="" getter=""> <member name="application/config/custom_user_dir_name" type="String" setter="" getter="">
This user directory is used for storing persistent data ([code]user://[/code] filesystem). By default (no custom name defined), [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]). This user directory is used for storing persistent data ([code]user://[/code] filesystem). By default (no custom name defined), [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]).
The [member use_custom_user_dir] setting must be enabled for this to take effect. The [member application/config/use_custom_user_dir] setting must be enabled for this to take effect.
</member> </member>
<member name="application/config/icon" type="String" setter="" getter=""> <member name="application/config/icon" type="String" setter="" getter="">
Icon used for the project, set when project loads. Exporters will use this icon when possible to. Icon used for the project, set when project loads. Exporters will use this icon when possible to.
@ -185,7 +185,7 @@
Specifies a file to override project settings. For example: [code]user://custom_settings.cfg[/code]. Specifies a file to override project settings. For example: [code]user://custom_settings.cfg[/code].
</member> </member>
<member name="application/config/use_custom_user_dir" type="bool" setter="" getter=""> <member name="application/config/use_custom_user_dir" type="bool" setter="" getter="">
Allow the project to save to its own custom user dir (see [member custom_user_dir_name]). This setting only works for desktop platforms. A name must be set in the [member custom_user_dir_name] setting for this to take effect. Allow the project to save to its own custom user dir (see [member application/config/custom_user_dir_name]). This setting only works for desktop platforms. A name must be set in the [member application/config/custom_user_dir_name] setting for this to take effect.
</member> </member>
<member name="application/run/disable_stderr" type="bool" setter="" getter=""> <member name="application/run/disable_stderr" type="bool" setter="" getter="">
Disable printing to stderr on exported build. Disable printing to stderr on exported build.

View File

@ -10,7 +10,6 @@
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html#interpolating-with-quaternions</link> <link>https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html#interpolating-with-quaternions</link>
<link>https://docs.godotengine.org/en/latest/tutorials/math/rotations.html</link>
</tutorials> </tutorials>
<demos> <demos>
</demos> </demos>

View File

@ -4,7 +4,7 @@
The Editor's popup dialog for creating new [Script] files. The Editor's popup dialog for creating new [Script] files.
</brief_description> </brief_description>
<description> <description>
The ScriptCreateDialog creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling a [method popup]() method. The [code]ScriptCreateDialog[/code] creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling one of the [method Popup.popup] methods.
[codeblock] [codeblock]
func _ready(): func _ready():
dialog.config("Node", "res://new_node.gd") # for in-engine types dialog.config("Node", "res://new_node.gd") # for in-engine types

View File

@ -54,7 +54,7 @@
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Returns [code]true[/code] if this peer is currently connected to a host, [code]false[code] otherwise. Returns [code]true[/code] if this peer is currently connected to a host, [code]false[/code] otherwise.
</description> </description>
</method> </method>
<method name="set_no_delay"> <method name="set_no_delay">

View File

@ -4,10 +4,10 @@
Flat button helper class. Flat button helper class.
</brief_description> </brief_description>
<description> <description>
This is a helper class to generate a flat [Button] (see [method Button.set_flat]), creating a ToolButton is equivalent to: This is a helper class to generate a flat [Button] (see [member Button.flat]), creating a [code]ToolButton[/code] is equivalent to:
[codeblock] [codeblock]
var btn = Button.new() var btn = Button.new()
btn.set_flat(true) btn.flat = true
[/codeblock] [/codeblock]
</description> </description>
<tutorials> <tutorials>

View File

@ -340,7 +340,7 @@
</methods> </methods>
<members> <members>
<member name="playback_process_mode" type="int" setter="set_tween_process_mode" getter="get_tween_process_mode" enum="Tween.TweenProcessMode"> <member name="playback_process_mode" type="int" setter="set_tween_process_mode" getter="get_tween_process_mode" enum="Tween.TweenProcessMode">
The tween's animation process thread. See [enum TweenProcessMode]. Default value: [enum TWEEN_PROCESS_IDLE]. The tween's animation process thread. See [enum TweenProcessMode]. Default value: [constant TWEEN_PROCESS_IDLE].
</member> </member>
<member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale"> <member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale">
The tween's speed multiplier. For example, set it to [code]1.0[/code] for normal speed, [code]2.0[/code] for two times normal speed, or [code]0.5[/code] for half of the normal speed. A value of [code]0[/code] pauses the animation, but see also [method set_active] or [method stop_all] for this. The tween's speed multiplier. For example, set it to [code]1.0[/code] for normal speed, [code]2.0[/code] for two times normal speed, or [code]0.5[/code] for half of the normal speed. A value of [code]0[/code] pauses the animation, but see also [method set_active] or [method stop_all] for this.

View File

@ -164,7 +164,7 @@
<return type="float"> <return type="float">
</return> </return>
<description> <description>
Returns the vector's length squared. Prefer this function over [member length] if you need to sort vectors or need the squared length for some formula. Returns the vector's length squared. Prefer this method over [method length] if you need to sort vectors or need the squared length for some formula.
</description> </description>
</method> </method>
<method name="linear_interpolate"> <method name="linear_interpolate">

View File

@ -18,11 +18,11 @@
Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the [member RigidBody.mass] of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the [member RigidBody.mass] of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking.
</member> </member>
<member name="engine_force" type="float" setter="set_engine_force" getter="get_engine_force"> <member name="engine_force" type="float" setter="set_engine_force" getter="get_engine_force">
Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have [member VehicleWheel.set_use_as_traction] set to true and are in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have [member VehicleWheel.use_as_traction] set to true and are in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears.
A negative value will result in the vehicle reversing. A negative value will result in the vehicle reversing.
</member> </member>
<member name="steering" type="float" setter="set_steering" getter="get_steering"> <member name="steering" type="float" setter="set_steering" getter="get_steering">
The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have [member VehicleWheel.set_use_as_steering] set to true will automatically be rotated. The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have [member VehicleWheel.use_as_steering] set to true will automatically be rotated.
</member> </member>
</members> </members>
<constants> <constants>

View File

@ -4353,6 +4353,12 @@
</constant> </constant>
<constant name="MULTIMESH_COLOR_FLOAT" value="2" enum="MultimeshColorFormat"> <constant name="MULTIMESH_COLOR_FLOAT" value="2" enum="MultimeshColorFormat">
</constant> </constant>
<constant name="MULTIMESH_CUSTOM_DATA_NONE" value="0" enum="MultimeshCustomDataFormat">
</constant>
<constant name="MULTIMESH_CUSTOM_DATA_8BIT" value="1" enum="MultimeshCustomDataFormat">
</constant>
<constant name="MULTIMESH_CUSTOM_DATA_FLOAT" value="2" enum="MultimeshCustomDataFormat">
</constant>
<constant name="REFLECTION_PROBE_UPDATE_ONCE" value="0" enum="ReflectionProbeUpdateMode"> <constant name="REFLECTION_PROBE_UPDATE_ONCE" value="0" enum="ReflectionProbeUpdateMode">
</constant> </constant>
<constant name="REFLECTION_PROBE_UPDATE_ALWAYS" value="1" enum="ReflectionProbeUpdateMode"> <constant name="REFLECTION_PROBE_UPDATE_ALWAYS" value="1" enum="ReflectionProbeUpdateMode">

View File

@ -4,7 +4,7 @@
PacketPeer implementation using the ENet library. PacketPeer implementation using the ENet library.
</brief_description> </brief_description>
<description> <description>
A PacketPeer implementation that should be passed to [method SceneTree.set_network_peer] after being initialized as either a client or server. Events can then be handled by connecting to [SceneTree] signals. A PacketPeer implementation that should be passed to [member SceneTree.network_peer] after being initialized as either a client or server. Events can then be handled by connecting to [SceneTree] signals.
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/networking/high_level_multiplayer.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/networking/high_level_multiplayer.html</link>

View File

@ -2260,6 +2260,9 @@ void VisualServer::_bind_methods() {
BIND_ENUM_CONSTANT(MULTIMESH_COLOR_NONE); BIND_ENUM_CONSTANT(MULTIMESH_COLOR_NONE);
BIND_ENUM_CONSTANT(MULTIMESH_COLOR_8BIT); BIND_ENUM_CONSTANT(MULTIMESH_COLOR_8BIT);
BIND_ENUM_CONSTANT(MULTIMESH_COLOR_FLOAT); BIND_ENUM_CONSTANT(MULTIMESH_COLOR_FLOAT);
BIND_ENUM_CONSTANT(MULTIMESH_CUSTOM_DATA_NONE);
BIND_ENUM_CONSTANT(MULTIMESH_CUSTOM_DATA_8BIT);
BIND_ENUM_CONSTANT(MULTIMESH_CUSTOM_DATA_FLOAT);
BIND_ENUM_CONSTANT(REFLECTION_PROBE_UPDATE_ONCE); BIND_ENUM_CONSTANT(REFLECTION_PROBE_UPDATE_ONCE);
BIND_ENUM_CONSTANT(REFLECTION_PROBE_UPDATE_ALWAYS); BIND_ENUM_CONSTANT(REFLECTION_PROBE_UPDATE_ALWAYS);