Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid punning [param enabled] in documentation #80066

Merged
merged 1 commit into from
Jul 31, 2023
Merged

Avoid punning [param enabled] in documentation #80066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/classes/NavigationServer2D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<param index="0" name="agent" type="RID" />
<param index="1" name="enabled" type="bool" />
<description>
If [param enabled] is [code]true[/code] the specified [param agent] uses avoidance.
If [param enabled] is [code]true[/code], the specified [param agent] uses avoidance.
</description>
</method>
<method name="agent_set_avoidance_layers">
Expand Down Expand Up @@ -283,7 +283,7 @@
<param index="0" name="link" type="RID" />
<param 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.
If [param enabled] is [code]true[/code], the specified [param link] will contribute to its current navigation map.
</description>
</method>
<method name="link_set_end_position">
Expand Down Expand Up @@ -485,7 +485,7 @@
<param index="0" name="map" type="RID" />
<param index="1" name="enabled" type="bool" />
<description>
Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
Set the navigation [param map] edge connection use. If [param enabled] is [code]true[/code], the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description>
</method>
<method name="obstacle_create">
Expand Down Expand Up @@ -520,7 +520,7 @@
<param index="0" name="obstacle" type="RID" />
<param index="1" name="enabled" type="bool" />
<description>
If [param enabled] the provided [param obstacle] affects avoidance using agents.
If [param enabled] is [code]true[/code], the provided [param obstacle] affects avoidance using agents.
</description>
</method>
<method name="obstacle_set_avoidance_layers">
Expand Down Expand Up @@ -744,7 +744,7 @@
<param index="0" name="region" type="RID" />
<param index="1" name="enabled" type="bool" />
<description>
If [param enabled] the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
If [param enabled] is [code]true[/code], the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description>
</method>
<method name="set_debug_enabled">
Expand Down
12 changes: 6 additions & 6 deletions doc/classes/NavigationServer3D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<param index="0" name="agent" type="RID" />
<param index="1" name="enabled" type="bool" />
<description>
If [param enabled] the provided [param agent] calculates avoidance.
If [param enabled] is [code]true[/code], the provided [param agent] calculates avoidance.
</description>
</method>
<method name="agent_set_avoidance_layers">
Expand Down Expand Up @@ -324,7 +324,7 @@
<param index="0" name="link" type="RID" />
<param 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.
If [param enabled] is [code]true[/code], the specified [param link] will contribute to its current navigation map.
</description>
</method>
<method name="link_set_end_position">
Expand Down Expand Up @@ -574,7 +574,7 @@
<param index="0" name="map" type="RID" />
<param index="1" name="enabled" type="bool" />
<description>
Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
Set the navigation [param map] edge connection use. If [param enabled] is [code]true[/code], the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description>
</method>
<method name="obstacle_create">
Expand Down Expand Up @@ -616,7 +616,7 @@
<param index="0" name="obstacle" type="RID" />
<param index="1" name="enabled" type="bool" />
<description>
If [param enabled] the provided [param obstacle] affects avoidance using agents.
If [param enabled] is [code]true[/code], the provided [param obstacle] affects avoidance using agents.
</description>
</method>
<method name="obstacle_set_avoidance_layers">
Expand Down Expand Up @@ -813,7 +813,7 @@
<param index="0" name="region" type="RID" />
<param 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.
If [param enabled] is [code]true[/code], the specified [param region] will contribute to its current navigation map.
</description>
</method>
<method name="region_set_enter_cost">
Expand Down Expand Up @@ -877,7 +877,7 @@
<param index="0" name="region" type="RID" />
<param index="1" name="enabled" type="bool" />
<description>
If [param enabled] the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
If [param enabled] is [code]true[/code], the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description>
</method>
<method name="set_active">
Expand Down