mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-08 15:09:50 +01:00
68 lines
3.3 KiB
Markdown
68 lines
3.3 KiB
Markdown
|
.. _doc_navigation_advanced_using_navigationlayers:
|
||
|
|
|
||
|
|
Using NavigationLayers
|
||
|
|
======================
|
||
|
|
|
||
|
|
NavigationLayers are an optional feature to further control which navigation meshes are considered in a path query and which regions can be connected.
|
||
|
|
They work similar to how physics layers control collision between collision objects or how visual layers control what is rendered to the Viewport.
|
||
|
|
|
||
|
|
NavigationLayers can be named in the ``ProjectSettings`` the same as PhysicsLayers or VisualLayers.
|
||
|
|
|
||
|
|
.. image:: img/navigationlayers_naming.png
|
||
|
|
|
||
|
|
If two regions have not a single compatible layer they will not be merged by the NavigationServer. See :ref:`doc_navigation_connecting_navmesh` for more information on merging navmesh.
|
||
|
|
|
||
|
|
If a region has not a single compatible navigation layer with the ``navigation_layers`` parameter of a path query this regions navigation mesh will be skipped in pathfinding.
|
||
|
|
See :ref:`doc_navigation_using_navigationpaths` for more information on querying the NavigationServer for paths.
|
||
|
|
|
||
|
|
NavigationLayers are a single ``int`` value that is used as a ``bitmask``.
|
||
|
|
Many navigation related nodes have ``set_navigation_layer_value()`` and
|
||
|
|
``get_navigation_layer_value()`` functions to set and get a layer number directly
|
||
|
|
without the need for more complex bitwise operations.
|
||
|
|
|
||
|
|
In scripts the following helper functions can be used to work with the navigation_layers bitmask.
|
||
|
|
|
||
|
|
.. tabs::
|
||
|
|
.. code-tab:: gdscript GDScript
|
||
|
|
|
||
|
|
func change_layers():
|
||
|
|
var region: NavigationRegion3D = get_node("NavigationRegion3D")
|
||
|
|
# enables 4-th layer for this region
|
||
|
|
region.navigation_layers = enable_bitmask_inx(region.navigation_layers, 4)
|
||
|
|
# disables 1-rst layer for this region
|
||
|
|
region.navigation_layers = disable_bitmask_inx(region.navigation_layers, 1)
|
||
|
|
|
||
|
|
var agent: NavigationAgent3D = get_node("NavigationAgent3D")
|
||
|
|
# make future path queries of this agent ignore regions with 4-th layer
|
||
|
|
agent.navigation_layers = disable_bitmask_inx(agent.navigation_layers, 4)
|
||
|
|
|
||
|
|
var path_query_navigation_layers: int = 0
|
||
|
|
path_query_navigation_layers = enable_bitmask_inx(path_query_navigation_layers, 2)
|
||
|
|
# get a path that only considers 2-nd layer regions
|
||
|
|
var path: PoolVector3Array = NavigationServer3D.map_get_path(
|
||
|
|
map,
|
||
|
|
start_position,
|
||
|
|
target_position,
|
||
|
|
true,
|
||
|
|
path_query_navigation_layers
|
||
|
|
)
|
||
|
|
|
||
|
|
static func is_bitmask_inx_enabled(_bitmask: int, _index: int) -> bool:
|
||
|
|
return _bitmask & (1 << _index) != 0
|
||
|
|
|
||
|
|
static func enable_bitmask_inx(_bitmask: int, _index: int) -> int:
|
||
|
|
return _bitmask | (1 << _index)
|
||
|
|
|
||
|
|
static func disable_bitmask_inx(_bitmask: int, _index: int) -> int:
|
||
|
|
return _bitmask & ~(1 << _index)
|
||
|
|
|
||
|
|
Changing navigation layers for path queries is a performance friendly alternative to
|
||
|
|
enabling / disabling entire navigation regions. Compared to region changes a
|
||
|
|
navigation path query with different navigation layers does not
|
||
|
|
trigger large scale updates on the NavigationServer.
|
||
|
|
|
||
|
|
Changing the navigation layers of NavigationAgent nodes will have an immediate
|
||
|
|
effect on the next path query. Changing the navigation layers of
|
||
|
|
regions will have an immediate effect on the region but any new region
|
||
|
|
connect or disconnect will only be in effect after the next physics_frame.
|