From 285234e8d908a9dad0cda568e98f777ff002481e Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sun, 26 Aug 2018 15:31:09 -0700 Subject: [PATCH] [DOCS] Corrections and clarifications --- doc/classes/KinematicBody.xml | 2 ++ doc/classes/PhysicsMaterial.xml | 4 ++++ doc/classes/Vector2.xml | 12 +++++++++--- doc/classes/Vector3.xml | 14 +++++++++++--- doc/classes/VideoStream.xml | 1 + doc/classes/ViewportContainer.xml | 3 +++ doc/classes/WindowDialog.xml | 2 +- 7 files changed, 31 insertions(+), 7 deletions(-) diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 0c66319ae73..17310ab4dc4 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -115,6 +115,8 @@ + Moves the body while keeping it attached to slopes. Similar to [method move_and_slide]. + As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0, 0)[/code] or by using [method move_and_slide] instead. diff --git a/doc/classes/PhysicsMaterial.xml b/doc/classes/PhysicsMaterial.xml index bfebb472a55..3eebcc57a1d 100644 --- a/doc/classes/PhysicsMaterial.xml +++ b/doc/classes/PhysicsMaterial.xml @@ -1,8 +1,10 @@ + A material for physics properties. + Provides a means of modifying the collision properties of a [PhysicsBody]. @@ -14,8 +16,10 @@ + The body's bounciness. Default value: [code]0[/code]. + The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). Default value: [code]1[/code]. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 4bc18b926ed..a721ef50c55 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -109,7 +109,7 @@ - Cubicly interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], or a percentage of how far along the interpolation is. + Cubicly interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. @@ -175,7 +175,7 @@ - Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is. + Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. @@ -227,7 +227,7 @@ - Returns the result of SLERP between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Returns the result of SLERP between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. Both vectors need to be normalized. @@ -267,16 +267,22 @@ + Null vector. + Infinite vector. + Left unit vector. + Right unit vector. + Up unit vector. + Down unit vector. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index b4dcc6c6aa4..4211c34d8e2 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -78,7 +78,7 @@ - Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount (t). (t) should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. @@ -151,7 +151,7 @@ - Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is. + Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation.. @@ -228,7 +228,7 @@ - Returns the result of SLERP between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. + Returns the result of SLERP between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], representing the amount of interpolation. Both vectors need to be normalized. @@ -280,20 +280,28 @@ Enumerated value for the Z axis. + Null vector. + Infinite vector. + Left unit vector. + Right unit vector. + Up unit vector. + Down unit vector. + Forward unit vector. + Back unit vector. diff --git a/doc/classes/VideoStream.xml b/doc/classes/VideoStream.xml index 6bfa48511bd..9f2655ed1bd 100644 --- a/doc/classes/VideoStream.xml +++ b/doc/classes/VideoStream.xml @@ -1,6 +1,7 @@ + Base resource for video streams. diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml index 8c60fb473da..dde429440d1 100644 --- a/doc/classes/ViewportContainer.xml +++ b/doc/classes/ViewportContainer.xml @@ -1,8 +1,10 @@ + Control for holding [Viewport]s. + A [Container] node that holds a [Viewport], automatically setting its size. @@ -12,6 +14,7 @@ + If [code]true[/code] the viewport will be scaled to the control's size. Default value:[code]false[/code]. diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index 39487f5020b..f7f2d10fcd9 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -24,7 +24,7 @@ If [code]true[/code] the user can resize the window. Default value: [code]false[/code]. - The text displayed in the window's title bar. Default value: "Save a File". + The text displayed in the window's title bar.