SDK 6.3/PAWN/Leaderboard: Difference between revisions
Jump to navigation
Jump to search
Official WOWCube SDK 6.3 documentation (automated publish from SDK headers) |
Mark PAWN API as legacy (supported, not developed) (WowBot) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{notice|'''Official WOWCube SDK documentation.''' SDK 6.3, PAWN API. Generated from the canonical SDK headers — do not edit by hand; regenerate from source.}} | {{notice|'''Official WOWCube SDK documentation.''' SDK 6.3, PAWN API. Generated from the canonical SDK headers — do not edit by hand; regenerate from source.}} | ||
{{notice|'''Legacy track.''' The PAWN API is supported but no longer actively developed — the last PAWN additions shipped in SDK 6.2. New development uses the [[SDK 6.3/C++/Native API|C++ (WebAssembly) API]].}} | |||
{{SDK 6.3 nav}} | |||
''← [[SDK 6.3]] · PAWN / Leaderboard'' | |||
==Data structures== | ==Data structures== | ||
| Line 15: | Line 20: | ||
:* wholeUserListCount - total users count | :* wholeUserListCount - total users count | ||
See also: LB_getInfo() | See also: [[#LB_getInfo|LB_getInfo()]] | ||
History: | History: | ||
: v5.0 - added | : v5.0 - added | ||
==Functions== | |||
===LB_getInfo=== | |||
Syntax: | |||
native LB_getInfo(info[LB_INFO]); | |||
Description: | |||
: Get leaderboard description. | |||
: Players score and achievements can be saved and shared via mobile | |||
: application and WOWCube Entertainment System servers. This function | |||
: provides synced information necessary to display points table. | |||
: Outputs | |||
:* info - structure describing leaderboard | |||
Return values: | |||
: Error code: | |||
: * 0 - success | |||
: * -1 - incorrect arguments count | |||
: * -2 - leaderboard is not synced | |||
: * -3 - fail to fill output structure | |||
See also: [[#LB_INFO|LB_INFO]], [[#LB_getScore|LB_getScore()]] | |||
===LB_getScore=== | |||
Syntax: | |||
native LB_getScore(leadTableBin[], size = sizeof(leadTableBin)); | |||
Description: | |||
: Get best results data data. | |||
: Players score and achievements can be saved and shared via mobile | |||
: application and WOWCube Entertainment System servers. This function | |||
: provides best results table data. | |||
Arguments: | |||
: ''size'' | |||
:: how many results to get | |||
: Outputs | |||
: ''leadTableBin'' | |||
:: TBD, should be structure with name and score | |||
Return values: | |||
: Error code: | |||
: * 0 - success | |||
: * -1 - incorrect arguments count | |||
: * -2 - leaderboard is not synced | |||
: * -3 - fail to fill output structure | |||
See also: [[#LB_getInfo|LB_getInfo()]] | |||
History: | |||
: v5.0 - align error codes with LB_getInfo. | |||
[[Category:SDK 6.3]] | [[Category:SDK 6.3]] | ||
[[Category:PAWN API]] | [[Category:PAWN API]] | ||
Latest revision as of 09:45, 26 July 2026
Official WOWCube SDK documentation. SDK 6.3, PAWN API. Generated from the canonical SDK headers — do not edit by hand; regenerate from source.
Legacy track. The PAWN API is supported but no longer actively developed — the last PAWN additions shipped in SDK 6.2. New development uses the C++ (WebAssembly) API.
SDK 6.3 · PAWN API: Core ·
Graphics ·
Topology ·
Sound ·
Motion Sensor ·
Leaderboard ·
Splash Screen ·
Physics ·
Network ·
Save ·
Scramble ·
Logging
C++: Native API · Application · GFX Engine · Rust: Rust API (experimental) · Changelog
← SDK 6.3 · PAWN / Leaderboard
Data structures
LB_INFO
Syntax:
#define LB_INFO [.leadCount, .selfPosition, .selfScore, .wholeUserListCount]
Description:
- Array with named fields with various leaderboard information.
- Fields:
- leadCount - how many best results there are available to display
- selfPosition - place which current user takes
- selfScore - current users score
- wholeUserListCount - total users count
See also: LB_getInfo()
History:
- v5.0 - added
Functions
LB_getInfo
Syntax:
native LB_getInfo(info[LB_INFO]);
Description:
- Get leaderboard description.
- Players score and achievements can be saved and shared via mobile
- application and WOWCube Entertainment System servers. This function
- provides synced information necessary to display points table.
- Outputs
- info - structure describing leaderboard
Return values:
- Error code:
- * 0 - success
- * -1 - incorrect arguments count
- * -2 - leaderboard is not synced
- * -3 - fail to fill output structure
See also: LB_INFO, LB_getScore()
LB_getScore
Syntax:
native LB_getScore(leadTableBin[], size = sizeof(leadTableBin));
Description:
- Get best results data data.
- Players score and achievements can be saved and shared via mobile
- application and WOWCube Entertainment System servers. This function
- provides best results table data.
Arguments:
- size
- how many results to get
- Outputs
- leadTableBin
- TBD, should be structure with name and score
Return values:
- Error code:
- * 0 - success
- * -1 - incorrect arguments count
- * -2 - leaderboard is not synced
- * -3 - fail to fill output structure
See also: LB_getInfo()
History:
- v5.0 - align error codes with LB_getInfo.