From 28bb2806f1afac8d256291a6b86352e11f074697 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 19 Feb 2020 09:55:47 +0100 Subject: doc: Sync classref with current source --- doc/classes/DTLSServer.xml | 6 ++-- doc/classes/Navigation.xml | 56 ++++++++++++++++++------------------ doc/classes/Navigation2D.xml | 36 +++++++++++------------ doc/classes/Navigation2DServer.xml | 40 +++++++++++++------------- doc/classes/NavigationServer.xml | 58 +++++++++++++++++++------------------- doc/classes/PacketPeerDTLS.xml | 2 +- doc/classes/UDPServer.xml | 2 +- 7 files changed, 100 insertions(+), 100 deletions(-) diff --git a/doc/classes/DTLSServer.xml b/doc/classes/DTLSServer.xml index 8c05f30550..8c71b61553 100644 --- a/doc/classes/DTLSServer.xml +++ b/doc/classes/DTLSServer.xml @@ -31,7 +31,7 @@ for p in peers: p.poll() # Must poll to update the state. if p.get_status() == PacketPeerDTLS.STATUS_CONNECTED: - while p.get_available_packet_count() > 0: + while p.get_available_packet_count() > 0: print("Received message from client: %s" % p.get_packet().get_string_from_utf8()) p.put_packet("Hello DTLS client".to_utf8()) [/codeblock] @@ -53,7 +53,7 @@ if !connected: # Try to contact server dtls.put_packet("The answer is... 42!".to_utf8()) - while dtls.get_available_packet_count() > 0: + while dtls.get_available_packet_count() > 0: print("Connected: %s" % dtls.get_packet().get_string_from_utf8()) connected = true [/codeblock] @@ -68,7 +68,7 @@ - + Setup the DTLS server to use the given [code]private_key[/code] and provide the given [code]certificate[/code] to clients. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index 8057aca127..0000ca6bd5 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -9,31 +9,39 @@ - - + + + + + Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface. - - + + - - - + - + + Returns the normal for the point returned by [method get_closest_point]. + + + + + + - Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (radius, height, etc.) are considered in the path calculation, otherwise they are ignored. + Returns the owner region RID for the point returned by [method get_closest_point]. - + - + @@ -41,31 +49,23 @@ Returns the closest point between the navigation surface and the segment. - - + + - - - Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. - - + + - + - - Returns the normal for the point returned by [method get_closest_point]. - - - - - - + + + - Returns the owner region RID for the point returned by [method get_closest_point]. + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (radius, height, etc.) are considered in the path calculation, otherwise they are ignored. diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index 20c666106a..0d016a3210 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -9,6 +9,24 @@ + + + + + + + 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 get_closest_point]. + + @@ -28,24 +46,6 @@ Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible. - - - - - - - Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. - - - - - - - - - Returns the owner region RID for the point returned by [method get_closest_point]. - - diff --git a/doc/classes/Navigation2DServer.xml b/doc/classes/Navigation2DServer.xml index 22b5d2574e..08776e2b15 100644 --- a/doc/classes/Navigation2DServer.xml +++ b/doc/classes/Navigation2DServer.xml @@ -164,50 +164,50 @@ Returns the map cell size. - - + + + + - Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions. + Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface. - - + + - - - - - + - Returns the navigation path to reach the destination from the origin, while avoiding static obstacles. + Returns the owner region RID for the point returned by [method map_get_closest_point]. - - + + - - - Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. + Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions. - - + + - + + + + + - Returns the owner region RID for the point returned by [method map_get_closest_point]. + Returns the navigation path to reach the destination from the origin, while avoiding static obstacles. diff --git a/doc/classes/NavigationServer.xml b/doc/classes/NavigationServer.xml index 61ea6f47b6..ec14322be3 100644 --- a/doc/classes/NavigationServer.xml +++ b/doc/classes/NavigationServer.xml @@ -164,28 +164,37 @@ Returns the map cell size. - - + + + + - Returns the edge connection margin of the map. + Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. - - + + - + - + + Returns the normal for the point returned by [method map_get_closest_point]. + + + + + + - + - Returns the navigation path to reach the destination from the origin. + Returns the owner region RID for the point returned by [method map_get_closest_point]. @@ -193,9 +202,9 @@ - + - + @@ -203,37 +212,28 @@ Returns the closest point between the navigation surface and the segment. - - + + - - - Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. + Returns the edge connection margin of the map. - - + + - + - - Returns the normal for the point returned by [method map_get_closest_point]. - - - - - - + - + - Returns the owner region RID for the point returned by [method map_get_closest_point]. + Returns the navigation path to reach the destination from the origin. diff --git a/doc/classes/PacketPeerDTLS.xml b/doc/classes/PacketPeerDTLS.xml index a9ba6dea00..19ebb9d81e 100644 --- a/doc/classes/PacketPeerDTLS.xml +++ b/doc/classes/PacketPeerDTLS.xml @@ -14,7 +14,7 @@ - + diff --git a/doc/classes/UDPServer.xml b/doc/classes/UDPServer.xml index 7f40edf61d..f3c865c392 100644 --- a/doc/classes/UDPServer.xml +++ b/doc/classes/UDPServer.xml @@ -45,7 +45,7 @@ if !connected: # Try to contact server udp.put_packet("The answer is... 42!".to_utf8()) - if udp.get_available_packet_count() > 0: + if udp.get_available_packet_count() > 0: print("Connected: %s" % udp.get_packet().get_string_from_utf8()) connected = true [/codeblock] -- cgit v1.2.3