From 8e3f71d75060c70745f541d5cab509f7bea690df Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 13 Aug 2021 19:23:31 +0200 Subject: Rename LineShape2D to WorldMarginShape2D The new name makes it more obvious that it acts as an infinite plane, and is consistent with its 3D counterpart (WorldMarginShape3D). --- doc/classes/LineShape2D.xml | 23 ----------------------- doc/classes/PhysicsServer2D.xml | 16 ++++++++-------- doc/classes/WorldMarginShape2D.xml | 23 +++++++++++++++++++++++ 3 files changed, 31 insertions(+), 31 deletions(-) delete mode 100644 doc/classes/LineShape2D.xml create mode 100644 doc/classes/WorldMarginShape2D.xml (limited to 'doc/classes') diff --git a/doc/classes/LineShape2D.xml b/doc/classes/LineShape2D.xml deleted file mode 100644 index 434e6fba8e..0000000000 --- a/doc/classes/LineShape2D.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - Line shape for 2D collisions. - - - Line shape for 2D collisions. It works like a 2D plane and will not allow any physics body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. - - - - - - - - The line's distance from the origin. - - - The line's normal. Defaults to [code]Vector2.UP[/code]. - - - - - diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index 387d79d210..1df2fd0158 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -716,11 +716,6 @@ Sets a joint parameter. See [enum JointParam] for a list of available parameters. - - - - - @@ -812,6 +807,11 @@ Sets the value for a space parameter. See [enum SpaceParameter] for a list of available parameters. + + + + + @@ -837,11 +837,11 @@ - - This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks. + + This is the constant for creating world margin shapes. A world margin shape is an [i]infinite[/i] line with an origin point, and a normal. Thus, it can be used for front/behind checks. - This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections. + This is the constant for creating segment shapes. A segment shape is a [i]finite[/i] line from a point A to a point B. It can be checked for intersections. This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks. diff --git a/doc/classes/WorldMarginShape2D.xml b/doc/classes/WorldMarginShape2D.xml new file mode 100644 index 0000000000..1839ab16ad --- /dev/null +++ b/doc/classes/WorldMarginShape2D.xml @@ -0,0 +1,23 @@ + + + + Line shape for 2D collisions. + + + Line shape for 2D collisions. It works like a 2D plane and will not allow any physics body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. + + + + + + + + The line's distance from the origin. + + + The line's normal. Defaults to [code]Vector2.UP[/code]. + + + + + -- cgit v1.2.3