From cc30e2a9a503f4b13eb25af2a552a029d6de815b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 13 Sep 2017 20:56:01 +0200 Subject: doc: Sync classref with current source [ci skip] --- doc/classes/AudioStreamPlayer.xml | 2 +- doc/classes/AudioStreamPlayer2D.xml | 2 +- doc/classes/AudioStreamPlayer3D.xml | 2 +- doc/classes/KinematicBody2D.xml | 111 ++------------ doc/classes/KinematicCollision2D.xml | 105 +++++++++++++ doc/classes/NavigationMesh.xml | 278 +++++++++++++++++++++++++++++++++++ doc/classes/Tree.xml | 8 + doc/classes/TreeItem.xml | 14 ++ 8 files changed, 418 insertions(+), 104 deletions(-) create mode 100644 doc/classes/KinematicCollision2D.xml diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 88e7b9ad9e..64823c3be5 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -121,7 +121,7 @@ - + diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 879f618c06..f2464ddac4 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -153,7 +153,7 @@ - + diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 8c5238ac40..668e0cc0d2 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -295,7 +295,7 @@ - + diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 448389e950..26c7c6125d 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -13,109 +13,28 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Return the velocity of the body that collided with this one. - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - + + - - - - + + - + - - - - - - - - + + @@ -138,22 +57,12 @@ - - + + - Move the body in the given direction, stopping if there is an obstacle. If as a result of a movement there will be any collision then informations about this collision will be in returned dictionary. Dictionary will contains those keys: - - "position" - collision position - - "normal" - collision normal - - "local_shape" - id of this kinematic body shape that took part in a collision - - "travel" - traveled movement before being stopped - - "remainder" - remaining movement before being stopped - - "collider_id" - id of the collider, it can be used when dealing with [Physics2DServer] - - "collider" - colliding body - - "collider_shape_index" - index of the colliding shape, inside collider body "collider_metadata" - If the body did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. Please note that this method is less user friendly than [method move_and_slide]. If you don't want to program each edge case manually, then it's recommended to use [method move_and_slide] instead. diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml new file mode 100644 index 0000000000..4ef35066d0 --- /dev/null +++ b/doc/classes/KinematicCollision2D.xml @@ -0,0 +1,105 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index c1bce2b410..788fadfd77 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -31,6 +31,84 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -45,12 +123,164 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -59,13 +289,61 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 68228ed803..a92a51049b 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -113,6 +113,14 @@ Get the flags of the current drop mode. + + + + + + + + diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 48159946fa..02c264cbff 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -99,6 +99,12 @@ + + + + + + @@ -383,6 +389,14 @@ + + + + + + + + -- cgit v1.2.3