diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Curve3D.xml | 4 | ||||
| -rw-r--r-- | doc/classes/KinematicBody2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/OrientedPathFollow.xml | 40 | ||||
| -rw-r--r-- | doc/classes/PathFollow.xml | 3 |
4 files changed, 6 insertions, 43 deletions
diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index b2e64f96a6..e9ee1c6974 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -225,7 +225,7 @@ </argument> <description> Sets the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. - The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow] or [OrientedPathFollow], this tilt is an offset over the natural tilt the [PathFollow] or [OrientedPathFollow] calculates. + The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the [PathFollow] calculates. </description> </method> <method name="tessellate" qualifiers="const"> @@ -248,7 +248,7 @@ The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. </member> <member name="up_vector_enabled" type="bool" setter="set_up_vector_enabled" getter="is_up_vector_enabled"> - If [code]true[/code], the curve will bake up vectors used for orientation. See [OrientedPathFollow]. Changing it forces the cache to be recomputed. + If [code]true[/code], the curve will bake up vectors used for orientation. This is used when a [member PathFollow.rotation_mode] is set to [code]ROTATION_ORIENTED[/code], see [PathFollow] for details. Changing it forces the cache to be recomputed. </member> </members> <constants> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 12d2bcec77..986010f832 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -94,7 +94,7 @@ [i]TODO: Update for stop_on_slope argument.[/i] If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. - Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. + Returns the [code]linear_velocity[/code] vector, rotated and/or scaled if a slide collision occurred. To get more detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> <method name="move_and_slide_with_snap"> diff --git a/doc/classes/OrientedPathFollow.xml b/doc/classes/OrientedPathFollow.xml deleted file mode 100644 index 665e3af6b2..0000000000 --- a/doc/classes/OrientedPathFollow.xml +++ /dev/null @@ -1,40 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="OrientedPathFollow" inherits="Spatial" category="Core" version="3.1"> - <brief_description> - Oriented point sampler for a [Path]. - </brief_description> - <description> - This node behaves like [PathFollow], except it uses its parent [Path] up vector information to enforce orientation. - Make sure to check if the curve of this node's parent [Path] has up vectors enabled. See [PathFollow] and [Curve3D] for further information. - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - </methods> - <members> - <member name="cubic_interp" type="bool" setter="set_cubic_interpolation" getter="get_cubic_interpolation"> - If [code]true[/code], the position between two cached points is interpolated cubically, and linearly otherwise. - The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. - There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. - </member> - <member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset"> - The node's offset along the curve. - </member> - <member name="loop" type="bool" setter="set_loop" getter="has_loop"> - If [code]true[/code], any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. - </member> - <member name="offset" type="float" setter="set_offset" getter="get_offset"> - The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. - </member> - <member name="unit_offset" type="float" setter="set_unit_offset" getter="get_unit_offset"> - The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. - </member> - <member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset"> - The node's offset perpendicular to the curve. - </member> - </members> - <constants> - </constants> -</class> diff --git a/doc/classes/PathFollow.xml b/doc/classes/PathFollow.xml index ed4a805a00..da4782a7c3 100644 --- a/doc/classes/PathFollow.xml +++ b/doc/classes/PathFollow.xml @@ -51,5 +51,8 @@ <constant name="ROTATION_XYZ" value="3" enum="RotationMode"> Allows the PathFollow to rotate in any axis. </constant> + <constant name="ROTATION_ORIENTED" value="4" enum="RotationMode"> + Uses the up vector information in a [Curve3D] to enforce orientation. This rotation mode requires the [Path]'s [member Curve3D.up_vector_enabled] property to be set to [code]true[/code]. + </constant> </constants> </class> |