Use game instance as 1st parameter

rexrainbow · Aug 6, 2023 · d596d63 · d596d63
1 parent ae4137a
commit d596d63
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 8 deletions.
diff --git a/docs/docs/charactercache.md b/docs/docs/charactercache.md
@@ -24,7 +24,7 @@ Generate bitmapfont from [text game object](text.md), or [bbcode text game objec
     ```
 - Add character-cache object
     ```javascript
-    var characterCache = scene.plugins.get('rexcharactercacheplugin').add(scene, config);
+    var characterCache = scene.plugins.get('rexcharactercacheplugin').add(config);
     ```
 
 #### Import plugin
@@ -53,7 +53,7 @@ Generate bitmapfont from [text game object](text.md), or [bbcode text game objec
     ```
 - Add character-cache object
     ```javascript
-    var characterCache = scene.plugins.get('rexCharacterCache').add(scene, config);
+    var characterCache = scene.plugins.get('rexCharacterCache').add(config);
     ```
 
 #### Import class
@@ -67,14 +67,18 @@ Generate bitmapfont from [text game object](text.md), or [bbcode text game objec
     import CharacterCache from 'phaser3-rex-plugins/plugins/charactercache.js';
     ```
 - Add character-cache object
+    ```javascript
+    var characterCache = new CharacterCache(game, config);
+    ```
+    or
     ```javascript
     var characterCache = new CharacterCache(scene, config);
     ```
 
 ### Create instance
 
 ```javascript
-var characterCache = scene.plugins.get('rexCharacterCache').add(scene, {
+var characterCache = scene.plugins.get('rexCharacterCache').add({
     key: '',  
     cellWidth: 32,
     cellHeight: 32,

diff --git a/examples/charactercache/page.js b/examples/charactercache/page.js
@@ -13,7 +13,7 @@ class Demo extends Phaser.Scene {
     }
 
     create() {
-        var characterCache = this.plugins.get('rexCharacterCache').add(this, {
+        var characterCache = this.plugins.get('rexCharacterCache').add({
             key: 'font',
 
             cellWidth: 32, cellHeight: 32,

diff --git a/examples/charactercache/settext.js b/examples/charactercache/settext.js
@@ -12,7 +12,7 @@ class Demo extends Phaser.Scene {
     }
 
     create() {
-        var characterCache = this.plugins.get('rexCharacterCache').add(this, {
+        var characterCache = this.plugins.get('rexCharacterCache').add({
             key: 'font',
 
             cellWidth: 32, cellHeight: 32,

diff --git a/examples/charactercache/textbox.js b/examples/charactercache/textbox.js
@@ -18,7 +18,7 @@ class Demo extends Phaser.Scene {
     }
 
     create() {
-        var characterCache = this.plugins.get('rexCharacterCache').add(this, {
+        var characterCache = this.plugins.get('rexCharacterCache').add({
             key: 'font',
 
             cellWidth: 32, cellHeight: 32,

diff --git a/examples/charactercache/typing.js b/examples/charactercache/typing.js
@@ -13,7 +13,7 @@ class Demo extends Phaser.Scene {
     }
 
     create() {
-        var characterCache = this.plugins.get('rexCharacterCache').add(this, {
+        var characterCache = this.plugins.get('rexCharacterCache').add({
             key: 'font',
 
             cellWidth: 32, cellHeight: 32,

diff --git a/plugins/charactercache-plugin.d.ts b/plugins/charactercache-plugin.d.ts
@@ -2,7 +2,11 @@ import CharacterCache from './charactercache';
 
 export default class CharacterCachePlugin extends Phaser.Plugins.BasePlugin {
     add(
-        scene: Phaser.Scene,
+        config: CharacterCache.IConfig
+    ): CharacterCache;
+
+    add(
+        scene: Phaser.Scene | Phaser.Game,
         config: CharacterCache.IConfig
     ): CharacterCache;
 

diff --git a/plugins/charactercache-plugin.js b/plugins/charactercache-plugin.js
@@ -1,5 +1,7 @@
 import CharacterCache from './charactercache.js';
 
+const IsPlainObject = Phaser.Utils.Objects.IsPlainObject;
+
 class CharacterCachePlugin extends Phaser.Plugins.BasePlugin {
 
     constructor(pluginManager) {
@@ -12,6 +14,10 @@ class CharacterCachePlugin extends Phaser.Plugins.BasePlugin {
     }
 
     add(scene, config) {
+        if (IsPlainObject(scene)) {
+            config = scene;
+            scene = this.game;
+        }
         return new CharacterCache(scene, config);
     }
 }

diff --git a/plugins/texture/charactercache/CharacterCache.js b/plugins/texture/charactercache/CharacterCache.js
@@ -53,6 +53,8 @@ class CharacterCache {
         if (this.textObject) {
             this.textObject.destroy();
         }
+
+        this.game = null;
     }
 
     destroy() {