summaryrefslogtreecommitdiffstats
path: root/doc/classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-04-19 16:28:30 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-04-19 16:28:30 +0200
commitfba68034860b74039aeaafd160eaeb4e17f7054b (patch)
tree83eb90e81086c0f0f2407a44ca1cb50b34a1e930 /doc/classes
parent626c6a0ff877ee3f4e42e38c42d61a1af07c4c37 (diff)
parent58593d1bb706410bbdbd265ed8b698eb95b7b61f (diff)
downloadredot-engine-fba68034860b74039aeaafd160eaeb4e17f7054b.tar.gz
Merge pull request #90876 from smix8/source_geometry_callback
Add navigation mesh source geometry parsers and callbacks
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/NavigationServer2D.xml17
-rw-r--r--doc/classes/NavigationServer3D.xml17
2 files changed, 34 insertions, 0 deletions
diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml
index a6f6abccbd..a0d03d7a01 100644
--- a/doc/classes/NavigationServer2D.xml
+++ b/doc/classes/NavigationServer2D.xml
@@ -956,6 +956,23 @@
Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".
</description>
</method>
+ <method name="source_geometry_parser_create">
+ <return type="RID" />
+ <description>
+ Creates a new source geometry parser. If a [Callable] is set for the parser with [method source_geometry_parser_set_callback] the callback will be called for every single node that gets parsed whenever [method parse_source_geometry_data] is used.
+ </description>
+ </method>
+ <method name="source_geometry_parser_set_callback">
+ <return type="void" />
+ <param index="0" name="parser" type="RID" />
+ <param index="1" name="callback" type="Callable" />
+ <description>
+ Sets the [param callback] [Callable] for the specific source geometry [param parser]. The [Callable] will receive a call with the following parameters:
+ - [code]navigation_mesh[/code] - The [NavigationPolygon] reference used to define the parse settings. Do NOT edit or add directly to the navigation mesh.
+ - [code]source_geometry_data[/code] - The [NavigationMeshSourceGeometryData2D] reference. Add custom source geometry for navigation mesh baking to this object.
+ - [code]node[/code] - The [Node] that is parsed.
+ </description>
+ </method>
</methods>
<signals>
<signal name="map_changed">
diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml
index 6fcf033544..ff3e6fd8a6 100644
--- a/doc/classes/NavigationServer3D.xml
+++ b/doc/classes/NavigationServer3D.xml
@@ -1103,6 +1103,23 @@
Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".
</description>
</method>
+ <method name="source_geometry_parser_create">
+ <return type="RID" />
+ <description>
+ Creates a new source geometry parser. If a [Callable] is set for the parser with [method source_geometry_parser_set_callback] the callback will be called for every single node that gets parsed whenever [method parse_source_geometry_data] is used.
+ </description>
+ </method>
+ <method name="source_geometry_parser_set_callback">
+ <return type="void" />
+ <param index="0" name="parser" type="RID" />
+ <param index="1" name="callback" type="Callable" />
+ <description>
+ Sets the [param callback] [Callable] for the specific source geometry [param parser]. The [Callable] will receive a call with the following parameters:
+ - [code]navigation_mesh[/code] - The [NavigationMesh] reference used to define the parse settings. Do NOT edit or add directly to the navigation mesh.
+ - [code]source_geometry_data[/code] - The [NavigationMeshSourceGeometryData3D] reference. Add custom source geometry for navigation mesh baking to this object.
+ - [code]node[/code] - The [Node] that is parsed.
+ </description>
+ </method>
</methods>
<signals>
<signal name="avoidance_debug_changed">