* Initialisation and Core

Supported platforms: html5
Available since: Gideros 2018.3

Description

You need to do two things to target Facebook Instant Games:

1. Tick the Facebook Instant Game tickbox when exporting to HTML5, you can also specify the percentage indicator that the game will show it has loaded before you take control.
2. Require the FBInstant library code, see the example below.

You can upload, debug and test your game by creating a player and uploading to Facebook servers as a game. The player will interact with the Gideros Studio similar to any other player.

The only restriction with the player is that it only works on the computer viewing the html5 game (localhost) - this would normally rule out actual phones but there is a workaround for Android:

1. Connect your Android phone to your computer using ADB.
2. Type in this command in a command console shell (Windows) or terminal (Mac): adb reverse tcp:15001 tcp:15001
3. The Android device now will see the Gideros Studio when testing the game when a player is launched from within Facebook Messenger.

Please refer to the <a href="https://developers.facebook.com/docs/games/instant-games/getting-started/quickstart">original Facebook documentation</a> for more information about testing and uploading.

Please note that the offical Facebook documentation mentions having to wait for initializeAsync, with Gideros this has already been done for you before your game starts.

It is very important that the 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.

Examples

Initialisation and removal of the Facebook loading progress indicator.

 
pcall(function() FBInstant=require "FBInstant" end)
if FBInstant then
	FBInstant.startGameAsync(function() 
		print("Loading screen removed")
		FBInstantAPI=true
	end)
else
	print("FBInstant not loaded")
end

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

Events Constants