summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationObstacle3D.xml
blob: e6ea70b91a69eefa03ba564a962a639a36f6ac7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationObstacle3D" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<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. [NavigationObstacle3D] is physics safe.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_rid" qualifiers="const">
			<return type="RID" />
			<description>
				Returns the [RID] of this obstacle on the [NavigationServer3D].
			</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 false.
		</member>
	</members>
</class>