From a0e5645d1802278f7c42c13882842fefdf3e20d0 Mon Sep 17 00:00:00 2001 From: Relintai Date: Sat, 10 Jun 2023 21:10:45 +0200 Subject: [PATCH] Fix godot4 syntax in docs. --- doc/classes/Navigation2DServer.xml | 124 +++++++-------- doc/classes/NavigationAgent.xml | 16 +- doc/classes/NavigationAgent2D.xml | 16 +- doc/classes/NavigationGeometryParser2D.xml | 8 +- doc/classes/NavigationGeometryParser3D.xml | 8 +- doc/classes/NavigationLink2D.xml | 10 +- doc/classes/NavigationLink3D.xml | 10 +- doc/classes/NavigationMesh.xml | 2 +- doc/classes/NavigationMeshGenerator.xml | 48 +++--- doc/classes/NavigationMeshInstance.xml | 2 +- .../NavigationMeshSourceGeometryData2D.xml | 12 +- .../NavigationMeshSourceGeometryData3D.xml | 20 +-- doc/classes/NavigationObstacle.xml | 10 +- doc/classes/NavigationObstacle2D.xml | 10 +- doc/classes/NavigationPathQueryResult2D.xml | 8 +- doc/classes/NavigationPathQueryResult3D.xml | 8 +- doc/classes/NavigationPolygon.xml | 16 +- doc/classes/NavigationPolygonInstance.xml | 10 +- doc/classes/NavigationServer.xml | 146 +++++++++--------- 19 files changed, 242 insertions(+), 242 deletions(-) diff --git a/doc/classes/Navigation2DServer.xml b/doc/classes/Navigation2DServer.xml index d66818197..5612829db 100644 --- a/doc/classes/Navigation2DServer.xml +++ b/doc/classes/Navigation2DServer.xml @@ -25,7 +25,7 @@ - + Return [code]true[/code] if the specified [param agent] uses avoidance. @@ -57,32 +57,32 @@ - - + + If [param enabled] is [code]true[/code] the specified [param agent] uses avoidance. - - + + Set the agent's [code]avoidance_layers[/code] bitmask. - - + + Set the agent's [code]avoidance_mask[/code] bitmask. - - + + Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority). The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. @@ -162,8 +162,8 @@ - - + + Replaces the internal velocity in the collision avoidance simulation with [param velocity] for the specified [param agent]. When an agent is teleported to a new position far away this function should be used in the same frame. If called frequently this function can get agents stuck. @@ -195,120 +195,120 @@ - + Returns the ending position of this [code]link[/code]. - + Returns the [code]enter_cost[/code] of this [code]link[/code]. - + Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to. - + Returns the navigation layers for this [code]link[/code]. - + Returns the [code]ObjectID[/code] of the object which manages this link. - + Returns the starting position of this [code]link[/code]. - + Returns the [code]travel_cost[/code] of this [code]link[/code]. - + Returns whether this [code]link[/code] can be travelled in both directions. - - + + Sets whether this [code]link[/code] can be travelled in both directions. - - + + Sets the exit position for the [code]link[/code]. - - + + Sets the [code]enter_cost[/code] for this [code]link[/code]. - - + + Sets the navigation map [RID] for the link. - - + + Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer2D.map_get_path]). - - + + Set the [code]ObjectID[/code] of the object which manages this link. - - + + Sets the entry position for this [code]link[/code]. - - + + Sets the [code]travel_cost[/code] for this [code]link[/code]. @@ -375,21 +375,21 @@ - + Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. - - + + Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code]. - - + + Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [code]map[/code]. @@ -414,7 +414,7 @@ - + Returns whether the navigation [param map] allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -466,62 +466,62 @@ - + Returns the navigation map [RID] the requested [param obstacle] is currently assigned to. - - + + - - + + Sets the navigation map [RID] for the obstacle. - - + + Sets the position of the obstacle in world space. - - + + Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. - - + + Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters2D]. Updates the provided [NavigationPathQueryResult2D] result object with the path among other results requested by the query. - - + + Set the map's link connection radius used to connect links to navigation polygons. - - + + Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -578,7 +578,7 @@ - + Returns the [code]ObjectID[/code] of the object which manages this region. @@ -592,7 +592,7 @@ - + Returns whether the navigation [param region] is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -641,8 +641,8 @@ - - + + Set the [code]ObjectID[/code] of the object which manages this region. @@ -665,8 +665,8 @@ - - + + If [param enabled] the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. diff --git a/doc/classes/NavigationAgent.xml b/doc/classes/NavigationAgent.xml index b7ff8c122..d62b36ae3 100644 --- a/doc/classes/NavigationAgent.xml +++ b/doc/classes/NavigationAgent.xml @@ -18,14 +18,14 @@ - + Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. - + Returns whether or not the specified mask of the [member avoidance_mask] bitmask is enabled, given a [param mask_number] between 1 and 32. @@ -112,16 +112,16 @@ - - + + Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. - - + + Based on [param value], enables or disables the specified mask in the [member avoidance_mask] bitmask, given a [param mask_number] between 1 and 32. @@ -227,7 +227,7 @@ - + Notifies when a navigation link has been reached. The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: @@ -261,7 +261,7 @@ - + Notifies when a waypoint along the path has been reached. The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index 05454d374..39bbe26f1 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -18,14 +18,14 @@ - + Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. - + Returns whether or not the specified mask of the [member avoidance_mask] bitmask is enabled, given a [param mask_number] between 1 and 32. @@ -112,16 +112,16 @@ - - + + Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. - - + + Based on [param value], enables or disables the specified mask in the [member avoidance_mask] bitmask, given a [param mask_number] between 1 and 32. @@ -220,7 +220,7 @@ - + Notifies when a navigation link has been reached. The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: @@ -254,7 +254,7 @@ - + Notifies when a waypoint along the path has been reached. The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: diff --git a/doc/classes/NavigationGeometryParser2D.xml b/doc/classes/NavigationGeometryParser2D.xml index f36040ce4..764660ca2 100644 --- a/doc/classes/NavigationGeometryParser2D.xml +++ b/doc/classes/NavigationGeometryParser2D.xml @@ -11,16 +11,16 @@ - - - + + + Called when overridden and the [NavigationMeshGenerator] is parsing geometry for [NavigationPolygon] baking. Custom 2D geometry can be added to the [param source_geometry]. - + Called when parsing geometry nodes for [NavigationPolygon] baking. If [code]true[/code] will call [method _parse_geometry] with this node. diff --git a/doc/classes/NavigationGeometryParser3D.xml b/doc/classes/NavigationGeometryParser3D.xml index b4c2d6380..a87a51643 100644 --- a/doc/classes/NavigationGeometryParser3D.xml +++ b/doc/classes/NavigationGeometryParser3D.xml @@ -11,16 +11,16 @@ - - - + + + Called when overridden and the [NavigationMeshGenerator] is parsing geometry for [NavigationMesh] baking. Custom 3D geometry can be added to the [param source_geometry]. - + Called when parsing geometry nodes for [NavigationMesh] baking. If [code]true[/code] will call [method _parse_geometry] with this node. diff --git a/doc/classes/NavigationLink2D.xml b/doc/classes/NavigationLink2D.xml index 7dd7e3177..5448f8c2c 100644 --- a/doc/classes/NavigationLink2D.xml +++ b/doc/classes/NavigationLink2D.xml @@ -24,29 +24,29 @@ - + Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. - + Sets the [member end_position] that is relative to the link from a global [param position]. - + Sets the [member start_position] that is relative to the link from a global [param position]. - - + + Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. diff --git a/doc/classes/NavigationLink3D.xml b/doc/classes/NavigationLink3D.xml index 128648ba2..efe6c1690 100644 --- a/doc/classes/NavigationLink3D.xml +++ b/doc/classes/NavigationLink3D.xml @@ -24,29 +24,29 @@ - + Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. - + Sets the [member end_position] that is relative to the link from a global [param position]. - + Sets the [member start_position] that is relative to the link from a global [param position]. - - + + Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 4553a9830..36e01c2f9 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -38,7 +38,7 @@ - + Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon. diff --git a/doc/classes/NavigationMeshGenerator.xml b/doc/classes/NavigationMeshGenerator.xml index 223b7e246..c555bb950 100644 --- a/doc/classes/NavigationMeshGenerator.xml +++ b/doc/classes/NavigationMeshGenerator.xml @@ -14,96 +14,96 @@ - - - + + + Bakes the provided [param navigation_polygon] with the data from the provided [param source_geometry_data]. After the process is finished the optional [param callback] will be called. - - - + + + Bakes the provided [param navigation_mesh] with the data from the provided [param source_geometry_data]. After the process is finished the optional [param callback] will be called. - + Returns [code]true[/code] if [param navigation_mesh] is currently baking or geometry parsing. - + Returns [code]true[/code] if [param navigation_polygon] is currently baking or geometry parsing. - - - + + + Parses the [SceneTree] (not thread-safe) for source geometry according to the properties of [param navigation_polygon] and returns a [NavigationMeshSourceGeometryData2D] that can be used to bake a navigation mesh. After the process is finished the optional [param callback] will be called. - - - + + + Parses the [SceneTree] (not thread-safe) for source geometry according to the properties of [param navigation_mesh] and returns a [NavigationMeshSourceGeometryData2D] that can be used to bake a navigation mesh. After the process is finished the optional [param callback] will be called. - - - + + + Uses both [method parse_2d_source_geometry_data] and [method bake_2d_from_source_geometry_data] in sequence. After the process is finished the optional [param callback] will be called. - - - + + + Uses both [method parse_3d_source_geometry_data] and [method bake_3d_from_source_geometry_data] in sequence. After the process is finished the optional [param callback] will be called. - + Registers a 2d navigation geometry parser to contribute geometry data from parser specified node class(es) for navigation mesh baking. - + Registers a 3d navigation geometry parser to contribute geometry data from parser specified node class(es) for navigation mesh baking. - + Unregisters the specific 2d navigation geometry parser. - + Unregisters the specific 3d navigation geometry parser. diff --git a/doc/classes/NavigationMeshInstance.xml b/doc/classes/NavigationMeshInstance.xml index a435b8b1a..a72333fe8 100644 --- a/doc/classes/NavigationMeshInstance.xml +++ b/doc/classes/NavigationMeshInstance.xml @@ -52,7 +52,7 @@ - + Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World3D] default navigation map so this function is only required to override the default map. diff --git a/doc/classes/NavigationMeshSourceGeometryData2D.xml b/doc/classes/NavigationMeshSourceGeometryData2D.xml index b9161f3aa..469a39c4b 100644 --- a/doc/classes/NavigationMeshSourceGeometryData2D.xml +++ b/doc/classes/NavigationMeshSourceGeometryData2D.xml @@ -11,14 +11,14 @@ - + Adds the outline points of a shape as obstructed area. - + Adds the outline points of a shape as traversable area. @@ -30,13 +30,13 @@ - + Returns all the obstructed area outlines arrays. - + Returns all the traversable area outlines arrays. @@ -49,14 +49,14 @@ - + Sets all the obstructed area outlines arrays. - + Sets all the traversable area outlines arrays. diff --git a/doc/classes/NavigationMeshSourceGeometryData3D.xml b/doc/classes/NavigationMeshSourceGeometryData3D.xml index 9fa810bdd..8877124df 100644 --- a/doc/classes/NavigationMeshSourceGeometryData3D.xml +++ b/doc/classes/NavigationMeshSourceGeometryData3D.xml @@ -11,24 +11,24 @@ - - + + Adds an array of vertex positions to the geometry data for navigation mesh baking to form triangulated faces. For each face the array must have three vertex positions in clockwise winding order. Since [NavigationMesh] resource have no transform all vertex positions need to be offset by the node's transform using the [code]xform[/code] parameter. - - + + Adds the geometry data of a [Mesh] resource to the navigation mesh baking data. The mesh must have valid triangulated mesh data to be considered. Since [NavigationMesh] resource have no transform all vertex positions need to be offset by the node's transform using the [code]xform[/code] parameter. - - + + Adds an [Array] the size of [constant Mesh.ARRAY_MAX] and with vertices at index [constant Mesh.ARRAY_VERTEX] and indices at index [constant Mesh.ARRAY_INDEX] to the navigation mesh baking data. The array must have valid triangulated mesh data to be considered. Since [NavigationMesh] resource have no transform all vertex positions need to be offset by the node's transform using the [code]xform[/code] parameter. @@ -40,13 +40,13 @@ - + Returns the parsed source geometry data indices array. - + Returns the parsed source geometry data vertices array. @@ -59,7 +59,7 @@ - + Sets the parsed source geometry data indices. The indices need to be matched with appropriated vertices. [b]Warning:[/b] Inappropriate data can crash the baking process of the involved third-party libraries. @@ -67,7 +67,7 @@ - + Sets the parsed source geometry data vertices. The vertices need to be matched with appropriated indices. [b]Warning:[/b] Inappropriate data can crash the baking process of the involved third-party libraries. diff --git a/doc/classes/NavigationObstacle.xml b/doc/classes/NavigationObstacle.xml index a15325bac..a5024b902 100644 --- a/doc/classes/NavigationObstacle.xml +++ b/doc/classes/NavigationObstacle.xml @@ -20,7 +20,7 @@ - + Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. @@ -45,8 +45,8 @@ - - + + Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. @@ -60,7 +60,7 @@ - + Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the [code]obstacle[/code] on the NavigationServer. @@ -83,7 +83,7 @@ Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices. - + The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle. diff --git a/doc/classes/NavigationObstacle2D.xml b/doc/classes/NavigationObstacle2D.xml index 21651444d..c1f5f0ea3 100644 --- a/doc/classes/NavigationObstacle2D.xml +++ b/doc/classes/NavigationObstacle2D.xml @@ -20,7 +20,7 @@ - + Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. @@ -45,8 +45,8 @@ - - + + Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. @@ -60,7 +60,7 @@ - + Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the [code]obstacle[/code] on the NavigationServer. @@ -76,7 +76,7 @@ Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices. - + The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle. diff --git a/doc/classes/NavigationPathQueryResult2D.xml b/doc/classes/NavigationPathQueryResult2D.xml index c02cc4352..8bca8f745 100644 --- a/doc/classes/NavigationPathQueryResult2D.xml +++ b/doc/classes/NavigationPathQueryResult2D.xml @@ -18,16 +18,16 @@ - + The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer2D.map_get_path]. - + The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through. - + The [RID]s of the regions and links that each point of the path goes through. - + The type of navigation primitive (region or link) that each point of the path goes through. diff --git a/doc/classes/NavigationPathQueryResult3D.xml b/doc/classes/NavigationPathQueryResult3D.xml index e4de95fac..82fb17ee4 100644 --- a/doc/classes/NavigationPathQueryResult3D.xml +++ b/doc/classes/NavigationPathQueryResult3D.xml @@ -18,16 +18,16 @@ - + The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer3D.map_get_path]. - + The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through. - + The [RID]s of the regions and links that each point of the path goes through. - + The type of navigation primitive (region or link) that each point of the path goes through. diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 7454a5222..9f69d89f2 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -10,7 +10,7 @@ Using [method add_outline]: [codeblock] var new_navigation_polygon = NavigationPolygon.new() - var new_navigation_polygon_outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) + var new_navigation_polygon_outline = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) new_navigation_polygon.add_outline(new_navigation_polygon_outline) NavigationMeshGenerator.bake_2d_from_source_geometry_data(new_navigation_polygon, NavigationMeshSourceGeometryData2D.new()); $NavigationRegion2D.navigation_polygon = new_navigation_polygon @@ -18,9 +18,9 @@ Using [method add_polygon] and indices of the vertices array. [codeblock] var new_navigation_polygon = NavigationPolygon.new() - var new_navigation_polygon_vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) + var new_navigation_polygon_vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) new_navigation_polygon.vertices = new_navigation_polygon_vertices - var new_navigation_polygon_polygon_indices = PackedInt32Array([0, 1, 2, 3]) + var new_navigation_polygon_polygon_indices = PoolIntArray([0, 1, 2, 3]) new_navigation_polygon.add_polygon(new_navigation_polygon_polygon_indices) new_navigation_polygon.commit_changes() $NavigationRegion2D.navigation_polygon = new_navigation_polygon @@ -104,21 +104,21 @@ - + Sets the array of baked outlines. The baked outlines are the result of a finished [NavigationMeshGenerator] baking process and primarily used for debugging purposes. - + Sets the outline arrays. The outlines need to be baked to actual navigation mesh polygons by using the [NavigationMeshGenerator]. - + Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon. @@ -164,14 +164,14 @@ - + Returns the array of baked outlines. The baked outlines are the result of a finished [NavigationMeshGenerator] baking process and primarily used for debugging purposes. - + Returns whether or not the specified layer of the [member geometry_collision_mask] is enabled, given a [param layer_number] between 1 and 32. diff --git a/doc/classes/NavigationPolygonInstance.xml b/doc/classes/NavigationPolygonInstance.xml index 241b3d87c..cfdd97955 100644 --- a/doc/classes/NavigationPolygonInstance.xml +++ b/doc/classes/NavigationPolygonInstance.xml @@ -17,7 +17,7 @@ - + Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. @@ -37,7 +37,7 @@ - + Bakes the [NavigationPolygon]. If [param on_thread] is set to [code]true[/code] (default), the baking is done on a separate thread. @@ -50,8 +50,8 @@ - - + + Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. @@ -66,7 +66,7 @@ - + Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map. diff --git a/doc/classes/NavigationServer.xml b/doc/classes/NavigationServer.xml index 56b0c60bc..0bc3b6430 100644 --- a/doc/classes/NavigationServer.xml +++ b/doc/classes/NavigationServer.xml @@ -25,7 +25,7 @@ - + Returns [code]true[/code] if the provided [param agent] has avoidance enabled. @@ -39,7 +39,7 @@ - + Returns [code]true[/code] if the provided [param agent] uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z). @@ -64,32 +64,32 @@ - - + + If [param enabled] the provided [param agent] calculates avoidance. - - + + Set the agent's [code]avoidance_layers[/code] bitmask. - - + + Set the agent's [code]avoidance_mask[/code] bitmask. - - + + Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority). The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. @@ -97,8 +97,8 @@ - - + + Updates the provided [param agent] [param height]. @@ -153,8 +153,8 @@ - - + + The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -162,7 +162,7 @@ - + The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. @@ -170,7 +170,7 @@ - + Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled. If [code]true[/code] the agent calculates avoidance velocities in 3D for the xyz-axis, e.g. for games that take place in air, unterwater or space. The 3D using agent only avoids other 3D avoidance using agent's. The 3D using agent only reacts to radius based avoidance obstacles. The 3D using agent ignores any vertices based obstacles. The 3D using agent only avoids other 3D using agent's. @@ -187,8 +187,8 @@ - - + + Replaces the internal velocity in the collision avoidance simulation with [param velocity] for the specified [param agent]. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. @@ -202,7 +202,7 @@ - + If [code]true[/code] enables debug mode on the NavigationServer. @@ -215,7 +215,7 @@ - + Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states. @@ -228,120 +228,120 @@ - + Returns the ending position of this [code]link[/code]. - + Returns the [code]enter_cost[/code] of this [code]link[/code]. - + Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to. - + Returns the navigation layers for this [code]link[/code]. - + Returns the [code]ObjectID[/code] of the object which manages this link. - + Returns the starting position of this [code]link[/code]. - + Returns the [code]travel_cost[/code] of this [code]link[/code]. - + Returns whether this [code]link[/code] can be travelled in both directions. - - + + Sets whether this [code]link[/code] can be travelled in both directions. - - + + Sets the exit position for the [code]link[/code]. - - + + Sets the [code]enter_cost[/code] for this [code]link[/code]. - - + + Sets the navigation map [RID] for the link. - - + + Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer3D.map_get_path]). - - + + Set the [code]ObjectID[/code] of the object which manages this link. - - + + Sets the entry position for this [code]link[/code]. - - + + Sets the [code]travel_cost[/code] for this [code]link[/code]. @@ -426,21 +426,21 @@ - + Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. - - + + Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code]. - - + + Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [code]map[/code]. @@ -472,7 +472,7 @@ - + Returns true if the navigation [param map] allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -518,8 +518,8 @@ - - + + Set the map's link connection radius used to connect links to navigation polygons. @@ -540,55 +540,55 @@ - + Returns the navigation map [RID] the requested [param obstacle] is currently assigned to. - - + + Set the obstacles's [code]avoidance_layers[/code] bitmask. - - + + Sets the [param height] for the [param obstacle]. In 3D agents will ignore obstacles that are above or below them while using 2D avoidance. - - + + Assigns the [param obstacle] to a navigation map. - - + + Updates the [param position] in world space for the [param obstacle]. - - + + Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. - - + + Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -604,8 +604,8 @@ - - + + Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters3D]. Updates the provided [NavigationPathQueryResult3D] result object with the path among other results requested by the query. @@ -662,7 +662,7 @@ - + Returns the [code]ObjectID[/code] of the object which manages this region. @@ -676,7 +676,7 @@ - + Returns true if the navigation [param region] is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. @@ -725,8 +725,8 @@ - - + + Set the [code]ObjectID[/code] of the object which manages this region. @@ -749,8 +749,8 @@ - - + + If [param enabled] the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.