players.load()

类型 函数
返回值
修订 版本 2024.3703
关键词 Google Play 游戏服务, 游戏网络, gpgs, 玩家, 加载
另请参阅 gpgs.players
gpgs.*

概述

检索当前玩家、指定玩家或多个玩家的信息。

语法

gpgs.players.load( params )
params (必填)

. 包含调用的参数 — 有关详细信息,请参阅下一节。

参数参考

params 表包含调用的参数。

playerId (可选)

字符串. 仅在 Android 上支持;如果提供,则仅加载此玩家的信息。如果省略,则加载当前玩家的信息。

playerIds (可选)

数组. 仅在 Android 上支持;使用 字符串 元素填充以加载每个指定玩家的信息。如果提供,则此参数的优先级高于 playerId

source (可选)

字符串. 以下值之一。如果提供,则此参数的优先级高于 playerIds,并从指定来源加载玩家信息。

  • "connected"
  • "invitable" (仅限 Android)
  • "recentlyPlayedWith"
limit (可选)

数字. 将结果数量限制为此值。所有结果在内部以每批 25 个项目的形式获取。

reload (可选)

布尔值. 如果为 true,则将重新检索数据,而不是从缓存中检索。

listener (可选)

监听器. 接收 加载 事件的监听器函数。