Skip to content
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.

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

Documentation: Add programming guide section on physics engines #1275

Open
pushfoo opened this issue Jul 14, 2022 · 1 comment
Open

Documentation: Add programming guide section on physics engines #1275

pushfoo opened this issue Jul 14, 2022 · 1 comment
Assignees

Comments

@pushfoo
Copy link
Member

pushfoo commented Jul 14, 2022

Documentation request:

What documentation needs to be added?

A high-level overview of how to work with physics engines such as PyMunk, making sure to warn users about the engine overwriting angle, position, and other attributes after calling physics_engine.step()

Where should it be added?

A physics engine page in the programming guide.

Details

I had an issue with PyMunk in the past where attempting to teleport a sprite by changing the position did not work, and a user asked a similar question in the help channels yesterday about why setting the angle wasn't working.

This is a recurring issue, so it makes sense to include a warning about this and other physics engine pitfalls in the programming guide.

@pushfoo
Copy link
Member Author

pushfoo commented Jul 5, 2024

TL;DR: I can rough this from notes and docstrings, then have @DragonMoffon review

The plan:

  1. Get Fix incorrect PhyicsEnginePymunk doc and expand some stubs #2216 merged
  2. Do follow-up passes with Dragon
  3. Move things we find excessive to this new page
  4. Make sure we cover the sync issue:
    • Briefly in the tutorial
    • Thoroughly in this page
    • Cross-referenced by the tut and API doc

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

No branches or pull requests

3 participants