函数的用法
IsReady()
int IsReady(StatusCallback callback);
名称 | 类型 | 描述 |
callback | StatusCallback | 回调函数 |
返回:
int
。值为
1
表示函数已完成且没有错误。
初始化统计资料和成就 API。初始化完成后,回调函数将提供代码:如果成功会返回 0 ;如果失败,则返回 错误代码 。在调用其他统计资料和成就 API 函数之前,请先调用此函数。
DownloadStats()
int DownloadStats(StatusCallback callback);
返回:
int
。值为
1
表示函数已完成且没有错误。
调用此函数可从 VIVEPORT 后端为当前最终用户下载所有统计资料和成就。该数据由 SDK 缓存,并可使用
GetStat()
,
GetAchievement()
和
GetAchievementUnlockTime()
获取。回调函数将在完成时提供代码:如果成功会返回
0
;如果失败,则返回
错误代码
。
UploadStats()
int UploadStats(StatusCallback callback);
名称 | 类型 | 描述 |
callback | StatusCallback | 回调函数 |
返回:
int
。成功完成时返回
1
。
调用此函数可将本地储存的统计资料和成就上传到 VIVEPORT 后端。在上传之前,请确保您的内容已先调用了
SetStat()
或
SetAchievement()
函数。回调函数将在完成时提供代码:如果成功会返回
0
;如果失败,则返回
错误代码
。
int GetStat()
int GetStat(string name, int defaultValue);
名称 | 类型 | 描述 |
name | string | 在 VIVEPORT 开发者控制台中指定的统计资料 API 名称 |
defaultValue | int | 统计资料的默认值(若无可用的值) |
返回:
int
。返回由
name
指定的统计资料值。如果没有可用的统计资料,则返回
defaultValue
。
float GetStat()
float GetStat(string name, float defaultValue);
名称 | 类型 | 描述 |
name | string | 在 VIVEPORT 开发者控制台中指定的统计资料 API 名称 |
defaultValue | float | 统计资料的默认值(若无可用的值) |
返回:
float
。返回由
name
指定的统计资料值。如果没有可用的统计资料,则返回
defaultValue
。
void SetStat(string, int)
void SetStat(string name, int value);
名称 | 类型 | 描述 |
name | string | 在 VIVEPORT 开发者控制台中指定的统计资料 API 名称 |
value | int | 统计资料值 |
通过
name
设置整数类型的统计资料。统计资料和成就由 VIVEPORT SDK 在本地缓存。请确保在退出内容之前,使用
UploadStats()
上传统计资料,才能将统计资料上传到 VIVEPORT 后端。请注意,如果在
VIVEPORT 开发者控制台
中设置了最小或最大变化,不符合这些参数的统计资料将会被舍弃,而不另行提示。
void SetStat(string, float)
void SetStat(string name, int value);
名称 | 类型 | 描述 |
name | string | 在 VIVEPORT 开发者控制台中指定的统计资料 API 名称 |
value | float | 统计资料值 |
通过
name
设置
float
类型的统计资料。统计资料和成就由 VIVEPORT SDK 在本地缓存。请确保在退出内容之前,使用
UploadStats()
上传统计资料,才能将统计资料上传到 VIVEPORT 后端。
GetAchievement()
bool GetAchievement(string pchName);
名称 | 类型 | 描述 |
name | string | 在 VIVEPORT 开发者控制台中指定的统计资料 API 名称 |
返回:
bool
。如果成就已解锁,则为
TRUE
;反之则为
FALSE
。
通过成就名称检查 VIVEPORT SDK 缓存中的成就状态。
GetAchievementUnlockTime()
int GetAchievementUnlockTime(string pchName);
名称 | 类型 | 描述 |
pchName | string | 在 VIVEPORT 开发者控制台中指定的统计资料 API 名称 |
返回:
int
。成就解锁时间(Unix 时间)。
SetAchievement()
int SetAchievement(string pchName);
名称 | 类型 | 描述 |
pchName | string | 在 VIVEPORT 开发者控制台中指定的统计资料 API 名称 |
返回:
int
。值为
1
表示函数已完成且没有错误。
通过
name
解锁成就。
ClearAchievement()
int ClearAchievement(string pchName);
名称 | 类型 | 描述 |
pchName | string | 在 VIVEPORT 开发者控制台中指定的统计资料 API 名称 |
返回:
int
。值为
1
表示函数已完成且没有错误。
通过
name
重置成就。