Docs error in "Scene systems and plugins"
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 40.3k
- Forks
- 7.2k
- PR merge metrics
- No merged PRs in 30d
Description
https://docs.phaser.io/phaser/concepts/scenes#scene-systems-and-plugins
Any extra scene plugins you've added in the game config with
{ start: true }or any{ mapping: … }are also default plugins.
etc. is incorrect. The correct description is
Any scene plugins added to the game config are default plugins and will be installed in each scene unless excluded in the scene config.
Custom scene plugins can be excluded like
new Phaser.Scene({
// Phaser's default scene plugins only.
plugins: Phaser.Plugins.DefaultPlugins.DefaultScene
});
Phaser default scene plugins can be excluded like
new Phaser.Scene({
// "DataManagerPlugin", "Loader", and "LightsPlugin" are omitted.
plugins: ["Clock", "InputPlugin", "TweenManager"],
});
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked Phaser documentation page at the Scene systems and plugins section and locate its source in the documentation repository. Replace the incorrect description with the provided wording and examples, then verify the rendered page accurately explains default and excluded scene plugins.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100