From 7adf4cc9b5de6701a41e27690a69b9892d5eed85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 30 Jul 2021 15:28:05 +0200 Subject: doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. --- doc/classes/NavigationServer2D.xml | 267 +++++++++++++------------------------ 1 file changed, 89 insertions(+), 178 deletions(-) (limited to 'doc/classes/NavigationServer2D.xml') diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index b0a57ed227..042ab06e6f 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -16,337 +16,249 @@ - - + Creates the agent. - - - - + + Returns true if the map got changed the previous frame. - - - - - - - - - - + + + + + Callback called at the end of the RVO process. - - - - - - + + + Puts the agent in the map. - - - - - - + + + Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. - - - - - - + + + Sets the maximum speed of the agent. Must be positive. - - - - - - + + + Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. - - - - - - + + + Sets the position of the agent in world space. - - - - - - + + + Sets the radius of the agent. - - - - - - + + + Sets the new target velocity. - - - - - - + + + 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. Must be positive. - - - - - - + + + Sets the current velocity of the agent. - - - - + + Destroy the RID - - + Create a new map. - - - - + + Returns the map cell size. - - - - - - + + + Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface. - - - - - - + + + Returns the owner region RID for the point returned by [method map_get_closest_point]. - - - - + + Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions. - - - - - - - - - - - - + + + + + + Returns the navigation path to reach the destination from the origin. [code]layers[/code] is a bitmask of all region layers that are allowed to be in the path. - - - - + + Returns true if the map is active. - - - - - - + + + Sets the map active. - - - - - - + + + Set the map cell size used to weld the navigation mesh polygons. - - - - - - + + + Set the map edge connection margin used to weld the compatible region edges. - - + Creates a new region. - - - - - - + + + Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. - - - - - - + + + Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. - - - - + + Returns how many connections this [code]region[/code] has with other regions in the map. - - - - + + Returns the region's layers. - - - - - - + + + Set the region's layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]). - - - - - - + + + Sets the map for the region. - - - - - - + + + Sets the navigation mesh for the region. - - - - - - + + + Sets the global transformation for the region. @@ -354,8 +266,7 @@ - - + Emitted when a navigation map is updated, when a region moves or is modified. -- cgit v1.2.3