Skip to content

Update snap to ground documentation to match implementation #136

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

Merged
merged 1 commit into from
Apr 4, 2025
Merged

Update snap to ground documentation to match implementation #136

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
4 changes: 2 additions & 2 deletions docs/user_guides/templates/character_controller_snap_to_ground.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
If enabled, **snap-to-ground** will force the character to stick to the ground if the following conditions are met
simultaneously:
- At the start of the movement, the character touches the ground.
- The movement has no up component (i.e. the character isn’t jumping).
- The movement has a slight downward component.
- At the end of the desired movement, the character would be separated from the ground by a distance smaller than the
distance provided by the **snap-to-ground** parameter.

Expand Down Expand Up @@ -36,4 +36,4 @@ Typical usages of snap-to-ground include going downstairs or remaining in contac
<load path='/2d/javascript/src/snippets/character_controller.ts' marker='Snap' />
```

</js>
</js>