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

Docs: engine pausing refers to nonexistent property #1102

Open
ggorlen opened this issue Mar 24, 2022 · 0 comments · May be fixed by #1103
Open

Docs: engine pausing refers to nonexistent property #1102

ggorlen opened this issue Mar 24, 2022 · 0 comments · May be fixed by #1103

Comments

@ggorlen
Copy link

ggorlen commented Mar 24, 2022

The Runner docs say:

Matter.Runner.[stop](https://brm.io/matter-js/docs/classes/Runner.html#method_stop)(runner)
Ends execution of Runner.run on the given runner, by canceling the animation frame request event loop. If you wish to only temporarily pause the engine, see engine.enabled instead.

I might be missing something, but I believe engine.enabled is a typo and should be runner.enabled. See runnable exampe of pausing/resuming the runner with runner.enabled, and add console.log(engine.enabled) to see that it's undefined.

@ggorlen ggorlen linked a pull request Mar 24, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant