Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . FacebookInstantGamesPlugin

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . FacebookInstantGamesPlugin

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:

this.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:

name type description
game Phaser.Game

A reference to the Phaser.Game instance.

Since: 3.13.0

Extends


Members

ads: Array.<AdInstance>
Focus
Focus

Description:

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

Type:
Array.<AdInstance>
Since: 3.13.0
Focus
Focus
catalog: Array.<Product>
Focus
Focus

Description:

The set of products that are registered to the game.

Type:
Array.<Product>
Since: 3.13.0
Focus
Focus
contextID: string
Focus
Focus

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.

Type:
string
Since: 3.13.0
Focus
Focus
<nullable> contextType: string
Focus
Focus

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.

Type:
string
Since: 3.13.0
Focus
Focus

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.

Type:
Since: 3.13.0
Focus
Focus
dataLocked: boolean
Focus
Focus

Description:

Is the Data Manager currently locked?

Type:
boolean
Since: 3.13.0
Focus
Focus
entryPoint: string
Focus
Focus

Description:

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

Type:
string
Since: 3.13.0
Focus
Focus
entryPointData: any
Focus
Focus

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.

Type:
any
Since: 3.13.0
Focus
Focus
<readonly> game: Phaser.Game
Focus
Focus

Description:

A reference to the Phaser.Game instance.

Type:
Since: 3.13.0
Focus
Focus
hasLoaded: boolean
Focus
Focus

Description:

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

Type:
boolean
Since: 3.13.0
Focus
Focus

Description:

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

Type:
Since: 3.13.0
Focus
Focus
<nullable> locale: string
Focus
Focus

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.

Type:
string
Since: 3.13.0
Focus
Focus
paymentsReady: boolean
Focus
Focus

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+.

Type:
boolean
Since: 3.13.0
Focus
Focus
<nullable> platform: string
Focus
Focus

Description:

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

Type:
string
Since: 3.13.0
Focus
Focus
playerCanSubscribeBot: boolean
Focus
Focus

Description:

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

Type:
boolean
Since: 3.13.0
Focus
Focus
<nullable> playerID: string
Focus
Focus

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.

Type:
string
Since: 3.13.0
Focus
Focus
<nullable> playerName: string
Focus
Focus

Description:

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

Type:
string
Since: 3.13.0
Focus
Focus
<nullable> playerPhotoURL: string
Focus
Focus

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.

Type:
string
Since: 3.13.0
Focus
Focus
purchases: Array.<Purchase>
Focus
Focus

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.

Type:
Array.<Purchase>
Since: 3.13.0
Focus
Focus
supportedAPIs: Array.<string>
Focus
Focus

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.

Type:
Array.<string>
Since: 3.13.0
Focus
Focus
<nullable> version: string
Focus
Focus

Description:

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

Type:
string
Since: 3.13.0
Focus
Focus

Methods

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

Description:

Internal share handler.

Parameters:

name type arguments description
intent string

("INVITE" | "REQUEST" | "CHALLENGE" | "SHARE") Indicates the intent of the share.

text string

A text message to be shared.

key string

The key of the texture to use as the share image.

frame string <optional>

The frame of the texture to use as the share image. Set to null if you don't require a frame, but do need to set session data.

sessionData object <optional>

A blob of data to attach to the share.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
<private> _update(action, cta, text, key, frame, template, updateData)
Focus
Focus

Description:

Internal update handler.

Parameters:

name type description
action string

The update action.

cta string

The call to action text.

text object

The text object.

key string

The key of the texture to use as the share image.

frame string | integer

The frame of the texture to use as the share image. Set to null if you don't require a frame, but do need to set session data.

template string

The update template key.

updateData object

The update data object payload.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
addListener(event, fn, [context])
Focus
Focus

Description:

Add a listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#addListener
Examples:
Since: 3.0.0
Focus
Focus
canSubscribeBot()
Focus
Focus

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:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
<private> changeDataHandler(parent, key, value)
Focus
Focus

Description:

Internal change data handler.

Parameters:

name type description
parent Phaser.Data.DataManager

The parent Data Manager instance.

key string

The key of the data.

value any

The value of the data.

Examples:
Since: 3.13.0
Focus
Focus
checkAPI(api)
Focus
Focus

Description:

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

Parameters:

name type description
api string

The API to check for, i.e. player.getID.

Returns:
Description:

true if the API is supported, otherwise false.

Type:
  • boolean
Examples:
Since: 3.13.0
Focus
Focus
chooseContext([options])
Focus
Focus

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:

name type arguments description
options ChooseContextConfig <optional>

An object specifying conditions on the contexts that should be offered.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
consumePurchase(purchaseToken)
Focus
Focus

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:

name type description
purchaseToken string

The purchase token of the purchase that should be consumed.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.17.0
Focus
Focus
createContext(playerID)
Focus
Focus

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:

name type description
playerID string

ID of the player.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
createShortcut()
Focus
Focus

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:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
destroy()
Focus
Focus

Description:

Quits the Facebook API and then destroys this plugin.

Overrides: Phaser.Events.EventEmitter#destroy
Examples:
Since: 3.13.0
Focus
Focus
emit(event, [args])
Focus
Focus

Description:

Calls each of the listeners registered for a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

args * <optional>

Additional arguments that will be passed to the event handler.

Returns:
Description:

true if the event had listeners, else false.

Type:
  • boolean
Inherited from: Phaser.Events.EventEmitter#emit
Examples:
Since: 3.0.0
Focus
Focus
eventNames()
Focus
Focus

Description:

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

Type:
  • Array.<(string
  • symbol)>
Inherited from: Phaser.Events.EventEmitter#eventNames
Examples:
Since: 3.0.0
Focus
Focus
flushData()
Focus
Focus

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:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
gameStarted()
Focus
Focus

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.

Examples:
Since: 3.13.0
Focus
Focus
<private> gameStartedHandler()
Focus
Focus

Description:

The internal gameStarted handler.

Examples:
Since: 3.20.0
Focus
Focus
getCatalog()
Focus
Focus

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:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
getData(keys)
Focus
Focus

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:

name type description
keys string | Array.<string>

The key/s of the data to retrieve.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
getID()
Focus
Focus

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:
Description:

The context ID.

Type:
  • string
Examples:
Since: 3.13.0
Focus
Focus
getLeaderboard(name)
Focus
Focus

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:

name type description
name string

The name of the leaderboard. Each leaderboard for an Instant Game must have its own distinct name.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
getLocale()
Focus
Focus

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:
Description:

The current locale.

Type:
  • string
Examples:
Since: 3.13.0
Focus
Focus
getPlatform()
Focus
Focus

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:
Description:

The current platform.

Type:
  • string
Examples:
Since: 3.13.0
Focus
Focus
getPlayerID()
Focus
Focus

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:
Description:

The player ID.

Type:
  • string
Examples:
Since: 3.13.0
Focus
Focus
getPlayerName()
Focus
Focus

Description:

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

Returns:
Description:

The player's localized display name.

Type:
  • string
Examples:
Since: 3.13.0
Focus
Focus
getPlayerPhotoURL()
Focus
Focus

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:
Description:

The player's photo url.

Type:
  • string
Examples:
Since: 3.13.0
Focus
Focus
getPlayers()
Focus
Focus

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:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
getProduct(productID)
Focus
Focus

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:

name type description
productID string

The Product ID of the item to get from the catalog.

Returns:
Description:

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

Type:
  • Product
Examples:
Since: 3.17.0
Focus
Focus
getPurchases()
Focus
Focus

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:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
getSDKVersion()
Focus
Focus

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:
Description:

The sdk version.

Type:
  • string
Examples:
Since: 3.13.0
Focus
Focus
getStats([keys])
Focus
Focus

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:

name type arguments description
keys Array.<string> <optional>

An optional array of unique keys to retrieve stats for. If the function is called without it, it will fetch all stats.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
getType()
Focus
Focus

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:
Description:

The context type.

Type:
  • string
Examples:
Since: 3.13.0
Focus
Focus
incStats(data)
Focus
Focus

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:

this.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:

name type description
data object

An object containing a set of key-value pairs indicating how much to increment each stat in cloud storage. Note that only numerical values are processed.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
isSizeBetween([min], [max])
Focus
Focus

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:

name type arguments description
min integer <optional>

The minimum bound of the context size query.

max integer <optional>

The maximum bound of the context size query.

Returns:
Description:

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

Type:
  • object
Examples:
Since: 3.13.0
Focus
Focus
listenerCount(event)
Focus
Focus

Description:

Return the number of listeners listening to a given event.

Parameters:

name type description
event string | symbol

The event name.

Returns:
Description:

The number of listeners.

Type:
  • number
Inherited from: Phaser.Events.EventEmitter#listenerCount
Examples:
Since: 3.0.0
Focus
Focus
listeners(event)
Focus
Focus

Description:

Return the listeners registered for a given event.

Parameters:

name type description
event string | symbol

The event name.

Returns:
Description:

The registered listeners.

Type:
  • Array.
Inherited from: Phaser.Events.EventEmitter#listeners
Examples:
Since: 3.0.0
Focus
Focus
loadPlayerPhoto(scene, key)
Focus
Focus

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.

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

Parameters:

name type description
scene Phaser.Scene

The Scene that will be responsible for loading this photo.

key string

The key to use when storing the photo in the Texture Manager.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
log(name, [value], [params])
Focus
Focus

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:

name type arguments description
name string

Name of the event. Must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters.

value number <optional>

An optional numeric value that FB Analytics can calculate a sum with.

params object <optional>

An optional object that can contain up to 25 key-value pairs to be logged with the event. Keys must be 2 to 40 characters, and can only contain '_', '-', ' ', and alphanumeric characters. Values must be less than 100 characters in length.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
matchPlayer([matchTag], [switchImmediately])
Focus
Focus

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:

name type arguments Default description
matchTag string <optional>

Optional extra information about the player used to group them with similar players. Players will only be grouped with other players with exactly the same tag. The tag must only include letters, numbers, and underscores and be 100 characters or less in length.

switchImmediately boolean <optional> false

Optional extra parameter that specifies whether the player should be immediately switched to the new context when a match is found. By default this will be false which will mean the player needs explicitly press play after being matched to switch to the new context.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
off(event, [fn], [context], [once])
Focus
Focus

Description:

Remove the listeners of a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

fn function <optional>

Only remove the listeners that match this function.

context * <optional>

Only remove the listeners that have this context.

once boolean <optional>

Only remove one-time listeners.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#off
Examples:
Since: 3.0.0
Focus
Focus
on(event, fn, [context])
Focus
Focus

Description:

Add a listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#on
Examples:
Since: 3.0.0
Focus
Focus
once(event, fn, [context])
Focus
Focus

Description:

Add a one-time listener for a given event.

Parameters:

name type arguments Default description
event string | symbol

The event name.

fn function

The listener function.

context * <optional> this

The context to invoke the listener with.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#once
Examples:
Since: 3.0.0
Focus
Focus
openChallenge(text, key, [frame], [sessionData])
Focus
Focus

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:

name type arguments description
text string

A text message to be shared.

key string

The key of the texture to use as the share image.

frame string <optional>

The frame of the texture to use as the share image. Set to null if you don't require a frame, but do need to set session data.

sessionData object <optional>

A blob of data to attach to the share.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
openInvite(text, key, [frame], [sessionData])
Focus
Focus

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:

name type arguments description
text string

A text message to be shared.

key string

The key of the texture to use as the share image.

frame string <optional>

The frame of the texture to use as the share image. Set to null if you don't require a frame, but do need to set session data.

sessionData object <optional>

A blob of data to attach to the share.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
openRequest(text, key, [frame], [sessionData])
Focus
Focus

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:

name type arguments description
text string

A text message to be shared.

key string

The key of the texture to use as the share image.

frame string <optional>

The frame of the texture to use as the share image. Set to null if you don't require a frame, but do need to set session data.

sessionData object <optional>

A blob of data to attach to the share.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
openShare(text, key, [frame], [sessionData])
Focus
Focus

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:

name type arguments description
text string

A text message to be shared.

key string

The key of the texture to use as the share image.

frame string <optional>

The frame of the texture to use as the share image. Set to null if you don't require a frame, but do need to set session data.

sessionData object <optional>

A blob of data to attach to the share.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
preloadAds(placementID)
Focus
Focus

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:

name type description
placementID string | Array.<string>

The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
preloadVideoAds(placementID)
Focus
Focus

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:

name type description
placementID string | Array.<string>

The ad placement ID, or an array of IDs, as created in your Audience Network settings within Facebook.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
purchase(productID, [developerPayload])
Focus
Focus

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:

name type arguments description
productID string

The identifier of the product to purchase.

developerPayload string <optional>

An optional developer-specified payload, to be included in the returned purchase's signed request.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
quit()
Focus
Focus

Description:

Quits the game.

Examples:
Since: 3.13.0
Focus
Focus
removeAllListeners([event])
Focus
Focus

Description:

Remove all listeners, or those of the specified event.

Parameters:

name type arguments description
event string | symbol <optional>

The event name.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#removeAllListeners
Examples:
Since: 3.0.0
Focus
Focus
removeListener(event, [fn], [context], [once])
Focus
Focus

Description:

Remove the listeners of a given event.

Parameters:

name type arguments description
event string | symbol

The event name.

fn function <optional>

Only remove the listeners that match this function.

context * <optional>

Only remove the listeners that have this context.

once boolean <optional>

Only remove one-time listeners.

Returns:
Description:

this.

Inherited from: Phaser.Events.EventEmitter#removeListener
Examples:
Since: 3.0.0
Focus
Focus
saveData(data)
Focus
Focus

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:

name type description
data object

An object containing a set of key-value pairs that should be persisted to cloud storage. The object must contain only serializable values - any non-serializable values will cause the entire modification to be rejected.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
saveSession(data)
Focus
Focus

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:

name type description
data object

An arbitrary data object, which must be less than or equal to 1000 characters when stringified.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
saveStats(data)
Focus
Focus

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:

name type description
data object

An object containing a set of key-value pairs that should be persisted to cloud storage as stats. Note that only numerical values are stored.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
<private> setDataHandler(parent, key, value)
Focus
Focus

Description:

Internal set data handler.

Parameters:

name type description
parent Phaser.Data.DataManager

The parent Data Manager instance.

key string

The key of the data.

value any

The value of the data.

Examples:
Since: 3.13.0
Focus
Focus
showAd(placementID)
Focus
Focus

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:

name type description
placementID string

The ad placement ID to display.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
showLoadProgress(scene)
Focus
Focus

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.:

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

Parameters:

name type description
scene Phaser.Scene

The Scene for which you want to show loader progress for.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
showVideo(placementID)
Focus
Focus

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:

name type description
placementID string

The ad placement ID to display.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
shutdown()
Focus
Focus

Description:

Removes all listeners.

Inherited from: Phaser.Events.EventEmitter#shutdown
Examples:
Since: 3.0.0
Focus
Focus
subscribeBot()
Focus
Focus

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:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
switchContext(contextID)
Focus
Focus

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:

name type description
contextID string

The ID of the desired context.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
switchGame(appID, [data])
Focus
Focus

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:

name type arguments description
appID string

The Application ID of the Instant Game to switch to. The application must be an Instant Game, and must belong to the same business as the current game.

data object <optional>

An optional data payload. This will be set as the entrypoint data for the game being switched to. Must be less than or equal to 1000 characters when stringified.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
update(cta, text, key, frame, template, updateData)
Focus
Focus

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:

text: {
    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:

name type description
cta string

The call to action text.

text object

The text object.

key string

The key of the texture to use as the share image.

frame string | integer

The frame of the texture to use as the share image. Set to null if you don't require a frame, but do need to set session data.

template string

The update template key.

updateData object

The update data object payload.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus
updateLeaderboard(cta, text, key, frame, template, updateData)
Focus
Focus

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:

text: {
    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:

name type description
cta string

The call to action text.

text object

The text object.

key string

The key of the texture to use as the share image.

frame string | integer

The frame of the texture to use as the share image. Set to null if you don't require a frame, but do need to set session data.

template string

The update template key.

updateData object

The update data object payload.

Returns:
Description:

This Facebook Instant Games Plugin instance.

Examples:
Since: 3.13.0
Focus
Focus