函數的用法
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
重設成就。