From a15620c83e7ee0f77d2582f0664431a7893c4283 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 7 Jan 2019 11:46:26 +0100 Subject: [PATCH] doc: Fix wrong references found by Sphinx and new makerst.py --- doc/classes/Area.xml | 2 +- doc/classes/AudioStreamPlayer.xml | 1 - doc/classes/AudioStreamPlayer2D.xml | 1 - doc/classes/AudioStreamPlayer3D.xml | 1 - doc/classes/BaseButton.xml | 2 +- doc/classes/Basis.xml | 1 - doc/classes/Control.xml | 2 +- doc/classes/DirectionalLight.xml | 6 +++--- doc/classes/EditorPlugin.xml | 2 +- doc/classes/EditorSpatialGizmo.xml | 2 +- doc/classes/GraphEdit.xml | 2 +- doc/classes/JSONParseResult.xml | 2 +- doc/classes/Light2D.xml | 14 +++++++------- doc/classes/NavigationPolygon.xml | 8 ++++---- doc/classes/OS.xml | 2 +- doc/classes/PackedScene.xml | 4 ++-- doc/classes/Physics2DServer.xml | 2 +- doc/classes/PhysicsServer.xml | 2 +- doc/classes/ProjectSettings.xml | 4 ++-- doc/classes/Quat.xml | 1 - doc/classes/ScriptCreateDialog.xml | 2 +- doc/classes/StreamPeerTCP.xml | 2 +- doc/classes/ToolButton.xml | 4 ++-- doc/classes/Tween.xml | 2 +- doc/classes/Vector2.xml | 2 +- doc/classes/VehicleBody.xml | 4 ++-- doc/classes/VisualServer.xml | 6 ++++++ .../enet/doc_classes/NetworkedMultiplayerENet.xml | 2 +- servers/visual_server.cpp | 3 +++ 29 files changed, 46 insertions(+), 42 deletions(-) diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index 203af27f45f..a538fe99352 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -69,7 +69,7 @@ - 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. diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index e04a808f34f..e880fc13236 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -7,7 +7,6 @@ Plays background audio. - https://docs.godotengine.org/en/latest/learning/features/audio/index.html https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 2051675488a..28754f8695d 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -7,7 +7,6 @@ Plays audio that dampens with distance from screen center. - https://docs.godotengine.org/en/latest/learning/features/audio/index.html https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index c7c9f4df9be..a0260d82615 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -7,7 +7,6 @@ Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. - https://docs.godotengine.org/en/latest/learning/features/audio/index.html https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 9c692201a21..05ffe6cc111 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -54,7 +54,7 @@ If [code]true[/code], the button is in disabled state and can't be clicked or toggled. - 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]). [ButtonGroup] associated to the button. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 95f6346321b..b96daed6fc7 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -9,7 +9,6 @@ https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html - https://docs.godotengine.org/en/latest/tutorials/math/rotations.html diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index da5d1c76e2f..f067b50c726 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -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 an open modal dialog closes. See [member show_modal]. + Sent when an open modal dialog closes. See [method show_modal]. Sent when this node is inside a [ScrollContainer] which has begun being scrolled. diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml index 63d686fe24d..4a2802ffa4a 100644 --- a/doc/classes/DirectionalLight.xml +++ b/doc/classes/DirectionalLight.xml @@ -33,13 +33,13 @@ Can be used to fix special cases of self shadowing when objects are perpendicular to the light. - 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. - 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]. - 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]. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index f1c34815629..bcf6d3009c1 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -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. - https://docs.godotengine.org/en/latest/development/plugins/index.html + https://docs.godotengine.org/en/latest/tutorials/plugins/editor/index.html diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index 2081ae7a4df..c3ecd3c3b79 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -4,7 +4,7 @@ Custom gizmo for editing Spatial objects. - 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]. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index e778a6423ab..715c23d869a 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -5,7 +5,7 @@ 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. diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index a9162e2d959..4d2987cc040 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -24,7 +24,7 @@ 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] [codeblock] var p = JSON.parse('["hello", "world", "!"]') diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 476156846df..0d754f1d4e0 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -59,7 +59,7 @@ If [code]true[/code], the Light2D will cast shadows. Default value: [code]false[/code]. - 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]. 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. - No filter applies to the shadow map. See [method shadow_filter]. + No filter applies to the shadow map. See [member shadow_filter]. - 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]. - 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]. - 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]. - 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]. - 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]. diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 4ede80b98c7..53389d6599f 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -6,22 +6,22 @@ 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]: - [code] + [codeblock] var polygon = NavigationPolygon.new() var outline = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) polygon.add_outline(outline) polygon.make_polygons_from_outlines() $NavigationPolygonInstance.navpoly = polygon - [/code] + [/codeblock] Using [method add_polygon] and indices of the vertices array. - [code] + [codeblock] var polygon = NavigationPolygon.new() var vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) polygon.set_vertices(vertices) var indices = PoolIntArray(0, 3, 1) polygon.add_polygon(indices) $NavigationPolygonInstance.navpoly = polygon - [/code] + [/codeblock] diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 21e3bb82b54..f6ad71b6e28 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -746,7 +746,7 @@ 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("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. diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 7dea004b90b..432ca4b23f2 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -18,7 +18,7 @@ node.add_child(rigid) # change owner of rigid, but not of collision - rigid.set_owner(node) + rigid.owner = node var scene = PackedScene.new() # only node and rigid are now packed @@ -61,7 +61,7 @@ - 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]. diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 84e15d3b261..cd887ff9506 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -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 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. 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. diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 899132e9279..e3ed43e7bc9 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -773,7 +773,7 @@ - Assigns a space to the body (see [method create_space]). + Assigns a space to the body (see [method space_create]). diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 1d2057eb4eb..172a50d779a 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -173,7 +173,7 @@ 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. 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]. - 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. Disable printing to stderr on exported build. diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index 468839dfba1..990dcc7a915 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -10,7 +10,6 @@ https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html#interpolating-with-quaternions - https://docs.godotengine.org/en/latest/tutorials/math/rotations.html diff --git a/doc/classes/ScriptCreateDialog.xml b/doc/classes/ScriptCreateDialog.xml index ac0384e1d47..2e24a2626b2 100644 --- a/doc/classes/ScriptCreateDialog.xml +++ b/doc/classes/ScriptCreateDialog.xml @@ -4,7 +4,7 @@ The Editor's popup dialog for creating new [Script] files. - 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] func _ready(): dialog.config("Node", "res://new_node.gd") # for in-engine types diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 76507d57177..18324d9043b 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -54,7 +54,7 @@ - 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. diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml index d8db95a854e..b52e1d39dc9 100644 --- a/doc/classes/ToolButton.xml +++ b/doc/classes/ToolButton.xml @@ -4,10 +4,10 @@ Flat button helper class. - 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] var btn = Button.new() - btn.set_flat(true) + btn.flat = true [/codeblock] diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index b902821fb20..c3af586b218 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -340,7 +340,7 @@ - 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]. 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. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 006a843c32a..1770dec80d6 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -164,7 +164,7 @@ - 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. diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml index 3ce0cadde94..53a47ec7d60 100644 --- a/doc/classes/VehicleBody.xml +++ b/doc/classes/VehicleBody.xml @@ -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. - 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. - 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. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 9b2814492d7..26a6bae48c4 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -4353,6 +4353,12 @@ + + + + + + diff --git a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml index e057a435ac7..4976a909459 100644 --- a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml +++ b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml @@ -4,7 +4,7 @@ PacketPeer implementation using the ENet library. - 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. https://docs.godotengine.org/en/latest/tutorials/networking/high_level_multiplayer.html diff --git a/servers/visual_server.cpp b/servers/visual_server.cpp index 2ff2eac5aff..02acf72951f 100644 --- a/servers/visual_server.cpp +++ b/servers/visual_server.cpp @@ -2260,6 +2260,9 @@ void VisualServer::_bind_methods() { BIND_ENUM_CONSTANT(MULTIMESH_COLOR_NONE); BIND_ENUM_CONSTANT(MULTIMESH_COLOR_8BIT); 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_ALWAYS);