Score - stingray.Score namespace reference - Stingray Lua API Reference
Description
The interface to access score functionality on PlayStation 4.
As the object is a singleton (there is only one Score), you do not need to pass any Score object to the functions. All the functions operate on the Score singleton.
Asynchronous operations return an ID that you can pass in calls to status() in order to fetch progress during the operation. You must free the memory that is used for this object by calling free() when the operation is done. Otherwise, the game will eventually run out of memory.
Other related reference items 
Functions
 |
free ( id )
Frees all data that the score system keeps track of for the operation with the specified ID.
|
id : | integer |
The ID of the ranking operation. |
| This function does not return any values. |
You must call free() on all ids that you get back, no matter whether the operation completed successfully or not. Otherwise, the score system will eventually run out of memory.
Other related reference items
| |
get_ranking_by_account_id ( user_id, board, account_ids ) : integer
Same as stingray.Score.get_ranking_by_range(), but gets the ranking for a specified list of users.
|
user_id : | integer |
The SceUserServiceUserId of the player. |
board : | integer |
The ID of the board. |
account_ids : | string[] |
A table that contains the SceNpAccountId of the users to retrieve. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown. |
integer |
An ID for the operation, which you can pass to stingray.Score.status() to track the progress of the operation. |
| |
get_ranking_by_range ( user_id, board, start, size ) : integer
Requests a sequence of rankings from the server.
|
user_id : | integer |
The SceUserServiceUserId of the player. |
board : | integer |
The SceNpScoreBoardId of the board. |
start : | integer |
The ranking of the first score entry that must be fetched. The top ranking has the value 1. If you pass 0, an error occurs. |
size : | integer |
The number of entries that must be fetched. Must be less than or equal to 100. |
integer |
An ID for the operation, which you can pass to stingray.Score.status() to track the progress of the operation. |
When the operation is complete, you can get the result by calling stingray.Score.ranking_result(). The results will be available and consume memory until you call stingray.Score.free().
Other related reference items
| |
ranking_result ( id ) : ps4_score_ranking_results
Returns the result of a ranking operation.
|
id : | integer |
The ID of the ranking operation. |
|
A table that contains the fetched rankings. |
You can call this function only after the operation has completed, and before you have called stingray.Score.free() on the operation.
Other related reference items
| |
record ( user_id, board, score, info, comment ) : integer
Records the score for the specified user on the board.
|
user_id : | integer |
The SceUserServiceUserId of the player. |
board : | integer |
The SceNpScoreBoardId of the board. |
score : | number |
The score to record. |
info : | string? |
Optional. Information about the score to record. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
comment : | string? |
Optional. Comment about the score to record. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
integer |
An ID for the operation, which you can pass to stingray.Score.status() to track the progress of the operation. |
| |
status ( id ) : integer
Returns the status of the operation with the specified id.
|
id : | integer |
The ID of the ranking operation. |
integer |
The status of the operation with the specified ID. May be any of the status code constants. |
Other related reference items
Status codes
May be returned by calls to status().
 |
COMPLETED : integer
The operation has successfully completed.
|
| |
ERROR : integer
An error occurred during the operation.
|
| |
STARTED : integer
The operation has started, but not yet finished.
|
| |
UNKNOWN : integer
Either the ID was never created, or it has already been freed.
|