diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml index 385e3a92854..6f5da28825c 100644 --- a/doc/classes/ShapeCast2D.xml +++ b/doc/classes/ShapeCast2D.xml @@ -15,7 +15,7 @@ - Adds a collision exception so the shape does not report collisions with the specified [CollisionObject2D] node. + Adds a collision exception so the shape does not report collisions with the specified node. @@ -35,19 +35,19 @@ Updates the collision information for the shape immediately, without waiting for the next [code]_physics_process[/code] call. Use this method, for example, when the shape or its parent has changed state. - [b]Note:[/b] [code]enabled == true[/code] is not required for this to work. + [b]Note:[/b] Setting [member enabled] to [code]true[/code] is not required for this to work. - The fraction from the [ShapeCast2D]'s origin to its [member target_position] (between 0 and 1) of how far the shape can move without triggering a collision. + Returns the fraction from this cast's origin to its [member target_position] of how far the shape can move without triggering a collision, as a value between [code]0.0[/code] and [code]1.0[/code]. - The fraction from the [ShapeCast2D]'s origin to its [member target_position] (between 0 and 1) of how far the shape must move to trigger a collision. + Returns the fraction from this cast's origin to its [member target_position] of how far the shape must move to trigger a collision, as a value between [code]0.0[/code] and [code]1.0[/code]. In ideal conditions this would be the same as [method get_closest_collision_safe_fraction], however shape casting is calculated in discrete steps, so the precise point of collision can occur between two calculated positions. @@ -97,7 +97,7 @@ Returns the collision point of one of the multiple collisions at [param index] where the shape intersects the colliding object. - [b]Note:[/b] this point is in the [b]global[/b] coordinate system. + [b]Note:[/b] This point is in the [b]global[/b] coordinate system. @@ -110,7 +110,7 @@ - Removes a collision exception so the shape does report collisions with the specified [CollisionObject2D] node. + Removes a collision exception so the shape does report collisions with the specified node. @@ -137,7 +137,7 @@ If [code]true[/code], collisions with [PhysicsBody2D]s will be reported. - The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. + The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. Returns the complete collision information from the collision sweep. The data returned is the same as in the [method PhysicsDirectSpaceState2D.get_rest_info] method. @@ -155,10 +155,10 @@ The number of intersections can be limited with this parameter, to reduce the processing time. - The [Shape2D]-derived shape to be used for collision queries. + The shape to be used for collision queries. - The shape's destination point, relative to this node's [code]position[/code]. + The shape's destination point, relative to this node's [member Node2D.position]. diff --git a/doc/classes/ShapeCast3D.xml b/doc/classes/ShapeCast3D.xml index f70cf169df8..ba0b021b4d9 100644 --- a/doc/classes/ShapeCast3D.xml +++ b/doc/classes/ShapeCast3D.xml @@ -15,7 +15,7 @@ - Adds a collision exception so the shape does not report collisions with the specified [CollisionObject3D] node. + Adds a collision exception so the shape does not report collisions with the specified node. @@ -28,26 +28,26 @@ - Removes all collision exceptions for this [ShapeCast3D]. + Removes all collision exceptions for this shape. Updates the collision information for the shape immediately, without waiting for the next [code]_physics_process[/code] call. Use this method, for example, when the shape or its parent has changed state. - [b]Note:[/b] [code]enabled == true[/code] is not required for this to work. + [b]Note:[/b] Setting [member enabled] to [code]true[/code] is not required for this to work. - The fraction from the [ShapeCast3D]'s origin to its [member target_position] (between 0 and 1) of how far the shape can move without triggering a collision. + Returns the fraction from this cast's origin to its [member target_position] of how far the shape can move without triggering a collision, as a value between [code]0.0[/code] and [code]1.0[/code]. - The fraction from the [ShapeCast3D]'s origin to its [member target_position] (between 0 and 1) of how far the shape must move to trigger a collision. + Returns the fraction from this cast's origin to its [member target_position] of how far the shape must move to trigger a collision, as a value between [code]0.0[/code] and [code]1.0[/code]. In ideal conditions this would be the same as [method get_closest_collision_safe_fraction], however shape casting is calculated in discrete steps, so the precise point of collision can occur between two calculated positions. @@ -97,7 +97,7 @@ Returns the collision point of one of the multiple collisions at [param index] where the shape intersects the colliding object. - [b]Note:[/b] this point is in the [b]global[/b] coordinate system. + [b]Note:[/b] This point is in the [b]global[/b] coordinate system. @@ -110,7 +110,7 @@ - Removes a collision exception so the shape does report collisions with the specified [CollisionObject3D] node. + Removes a collision exception so the shape does report collisions with the specified node. @@ -166,10 +166,10 @@ The number of intersections can be limited with this parameter, to reduce the processing time. - The [Shape3D]-derived shape to be used for collision queries. + The shape to be used for collision queries. - The shape's destination point, relative to this node's [code]position[/code]. + The shape's destination point, relative to this node's [member Node3D.position].