Facebook Instant Games Reference

Allow your game to send scores and interact with the Facebook Instant Games platform. Read more explanations about it.

Actions

Load and prepare an interstitial ad
Request and load an interstitial ad from Facebook, so that it is ready to be shown.

See parameters

Parameter 0 (string): The Ad Placement id (can be found while setting up the ad on Facebook)
Parameter 1 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs)

Load player data
Load the player data with the given key in a variable

See parameters

Parameter 0 (string): Data key name (e.g: "Lives")
Parameter 1 (🗄️ Scene variable): Variable where to store loaded data
Parameter 2 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs)

Load player entry
Load the player entry in the given leaderboard

See parameters

Parameter 0 (string): Leaderboard name (e.g: "PlayersBestTimes")
Parameter 1 (🗄️ Scene variable): Variable where to store the player rank (of -1 if not ranked)
Parameter 2 (🗄️ Scene variable): Variable where to store the player score (of -1 if no score)
Parameter 3 (🗄️ Scene variable): Variable where to store extra data (if any)
Parameter 4 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs)

Load and prepare a rewarded video
Request and load a rewarded video from Facebook, so that it is ready to be shown.

See parameters

Parameter 0 (string): The Ad Placement id (can be found while setting up the ad on Facebook)
Parameter 1 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs)

Save player data
Save the content of the given scene variable in the player data, stored on Facebook Instant Games servers

See parameters

Parameter 0 (string): Data key name (e.g: "Lives")
Parameter 1 (🗄️ Scene variable): Scene variable with the content to save
Parameter 2 (🗄️ Scene variable): Variable where to store the success message (optional)
Parameter 3 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs)

Save player score
Save the score, and optionally the content of the given variable in the player score, for the given metadata.

See parameters

Parameter 0 (string): Leaderboard name (e.g: "PlayersBestTimes")
Parameter 1 (🔢 Number): Score to register for the player
Parameter 2 (🗄️ Scene variable): Optional variable with metadata to save
Parameter 3 (🗄️ Scene variable): Variable where to store the success message (optional)
Parameter 4 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs)

Show the loaded interstitial ad
Show the interstitial ad previously loaded in memory. This won't work if you did not load the interstitial before.

See parameters

Parameter 0 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs)

Show the loaded rewarded video
Show the rewarded video previously loaded in memory. This won't work if you did not load the video before.

See parameters

Parameter 0 (🗄️ Scene variable): Variable where to store the error message (optional, if an error occurs)

Conditions

Check if ads are supported
Check if showing ads is supported on this device (only mobile phones can show ads)

Is the interstitial ad ready
Check if the interstitial ad requested from Facebook is loaded and ready to be shown.

Is the rewarded video ready
Check if the rewarded video requested from Facebook is loaded and ready to be shown.

Expressions

Expression	Description
`FacebookInstantGames::PlayerId()`	Get the player unique identifier
`FacebookInstantGames::PlayerName()`	Get the player name

The Facebook Instant Games extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager.

This page is an auto-generated reference page about the Facebook Instant Games feature of GDevelop, the open-source, cross-platform game engine designed for everyone. Learn more about all GDevelop features here.