Facebook InstantGame API V2.1中文版

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

如果您需要 SDK 对应的 jsd.ts 文件,可以在这个 Github 仓下载 FBInstantGameDTS

FBInstant

API 说明 v2.1

FBInstantstartGameAsync

Instant Games SDK 的顶级命名空间.

FBInstant.getLocale

获取用户的地域信息。 例如 zh_CNen_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 <String> 要获取的数据的key值
返回值 Promise <Object> 如果发送的Key存在,则通过Promise 返回储存的数据对象.

FBInstant.player.setDataAsync

把当前用户的数据储存在平台上。

代码示例:

FBInstant.player
  .setDataAsync({
    achievements: ['medal1', 'medal2', 'medal3'],
    currentLife: 300,
  })
  .then(function() {
    console.log('data is saved');
});

参数
• data Object 包含key-value的数据对象.
返回值 Promise 数据储存成功会返回一个promise

FBInstant.context

当前游戏的来源信息

FBInstant.context.getID

当前游戏来源的唯一id。例如你的信息流中有很多好友都发了这个游戏,通过这个id来知道你玩的是哪一个。注意,必须在FBInstant.startGameAsync的回调后才能得到这个id。在FBInstant.endGameAsync的回调后可能会更新这个id。如果平台不支持,或者是在独立页面玩的游戏,这个id值为null

代码示例:

var contextID = FBInstant.context.getID();

FBInstant.context.getType

通过该方法可以获知用户是在哪玩的这个游戏。比如 'post', 'thread', 'group', or 'solo'.

代码示例:

var contextType = FBInstant.context.getType();

FBInstant.setScore

向平台上传分数。每当玩家的分数在游戏中改变时,就可以调用这个方法,这样平台可以在游戏外实时更新这些分数,提升用户体验。当调用 endGameAsync 时,通过这个API发送的分数将显示在排行榜上。

代码示例:

FBInstant.setScore(42);

参数
• score number 玩家在游戏里的分数

FBInstant.endGameAsync

显示平台统一的游戏结束画面。

代码示例:

FBInstant.endGameAsync().then(function() {
  // 在这里我们可以确定,玩家点击了重玩的按钮
  myGame.resetScore();
  myGame.restartWithoutTutorial();
});

当游戏重新开始的时候,返回一个 Promise

FBInstant.takeScreenshotAsync

进行截屏,用户以后可以分享给好友。

代码示例:

myGame.displayFinalScore();
FBInstant.takeScreenshotAsync().then(function() {
  console.log('Screenshot taken!');
}).catch(function() {
  console.log('Failed to take screenshot.');
});

截屏成功或者失败,都会返回一个 Promise

FBInstant.sendScreenshotAsync

用户要分享的截屏画面。截屏尺寸应该和游戏场景的尺寸一致。

代码示例:

var scoreCanvas = new HtmlCanvasElement();
var base64Picture = scoreCanvas.toDataURL();
FBInstant.sendScreenshotAsync(base64Picture).then(function() {
  console.log('Screenshot sent!');
}).catch(function(error) {
  console.log('Failed to send screenshot.');
  console.log(error.toString());
});

参数

• base64picture string 把截图进行 base64 编码后的字符串
发送成功或者失败,都会返回一个 Promise

FBInstant.abort

遇到错误中止游戏。只有当游戏进入不可恢复的状态时才被调用。

代码示例:

FBInstant.abort(e);

参数

• e Error 具体的错误信息。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,186评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,858评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,620评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,888评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,009评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,149评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,204评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,956评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,385评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,698评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,863评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,544评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,185评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,899评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,141评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,684评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,750评论 2 351

推荐阅读更多精彩内容