This page contains changes which are not marked for translation.

Supported platforms: Platform html5.png
Available since: Gideros 2018.3


Facebook Instant Games Initialisation and Core.

It is very important that only the following API calls are made before startGameAsync has resolved:

  • FBInstant.getSDKVersion()
  • FBInstant.initializeAsync()
  • FBInstant.getPlatform()
  • FBInstant.setLoadingProgress()
  • FBInstant.getSupportedAPIs()
  • FBInstant.quit()
  • FBInstant.onPause()
  • FBInstant.player.getID()

To help do this you could create a variable called FBInstantAPI and set it to true once startGameAsync has been resolved - then only call other API commands if FBInstant is true and then if FBInstantAPI is true.


Initialisation and removal of the Facebook loading progress indicator.

pcall(function() FBInstant=require "FBInstant" end)
if FBInstant then
		print("Loading screen removed")
	print("FBInstant not loaded")


FBInstant.canCreateShortcutAsync Returns whether or not the user is eligible to have shortcut creation requested.
FBInstant.checkCanPlayerMatchAsync Checks if the current player is eligible for the matchPlayerAsync API.
FBInstant.createShortcutAsync Prompts the user to create a shortcut to the game.
FBInstant.getEntryPointAsync Returns the entry point that the game was launched from.
FBInstant.getEntryPointData Returns any data object associated with the entry point that the game was launched from.
FBInstant.getInterstitialAdAsync Attempt to create an instance of interstitial ad.
FBInstant.getLeaderboardAsync Fetch a specific leaderboard belonging to this Instant Game.
FBInstant.getLocale The current locale.
FBInstant.getPlatform The platform on which the game is currently running.
FBInstant.getRewardedVideoAsync Attempt to create an instance of rewarded video.
FBInstant.getSDKVersion The string representation of this SDK version.
FBInstant.getSupportedAPIs Provides a list of API functions that are supported by the client.
FBInstant.logEvent Log an app event with FB Analytics.
FBInstant.matchPlayerAsync Attempts to match the current player with other users looking for people to play with.
FBInstant.onPause Set a callback to be fired when a pause event is triggered.
FBInstant.quit Quits the game.
FBInstant.setLoadingProgress Report the game's initial loading progress.
FBInstant.setSessionData Sets the data associated with the individual gameplay session for the current context.
FBInstant.shareAsync This invokes a dialog to let the user share specified content.
FBInstant.startGameAsync This indicates that the game has finished initial loading and is ready to start.
FBInstant.switchGameAsync Request that the client switch to a different Instant Game.
FBInstant.updateAsync Informs Facebook of an update that occurred in the game.