Facebook InstantGame API V2.1中文版

Facebook InstantGame是FB新推出的一种游戏类型，简单的说就是在FB的信息流中就可以直接玩HTML5游戏，不需要跳转到单独的页面。此外在FB的Messenger app中也可以玩。目前该功能还处于内测阶段(截止到2017.1.4)。我把它的api翻译成了中文，有需要的朋友可以参考一下

如果您需要 SDK 对应的 js 和 d.ts 文件，可以在这个 Github 仓下载 FBInstantGameDTS

FBInstant

API 说明 v2.1

FBInstantstartGameAsync

Instant Games SDK 的顶级命名空间.

FBInstant.getLocale

获取用户的地域信息。 例如 zh_CN、 en_US
全部的地域信息数据，请看此链接 https://www.facebook.com/translations/FacebookLocales.xml 。
注意，只有FBInstant.initializeAsync()获得回调以后，才能调用这个api。

代码示例：

var locale = FBInstant.getLocale(); // 'en_US'

FBInstant.getPlatform

当前游戏运行在哪个平台，返回值为：'iOS', 'android' 和 'web'。
注意，只有FBInstant.initializeAsync()获得回调以后，才能调用这个api。

代码示例：

var platform = FBInstant.getPlatform(); // 'iOS', 'android' or 'web'

FBInstant.getSDKVersion

获取SDK的版本号，例如 "2.0"。

代码示例：

var sdkVersion = FBInstant.getSDKVersion(); // '2.0'

FBInstant.initializeAsync

初始化SDK，应当在其他API使用前调用。
代码示例：

FBInstant.initializeAsync().then(function() {
  var locale = FBInstant.getLocale(); // 'en_US'
  var platform = FBInstant.getPlatform(); // 'iOS', 'android' or 'web'
  var sdkVersion = FBInstant.getSDKVersion(); // '2.0'
  var playerID = FBInstant.player.getID();
});

当sdk 初始化结束会返回一个 Promise

FBInstant.setLoadingProgress

告诉平台游戏初始化资源加载的进度

代码示例：

FBInstant.setLoadingProgress(50); // 50%的资源被加载了

参数
• percentage number 0到100之间的数字

FBInstant.startGameAsync

这表明游戏已完成加载资源，用户准备好开始玩了。
代码示例：

FBInstant.startGameAsync().then(function() {
  //在这我们可以确定用户点击了开始游戏的按钮
  myGame.start();
});

当游戏应当开始玩的时候会返回一个 Promise
收到这个信号说明用户已经明确的准备好玩游戏了，在此之后，游戏里不应该再有另一个“点击开始”的步骤。

FBInstant.player

包含当前用户信息的一些方法和属性

FBInstant.player.getID

玩家的唯一标识ID。一个Facebook用户的id是不会改变的。同一个Facebook的用户，在不同的游戏里会有不用的id。
注意，只有FBInstant.initializeAsync()获得回调以后，才能调用这个api。

代码示例：

var playerID = FBInstant.player.getID();

FBInstant.player.getName

用户的名字。
注意，只有FBInstant.initializeAsync()获得回调以后，才能调用这个api。

代码示例：

var playerName = FBInstant.player.getName();

FBInstant.player.getPhoto

用户头像的链接地址。头像的图片始终为正方形，尺寸最小为200x200。建议在游戏中使用的时候，先将图像缩放到所需的大小。
注意，只有FBInstant.initializeAsync()获得回调以后，才能调用这个api。
警告：由于跨域的问题，在 canvas 里使用图片会有问题。要防止此情况，请将图像的 cross-origin 属性设置为 "anonymous"

代码示例：

var playerImage = new Image();
playerImage.crossOrigin = 'anonymous';
playerImage.src = FBInstant.player.getPhoto();

FBInstant.player.getDataAsync

取回当前用户在平台储存的数据

代码示例：

FBInstant.player
  .getDataAsync(['achievements', 'currentLife'])
  .then(function(data) {
     console.log('data is loaded');
     var achievements = data['achievements'];
     var currentLife = data['currentLife'];
});

参数
• keys Array 要获取的数据的key值
返回值 Promise