Tightened the source code and README documentations in the library.

This commit is contained in:
2026-09-18 12:45:39 +02:00
parent c9f887bacb
commit 9ae10590cc
97 changed files with 854 additions and 1142 deletions
@@ -3,11 +3,9 @@ internal import CPlaydate
/// The cached `playdate->scoreboards` C API table.
var scoreboardsAPI: UnsafePointer<playdate_scoreboards> { Playdate.scoreboardsAPI.unsafelyUnwrapped }
/// The scoreboards API for games with online leaderboards.
///
/// The C callbacks carry no userdata, so one completion per operation kind
/// is tracked at a time; starting a second request of the same kind before
/// the first completes replaces the stored completion.
/// Online leaderboards. Requests return `false` if they could not start; completions
/// fail with `PlaydateError` (the C error message). One pending completion per
/// operation: a repeat request replaces it. C results are copied and freed.
public enum Scoreboards {}
extension Scoreboards {
@@ -16,8 +14,7 @@ extension Scoreboards {
nonisolated(unsafe) private static var boardsCompletion: ((Result<BoardsList, PlaydateError>) -> Void)?
nonisolated(unsafe) private static var scoresCompletion: ((Result<ScoresList, PlaydateError>) -> Void)?
/// Submits a score to the board. Returns `false` if the request could
/// not be started.
/// Submits `value` to `boardID`; `completion` gets the resulting score.
@discardableResult
public static func addScore(boardID: String, value: UInt32,
completion: @escaping (Result<Score, PlaydateError>) -> Void) -> Bool {
@@ -31,7 +28,7 @@ extension Scoreboards {
}
}
/// Fetches the current player's best score on the board.
/// Fetches the current player's best score on `boardID`.
@discardableResult
public static func getPersonalBest(boardID: String,
completion: @escaping (Result<Score, PlaydateError>) -> Void) -> Bool {
@@ -45,7 +42,7 @@ extension Scoreboards {
}
}
/// Fetches the list of the game's boards.
/// Fetches the game's boards.
@discardableResult
public static func getScoreboards(completion: @escaping (Result<BoardsList, PlaydateError>) -> Void) -> Bool {
boardsCompletion = completion
@@ -62,7 +59,7 @@ extension Scoreboards {
}) != 0
}
/// Fetches the scores on the board.
/// Fetches the scores on `boardID`.
@discardableResult
public static func getScores(boardID: String,
completion: @escaping (Result<ScoresList, PlaydateError>) -> Void) -> Bool {
@@ -1,11 +1,11 @@
internal import CPlaydate
extension Scoreboards {
/// A board belonging to the game.
/// One of the game's boards. Copied from `PDBoard`.
public struct Board {
/// The board's identifier, used in the other scoreboard calls.
/// Passed as `boardID` to the other calls.
public let boardID: String
/// The board's display name.
/// Display name.
public let name: String
init(_ board: PDBoard) {
@@ -1,11 +1,10 @@
internal import CPlaydate
extension Scoreboards {
/// The game's boards.
/// The game's boards. Copied from `PDBoardsList`.
public struct BoardsList {
/// When the list was last updated, in seconds since the epoch.
/// Last update, in seconds since the epoch.
public let lastUpdated: UInt32
/// The game's boards.
public let boards: [Board]
init(_ list: PDBoardsList) {
@@ -1,15 +1,14 @@
internal import CPlaydate
extension Scoreboards {
/// A score on a board.
/// A score on a board. Copied from `PDScore` or `PDListScore`.
public struct Score {
/// The score's position on the board, starting at 1.
/// Position on the board, from 1.
public let rank: UInt32
/// The score's value.
public let value: UInt32
/// The name of the player who posted the score.
/// Name of the player who posted it.
public let player: String
/// The board the score belongs to, when known.
/// `nil` if the C API gave none.
public let boardID: String?
init(_ score: PDScore) {
@@ -1,17 +1,16 @@
internal import CPlaydate
extension Scoreboards {
/// The scores on a board.
/// The scores on a board. Copied from `PDScoresList`.
public struct ScoresList {
/// The board the scores belong to.
public let boardID: String
/// When the list was last updated, in seconds since the epoch.
/// Last update, in seconds since the epoch.
public let lastUpdated: UInt32
/// Whether the current player's score is included in the list.
/// Whether the current player's score is in the list.
public let playerIncluded: Bool
/// The maximum number of scores the list can hold.
/// Maximum number of scores the list can hold.
public let limit: UInt32
/// The scores, ordered by rank.
/// Ordered by rank.
public let scores: [Score]
init(_ list: PDScoresList) {