Files
playdate-kit/Sources/PlaydateKit/Scoreboards/Scoreboards.swift
T
javier c5037dd716 Swift 6.4 migration and exhancements (#1)
This PR contains the work done to update the library and the attached example project to use the Swift 6.4 computer as a minimum supported version and also, to use the latest features introduced in it.

Reviewed-on: #1
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
2026-09-18 13:15:08 +00:00

92 lines
4.3 KiB
Swift

internal import CPlaydate
/// The cached `playdate->scoreboards` C API table.
var scoreboardsAPI: UnsafePointer<playdate_scoreboards> { Playdate.scoreboardsAPI.unsafelyUnwrapped }
/// 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 {
nonisolated(unsafe) private static var addScoreCompletion: ((Result<Score, PlaydateError>) -> Void)?
nonisolated(unsafe) private static var personalBestCompletion: ((Result<Score, PlaydateError>) -> Void)?
nonisolated(unsafe) private static var boardsCompletion: ((Result<BoardsList, PlaydateError>) -> Void)?
nonisolated(unsafe) private static var scoresCompletion: ((Result<ScoresList, PlaydateError>) -> Void)?
/// 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 {
addScoreCompletion = completion
return boardID.withCString { cBoardID in
scoreboardsAPI.pointee.addScore.unsafelyUnwrapped(cBoardID, value, { score, errorMessage in
let completion = Scoreboards.addScoreCompletion
Scoreboards.addScoreCompletion = nil
completion?(Scoreboards.result(score, errorMessage))
}) != 0
}
}
/// Fetches the current player's best score on `boardID`.
@discardableResult
public static func getPersonalBest(boardID: String,
completion: @escaping (Result<Score, PlaydateError>) -> Void) -> Bool {
personalBestCompletion = completion
return boardID.withCString { cBoardID in
scoreboardsAPI.pointee.getPersonalBest.unsafelyUnwrapped(cBoardID, { score, errorMessage in
let completion = Scoreboards.personalBestCompletion
Scoreboards.personalBestCompletion = nil
completion?(Scoreboards.result(score, errorMessage))
}) != 0
}
}
/// Fetches the game's boards.
@discardableResult
public static func getScoreboards(completion: @escaping (Result<BoardsList, PlaydateError>) -> Void) -> Bool {
boardsCompletion = completion
return scoreboardsAPI.pointee.getScoreboards.unsafelyUnwrapped({ boards, errorMessage in
let completion = Scoreboards.boardsCompletion
Scoreboards.boardsCompletion = nil
guard let boards else {
completion?(.failure(PlaydateError(cString: errorMessage)))
return
}
let list = BoardsList(boards.pointee)
scoreboardsAPI.pointee.freeBoardsList.unsafelyUnwrapped(boards)
completion?(.success(list))
}) != 0
}
/// Fetches the scores on `boardID`.
@discardableResult
public static func getScores(boardID: String,
completion: @escaping (Result<ScoresList, PlaydateError>) -> Void) -> Bool {
scoresCompletion = completion
return boardID.withCString { cBoardID in
scoreboardsAPI.pointee.getScores.unsafelyUnwrapped(cBoardID, { scores, errorMessage in
let completion = Scoreboards.scoresCompletion
Scoreboards.scoresCompletion = nil
guard let scores else {
completion?(.failure(PlaydateError(cString: errorMessage)))
return
}
let list = ScoresList(scores.pointee)
scoreboardsAPI.pointee.freeScoresList.unsafelyUnwrapped(scores)
completion?(.success(list))
}) != 0
}
}
private static func result(_ score: UnsafeMutablePointer<PDScore>?,
_ errorMessage: UnsafePointer<CChar>?) -> Result<Score, PlaydateError> {
guard let score else {
return .failure(PlaydateError(cString: errorMessage))
}
let value = Score(score.pointee)
scoreboardsAPI.pointee.freeScore.unsafelyUnwrapped(score)
return .success(value)
}
}