Skip to content

Update NavMeshModifierVolume.md #180

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update NavMeshModifierVolume.md #180

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
7 changes: 4 additions & 3 deletions Documentation/NavMeshModifierVolume.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@

![NavMeshModifierVolume example](Images/NavMeshModifierVolume-Example.png)

NavMesh Modifier Volume allows you to mark the area that falls inside the volume with specific area type. Where NavMesh Modifier marks certain objects with an area type, the Modifier Volume allows change the area type even more locally based on a volume.
NavMesh Modifier Volume allows you to mark the area that falls inside the volume with specific area type. Where NavMesh Modifier marks certain objects with an area type, the Modifier Volume allows changing the area type even more locally based on a volume.

The modifier is useful for annotating certain areas over walkable surfaces which might not be represented as separate geometry, e.g. danger areas. It can be even be used to make certain areas non-walkable.

The NavMesh Modifier Volume affects the NavMesh generation process, this means the NavMesh has to be updated to reflect changes to NavMesh Modifier Volumes.

## Parameters
* Size – dimensions of the modifier volume.
* Center – center of the modifier volume relative to the GameObject center.
* Center – the centre of the modifier volume relative to the GameObject centre.
Copy link

Choose a reason for hiding this comment

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

why change the spelling to something that doesn't match the actual parameter name? centre may be more correct, but better to match the current style and spelling conventions. ;-)

* Area Type – describes the area type which the volume applies.
* Affected Agents – a selection of agents the Modifier affects. For example, you may choose to create danger zone for specific agent type only.
* Affected Agents – a selection of agents the Modifier affects. For example, you may choose to create a danger zone for a specific agent type only.