NavigationRegion2D.xml 1.4 KB

123456789101112131415161718192021222324
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="NavigationRegion2D" inherits="Node2D" version="4.0">
  3. <brief_description>
  4. A region of the 2D navigation map.
  5. </brief_description>
  6. <description>
  7. A region of the navigation map. It tells the [NavigationServer2D] what can be navigated and what cannot, based on its [NavigationPolygon] resource.
  8. Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using [method NavigationServer2D.map_set_edge_connection_margin].
  9. [b]Note:[/b] Overlapping two regions' polygons is not enough for connecting two regions. They must share a similar edge.
  10. </description>
  11. <tutorials>
  12. </tutorials>
  13. <members>
  14. <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">
  15. Determines if the [NavigationRegion2D] is enabled or disabled.
  16. </member>
  17. <member name="layers" type="int" setter="set_layers" getter="get_layers" default="1">
  18. A bitfield determining all layers the region belongs to. These layers can be checked upon when requesting a path with [method NavigationServer2D.map_get_path].
  19. </member>
  20. <member name="navpoly" type="NavigationPolygon" setter="set_navigation_polygon" getter="get_navigation_polygon">
  21. The [NavigationPolygon] resource to use.
  22. </member>
  23. </members>
  24. </class>