Skip to content

Conversation

@smix8
Copy link
Contributor

@smix8 smix8 commented Dec 9, 2023

Updates navigation mesh baking doc.

Adds doc for the new 2D navigation mesh baking in Godot 4.2.
Adds examples for NavigationRegion and NavigationServer baking.
Removes the outdated descriptions for the old navigation mesh baking or deprecated functions.

There is a lot of stuff still missing but that will take another few weeks if not months and I don't want the doc to stay completely outdate with wrong information and examples for that long.

@smix8 smix8 force-pushed the navigationregion_baking branch from 535bfe0 to 14cda27 Compare December 9, 2023 01:06
@skyace65 skyace65 added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation cherrypick:4.2 labels Dec 9, 2023
Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@smix8 smix8 force-pushed the navigationregion_baking branch from 14cda27 to 674f471 Compare December 10, 2023 08:24
Copy link
Member

@timothyqiu timothyqiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some markers are used incorrectly.

@smix8 smix8 force-pushed the navigationregion_baking branch 2 times, most recently from 5aa4ac9 to cf46d62 Compare December 10, 2023 15:29
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Think some of the sentences need to be broken up with commas or periods, to lessen the mental workload of reading long sentences, especially before connecting words such as "and" and "or"

@smix8 smix8 force-pushed the navigationregion_baking branch from cf46d62 to 8f0f083 Compare December 10, 2023 16:06
Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we have a specific line length limit. But the general rule of thumb is if it is so long it shows up on two lines in github it should be broken up.

Also for the suggested changes on "-" lines make sure the first letter of the second line lines up with the first letter on the first line. I think my suggested changes do but it's hard to tell.

@smix8 smix8 force-pushed the navigationregion_baking branch from 8f0f083 to 9275322 Compare December 11, 2023 09:37
@skyace65
Copy link
Contributor

@AThousandShips any other changes that should be made?

Copy link
Member

@timothyqiu timothyqiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did a proofreading. I think it's worth adding some punctuation marks.

Also found a typo. (agent_max_climp -> agent_max_climb)

Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but agreeing with the punctuation suggestions

@smix8 smix8 force-pushed the navigationregion_baking branch from 9275322 to 7a168a5 Compare December 12, 2023 19:52
Updates navigation mesh baking doc.
@smix8 smix8 force-pushed the navigationregion_baking branch from 7a168a5 to c8f7e92 Compare December 12, 2023 19:53
@skyace65 skyace65 merged commit ca93dda into godotengine:master Dec 13, 2023
@skyace65
Copy link
Contributor

Thanks! Great navigation docs as always.

@smix8 smix8 deleted the navigationregion_baking branch December 13, 2023 08:38
@mhilbrunner
Copy link
Member

Cherry-picked to 4.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants