diff options
| author | Theraot <Theraot@gmail.com> | 2022-03-01 17:02:04 -0500 |
|---|---|---|
| committer | Theraot <Theraot@gmail.com> | 2022-03-01 17:02:04 -0500 |
| commit | b18a018ad23f95b1f3cdedc74c14e09d666dc346 (patch) | |
| tree | d30694d5b49b77731b7dba255405fba967e528af | |
| parent | 3590cdfd34eea8dda746d7db1c7e5a79af389026 (diff) | |
Updating AStar2D documentation to mention the new bidirectional paramter
| -rw-r--r-- | doc/classes/AStar2D.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index 2dde3ad340..60d2986e07 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -52,8 +52,9 @@ <return type="bool" /> <argument index="0" name="id" type="int" /> <argument index="1" name="to_id" type="int" /> + <argument index="2" name="bidirectional" type="bool" default="true" /> <description> - Returns whether there is a connection/segment between the given points. + Returns whether there is a connection/segment between the given points. If [code]bidirectional[/code] is [code]false[/code], returns whether movement from [code]id[/code] to [code]to_id[/code] is possible through this segment. </description> </method> <method name="clear"> @@ -89,8 +90,9 @@ <return type="void" /> <argument index="0" name="id" type="int" /> <argument index="1" name="to_id" type="int" /> + <argument index="2" name="bidirectional" type="bool" default="true" /> <description> - Deletes the segment between the given points. + Deletes the segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is prevented, and a unidirectional segment possibly remains. </description> </method> <method name="get_available_point_id" qualifiers="const"> |