The Facebook Instant Games Plugin for Phaser 3 provides a seamless bridge between Phaser and the Facebook Instant Games API version 6.2.

You can access this plugin via the facebook property in a Scene, i.e:

Copythis.facebook.getPlatform();

If this is unavailable please check to make sure you're using a build of Phaser that has this plugin within it. You can quickly check this by looking at the dev tools console header - the Phaser version number will have -FB after it if this plugin is loaded.

If you are building your own version of Phaser then use this Webpack DefinePlugin flag:

"typeof PLUGIN_FBINSTANT": JSON.stringify(true)

You will find that every Instant Games API method has a mapping in this plugin. For a full list please consult either the plugin documentation, or the 6.2 SDK documentation at https://developers.facebook.com/docs/games/instant-games/sdk/fbinstant6.2

Internally this plugin uses its own Data Manager to handle seamless user data updates and provides handy functions for advertisement displaying, opening share dialogs, logging, leaderboards, purchase API requests, loader integration and more.

To get started with Facebook Instant Games you will need to register on Facebook and create a new Instant Game app that has its own unique app ID. Facebook have also provided a dashboard interface for setting up various features for your game, including leaderboards, ad requests and the payments API. There are lots of guides on the Facebook Developers portal to assist with setting these various systems up: https://developers.facebook.com/docs/games/instant-games/guides

For more details follow the Quick Start guide here: https://developers.facebook.com/docs/games/instant-games

Constructor

new FacebookInstantGamesPlugin(game)

Parameters

---

Scope: static

Extends

Phaser.Events.EventEmitter

Source: src/FacebookInstantGamesPlugin.js#L17
Since: 3.13.0

Public Members

ads

ads: Array.<AdInstance>

Description:

Contains AdInstance objects, as created by the preloadAds() method.

Source: src/FacebookInstantGamesPlugin.js#L287
Since: 3.13.0

---

catalog

catalog: Array.<Product>

Description:

The set of products that are registered to the game.

Source: src/FacebookInstantGamesPlugin.js#L258
Since: 3.13.0

---

contextID

contextID: string

Description:

A unique identifier for the current game context. This represents a specific context that the game is being played in (for example, a particular messenger conversation or facebook post). The identifier will be null if game is being played in a solo context. This value is populated automatically during boot.

Source: src/FacebookInstantGamesPlugin.js#L146
Since: 3.13.0

---

contextType

contextType: string

Description:

The current context in which your game is running. This can be either null or one of:

POST - The game is running inside of a Facebook post. THREAD - The game is running inside a Facebook Messenger thread. GROUP - The game is running inside a Facebook Group. SOLO - This is the default context, the player is the only participant.

This value is populated automatically during boot.

Source: src/FacebookInstantGamesPlugin.js#L158
Since: 3.13.0

---

data

data: Phaser.Data.DataManager

Description:

A Data Manager instance. It allows you to store, query and retrieve any key/value data you may need to store. It's also used internally by the plugin to store FBIG API data.

Source: src/FacebookInstantGamesPlugin.js#L80
Since: 3.13.0

---

dataLocked

dataLocked: boolean

Description:

Is the Data Manager currently locked?

Source: src/FacebookInstantGamesPlugin.js#L104
Since: 3.13.0

---

entryPoint

entryPoint: string

Description:

Holds the entry point that the game was launched from. This value is populated automatically during boot.

Source: src/FacebookInstantGamesPlugin.js#L124
Since: 3.13.0

---

entryPointData

entryPointData: any

Description:

An object that contains any data associated with the entry point that the game was launched from. The contents of the object are developer-defined, and can occur from entry points on different platforms. This will return null for older mobile clients, as well as when there is no data associated with the particular entry point. This value is populated automatically during boot.

Source: src/FacebookInstantGamesPlugin.js#L134
Since: 3.13.0

---

game

game: Phaser.Game

Description:

A reference to the Phaser.Game instance.

Source: src/FacebookInstantGamesPlugin.js#L70
Since: 3.13.0

---

hasLoaded

hasLoaded: boolean

Description:

Has the Facebook Instant Games API loaded yet? This is set automatically during the boot process.

Source: src/FacebookInstantGamesPlugin.js#L94
Since: 3.13.0

---

leaderboards

leaderboards: Array.<Phaser.FacebookInstantGamesLeaderboard>

Description:

Contains all of the leaderboard data, as populated by the getLeaderboard() method.

Source: src/FacebookInstantGamesPlugin.js#L278
Since: 3.13.0

---

locale

locale: string

Description:

The current locale. See https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values. Use this to determine what languages the current game should be localized with. This value is populated automatically during boot.

Source: src/FacebookInstantGamesPlugin.js#L175
Since: 3.13.0

---

paymentsReady

paymentsReady: boolean

Description:

Does the current platform and context allow for use of the payments API? Currently this is only available on Facebook.com and Android 6+.

Source: src/FacebookInstantGamesPlugin.js#L248
Since: 3.13.0

---

platform

platform: string

Description:

The platform on which the game is currently running, i.e. IOS. This value is populated automatically during boot.

Source: src/FacebookInstantGamesPlugin.js#L187
Since: 3.13.0

---

playerCanSubscribeBot

playerCanSubscribeBot: boolean

Description:

Whether a player can subscribe to the game bot or not.

Source: src/FacebookInstantGamesPlugin.js#L239
Since: 3.13.0

---

playerID

playerID: string

Description:

Holds the id of the player. This is a string based ID, the same as FBInstant.player.getID(). This value is populated automatically during boot if the API is supported.

Source: src/FacebookInstantGamesPlugin.js#L207
Since: 3.13.0

---

playerName

playerName: string

Description:

The player's localized display name. This value is populated automatically during boot if the API is supported.

Source: src/FacebookInstantGamesPlugin.js#L217
Since: 3.13.0

---

playerPhotoURL

playerPhotoURL: string

Description:

A url to the player's public profile photo. The photo will always be a square, and with dimensions of at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant. It's recommended to always scale the image to a desired size before rendering. This value is populated automatically during boot if the API is supported.

Source: src/FacebookInstantGamesPlugin.js#L227
Since: 3.13.0

---

purchases

purchases: Array.<Purchase>

Description:

Contains all of the player's unconsumed purchases. The game must fetch the current player's purchases as soon as the client indicates that it is ready to perform payments-related operations, i.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.

Source: src/FacebookInstantGamesPlugin.js#L267
Since: 3.13.0

---

supportedAPIs

supportedAPIs: Array.<string>

Description:

A list of the Facebook Instant Games APIs that are available, based on the given platform, context and user privacy settings. This value is populated automatically during boot.

Source: src/FacebookInstantGamesPlugin.js#L113
Since: 3.13.0

---

version

version: string

Description:

The string representation of the Facebook Instant Games SDK version being used. This value is populated automatically during boot.

Source: src/FacebookInstantGamesPlugin.js#L197
Since: 3.13.0

---

Public Methods

addListener

<instance> addListener(event, fn, [context])

Description:

Add a listener for a given event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - this.

Inherits: Phaser.Events.EventEmitter#addListener

Source: src/events/EventEmitter.js#L111
Since: 3.0.0

---

canSubscribeBot

<instance> canSubscribeBot()

Description:

Checks if the current player can subscribe to the game bot.

It makes an async call to the API, so the result isn't available immediately.

If they can subscribe, the playerCanSubscribeBot property is set to true and this plugin will emit the cansubscribebot event.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a cansubscribebotfail event instead.

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L723
Since: 3.13.0

---

checkAPI

<instance> checkAPI(api)

Description:

Checks to see if a given Facebook Instant Games API is available or not.

Parameters:

Returns: boolean - true if the API is supported, otherwise false.

Source: src/FacebookInstantGamesPlugin.js#L494
Since: 3.13.0

---

chooseContext

<instance> chooseContext([options])

Description:

Opens a context selection dialog for the player. If the player selects an available context, the client will attempt to switch into that context, and emit the choose event if successful. Otherwise, if the player exits the menu or the client fails to switch into the new context, the choosefail event will be emitted.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1351
Since: 3.13.0

---

consumePurchase

<instance> consumePurchase(purchaseToken)

Description:

Consumes a specific purchase belonging to the current player. Before provisioning a product's effects to the player, the game should request the consumption of the purchased product. Once the purchase is successfully consumed, the game should immediately provide the player with the effects of their purchase.

It makes an async call to the API, so the result isn't available immediately.

If they are successfully subscribed this plugin will emit the consumepurchase event along with the purchase data.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a consumepurchasefail event instead.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1626
Since: 3.17.0

---

createContext

<instance> createContext(playerID)

Description:

Attempts to create or switch into a context between a specified player and the current player. This plugin will emit the create event once the context switch is completed. If the API call fails, such as if the player listed is not a Connected Player of the current player or if the player does not provide permission to enter the new context, then the plugin will emit a 'createfail' event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1385
Since: 3.13.0

---

createShortcut

<instance> createShortcut()

Description:

Prompts the user to create a shortcut to the game if they are eligible to. Can only be called once per session.

It makes an async call to the API, so the result isn't available immediately.

If the user choose to create a shortcut this plugin will emit the shortcutcreated event.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a shortcutcreatedfail event instead.

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1856
Since: 3.13.0

---

destroy

<instance> destroy()

Description:

Quits the Facebook API and then destroys this plugin.

Overrides: Phaser.Events.EventEmitter#destroy

Source: src/FacebookInstantGamesPlugin.js#L2290
Since: 3.13.0

---

emit

<instance> emit(event, [args])

Description:

Calls each of the listeners registered for a given event.

Parameters:

Returns: boolean - true if the event had listeners, else false.

Inherits: Phaser.Events.EventEmitter#emit

Source: src/events/EventEmitter.js#L86
Since: 3.0.0

---

eventNames

<instance> eventNames()

Description:

Return an array listing the events for which the emitter has registered listeners.

Returns: Array.<(string | symbol)> - undefined

Inherits: Phaser.Events.EventEmitter#eventNames

Source: src/events/EventEmitter.js#L55
Since: 3.0.0

---

flushData

<instance> flushData()

Description:

Immediately flushes any changes to the player data to the designated cloud storage. This function is expensive, and should primarily be used for critical changes where persistence needs to be immediate and known by the game. Non-critical changes should rely on the platform to persist them in the background. NOTE: Calls to player.setDataAsync will be rejected while this function's result is pending.

Data managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this method directly if you need to flush the data directly.

When the APIs flushDataAsync call resolves it will emit the flushdata event from this plugin. If the call fails for some reason it will emit flushdatafail instead.

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L891
Since: 3.13.0

---

gameStarted

<instance> gameStarted()

Description:

This method is called automatically when the game has finished loading, if you used the showLoadProgress method. If your game doesn't need to load any assets, or you're managing the load yourself, then call this method directly to start the API running.

When the API has finished starting this plugin will emit a startgame event which you should listen for.

Source: src/FacebookInstantGamesPlugin.js#L398
Since: 3.13.0

---

getCatalog

<instance> getCatalog()

Description:

Fetches the game's product catalog.

It makes an async call to the API, so the result isn't available immediately.

If they are successfully subscribed this plugin will emit the getcatalog event along with the catalog data.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a getcatalogfail event instead.

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1458
Since: 3.13.0

---

getData

<instance> getData(keys)

Description:

Gets the associated data from the player based on the given key, or array of keys.

The data is requested in an async call, so the result isn't available immediately.

When the call completes the data is set into this plugins Data Manager and the getdata event will be emitted.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L802
Since: 3.13.0

---

getID

<instance> getID()

Description:

Returns the unique identifier for the current game context. This represents a specific context that the game is being played in (for example, a particular messenger conversation or facebook post). The identifier will be null if game is being played in a solo context.

It is only populated if contextGetID is in the list of supported APIs.

Returns: string - The context ID.

Source: src/FacebookInstantGamesPlugin.js#L516
Since: 3.13.0

---

getLeaderboard

<instance> getLeaderboard(name)

Description:

Fetch a specific leaderboard belonging to this Instant Game.

The data is requested in an async call, so the result isn't available immediately.

When the call completes the getleaderboard event will be emitted along with a Leaderboard object instance.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L2251
Since: 3.13.0

---

getLocale

<instance> getLocale()

Description:

Returns the current locale. See https://origincache.facebook.com/developers/resources/?id=FacebookLocales.xml for a complete list of supported locale values. Use this to determine what languages the current game should be localized with. It is only populated if getLocale is in the list of supported APIs.

Returns: string - The current locale.

Source: src/FacebookInstantGamesPlugin.js#L563
Since: 3.13.0

---

getPlatform

<instance> getPlatform()

Description:

Returns the platform on which the game is currently running, i.e. IOS. It is only populated if getPlatform is in the list of supported APIs.

Returns: string - The current platform.

Source: src/FacebookInstantGamesPlugin.js#L584
Since: 3.13.0

---

getPlayerID

<instance> getPlayerID()

Description:

Returns the id of the player. This is a string based ID, the same as FBInstant.player.getID(). It is only populated if playerGetID is in the list of supported APIs.

Returns: string - The player ID.

Source: src/FacebookInstantGamesPlugin.js#L622
Since: 3.13.0

---

getPlayerName

<instance> getPlayerName()

Description:

Returns the player's localized display name. It is only populated if playerGetName is in the list of supported APIs.

Returns: string - The player's localized display name.

Source: src/FacebookInstantGamesPlugin.js#L641
Since: 3.13.0

---

getPlayerPhotoURL

<instance> getPlayerPhotoURL()

Description:

Returns the url to the player's public profile photo. The photo will always be a square, and with dimensions of at least 200x200. When rendering it in the game, the exact dimensions should never be assumed to be constant. It's recommended to always scale the image to a desired size before rendering. It is only populated if playerGetPhoto is in the list of supported APIs.

Returns: string - The player's photo url.

Source: src/FacebookInstantGamesPlugin.js#L660
Since: 3.13.0

---

getPlayers

<instance> getPlayers()

Description:

Fetches an array of ConnectedPlayer objects containing information about active players (people who played the game in the last 90 days) that are connected to the current player.

It makes an async call to the API, so the result isn't available immediately.

If they are successfully subscribed this plugin will emit the players event along with the player data.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a playersfail event instead.

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1420
Since: 3.13.0

---

getProduct

<instance> getProduct(productID)

Description:

Fetches a single Product from the game's product catalog.

The product catalog must have been populated using getCatalog prior to calling this method.

Use this to look-up product details based on a purchase list.

Parameters:

Returns: Product - The Product from the catalog, or null if it couldn't be found or the catalog isn't populated.

Source: src/FacebookInstantGamesPlugin.js#L1503
Since: 3.17.0

---

getPurchases

<instance> getPurchases()

Description:

Fetches all of the player's unconsumed purchases. The game must fetch the current player's purchases as soon as the client indicates that it is ready to perform payments-related operations, i.e. at game start. The game can then process and consume any purchases that are waiting to be consumed.

It makes an async call to the API, so the result isn't available immediately.

If they are successfully subscribed this plugin will emit the getpurchases event along with the purchase data.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a getpurchasesfail event instead.

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1579
Since: 3.13.0

---

getSDKVersion

<instance> getSDKVersion()

Description:

Returns the string representation of the Facebook Instant Games SDK version being used. It is only populated if getSDKVersion is in the list of supported APIs.

Returns: string - The sdk version.

Source: src/FacebookInstantGamesPlugin.js#L603
Since: 3.13.0

---

getStats

<instance> getStats([keys])

Description:

Retrieve stats from the designated cloud storage of the current player.

The data is requested in an async call, so the result isn't available immediately.

When the call completes the getstats event will be emitted along with the data object returned.

If the call fails, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a getstatsfail event instead.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L929
Since: 3.13.0

---

getType

<instance> getType()

Description:

Returns the current context in which your game is running. This can be either null or one of:

POST - The game is running inside of a Facebook post. THREAD - The game is running inside a Facebook Messenger thread. GROUP - The game is running inside a Facebook Group. SOLO - This is the default context, the player is the only participant.

It is only populated if contextGetType is in the list of supported APIs.

Returns: string - The context type.

Source: src/FacebookInstantGamesPlugin.js#L538
Since: 3.13.0

---

incStats

<instance> incStats(data)

Description:

Increment the stats of the current player and save them to the designated cloud storage.

Stats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats, all other data types will be ignored.

The data object provided for this call should contain offsets for how much to modify the stats by:

Copythis.facebook.incStats({
    level: 1,
    zombiesSlain: 17,
    rank: -1
});

The data is requested in an async call, so the result isn't available immediately.

When the call completes the incstats event will be emitted along with the data object returned.

If the call fails, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a incstatsfail event instead.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1018
Since: 3.13.0

---

isSizeBetween

<instance> isSizeBetween([min], [max])

Description:

This function determines whether the number of participants in the current game context is between a given minimum and maximum, inclusive. If one of the bounds is null only the other bound will be checked against. It will always return the original result for the first call made in a context in a given game play session. Subsequent calls, regardless of arguments, will return the answer to the original query until a context change occurs and the query result is reset.

Parameters:

Returns: object - The Context Size Response object in the format: {answer: boolean, minSize: number?, maxSize: number?}.

Source: src/FacebookInstantGamesPlugin.js#L1269
Since: 3.13.0

---

listenerCount

<instance> listenerCount(event)

Description:

Return the number of listeners listening to a given event.

Parameters:

Returns: number - The number of listeners.

Inherits: Phaser.Events.EventEmitter#listenerCount

Source: src/events/EventEmitter.js#L75
Since: 3.0.0

---

listeners

<instance> listeners(event)

Description:

Return the listeners registered for a given event.

Parameters:

Returns: Array.<function()> - The registered listeners.

Inherits: Phaser.Events.EventEmitter#listeners

Source: src/events/EventEmitter.js#L64
Since: 3.0.0

---

loadPlayerPhoto

<instance> loadPlayerPhoto(scene, key)

Description:

Load the player's photo and store it in the Texture Manager, ready for use in-game.

This method works by using a Scene Loader instance and then asking the Loader to retrieve the image.

When complete the plugin will emit a photocomplete event, along with the key of the photo.

Copythis.facebook.loadPlayerPhoto(this, 'player').once('photocomplete', function (key) {
  this.add.image(x, y, 'player');
}, this);

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L681
Since: 3.13.0

---

log

<instance> log(name, [value], [params])

Description:

Log an app event with FB Analytics.

See https://developers.facebook.com/docs/javascript/reference/v2.8#app_events for more details about FB Analytics.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1905
Since: 3.13.0

---

matchPlayer

<instance> matchPlayer([matchTag], [switchImmediately])

Description:

Attempts to match the current player with other users looking for people to play with. If successful, a new Messenger group thread will be created containing the matched players and the player will be context switched to that thread. This plugin will also dispatch the matchplayer event, containing the new context ID and Type.

The default minimum and maximum number of players in one matched thread are 2 and 20 respectively, depending on how many players are trying to get matched around the same time.

The values can be changed in fbapp-config.json. See the Bundle Config documentation for documentation about fbapp-config.json.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L2210
Since: 3.13.0

---

off

<instance> off(event, [fn], [context], [once])

Description:

Remove the listeners of a given event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - this.

Inherits: Phaser.Events.EventEmitter#off

Source: src/events/EventEmitter.js#L151
Since: 3.0.0

---

on

<instance> on(event, fn, [context])

Description:

Add a listener for a given event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - this.

Inherits: Phaser.Events.EventEmitter#on

Source: src/events/EventEmitter.js#L98
Since: 3.0.0

---

once

<instance> once(event, fn, [context])

Description:

Add a one-time listener for a given event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - this.

Inherits: Phaser.Events.EventEmitter#once

Source: src/events/EventEmitter.js#L124
Since: 3.0.0

---

openChallenge

<instance> openChallenge(text, key, [frame], [sessionData])

Description:

This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.

A blob of data can be attached to the share which every game session launched from the share will be able to access via the this.entryPointData property.

This data must be less than or equal to 1000 characters when stringified.

When this method is called you should consider your game paused. Listen out for the resume event from this plugin to know when the dialog has been closed.

The user may choose to cancel the share action and close the dialog. The resulting resume event will be dispatched regardless if the user actually shared the content or not.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1192
Since: 3.13.0

---

openInvite

<instance> openInvite(text, key, [frame], [sessionData])

Description:

This invokes a dialog to let the user invite a friend to play this game, either as a message in Messenger or as a post on the user's timeline.

A blob of data can be attached to the share which every game session launched from the share will be able to access via the this.entryPointData property.

This data must be less than or equal to 1000 characters when stringified.

When this method is called you should consider your game paused. Listen out for the resume event from this plugin to know when the dialog has been closed.

The user may choose to cancel the share action and close the dialog. The resulting resume event will be dispatched regardless if the user actually shared the content or not.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1140
Since: 3.13.0

---

openRequest

<instance> openRequest(text, key, [frame], [sessionData])

Description:

This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.

A blob of data can be attached to the share which every game session launched from the share will be able to access via the this.entryPointData property.

This data must be less than or equal to 1000 characters when stringified.

When this method is called you should consider your game paused. Listen out for the resume event from this plugin to know when the dialog has been closed.

The user may choose to cancel the share action and close the dialog. The resulting resume event will be dispatched regardless if the user actually shared the content or not.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1166
Since: 3.13.0

---

openShare

<instance> openShare(text, key, [frame], [sessionData])

Description:

This invokes a dialog to let the user share specified content, either as a message in Messenger or as a post on the user's timeline.

A blob of data can be attached to the share which every game session launched from the share will be able to access via the this.entryPointData property.

This data must be less than or equal to 1000 characters when stringified.

When this method is called you should consider your game paused. Listen out for the resume event from this plugin to know when the dialog has been closed.

The user may choose to cancel the share action and close the dialog. The resulting resume event will be dispatched regardless if the user actually shared the content or not.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1114
Since: 3.13.0

---

preloadAds

<instance> preloadAds(placementID)

Description:

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.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1936
Since: 3.13.0

---

preloadVideoAds

<instance> preloadVideoAds(placementID)

Description:

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.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L2022
Since: 3.13.0

---

purchase

<instance> purchase(productID, [developerPayload])

Description:

Begins the purchase flow for a specific product.

It makes an async call to the API, so the result isn't available immediately.

If they are successfully subscribed this plugin will emit the purchase event along with the purchase data.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a purchasefail event instead.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1530
Since: 3.13.0

---

quit

<instance> quit()

Description:

Quits the game.

Source: src/FacebookInstantGamesPlugin.js#L1894
Since: 3.13.0

---

removeAllListeners

<instance> removeAllListeners([event])

Description:

Remove all listeners, or those of the specified event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - this.

Inherits: Phaser.Events.EventEmitter#removeAllListeners

Source: src/events/EventEmitter.js#L165
Since: 3.0.0

---

removeListener

<instance> removeListener(event, [fn], [context], [once])

Description:

Remove the listeners of a given event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - this.

Inherits: Phaser.Events.EventEmitter#removeListener

Source: src/events/EventEmitter.js#L137
Since: 3.0.0

---

saveData

<instance> saveData(data)

Description:

Set data to be saved to the designated cloud storage of the current player. The game can store up to 1MB of data for each unique player.

The data save is requested in an async call, so the result isn't available immediately.

Data managed via this plugins Data Manager instance is automatically synced with Facebook. However, you can call this method directly if you need to replace the data object directly.

When the APIs setDataAsync call resolves it will emit the savedata event from this plugin. If the call fails for some reason it will emit savedatafail instead.

The call resolving does not necessarily mean that the input has already been persisted. Rather, it means that the data was valid and has been scheduled to be saved. It also guarantees that all values that were set are now available in getData.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L848
Since: 3.13.0

---

saveSession

<instance> saveSession(data)

Description:

Sets the data associated with the individual gameplay session for the current context.

This function should be called whenever the game would like to update the current session data.

This session data may be used to populate a variety of payloads, such as game play webhooks.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1079
Since: 3.13.0

---

saveStats

<instance> saveStats(data)

Description:

Save the stats of the current player to the designated cloud storage.

Stats in the Facebook Instant Games API are purely numerical values paired with a string-based key. Only numbers can be saved as stats, all other data types will be ignored.

The data is requested in an async call, so the result isn't available immediately.

When the call completes the savestats event will be emitted along with the data object returned.

If the call fails, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a savestatsfail event instead.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L967
Since: 3.13.0

---

showAd

<instance> showAd(placementID)

Description:

Displays a previously loaded interstitial ad.

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, it will emit the adsnotloaded event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L2108
Since: 3.13.0

---

showLoadProgress

<instance> showLoadProgress(scene)

Description:

Call this method from your Scene.preload in order to sync the load progress of the Phaser Loader with the Facebook Instant Games loader display, i.e.:

Copythis.facebook.showLoadProgress(this);
this.facebook.once('startgame', this.startGame, this);

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L357
Since: 3.13.0

---

showVideo

<instance> showVideo(placementID)

Description:

Displays a previously loaded interstitial video ad.

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, it will emit the adsnotloaded event.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L2159
Since: 3.13.0

---

shutdown

<instance> shutdown()

Description:

Removes all listeners.

Inherits: Phaser.Events.EventEmitter#shutdown

Source: src/events/EventEmitter.js#L31
Since: 3.0.0

---

subscribeBot

<instance> subscribeBot()

Description:

Subscribes the current player to the game bot.

It makes an async call to the API, so the result isn't available immediately.

If they are successfully subscribed this plugin will emit the subscribebot event.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a subscribebotfail event instead.

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L764
Since: 3.13.0

---

switchContext

<instance> switchContext(contextID)

Description:

Request a switch into a specific context. If the player does not have permission to enter that context, or if the player does not provide permission for the game to enter that context, this will emit a switchfail event.

Otherwise, the plugin will emit the switch event when the game has switched into the specified context.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1293
Since: 3.13.0

---

switchGame

<instance> switchGame(appID, [data])

Description:

Request that the client switch to a different Instant Game.

It makes an async call to the API, so the result isn't available immediately.

If the game switches successfully this plugin will emit the switchgame event and the client will load the new game.

If they cannot, i.e. it's not in the list of supported APIs, or the request was rejected, it will emit a switchgamefail event instead.

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1806
Since: 3.13.0

---

update

<instance> update(cta, text, key, frame, template, updateData)

Description:

Informs Facebook of a custom update that occurred in the game. This will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is. Once Facebook returns control to the game the plugin will emit an update or updatefail event.

It makes an async call to the API, so the result isn't available immediately.

The text parameter is an update payload with the following structure:

Copytext: {
    default: 'X just invaded Y\'s village!',
    localizations: {
        ar_AR: 'X \u0641\u0642\u0637 \u063A\u0632\u062A ' +
        '\u0642\u0631\u064A\u0629 Y!',
        en_US: 'X just invaded Y\'s village!',
        es_LA: '\u00A1X acaba de invadir el pueblo de Y!',
    }
}

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1667
Since: 3.13.0

---

updateLeaderboard

<instance> updateLeaderboard(cta, text, key, frame, template, updateData)

Description:

Informs Facebook of a leaderboard update that occurred in the game. This will temporarily yield control to Facebook and Facebook will decide what to do based on what the update is. Once Facebook returns control to the game the plugin will emit an update or updatefail event.

It makes an async call to the API, so the result isn't available immediately.

The text parameter is an update payload with the following structure:

Copytext: {
    default: 'X just invaded Y\'s village!',
    localizations: {
        ar_AR: 'X \u0641\u0642\u0637 \u063A\u0632\u062A ' +
        '\u0642\u0631\u064A\u0629 Y!',
        en_US: 'X just invaded Y\'s village!',
        es_LA: '\u00A1X acaba de invadir el pueblo de Y!',
    }
}

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1705
Since: 3.13.0

---

Private Methods

_share

<instance> _share(intent, text, key, [frame], [sessionData])

Description:

Internal share handler.

Access: private

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1218
Since: 3.13.0

---

_update

<instance> _update(action, cta, text, key, frame, template, updateData)

Description:

Internal update handler.

Access: private

Parameters:

Returns: Phaser.FacebookInstantGamesPlugin - This Facebook Instant Games Plugin instance.

Source: src/FacebookInstantGamesPlugin.js#L1743
Since: 3.13.0

---

changeDataHandler

<instance> changeDataHandler(parent, key, value)

Description:

Internal change data handler.

Access: private

Parameters:

Source: src/FacebookInstantGamesPlugin.js#L327
Since: 3.13.0

---

gameStartedHandler

<instance> gameStartedHandler()

Description:

The internal gameStarted handler.

Access: private

Source: src/FacebookInstantGamesPlugin.js#L424
Since: 3.20.0

---

setDataHandler

<instance> setDataHandler(parent, key, value)

Description:

Internal set data handler.

Access: private

Parameters:

Source: src/FacebookInstantGamesPlugin.js#L297
Since: 3.13.0

---