diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-05-04 23:29:17 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-04 23:29:17 +0200 |
| commit | 174c14762fd38f8a8f0a04f69a5fdf3f81fc1b75 (patch) | |
| tree | 41300160ded07f3a444315ac5e822ba26e1715d0 /doc | |
| parent | 477b53d28019d503ec8983dd7d2530180ff739a0 (diff) | |
| parent | 88d3f14697a91348eab236a675399d0342ff3566 (diff) | |
Merge pull request #60765 from Scony/bake-navigation-mesh-off-thread
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/NavigationRegion3D.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/NavigationRegion3D.xml b/doc/classes/NavigationRegion3D.xml index b27410ed74..60f1020286 100644 --- a/doc/classes/NavigationRegion3D.xml +++ b/doc/classes/NavigationRegion3D.xml @@ -12,8 +12,9 @@ <methods> <method name="bake_navigation_mesh"> <return type="void" /> + <argument index="0" name="on_thread" type="bool" default="true" /> <description> - Bakes the [NavigationMesh]. The baking is done in a separate 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]. + Bakes the [NavigationMesh]. If [code]on_thread[/code] is set to [code]true[/code] (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new [NavigationMesh]. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization. </description> </method> <method name="get_region_rid" qualifiers="const"> |