af88438c71
Merge pull request #64354 from Mickeon/rename-navigation-distance
2022-08-25 18:35:23 +02:00
ef942718a0
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-15 15:49:48 +03:00
b62d06fbed
Rename Navigation's `neighbor_dist` to `neightbor_distance`
...
NavigationAgent2D/3D.`neighbor_dist` -> `neighbor_distance` (also affects setters and getters)
NavigationServer2D/3D.`agent_set_neighbor_dist()` -> `agent_set_neighbor_distance()`
Also changes their parameters' names.
Doesn't affect "Agent.neighborDist_" in Agent.h
2022-08-13 12:40:55 +02:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
e1a4d1d08c
Clarify NavigationAgent radius property
...
Documents Navigation radius property, especially that it affects avoidance only.
2022-06-26 13:04:02 +02:00
21b0c7fc22
Merge pull request #62214 from smix8/navigation_layer_bitmask_helpers_4.x
2022-06-20 15:13:33 +02:00
55923ade68
Add navigation layer bitmask helper functions
...
Adds helper functions to work with the navigation layer bitmask.
2022-06-19 13:47:19 +02:00
07740302f3
Add NavigationAgent desired path distance
...
Add NavigationAgent desired path distance
2022-06-18 19:11:49 +02:00
245da150e7
Streamline Navigation layer function names.
...
Streamline Navigation layer function names.
2022-06-15 00:18:48 +02:00
f10ff0efda
Add NavigationAgent set_navigation_map() function
...
Add NavigationAgent set_navigation_map() and get_navigation_map() function.
2022-06-14 21:48:47 +02:00
9c7f03aefc
Document the correct use of NavigationAgent path functions
...
Document the correct use of NavigationAgent path functions.
2022-06-09 01:51:33 +02:00
7f3688603c
Process NavigationAgent2D/3D avoidance on demand only
...
Changes NavigationAgent avoidance callback to a toggle that is disabled by default.
Also fixes a few missing descriptions / wrong warnings.
2022-05-20 23:47:10 +02:00
4972f1b864
Expose navigable layers for NavigationAgent2D/3D
2022-03-20 15:04:56 +01:00
b68dd2e189
Add an XML schema for documentation
...
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.
Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-15 00:03:31 +01:00
6f0e31a3c9
Misc documentation improvements
2022-01-08 22:38:55 +08:00
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05:00
7adf4cc9b5
doc: Use self-closing tags for `return` and `argument`
...
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
cab5064f20
doc: Sync classref with current source
...
And typo fix from https://github.com/godotengine/godot-docs/pull/4882 .
2021-04-29 12:11:40 +02:00
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
a9dc53d152
Remove Navigation2D/3D nodes, and move the navigation map to the world resource
2021-03-10 11:23:06 +01:00
7bf6e5f773
Fix various typos
...
Found via `codespell`
2020-03-11 13:59:18 -04:00
213a85521d
doc: Sync classref with current source
...
Handle removal of Pool*Array types and other recent changes.
2020-02-18 14:02:02 +01:00
0e3d625737
doc: Sync classref with current source
...
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.
Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 12:37:13 +01:00
383c583a0b
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:06 +01:00
Rémi Verschelde
Andy Maloney
Micky
Yuri Sizov
smix8
BARTEK-PC\Bartek
Hugo Locurcio
Haoyu Qiu
Aaron Franke
Rémi Verschelde
Paul Joannon
Gilles Roudière
luz.paz
Duroxxigar