diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2021-08-13 19:23:31 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2021-08-14 03:12:13 +0200 |
| commit | 8e3f71d75060c70745f541d5cab509f7bea690df (patch) | |
| tree | 4ffd6ca1e96fdd3d429ca855e73132f44c5ff148 /doc/classes/WorldMarginShape2D.xml | |
| parent | 3a48474c49faff6fd12f7875a841fa7872d56f9e (diff) | |
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).
Diffstat (limited to 'doc/classes/WorldMarginShape2D.xml')
| -rw-r--r-- | doc/classes/WorldMarginShape2D.xml | 23 |
1 files changed, 23 insertions, 0 deletions
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 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="WorldMarginShape2D" inherits="Shape2D" version="4.0"> + <brief_description> + Line shape for 2D collisions. + </brief_description> + <description> + 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. + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="distance" type="float" setter="set_distance" getter="get_distance" default="0.0"> + The line's distance from the origin. + </member> + <member name="normal" type="Vector2" setter="set_normal" getter="get_normal" default="Vector2(0, -1)"> + The line's normal. Defaults to [code]Vector2.UP[/code]. + </member> + </members> + <constants> + </constants> +</class> |