diff --git a/classes/class_area.rst b/classes/class_area.rst index 9619703f1..7c1712b1c 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -423,7 +423,7 @@ If ``true``, the given body overlaps the Area. Note that the result of this test - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** -Set/clear individual bits on the layer mask. This simplifies editing this ``Area[code]'s layers. +Set/clear individual bits on the layer mask. This simplifies editing this ``Area``'s layers. .. _class_Area_method_set_collision_mask_bit: diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 94a8ed3a1..068603eff 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -86,8 +86,6 @@ Plays background audio. Tutorials --------- -- :doc:`../learning/features/audio/index` - - :doc:`../tutorials/audio/audio_streams` Property Descriptions diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 27ff56b95..e71ec3591 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -71,8 +71,6 @@ Plays audio that dampens with distance from screen center. Tutorials --------- -- :doc:`../learning/features/audio/index` - - :doc:`../tutorials/audio/audio_streams` Property Descriptions diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 36bc1b2df..2b63ef94e 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -136,8 +136,6 @@ Plays a sound effect with directed sound effects, dampens with distance if neede Tutorials --------- -- :doc:`../learning/features/audio/index` - - :doc:`../tutorials/audio/audio_streams` Property Descriptions diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 6e5ae0343..d04d97fd8 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -176,7 +176,7 @@ If ``true``, the button is in disabled state and can't be clicked or toggled. | *Getter* | get_enabled_focus_mode() | +----------+-------------------------------+ -Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`disabled`). +Focus access mode to use when switching between enabled/disabled (see :ref:`Control.focus_mode` and :ref:`disabled`). .. _class_BaseButton_property_group: diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 6b584c92d..b59e79ac1 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -80,8 +80,6 @@ Tutorials - :doc:`../tutorials/3d/using_transforms` -- :doc:`../tutorials/math/rotations` - Property Descriptions --------------------- diff --git a/classes/class_control.rst b/classes/class_control.rst index a48799aea..32b75aa43 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -551,7 +551,7 @@ Constants - **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the control. Happens when you call one of the ``add_*_override`` methods. -- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. +- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. - **NOTIFICATION_SCROLL_BEGIN** = **47** --- Sent when this node is inside a :ref:`ScrollContainer` which has begun being scrolled. diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index e262e8df6..21688d3ea 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -165,7 +165,7 @@ Can be used to fix special cases of self shadowing when objects are perpendicula | *Getter* | get_param() | +----------+------------------+ -The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used in directional_shadow_mode SHADOW_PARALLEL\_\*_SPLITS. +The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is one of the ``SHADOW_PARALLEL_*_SPLITS`` constants. .. _class_DirectionalLight_property_directional_shadow_split_2: @@ -177,7 +177,7 @@ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow | *Getter* | get_param() | +----------+------------------+ -The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used in directional_shadow_mode SHADOW_PARALLEL\_\*_SPLITS. +The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is ``SHADOW_PARALLEL_3_SPLITS`` or ``SHADOW_PARALLEL_4_SPLITS``. .. _class_DirectionalLight_property_directional_shadow_split_3: @@ -189,5 +189,5 @@ The distance from shadow split 1 to split 2. Relative to :ref:`directional_shado | *Getter* | get_param() | +----------+------------------+ -The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used in directional_shadow_mode SHADOW_PARALLEL_4_SPLITS. +The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used when :ref:`directional_shadow_mode` is ``SHADOW_PARALLEL_4_SPLITS``. diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index a6b30837e..1bad9b721 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -247,7 +247,7 @@ Plugins are used by the editor to extend functionality. The most common types of Tutorials --------- -- :doc:`../development/plugins/index` +- :doc:`../tutorials/plugins/editor/index` Method Descriptions ------------------- diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index a247e349b..43a639482 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -52,7 +52,7 @@ Methods Description ----------- -Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by :ref:`EditorPlugin.create_spatial_gizmo`. +Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by :ref:`EditorSpatialGizmoPlugin.create_gizmo`. Method Descriptions ------------------- diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 481506635..255fc38f2 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -159,7 +159,7 @@ 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. -It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode`) when using GraphEdits. +It is greatly advised to enable low processor usage mode (see :ref:`OS.low_processor_usage_mode`) when using GraphEdits. Property Descriptions --------------------- diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 9469f247c..e14d22251 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -85,7 +85,7 @@ The error message if JSON source was not successfully parsed. See :ref:`@GlobalS A :ref:`Variant` containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces (``{}``) a :ref:`Dictionary` will be returned, if JSON source starts with braces (``[]``) an :ref:`Array` will be returned. -*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. +*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.* 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:* diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 687ad7be1..2e7fc7fe3 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -102,17 +102,17 @@ enum **Mode**: enum **ShadowFilter**: -- **SHADOW_FILTER_NONE** = **0** --- No filter applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_NONE** = **0** --- No filter applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF3** = **1** --- Percentage closer filtering (3 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF3** = **1** --- Percentage closer filtering (3 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF5** = **2** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF5** = **2** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF7** = **3** --- Percentage closer filtering (7 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF7** = **3** --- Percentage closer filtering (7 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF9** = **4** --- Percentage closer filtering (9 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF9** = **4** --- Percentage closer filtering (9 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF13** = **5** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF13** = **5** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter`. Description ----------- @@ -312,7 +312,7 @@ If ``true``, the Light2D will cast shadows. Default value: ``false``. | *Getter* | get_shadow_filter() | +----------+--------------------------+ -Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. Default value: ``None``. +Shadow filter type. Use :ref:`ShadowFilter` constants as values. Default value: ``SHADOW_FILTER_NONE``. .. _class_Light2D_property_shadow_filter_smooth: diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 4d2b4f642..74dc9ce18 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -56,37 +56,24 @@ There are two ways to create polygons. Either by using the :ref:`add_outline`: -`` +:: -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 - -`` + 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 Using :ref:`add_polygon` and indices of the vertices array. -`` +:: -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 - -`` + 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 Method Descriptions ------------------- diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 4cb1d93c0..e1710357d 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -82,7 +82,7 @@ enum **CompressionMode**: Description ----------- -A PacketPeer implementation that should be passed to :ref:`SceneTree.set_network_peer` after being initialized as either a client or server. Events can then be handled by connecting to :ref:`SceneTree` signals. +A PacketPeer implementation that should be passed to :ref:`SceneTree.network_peer` after being initialized as either a client or server. Events can then be handled by connecting to :ref:`SceneTree` signals. Tutorials --------- diff --git a/classes/class_os.rst b/classes/class_os.rst index 3e8ab4064..9d8ecfd27 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -1193,7 +1193,7 @@ Requests the OS to open a resource with the most appropriate program. For exampl ``OS.shell_open("C:\\Users\name\Downloads")`` on Windows opens the file explorer at the downloads folders of the user. -``OS.shell_open("http://godotengine.org")`` opens the default web browser on the official Godot website. +``OS.shell_open("https://godotengine.org")`` opens the default web browser on the official Godot website. .. _class_OS_method_show_virtual_keyboard: diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 4f9564266..a2c2277cc 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -76,7 +76,7 @@ Example of saving a node with different owners: The following example creates 3 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 @@ -120,5 +120,5 @@ Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). - :ref:`Error` **pack** **(** :ref:`Node` path **)** -Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner`. +Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.owner`. diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 87b72afb8..2958e41a7 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -296,7 +296,7 @@ enum **ShapeType**: - **SHAPE_CAPSULE** = **5** --- 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. -- **SHAPE_CONVEX_POLYGON** = **6** --- 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 :ref:`CollisionPolygon2D.set_polygon`, polygons modified with :ref:`shape_set_data` do not verify that the points supplied form is a convex polygon. +- **SHAPE_CONVEX_POLYGON** = **6** --- 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 :ref:`CollisionPolygon2D.polygon` property, polygons modified with :ref:`shape_set_data` do not verify that the points supplied form is a convex polygon. - **SHAPE_CONCAVE_POLYGON** = **7** --- 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/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 9c9a395fd..300f70828 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -1258,7 +1258,7 @@ Sets the transform matrix for a body shape. - void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** -Assigns a space to the body (see :ref:`create_space`). +Assigns a space to the body (see :ref:`space_create`). .. _class_PhysicsServer_method_body_set_state: diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 444148477..087326615 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -602,7 +602,7 @@ Path to an image used for boot splash. This user directory is used for storing persistent data (``user://`` filesystem). By default (no custom name defined), ``user://`` resolves to a project-specific folder in Godot's own configuration folder (see :ref:`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 :ref:`OS.get_user_data_dir`). -The :ref:`use_custom_user_dir` setting must be enabled for this to take effect. +The :ref:`application/config/use_custom_user_dir` setting must be enabled for this to take effect. .. _class_ProjectSettings_property_application/config/icon: @@ -626,7 +626,7 @@ Specifies a file to override project settings. For example: ``user://custom_sett - :ref:`bool` **application/config/use_custom_user_dir** -Allow the project to save to its own custom user dir (see :ref:`custom_user_dir_name`). This setting only works for desktop platforms. A name must be set in the :ref:`custom_user_dir_name` setting for this to take effect. +Allow the project to save to its own custom user dir (see :ref:`application/config/custom_user_dir_name`). This setting only works for desktop platforms. A name must be set in the :ref:`application/config/custom_user_dir_name` setting for this to take effect. .. _class_ProjectSettings_property_application/run/disable_stderr: diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 631180eba..eb7ff835c 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -87,8 +87,6 @@ Tutorials - `#interpolating-with-quaternions <../tutorials/3d/using_transforms.html#interpolating-with-quaternions>`_ in :doc:`../tutorials/3d/using_transforms` -- :doc:`../tutorials/math/rotations` - Property Descriptions --------------------- diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index 2168682ed..e51493ac0 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -35,7 +35,7 @@ Emitted when the user clicks the OK button. 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 :ref:`popup`\ () method. +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 one of the :ref:`Popup.popup` methods. :: diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 5f258a6b1..ac0fbbefe 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -100,7 +100,7 @@ Return the status of the connection, see :ref:`Status - :ref:`bool` **is_connected_to_host** **(** **)** const -Returns ``true`` if this peer is currently connected to a host, ``false[code] otherwise. +Returns ``true`` if this peer is currently connected to a host, ``false`` otherwise. .. _class_StreamPeerTCP_method_set_no_delay: diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index e9fa75088..693b637f8 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -46,10 +46,10 @@ Theme Properties Description ----------- -This is a helper class to generate a flat :ref:`Button` (see :ref:`Button.set_flat`), creating a ToolButton is equivalent to: +This is a helper class to generate a flat :ref:`Button` (see :ref:`Button.flat`), creating a ``ToolButton`` is equivalent to: :: var btn = Button.new() - btn.set_flat(true) + btn.flat = true diff --git a/classes/class_tween.rst b/classes/class_tween.rst index da37ee8af..33c311cd5 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -212,7 +212,7 @@ Property Descriptions | *Getter* | get_tween_process_mode() | +----------+-------------------------------+ -The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: TWEEN_PROCESS_IDLE. +The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. .. _class_Tween_property_playback_speed: diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 961e6c8c0..66dc23e44 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -251,7 +251,7 @@ Returns the vector's length. - :ref:`float` **length_squared** **(** **)** -Returns the vector's length squared. Prefer this function over :ref:`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 :ref:`length` if you need to sort vectors or need the squared length for some formula. .. _class_Vector2_method_linear_interpolate: diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index e0c38d45b..a37f7cac3 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -59,7 +59,7 @@ Slows down the vehicle by applying a braking force. The vehicle is only slowed d | *Getter* | get_engine_force() | +----------+-------------------------+ -Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have :ref:`VehicleWheel.set_use_as_traction` set to true and are in contact with a surface. The :ref:`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 :ref:`VehicleWheel.use_as_traction` set to true and are in contact with a surface. The :ref:`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. @@ -73,5 +73,5 @@ A negative value will result in the vehicle reversing. | *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 :ref:`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 :ref:`VehicleWheel.use_as_steering` set to true will automatically be rotated. diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 643b923a6..fb39be044 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -478,7 +478,7 @@ Methods +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_surface_update_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, VisualServer.MultimeshCustomDataFormat custom_data_format=0 **)** | +| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1565,6 +1565,22 @@ enum **MultimeshColorFormat**: - **MULTIMESH_COLOR_FLOAT** = **2** +.. _enum_VisualServer_MultimeshCustomDataFormat: + +.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_NONE: + +.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_8BIT: + +.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_FLOAT: + +enum **MultimeshCustomDataFormat**: + +- **MULTIMESH_CUSTOM_DATA_NONE** = **0** + +- **MULTIMESH_CUSTOM_DATA_8BIT** = **1** + +- **MULTIMESH_CUSTOM_DATA_FLOAT** = **2** + .. _enum_VisualServer_ReflectionProbeUpdateMode: .. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ONCE: @@ -2896,7 +2912,7 @@ Sets a mesh's surface's material. .. _class_VisualServer_method_multimesh_allocate: -- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, VisualServer.MultimeshCustomDataFormat custom_data_format=0 **)** +- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** .. _class_VisualServer_method_multimesh_get_aabb: diff --git a/getting_started/editor/unity_to_godot.rst b/getting_started/editor/unity_to_godot.rst index abd9f1065..937583913 100644 --- a/getting_started/editor/unity_to_godot.rst +++ b/getting_started/editor/unity_to_godot.rst @@ -232,14 +232,14 @@ Connections: groups and signals You can control nodes by accessing them using a script and calling functions (built-in or user-defined) on them. But there's more: You can also place them in a group and call a function on all nodes contained in this group! -This is explained in :ref:`this page `. +This is explained in the :ref:`scripting documentation `. But there's more! Certain nodes throw signals when certain actions happen. You can connect these signals to call a specific function when they happen. Note that you can define your own signals and send them whenever you want. -This feature is documented `here <../scripting/gdscript/gdscript_basics.html#signals>`_. +See the :ref:`signals documentation ` for details. -Script Serialization +Script serialization ^^^^^^^^^^^^^^^^^^^^ Unity can handle script serialization in two ways: @@ -248,8 +248,9 @@ Unity can handle script serialization in two ways: - Explicit: Non-public fields can be serialized using the ``[SerializeField]`` attribute. Godot also has a built-in script serialization system, but it works only explicitly. -You can serialize any serializable type (:ref:`built-in and various engine types `, including :ref:`class_Array` and :ref:`class_Dictionary`) -using the ``export`` keyword. This workflow is explained `here <../scripting/gdscript/gdscript_basics.html#exports>`_. +You can serialize any serializable type (:ref:`built-in and various engine types `, +including :ref:`class_Array` and :ref:`class_Dictionary`) using the ``export`` keyword. +See the :ref:`exports documentation ` for details. Unity also has a data type called ``ScriptableObject`` used to serialize custom asset objects. Its equivalent in Godot is the base class for all resources: :ref:`class_Resource`. diff --git a/getting_started/scripting/gdscript/gdscript_basics.rst b/getting_started/scripting/gdscript/gdscript_basics.rst index 8df64fca7..55a346abf 100644 --- a/getting_started/scripting/gdscript/gdscript_basics.rst +++ b/getting_started/scripting/gdscript/gdscript_basics.rst @@ -339,6 +339,8 @@ therefore, it will not be stripped away when the script is compiled. lines is considered a comment. """ +.. _doc_gdscript_builtin_types: + Built-in types -------------- @@ -1195,6 +1197,8 @@ class resource is done by calling the ``new`` function on the class object:: var a = MyClass.new() a.some_function() +.. _doc_gdscript_exports: + Exports ~~~~~~~ @@ -1455,6 +1459,8 @@ Alternatively, when not using references, the ``is_instance_valid(instance)`` can be used to check if an object has been freed. +.. _doc_gdscript_signals: + Signals ~~~~~~~ diff --git a/getting_started/scripting/gdscript/static_typing.rst b/getting_started/scripting/gdscript/static_typing.rst index 97f09dce6..20ddae1aa 100644 --- a/getting_started/scripting/gdscript/static_typing.rst +++ b/getting_started/scripting/gdscript/static_typing.rst @@ -103,7 +103,7 @@ type: Currently you can use three types of… types: -1. :ref:`Built-in` +1. :ref:`Built-in ` 2. Core classes and nodes (``Object``, ``Node``, ``Area2D``, ``Camera2D``, etc.) 3. Your own, custom classes. Look at the new :ref:`class_name ` diff --git a/tutorials/3d/introduction_to_3d.rst b/tutorials/3d/introduction_to_3d.rst index 86ed31ba4..59b5793cf 100644 --- a/tutorials/3d/introduction_to_3d.rst +++ b/tutorials/3d/introduction_to_3d.rst @@ -47,13 +47,15 @@ not as standardized as images). DCC-created models ------------------ +.. FIXME: Needs update to properly description Godot 3.x workflow + (used to reference a non existing doc_importing_3d_meshes importer). + There are two pipelines to import 3D models in Godot. The first and most -common one is through the :ref:`doc_importing_3d_scenes` importer, which allows you to import +common one is by :ref:`doc_importing_3d_scenes`, which allows you to import entire scenes (just as they look in the DCC), including animation, skeletal rigs, blend shapes, etc. -The second pipeline is through the :ref:`doc_importing_3d_meshes` importer. This -second method allows importing simple .OBJ files as mesh resources, +The second pipeline is by importing simple .OBJ files as mesh resources, which can be then put inside a :ref:`MeshInstance ` node for display. @@ -61,8 +63,8 @@ Generated geometry ------------------ It is possible to create custom geometry by using the -:ref:`Mesh ` resource directly. Simply create your arrays -and use the :ref:`Mesh.add_surface() ` +:ref:`ArrayMesh ` resource directly. Simply create your arrays +and use the :ref:`ArrayMesh.add_surface_from_arrays() ` function. A helper class is also available, :ref:`SurfaceTool `, which provides a more straightforward API and helpers for indexing, generating normals, tangents, etc. diff --git a/tutorials/vr/vr_starter_tutorial.rst b/tutorials/vr/vr_starter_tutorial.rst index 3dabc2d40..3c6a8c982 100644 --- a/tutorials/vr/vr_starter_tutorial.rst +++ b/tutorials/vr/vr_starter_tutorial.rst @@ -44,11 +44,11 @@ The provided starter assets contain some 3D models, sounds, and a few scenes alr Feel free to use these assets however you want! All original assets belong to the Godot community, with the other assets belonging to those listed below: -.. note:: The sky panorama was created by **CGTuts** and can be found `here `_. +.. note:: The sky panorama was created by **CGTuts** (`original source `_). The font used is **Titillium-Regular**, and is licensed under the SIL Open Font License, Version 1.1. - The audio used are from several different sources, all downloaded from the **Sonnis #GameAudioGDC Bundle**. The license for the sound effects is included as a PDF `here `_. + The audio used are from several different sources, all downloaded from the **Sonnis #GameAudioGDC Bundle** (`license in PDF format `_). The folders where the audio files are stored have the same name as folders in the bundle. The **OpenVR addon** was created by Bastiaan Olij and is released under the MIT license. It can be found both `on the Asset Library `_ and `on GitHub `_. @@ -495,7 +495,7 @@ will move the player left. Next we account for dead zones on both the trackpad and the joystick. The code for doing this is adapted from the link below, and I would highly recommend looking at it. -.. tip:: You can find a great article explaining joystick dead zones `here `_. +.. tip:: You can find a great article explaining joystick dead zones `on Third Helix `_. One thing to note is how large we are making the dead zones. The reason we are using such large dead zones is so the player cannot move themselves accidentally by placing their finger on the center of the touchpad/joystick, which can make players experience motion sickness if they are not expecting it.