godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/NavigationObstacle.xml

43 lines
1.8 KiB
XML
Raw Normal View History

Backport NavigationServer with RVO2 to `3.x` Change the entire navigation system. Remove editor prefix from nav mesh generator class. It is now used for baking at runtime as well. Navigation supports obstacle avoidance now with the RVO2 library. Nav system will also automatically link all nav meshes together to form one overall complete nav map.
2021-12-16 05:15:23 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 22:01:02 +00:00
<class name="NavigationObstacle" inherits="Node" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Backport NavigationServer with RVO2 to `3.x` Change the entire navigation system. Remove editor prefix from nav mesh generator class. It is now used for baking at runtime as well. Navigation supports obstacle avoidance now with the RVO2 library. Nav system will also automatically link all nav meshes together to form one overall complete nav map.
2021-12-16 05:15:23 +00:00
<brief_description>
3D obstacle used in navigation for collision avoidance.
</brief_description>
<description>
3D obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. This can be done by having the obstacle as a child of a [Navigation] node, or using [method set_navigation]. [NavigationObstacle] is physics safe.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_navigation" qualifiers="const">
<return type="Node" />
<description>
Returns the [Navigation] node that the obstacle is using for its navigation system.
</description>
</method>
Expose NavigationObstacle2D/3D get_rid() and add config warning Exposes get_rid() function for scripting. Adds configuration warning when obstacle is used with not intended static body parent. (cherry picked from commit 001d89223f1377717d2b3d5ec453ff8dd3604182)
2022-05-14 21:33:09 +00:00
<method name="get_rid" qualifiers="const">
<return type="RID" />
<description>
Returns the [RID] of this obstacle on the [NavigationServer].
</description>
</method>
Backport NavigationServer with RVO2 to `3.x` Change the entire navigation system. Remove editor prefix from nav mesh generator class. It is now used for baking at runtime as well. Navigation supports obstacle avoidance now with the RVO2 library. Nav system will also automatically link all nav meshes together to form one overall complete nav map.
2021-12-16 05:15:23 +00:00
<method name="set_navigation">
<return type="void" />
<argument index="0" name="navigation" type="Node" />
<description>
Sets the [Navigation] node used by the obstacle. Useful when you don't want to make the obstacle a child of a [Navigation] node.
</description>
</method>
</methods>
<members>
<member name="estimate_radius" type="bool" setter="set_estimate_radius" getter="is_radius_estimated" default="true">
Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius.
</member>
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0">
The radius of the agent. Used only if [member estimate_radius] is set to [code]false[/code].
</member>
</members>
<constants>
</constants>
</class>