用法示例
以下示例重点介绍了开发者如何在内容中使用 VIVEPORT 排行榜 API。
在尝试实现任何 API 函数之前,请确保您的内容具有 VIVEPORT ID 和密钥。
-
使用
Viveport.Api.Init
调用最高级别的 API 以初始化 VIVEPORT SDK。对于 Unity 开发者,通常调用 MonobehaviorStart()
。 -
调用
Viveport.UserStats.IsReady()
以初始化 VIVEPORT 排行榜 API。 -
调用
Viveport.Leaderboard.DownloadLeaderBoardScores()
以下载得分。 -
请执行以下任一操作:
-
调用
Viveport.Leadboard.GetCount()
以检查排行榜得分的分数,该分数可用于确定GetLeaderboardScore()
的索引值。 -
调用
GetLeaderboardSortMethod()
以获取用于排行榜得分顺序的排序方法。这可用于整理本地显示的信息。 -
调用
GetLeaderboardDisplayType()
以确定排行榜储存的数据类型。有关完整列表,请参见LeaderBoardDisplayType()
。
-
调用
-
使用正确的索引调用
GetLeaderboardScore()
以获取得分。 - 向最终用户展示排行榜。
-
如果要上传新得分,请调用
UpLoadLeaderboardScore()
将其上传到 VIVEPORT 后端。
请记住,将根据 VIVEPORT 开发者控制台 中的排行榜配置来处理更改,例如累计或是替换得分。 -
不再需要时,请调用
Viveport.Api.Shutdown
以释放 VIVEPORT SDK 资源。在 Unity 中,通常是在 MonoBehaviorOnDestroy()
中或在Application.Quit()
之前。