diff options
Diffstat (limited to 'doc/classes/NavigationObstacle.xml')
| -rw-r--r-- | doc/classes/NavigationObstacle.xml | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/classes/NavigationObstacle.xml b/doc/classes/NavigationObstacle.xml new file mode 100644 index 0000000000..307538b77b --- /dev/null +++ b/doc/classes/NavigationObstacle.xml @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NavigationObstacle" inherits="Node" category="Core" version="3.2"> + <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"> + </return> + <description> + Returns the [Navigation] node that the obstacle is using for its navigation system. + </description> + </method> + <method name="set_navigation"> + <return type="void"> + </return> + <argument index="0" name="navigation" type="Node"> + </argument> + <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> +</class> |