From 3b64ecbc4b2dcc1fe254406aa5b3272b2d7d4876 Mon Sep 17 00:00:00 2001 From: Andrea Catania Date: Thu, 20 Feb 2020 17:56:30 +0100 Subject: Renamed NavigationMeshInstance to NavigationRegion --- doc/classes/Navigation.xml | 2 +- doc/classes/NavigationMeshInstance.xml | 42 ---------------------------------- doc/classes/NavigationRegion.xml | 42 ++++++++++++++++++++++++++++++++++ 3 files changed, 43 insertions(+), 43 deletions(-) delete mode 100644 doc/classes/NavigationMeshInstance.xml create mode 100644 doc/classes/NavigationRegion.xml (limited to 'doc') diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index 0000ca6bd5..93170bca4a 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -4,7 +4,7 @@ Mesh-based navigation and pathfinding node. - Provides navigation and pathfinding within a collection of [NavigationMesh]es. These will be automatically collected from child [NavigationMeshInstance] nodes. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. + Provides navigation and pathfinding within a collection of [NavigationMesh]es. These will be automatically collected from child [NavigationRegion] nodes. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. diff --git a/doc/classes/NavigationMeshInstance.xml b/doc/classes/NavigationMeshInstance.xml deleted file mode 100644 index 75bd62e278..0000000000 --- a/doc/classes/NavigationMeshInstance.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - An instance of a [NavigationMesh]. - - - An instance of a [NavigationMesh]. It tells the [Navigation] node what can be navigated and what cannot, based on the [NavigationMesh] resource. This should be a child of a [Navigation] node. - - - - - - - - - Bakes the [NavigationMesh]. The baking is done in a seperate thread because navigation baking is not a cheap operation. This can be done at runtime. When it is completed, it automatically sets the new [NavigationMesh]. - - - - - - Determines if the [NavigationMeshInstance] is enabled or disabled. - - - The [NavigationMesh] resource to use. - - - - - - Notifies when the navigation mesh bake operation is completed. - - - - - Notifies when the [NavigationMesh] has changed. - - - - - - diff --git a/doc/classes/NavigationRegion.xml b/doc/classes/NavigationRegion.xml new file mode 100644 index 0000000000..41fac70654 --- /dev/null +++ b/doc/classes/NavigationRegion.xml @@ -0,0 +1,42 @@ + + + + A region of the navigation map. + + + A region of the navigation map. It tells the [Navigation] node what can be navigated and what cannot, based on the [NavigationMesh] resource. This should be a child of a [Navigation] node (even not a direct child). + + + + + + + + + Bakes the [NavigationMesh]. The baking is done in a seperate thread because navigation baking is not a cheap operation. This can be done at runtime. When it is completed, it automatically sets the new [NavigationMesh]. + + + + + + Determines if the [NavigationRegion] is enabled or disabled. + + + The [NavigationMesh] resource to use. + + + + + + Notifies when the navigation mesh bake operation is completed. + + + + + Notifies when the [NavigationMesh] has changed. + + + + + + -- cgit v1.2.3 From 2e0fb66c6f5dd280a28bffb1233e400afa1a698d Mon Sep 17 00:00:00 2001 From: Andrea Catania Date: Fri, 21 Feb 2020 12:19:24 +0100 Subject: Renamed PlaneShape to WorldMarginShape --- doc/classes/PhysicsServer.xml | 2 +- doc/classes/PlaneShape.xml | 20 -------------------- doc/classes/WorldMarginShape.xml | 20 ++++++++++++++++++++ 3 files changed, 21 insertions(+), 21 deletions(-) delete mode 100644 doc/classes/PlaneShape.xml create mode 100644 doc/classes/WorldMarginShape.xml (limited to 'doc') diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 592d3d8e4e..c9f4accee2 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1467,7 +1467,7 @@ If [code]set[/code] there is a linear motor on this axis that targets a specific velocity. - The [Shape] is a [PlaneShape]. + The [Shape] is a [WorldMarginShape]. The [Shape] is a [RayShape]. diff --git a/doc/classes/PlaneShape.xml b/doc/classes/PlaneShape.xml deleted file mode 100644 index b40e133d00..0000000000 --- a/doc/classes/PlaneShape.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - Infinite plane shape for 3D collisions. - - - An infinite plane shape for 3D collisions. Note that the [Plane]'s normal matters; anything "below" the plane will collide with it. If the [PlaneShape] is used in a [PhysicsBody], it will cause colliding objects placed "below" it to teleport "above" the plane. - - - - - - - - The [Plane] used by the [PlaneShape] for collision. - - - - - diff --git a/doc/classes/WorldMarginShape.xml b/doc/classes/WorldMarginShape.xml new file mode 100644 index 0000000000..54f76a066b --- /dev/null +++ b/doc/classes/WorldMarginShape.xml @@ -0,0 +1,20 @@ + + + + Infinite plane shape for 3D collisions. + + + An infinite plane shape for 3D collisions. Note that the [Plane]'s normal matters; anything "below" the plane will collide with it. If the [WorldMarginShape] is used in a [PhysicsBody], it will cause colliding objects placed "below" it to teleport "above" the plane. + + + + + + + + The [Plane] used by the [WorldMarginShape] for collision. + + + + + -- cgit v1.2.3 From 483994601d8c9f25185fc78e1ae60b19849b00f9 Mon Sep 17 00:00:00 2001 From: Andrea Catania Date: Fri, 28 Feb 2020 08:05:04 +0100 Subject: Renamed NavigationPolygonInstance to NavigationRegion2D --- doc/classes/Navigation2D.xml | 2 +- doc/classes/NavigationPolygon.xml | 4 ++-- doc/classes/NavigationPolygonInstance.xml | 19 ------------------- doc/classes/NavigationRegion2D.xml | 19 +++++++++++++++++++ 4 files changed, 22 insertions(+), 22 deletions(-) delete mode 100644 doc/classes/NavigationPolygonInstance.xml create mode 100644 doc/classes/NavigationRegion2D.xml (limited to 'doc') diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index 0d016a3210..dcbfbc2350 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -4,7 +4,7 @@ 2D navigation and pathfinding node. - Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. These are automatically collected from child [NavigationPolygonInstance] nodes. + Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. These are automatically collected from child [NavigationRegion2D] nodes. diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index da291b7337..b0f77dff83 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -11,7 +11,7 @@ var outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) polygon.add_outline(outline) polygon.make_polygons_from_outlines() - $NavigationPolygonInstance.navpoly = polygon + $NavigationRegion2D.navpoly = polygon [/codeblock] Using [method add_polygon] and indices of the vertices array. [codeblock] @@ -20,7 +20,7 @@ polygon.set_vertices(vertices) var indices = PackedInt32Array(0, 3, 1) polygon.add_polygon(indices) - $NavigationPolygonInstance.navpoly = polygon + $NavigationRegion2D.navpoly = polygon [/codeblock] diff --git a/doc/classes/NavigationPolygonInstance.xml b/doc/classes/NavigationPolygonInstance.xml deleted file mode 100644 index 34c6b09859..0000000000 --- a/doc/classes/NavigationPolygonInstance.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/NavigationRegion2D.xml b/doc/classes/NavigationRegion2D.xml new file mode 100644 index 0000000000..aef114e1db --- /dev/null +++ b/doc/classes/NavigationRegion2D.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3