Haoyu Qiu
4750b77d2d
Fix typos and inconsistencies in classref
...
* Typo fixes.
* Navigation agent's `velocity_computed` signal is not emitted by
`set_velocity`, but at the end of that frame if `set_velocity` is
called.
* Simplify link in navigation agent's `avoidance_enabled` description.
* Unify `navigation_layers` description across `NavigationAgent{2,3}D`.
* Unify `is_normalized()` description across `Vector2`, `Vector3`, and
`Vector4`
(cherry picked from commit ff97c481d3
)
2023-03-27 18:02:28 +02:00
smix8
bea2da94da
Allow negative NavigationAgent2D path debug line_width for thin lines
...
Allows the line_width for NavigationAgent2D path debug to go negativ for thin line rendering.
(cherry picked from commit f6a10c0565
)
2023-03-16 16:45:07 +01:00
smix8
d87f124768
Add NavigationLink helper functions for global positions
...
Adds helper functions to set the links start and end position with global positions or get them as global positions.
Adds global start and end position for the navigation link to the 'link_reached' signal of NavigationAgent. That signal gets emitted when a navigation link waypoint is reached. Requires that 'owner' meta data is enabled on the NavigationAgent.
2023-02-14 21:56:58 +01:00
smix8
0ab764e84b
Add NavigationAgent Path Debug Visualization
...
Adds path debug visuals for NavigationAgent2D, NavigationAgent3D and NavigationServer.
2023-01-31 18:27:35 +01:00
smix8
bf1571979c
Rename Navigation uses of 'location' to 'position'
...
Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2023-01-26 18:19:03 +01:00
smix8
594ffd2200
Tweak NavigationAgent2D defaults
...
Tweaks default values for NavigationAgent2D to work better out of the box within a new 2D project using default resolution.
2023-01-11 23:47:16 +01:00
smix8
7506ecc5d9
Add navigation tutorial links inside class doc
...
Adds navigation tutorial links inside the class doc to the related and more detailed godot-docs pages.
2023-01-11 08:55:02 +01:00
Josh Jones
5d8ba2b2d1
Add support for emitting a signal when entering a NavLink
2022-12-17 16:33:41 -08:00
Rémi Verschelde
0bb94df247
Merge pull request #70230 from DarkKilauea/nav-experimental
...
[4.x] Mark navigation classes and nodes as experimental
2022-12-18 00:31:27 +01:00
smix8
34e7628f5f
Fix Navigation API abbreviations inconsistency
...
Schema for navigation to name user facing API with "navigation" without abbreviation and e.g. NavigationServer internals with abbr "nav".
2022-12-17 22:06:22 +01:00
Josh Jones
32371906eb
Mark navigation classes and nodes as experimental
...
The navigation team has some large changes planned for navigation in the 4.x timeframe, so marking these nodes as experimental to give users a heads up that the API may change in breaking ways.
2022-12-17 11:12:00 -08:00
Rémi Verschelde
0844f0ed10
Merge pull request #65452 from timothyqiu/agent-target
...
Make NavigationAgent `target_location` a property
2022-10-31 11:56:17 +01:00
RedMser
b9c3a5534b
Fix type of safe_velocity parameter
2022-10-27 22:45:24 +02:00
Haoyu Qiu
e4100495b5
Make NavigationAgent `target_location` a property
2022-10-27 13:51:38 +08:00
BenniKane
ed5b832a81
doc: Clarifying NavigationAgent and NavigationAgent2D velocity_computed requires avoidance_enabled to be true to emit
2022-09-01 12:32:29 -05:00
Rémi Verschelde
af88438c71
Merge pull request #64354 from Mickeon/rename-navigation-distance
2022-08-25 18:35:23 +02:00
Andy Maloney
ef942718a0
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-15 15:49:48 +03:00
Micky
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
Yuri Sizov
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
smix8
e1a4d1d08c
Clarify NavigationAgent radius property
...
Documents Navigation radius property, especially that it affects avoidance only.
2022-06-26 13:04:02 +02:00
Rémi Verschelde
21b0c7fc22
Merge pull request #62214 from smix8/navigation_layer_bitmask_helpers_4.x
2022-06-20 15:13:33 +02:00
smix8
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
smix8
07740302f3
Add NavigationAgent desired path distance
...
Add NavigationAgent desired path distance
2022-06-18 19:11:49 +02:00
smix8
245da150e7
Streamline Navigation layer function names.
...
Streamline Navigation layer function names.
2022-06-15 00:18:48 +02:00
smix8
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
smix8
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
smix8
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
BARTEK-PC\Bartek
4972f1b864
Expose navigable layers for NavigationAgent2D/3D
2022-03-20 15:04:56 +01:00
Hugo Locurcio
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
Haoyu Qiu
6f0e31a3c9
Misc documentation improvements
2022-01-08 22:38:55 +08:00
Aaron Franke
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05:00
Rémi Verschelde
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
Rémi Verschelde
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
Paul Joannon
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
Gilles Roudière
a9dc53d152
Remove Navigation2D/3D nodes, and move the navigation map to the world resource
2021-03-10 11:23:06 +01:00
luz.paz
7bf6e5f773
Fix various typos
...
Found via `codespell`
2020-03-11 13:59:18 -04:00
Rémi Verschelde
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
Rémi Verschelde
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
Duroxxigar
383c583a0b
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:06 +01:00