Merge branch 'master' of https://github.com/photonstorm/phaser

Author: photonstorm

CHANGELOG.md

@@ -10,6 +10,13 @@
 * `Leaderboard.getPlayerScore` now only populates the `playerScore` property if the entry isn't `null`.
 * If the `setScore` or `getPlayerScore` calls fail, it will return `null` as the score instance, instead of causing a run-time error.
 * You can now pass an object or a string to `setScore` and objects will be automatically stringified.
+* The `preloadAds` method will now only create an AdInstance object if the interstitial `loadSync` promise resolves.
+* The `preloadVideoAds` method will now only create an AdInstance object if the interstitial `loadSync` promise resolves.
+* The `preloadAds` method will now emit the `adsnofill` event, if there are no ads in the inventory to load.
+* The `preloadVideoAds` method will now emit the `adsnofill` event, if there are no ads in the inventory to load.
+* The `showAd` method will now emit the `adsnotloaded` event, if there are no ads loaded matching the given Placement ID.
+* The `showVideo` method will now emit the `adsnotloaded` event, if there are no ads loaded matching the given Placement ID.
+* Showing an ad will emit the `adfinished` event when the ad is closed, previously this event was called `showad` but the new name better reflects what has happened.
 
 ### Keyboard Input - New Features
 

plugins/fbinstant/src/AdInstance.js

@@ -13,11 +13,11 @@
  * @property {boolean} video - Is this a video ad?
  */
 
-var AdInstance = function (instance, video)
+var AdInstance = function (placementID, instance, video)
 {
     return {
         instance: instance,
-        placementID: instance.getPlacementID(),
+        placementID: placementID,
         shown: false,
         video: video
     };

plugins/fbinstant/src/FacebookInstantGamesPlugin.js

@@ -1870,6 +1870,10 @@ var FacebookInstantGamesPlugin = new Class({
      * Attempt to create an instance of an interstitial ad.
      * 
      * If the instance is created successfully then the ad is preloaded ready for display in-game via the method `showAd()`.
+     * 
+     * If the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.
+     * 
+     * If the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.
      *
      * @method Phaser.FacebookInstantGamesPlugin#preloadAds
      * @since 3.13.0
@@ -1912,28 +1916,50 @@ var FacebookInstantGamesPlugin = new Class({
         for (i = 0; i < placementID.length; i++)
         {
             var id = placementID[i];
+            var data;
 
-            FBInstant.getInterstitialAdAsync(id).then(function (data)
+            FBInstant.getInterstitialAdAsync(id).then(function (interstitial)
             {
-                var ad = AdInstance(data, true);
-    
+                data = interstitial;
+
+                return interstitial.loadAsync();
+
+            }).then(function ()
+            {
+                var ad = AdInstance(id, data, false);
+
                 _this.ads.push(ad);
-    
-                return ad.loadAsync();
-    
+
+                _this.emit('adloaded', ad);
+
             }).catch(function (e)
             {
-                console.warn(e);
+                if (e.code === 'ADS_NO_FILL')
+                {
+                    _this.emit('adsnofill', id);
+                }
+                else if (e.code === 'ADS_FREQUENT_LOAD')
+                {
+                    _this.emit('adsfrequentload', id);
+                }
+                else
+                {
+                    console.warn(e);
+                }
             });
         }
 
         return this;
     },
 
     /**
-     * Attempt to create an instance of an interstitial video ad.
+     * Attempt to create an instance of an rewarded video ad.
      * 
      * If the instance is created successfully then the ad is preloaded ready for display in-game via the method `showVideo()`.
+     * 
+     * If the ad loads it will emit the `adloaded` event, passing the AdInstance as the only parameter.
+     * 
+     * If the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.
      *
      * @method Phaser.FacebookInstantGamesPlugin#preloadVideoAds
      * @since 3.13.0
@@ -1976,18 +2002,36 @@ var FacebookInstantGamesPlugin = new Class({
         for (i = 0; i < placementID.length; i++)
         {
             var id = placementID[i];
+            var data;
 
-            FBInstant.getRewardedVideoAsync(id).then(function (data)
+            FBInstant.getRewardedVideoAsync(id).then(function (reward)
             {
-                var ad = AdInstance(data, true);
-    
+                data = reward;
+
+                return reward.loadAsync();
+
+            }).then(function ()
+            {
+                var ad = AdInstance(id, data, true);
+
                 _this.ads.push(ad);
-    
-                return ad.loadAsync();
-    
+
+                _this.emit('adloaded', ad);
+
             }).catch(function (e)
             {
-                console.warn(e);
+                if (e.code === 'ADS_NO_FILL')
+                {
+                    _this.emit('adsnofill', id);
+                }
+                else if (e.code === 'ADS_FREQUENT_LOAD')
+                {
+                    _this.emit('adsfrequentload', id);
+                }
+                else
+                {
+                    console.warn(e);
+                }
             });
         }
 
@@ -1997,9 +2041,9 @@ var FacebookInstantGamesPlugin = new Class({
     /**
      * Displays a previously loaded interstitial ad.
      * 
-     * If the ad is successfully displayed this plugin will emit the `showad` event, with the AdInstance object as its parameter.
+     * If the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.
      * 
-     * If the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.
+     * If the ad cannot be displayed, it will emit the `adsnotloaded` event.
      *
      * @method Phaser.FacebookInstantGamesPlugin#showAd
      * @since 3.13.0
@@ -2022,18 +2066,20 @@ var FacebookInstantGamesPlugin = new Class({
                 {
                     ad.shown = true;
 
-                    _this.emit('showad', ad);
+                    _this.emit('adfinished', ad);
 
                 }).catch(function (e)
                 {
-                    if (e.code === 'ADS_NO_FILL')
+                    if (e.code === 'ADS_NOT_LOADED')
                     {
-                        _this.emit('adsnofill');
+                        _this.emit('adsnotloaded', ad);
                     }
-                    else
+                    else if (e.code === 'RATE_LIMITED')
                     {
-                        console.warn(e);
+                        _this.emit('adratelimited', ad);
                     }
+                    
+                    _this.emit('adshowerror', e, ad);
                 });
             }
         }
@@ -2044,9 +2090,9 @@ var FacebookInstantGamesPlugin = new Class({
     /**
      * Displays a previously loaded interstitial video ad.
      * 
-     * If the ad is successfully displayed this plugin will emit the `showad` event, with the AdInstance object as its parameter.
+     * If the ad is successfully displayed this plugin will emit the `adfinished` event, with the AdInstance object as its parameter.
      * 
-     * If the ad cannot be displayed because there was no inventory to fill it, it will emit the `adsnofill` event.
+     * If the ad cannot be displayed, it will emit the `adsnotloaded` event.
      *
      * @method Phaser.FacebookInstantGamesPlugin#showVideo
      * @since 3.13.0
@@ -2069,18 +2115,20 @@ var FacebookInstantGamesPlugin = new Class({
                 {
                     ad.shown = true;
 
-                    _this.emit('showad', ad);
+                    _this.emit('adfinished', ad);
 
                 }).catch(function (e)
                 {
-                    if (e.code === 'ADS_NO_FILL')
+                    if (e.code === 'ADS_NOT_LOADED')
                     {
-                        _this.emit('adsnofill');
+                        _this.emit('adsnotloaded', ad);
                     }
-                    else
+                    else if (e.code === 'RATE_LIMITED')
                     {
-                        console.warn(e);
+                        _this.emit('adratelimited', ad);
                     }
+                    
+                    _this.emit('adshowerror', e, ad);
                 });
             }
         }