Global plugins are properly registered to scenes when the game is hot-reloaded

Offen
#7,151 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 3 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
javascript
Bereich
game-dev

Rechercherichtung

Beginnen Sie mit src/plugins/PluginManager.js in den verknüpften Zeilen 444-448 und reproduzieren Sie dann das Problem mithilfe der globalen Plugin-Konfiguration und des im Bericht gezeigten Szenenzugriffs. Prüfen Sie den Hot-Reload-Pfad und bestätigen Sie, dass das Neuladen nicht mehr „Plugin key in use: l10n“ erzeugt und dass das Szenen-Mapping verfügbar bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Version

  • Phaser Version: 3.88.2
  • Operating system: Windows
  • Browser: Chrome

Description

When adding a global plugin through the game config, the plugin is automatically added to scenes.

However, if you're using hot-reloading (by default, I'm using the Svelte game template, which has this), re-adding the plugin doesn't work (Plugin key in use) as it's already there.

Image

Because of this, however, re-registering with scenes doesn't work, and you need to do it manually in the Boot scene or whatever

init() {
  const localisation = this.game.plugins.get(localisationPluginMapping) as LocalisationPlugin;
  this.game.scene.getScenes(false).forEach((scene) => {
    scene.l10n = localisation;
  });
}

I think it's because of this code in PluginManager.js where it returns null instead of the plugin.

Example Test Code

Create a basic plugin:

export class LocalisationPlugin extends Phaser.Plugins.BasePlugin {
	constructor(pluginManager: Phaser.Plugins.PluginManager) {
		super(pluginManager);
	}
...
}

export const LocalisationPluginConfig: Phaser.Types.Core.PluginObjectItem = {
	key: 'l10n',
	plugin: LocalisationPlugin,
	mapping: 'l10n'
};

Add the plugin to your config

const config: Phaser.Types.Core.GameConfig = {
	type: AUTO,
	width: Math.min(1024, window.innerWidth),
	height: Math.min(768, window.innerHeight),
	parent: 'game-container',
	backgroundColor: '#028af8',
	scene: [Boot, Preloader, MainMenu, MainGame],
	scale: {
		mode: Phaser.Scale.FIT,
		autoCenter: Phaser.Scale.CENTER_BOTH
	},
	plugins: {
		global: [LocalisationPluginConfig]
	}
};

In one of your scenes, access the plugin

create() {
	this.instructionsText = this.add
		.text(
			this.cameras.main.width / 2,
			this.cameras.main.height - 100,
			this.l10n.translateClickToStart().toUpperCase(),
			{
				fontFamily: 'Arial',
				fontSize: 15,
				color: '#ffffff',
				stroke: '#000000',
				strokeThickness: 3,
				align: 'center'
			}
		)
		.setOrigin(0.5);
}

Perform some action where hot-reloading is necessary. You should see the warning message Plugin key in use: l10n and the call to translateClickToStart will fail as l10n is undefined

Additional Information

I have very little experience with the code, but I think we could either:

  • Properly remove global plugins (scene plugins may also suffer, I haven't tested) so they can be re-added as normal
  • Gracefully handle the plugin already existing so it can still be re-registered with scenes (return the plugin rather than null)
  • Use this.game.plugins.get('l10n') rather than the return of registering the plugin (which is what I'm assuming it's using)
Vorherrschende Sprache
JavaScript
Sterne
40.7k
Forks
7.2k
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus phaserjs/phaser

Alle Issues in phaserjs/phaser

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.