Add documentation for when navigation debug mesh will show

[morganwesemann]

Adds documentation for when the navigation debug mesh will show in navigation debug tools. Closes #8911.

[smix8]

Debug shows other objects as well not just regions but I think we can generalize and shorten this by mentioning that any navigation debug visuals (and physics also for that matter) are currently based on nodes and the SceneTree.

If users work with the servers directly all changes and additions will not be visually reflected by the debug. The communication is one way from node to server, but not from server to node.

We already mention this in many class documentations for properties that if users update them with the server directly the node properties will stay outdated. There is a proposal to change that godotengine/godot-proposals#7208.

[morganwesemann]

Debug shows other objects as well not just regions but I think we can generalize and shorten this by mentioning that any navigation debug visuals (and physics also for that matter) are currently based on nodes and the SceneTree.

If users work with the servers directly all changes and additions will not be visually reflected by the debug. The communication is one way from node to server, but not from server to node.

We already mention this in many class documentations for properties that if users update them with the server directly the node properties will stay outdated. There is a proposal to change that godotengine/godot-proposals#7208.

Thank you for your comment! I completely missed seeing that issue, thanks for pointing it out. I've updated my PR to simplify and generalize the addition. I understand if we choose not to add this given godotengine/godot-proposals#7208 exists.

[skyace65]

Thanks! And congrats on your first merged PR!