Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-11 21:31:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Small fixes to the docs.

Browse Source
This commit is contained in:
Relintai 2023-09-10 08:26:35 +02:00
parent 1230419fb7
commit e31c09d1f4
5 changed files with 47 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/classes/Navigation2DServer.xml
View File

@ -40,7 +40,7 @@
</method>
<method name="agent_get_paused" qualifiers="const">
<return type="bool" />
<param index="0" name="agent" type="RID" />
<argument index="0" name="agent" type="RID" />
<description>
Returns [code]true[/code] if the specified [param agent] is paused.
</description>
@ -130,8 +130,8 @@
</method>
<method name="agent_set_paused">
<return type="void" />
<param index="0" name="agent" type="RID" />
<param index="1" name="paused" type="bool" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="paused" type="bool" />
<description>
If [param paused] is true the specified [param agent] will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks.
</description>
@ -211,7 +211,7 @@
</method>
<method name="link_get_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="link" type="RID" />
<argument index="0" name="link" type="RID" />
<description>
Returns [code]true[/code] if the specified [param link] is enabled.
</description>
@ -282,8 +282,8 @@
</method>
<method name="link_set_enabled">
<return type="void" />
<param index="0" name="link" type="RID" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] is [code]true[/code] the specified [param link] will contribute to its current navigation map.
</description>
@ -513,7 +513,7 @@
</method>
<method name="obstacle_get_avoidance_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="obstacle" type="RID" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns [code]true[/code] if the provided [param obstacle] has avoidance enabled.
</description>
@ -527,15 +527,15 @@
</method>
<method name="obstacle_get_paused" qualifiers="const">
<return type="bool" />
<param index="0" name="obstacle" type="RID" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns [code]true[/code] if the specified [param obstacle] is paused.
</description>
</method>
<method name="obstacle_set_avoidance_enabled">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] the provided [param obstacle] affects avoidance using agents.
</description>
@ -558,8 +558,8 @@
</method>
<method name="obstacle_set_paused">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="paused" type="bool" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="paused" type="bool" />
<description>
If [param paused] is true the specified [param obstacle] will not be processed, e.g. affect avoidance velocities.
</description>
@ -574,16 +574,16 @@
</method>
<method name="obstacle_set_radius">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="radius" type="float" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="radius" type="float" />
<description>
Sets the radius of the dynamic obstacle.
</description>
</method>
<method name="obstacle_set_velocity">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="velocity" type="Vector2" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="velocity" type="Vector2" />
<description>
Sets [param velocity] of the dynamic [param obstacle]. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle.
</description>
@ -627,7 +627,7 @@
</method>
<method name="region_get_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="region" type="RID" />
<argument index="0" name="region" type="RID" />
<description>
Returns [code]true[/code] if the specified [param region] is enabled.
</description>
@ -686,8 +686,8 @@
</method>
<method name="region_set_enabled">
<return type="void" />
<param index="0" name="region" type="RID" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] is [code]true[/code] the specified [param region] will contribute to its current navigation map.
</description>

46
doc/classes/NavigationServer.xml
View File

@ -40,7 +40,7 @@
</method>
<method name="agent_get_paused" qualifiers="const">
<return type="bool" />
<param index="0" name="agent" type="RID" />
<argument index="0" name="agent" type="RID" />
<description>
Returns [code]true[/code] if the specified [param agent] is paused.
</description>
@ -145,8 +145,8 @@
</method>
<method name="agent_set_paused">
<return type="void" />
<param index="0" name="agent" type="RID" />
<param index="1" name="paused" type="bool" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="paused" type="bool" />
<description>
If [param paused] is true the specified [param agent] will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks.
</description>
@ -242,7 +242,7 @@
</method>
<method name="link_get_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="link" type="RID" />
<argument index="0" name="link" type="RID" />
<description>
Returns [code]true[/code] if the specified [param link] is enabled.
</description>
@ -313,8 +313,8 @@
</method>
<method name="link_set_enabled">
<return type="void" />
<param index="0" name="link" type="RID" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] is [code]true[/code] the specified [param link] will contribute to its current navigation map.
</description>
@ -400,7 +400,7 @@
</method>
<method name="map_get_cell_height" qualifiers="const">
<return type="float" />
<param index="0" name="map" type="RID" />
<argument index="0" name="map" type="RID" />
<description>
Returns the map cell height used to rasterize the navigation mesh vertices on the Y axis.
</description>
@ -577,7 +577,7 @@
</method>
<method name="obstacle_get_avoidance_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="obstacle" type="RID" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns [code]true[/code] if the provided [param obstacle] has avoidance enabled.
</description>
@ -591,22 +591,22 @@
</method>
<method name="obstacle_get_paused" qualifiers="const">
<return type="bool" />
<param index="0" name="obstacle" type="RID" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns [code]true[/code] if the specified [param obstacle] is paused.
</description>
</method>
<method name="obstacle_get_use_3d_avoidance" qualifiers="const">
<return type="bool" />
<param index="0" name="obstacle" type="RID" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns [code]true[/code] if the provided [param obstacle] uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z).
</description>
</method>
<method name="obstacle_set_avoidance_enabled">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] the provided [param obstacle] affects avoidance using agents.
</description>
@ -637,8 +637,8 @@
</method>
<method name="obstacle_set_paused">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="paused" type="bool" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="paused" type="bool" />
<description>
If [param paused] is true the specified [param obstacle] will not be processed, e.g. affect avoidance velocities.
</description>
@ -653,24 +653,24 @@
</method>
<method name="obstacle_set_radius">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="radius" type="float" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="radius" type="float" />
<description>
Sets the radius of the dynamic obstacle.
</description>
</method>
<method name="obstacle_set_use_3d_avoidance">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
Sets if the [param obstacle] uses the 2D avoidance or the 3D avoidance while avoidance is enabled.
</description>
</method>
<method name="obstacle_set_velocity">
<return type="void" />
<param index="0" name="obstacle" type="RID" />
<param index="1" name="velocity" type="Vector3" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="velocity" type="Vector3" />
<description>
Sets [param velocity] of the dynamic [param obstacle]. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle.
</description>
@ -722,7 +722,7 @@
</method>
<method name="region_get_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="region" type="RID" />
<argument index="0" name="region" type="RID" />
<description>
Returns [code]true[/code] if the specified [param region] is enabled.
</description>
@ -781,8 +781,8 @@
</method>
<method name="region_set_enabled">
<return type="void" />
<param index="0" name="region" type="RID" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] is [code]true[/code] the specified [param region] will contribute to its current navigation map.
</description>

2
doc/classes/SceneTree.xml
View File

@ -70,7 +70,7 @@
</method>
<method name="get_first_node_in_group">
<return type="Node" />
<param index="0" name="group" type="StringName" />
<argument index="0" name="group" type="StringName" />
<description>
Returns the first node in the specified group, or [code]null[/code] if the group is empty or does not exist.
</description>

2
modules/gridmap/doc_classes/GridMap.xml
View File

@ -171,7 +171,7 @@
</method>
<method name="set_navigation_map">
<return type="void" />
<param index="0" name="navigation_map" type="RID" />
<argument index="0" name="navigation_map" type="RID" />
<description>
Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes.
</description>

6
modules/gridmap/doc_classes/MeshLibrary.xml
View File

@ -61,7 +61,7 @@
</method>
<method name="get_item_navigation_layers" qualifiers="const">
<return type="int" />
<param index="0" name="id" type="int" />
<argument index="0" name="id" type="int" />
<description>
Returns the item's navigation layers bitmask.
</description>
@ -135,8 +135,8 @@
</method>
<method name="set_item_navigation_layers">
<return type="void" />
<param index="0" name="id" type="int" />
<param index="1" name="navigation_layers" type="int" />
<argument index="0" name="id" type="int" />
<argument index="1" name="navigation_layers" type="int" />
<description>
Sets the item's navigation layers bitmask.
</description>