1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
mod stat_callback;
pub mod stats;
pub use self::stat_callback::*;
use super::*;
#[cfg(test)]
use serial_test::serial;
/// Access to the steam user interface
pub struct UserStats<Manager> {
pub(crate) user_stats: *mut sys::ISteamUserStats,
pub(crate) inner: Arc<Inner<Manager>>,
}
const CALLBACK_BASE_ID: i32 = 1100;
impl<Manager> UserStats<Manager> {
pub fn find_leaderboard<F>(&self, name: &str, cb: F)
where
F: FnOnce(Result<Option<Leaderboard>, SteamError>) + 'static + Send,
{
unsafe {
let name = CString::new(name).unwrap();
let api_call = sys::SteamAPI_ISteamUserStats_FindLeaderboard(
self.user_stats,
name.as_ptr() as *const _,
);
register_call_result::<sys::LeaderboardFindResult_t, _, _>(
&self.inner,
api_call,
CALLBACK_BASE_ID + 4,
move |v, io_error| {
cb(if io_error {
Err(SteamError::IOFailure)
} else {
Ok(if v.m_bLeaderboardFound != 0 {
Some(Leaderboard(v.m_hSteamLeaderboard))
} else {
None
})
})
},
);
}
}
pub fn find_or_create_leaderboard<F>(
&self,
name: &str,
sort_method: LeaderboardSortMethod,
display_type: LeaderboardDisplayType,
cb: F,
) where
F: FnOnce(Result<Option<Leaderboard>, SteamError>) + 'static + Send,
{
unsafe {
let name = CString::new(name).unwrap();
let sort_method = match sort_method {
LeaderboardSortMethod::Ascending => {
sys::ELeaderboardSortMethod::k_ELeaderboardSortMethodAscending
}
LeaderboardSortMethod::Descending => {
sys::ELeaderboardSortMethod::k_ELeaderboardSortMethodDescending
}
};
let display_type = match display_type {
LeaderboardDisplayType::Numeric => {
sys::ELeaderboardDisplayType::k_ELeaderboardDisplayTypeNumeric
}
LeaderboardDisplayType::TimeSeconds => {
sys::ELeaderboardDisplayType::k_ELeaderboardDisplayTypeTimeSeconds
}
LeaderboardDisplayType::TimeMilliSeconds => {
sys::ELeaderboardDisplayType::k_ELeaderboardDisplayTypeTimeMilliSeconds
}
};
let api_call = sys::SteamAPI_ISteamUserStats_FindOrCreateLeaderboard(
self.user_stats,
name.as_ptr() as *const _,
sort_method,
display_type,
);
register_call_result::<sys::LeaderboardFindResult_t, _, _>(
&self.inner,
api_call,
CALLBACK_BASE_ID + 4,
move |v, io_error| {
cb(if io_error {
Err(SteamError::IOFailure)
} else {
Ok(if v.m_bLeaderboardFound != 0 {
Some(Leaderboard(v.m_hSteamLeaderboard))
} else {
None
})
})
},
);
}
}
pub fn upload_leaderboard_score<F>(
&self,
leaderboard: &Leaderboard,
method: UploadScoreMethod,
score: i32,
details: &[i32],
cb: F,
) where
F: FnOnce(Result<Option<LeaderboardScoreUploaded>, SteamError>) + 'static + Send,
{
unsafe {
let method = match method {
UploadScoreMethod::KeepBest => {
sys::ELeaderboardUploadScoreMethod::k_ELeaderboardUploadScoreMethodKeepBest
}
UploadScoreMethod::ForceUpdate => {
sys::ELeaderboardUploadScoreMethod::k_ELeaderboardUploadScoreMethodForceUpdate
}
};
let api_call = sys::SteamAPI_ISteamUserStats_UploadLeaderboardScore(
self.user_stats,
leaderboard.0,
method,
score,
details.as_ptr(),
details.len() as _,
);
register_call_result::<sys::LeaderboardScoreUploaded_t, _, _>(
&self.inner,
api_call,
CALLBACK_BASE_ID + 6,
move |v, io_error| {
cb(if io_error {
Err(SteamError::IOFailure)
} else {
Ok(if v.m_bSuccess != 0 {
Some(LeaderboardScoreUploaded {
score: v.m_nScore,
was_changed: v.m_bScoreChanged != 0,
global_rank_new: v.m_nGlobalRankNew as _,
global_rank_previous: v.m_nGlobalRankPrevious as _,
})
} else {
None
})
})
},
);
}
}
pub fn download_leaderboard_entries<F>(
&self,
leaderboard: &Leaderboard,
request: LeaderboardDataRequest,
start: usize,
end: usize,
max_details_len: usize,
cb: F,
) where
F: FnOnce(Result<Vec<LeaderboardEntry>, SteamError>) + 'static + Send,
{
unsafe {
let request = match request {
LeaderboardDataRequest::Global => {
sys::ELeaderboardDataRequest::k_ELeaderboardDataRequestGlobal
}
LeaderboardDataRequest::GlobalAroundUser => {
sys::ELeaderboardDataRequest::k_ELeaderboardDataRequestGlobalAroundUser
}
LeaderboardDataRequest::Friends => {
sys::ELeaderboardDataRequest::k_ELeaderboardDataRequestFriends
}
};
let api_call = sys::SteamAPI_ISteamUserStats_DownloadLeaderboardEntries(
self.user_stats,
leaderboard.0,
request,
start as _,
end as _,
);
let user_stats = self.user_stats as isize;
register_call_result::<sys::LeaderboardScoresDownloaded_t, _, _>(
&self.inner,
api_call,
CALLBACK_BASE_ID + 5,
move |v, io_error| {
cb(if io_error {
Err(SteamError::IOFailure)
} else {
let len = v.m_cEntryCount;
let mut entries = Vec::with_capacity(len as usize);
for idx in 0..len {
let mut entry: sys::LeaderboardEntry_t = std::mem::zeroed();
let mut details = Vec::with_capacity(max_details_len);
sys::SteamAPI_ISteamUserStats_GetDownloadedLeaderboardEntry(
user_stats as *mut _,
v.m_hSteamLeaderboardEntries,
idx,
&mut entry,
details.as_mut_ptr(),
max_details_len as _,
);
details.set_len(entry.m_cDetails as usize);
entries.push(LeaderboardEntry {
user: SteamId(entry.m_steamIDUser.m_steamid.m_unAll64Bits),
global_rank: entry.m_nGlobalRank,
score: entry.m_nScore,
details,
})
}
Ok(entries)
})
},
);
}
}
/// Returns the display type of a leaderboard handle. Returns `None` if the leaderboard handle is invalid.
pub fn get_leaderboard_display_type(
&self,
leaderboard: &Leaderboard,
) -> Option<LeaderboardDisplayType> {
unsafe {
match sys::SteamAPI_ISteamUserStats_GetLeaderboardDisplayType(
self.user_stats,
leaderboard.0,
) {
sys::ELeaderboardDisplayType::k_ELeaderboardDisplayTypeNumeric => {
Some(LeaderboardDisplayType::Numeric)
}
sys::ELeaderboardDisplayType::k_ELeaderboardDisplayTypeTimeSeconds => {
Some(LeaderboardDisplayType::TimeSeconds)
}
sys::ELeaderboardDisplayType::k_ELeaderboardDisplayTypeTimeMilliSeconds => {
Some(LeaderboardDisplayType::TimeMilliSeconds)
}
_ => None,
}
}
}
/// Returns the sort method of a leaderboard handle. Returns `None` if the leaderboard handle is invalid.
pub fn get_leaderboard_sort_method(
&self,
leaderboard: &Leaderboard,
) -> Option<LeaderboardSortMethod> {
unsafe {
match sys::SteamAPI_ISteamUserStats_GetLeaderboardSortMethod(
self.user_stats,
leaderboard.0,
) {
sys::ELeaderboardSortMethod::k_ELeaderboardSortMethodAscending => {
Some(LeaderboardSortMethod::Ascending)
}
sys::ELeaderboardSortMethod::k_ELeaderboardSortMethodDescending => {
Some(LeaderboardSortMethod::Descending)
}
_ => None,
}
}
}
/// Returns the name of a leaderboard handle. Returns an empty string if the leaderboard handle is invalid.
pub fn get_leaderboard_name(&self, leaderboard: &Leaderboard) -> String {
unsafe {
let name = CStr::from_ptr(sys::SteamAPI_ISteamUserStats_GetLeaderboardName(
self.user_stats,
leaderboard.0,
));
name.to_string_lossy().into()
}
}
/// Returns the total number of entries in a leaderboard. Returns 0 if the leaderboard handle is invalid.
pub fn get_leaderboard_entry_count(&self, leaderboard: &Leaderboard) -> i32 {
unsafe {
sys::SteamAPI_ISteamUserStats_GetLeaderboardEntryCount(self.user_stats, leaderboard.0)
}
}
/// Triggers a [`UserStatsReceived`](./struct.UserStatsReceived.html) callback.
pub fn request_current_stats(&self) {
unsafe {
sys::SteamAPI_ISteamUserStats_RequestCurrentStats(self.user_stats);
}
}
/// Asynchronously fetch the data for the percentage of players who have received each achievement
/// for the current game globally.
///
/// You must have called `request_current_stats()` and it needs to return successfully via its
/// callback prior to calling this!*
///
/// **Note: Not sure if this is applicable, as the other achievement functions requiring
/// `request_current_stats()` don't specifically need it to be called in order for them to complete
/// successfully. Maybe it autoruns via `Client::init()/init_app()` somehow?*
pub fn request_global_achievement_percentages<F>(&self, cb: F)
where
F: FnOnce(Result<GameId, SteamError>) + 'static + Send,
{
unsafe {
let api_call =
sys::SteamAPI_ISteamUserStats_RequestGlobalAchievementPercentages(self.user_stats);
register_call_result::<sys::GlobalAchievementPercentagesReady_t, _, _>(
&self.inner,
api_call,
// `CALLBACK_BASE_ID + <number>`: <number> is found in Steamworks `isteamuserstats.h` header file
// (Under `struct GlobalAchievementPercentagesReady_t {...};` in this case)
CALLBACK_BASE_ID + 10,
move |v, io_error| {
cb(if io_error {
Err(SteamError::IOFailure)
} else {
Ok(GameId(v.m_nGameID))
})
},
);
}
}
/// Send the changed stats and achievements data to the server for permanent storage.
///
/// * Triggers a [`UserStatsStored`](../struct.UserStatsStored.html) callback if successful.
/// * Triggers a [`UserAchievementStored`](../struct.UserAchievementStored.html) callback
/// if achievements have been unlocked.
///
/// Requires [`request_current_stats()`](#method.request_current_stats) to have been called
/// and a successful [`UserStatsReceived`](./struct.UserStatsReceived.html) callback processed.
pub fn store_stats(&self) -> Result<(), ()> {
let success = unsafe { sys::SteamAPI_ISteamUserStats_StoreStats(self.user_stats) };
if success {
Ok(())
} else {
Err(())
}
}
/// Resets the current users stats and, optionally achievements.
pub fn reset_all_stats(&self, achievements_too: bool) -> Result<(), ()> {
let success = unsafe {
sys::SteamAPI_ISteamUserStats_ResetAllStats(self.user_stats, achievements_too)
};
if success {
Ok(())
} else {
Err(())
}
}
/// Gets the value of a given stat for the current user
///
/// The specified stat must exist and match the type set on the Steamworks App Admin website.
///
/// Requires [`request_current_stats()`](#method.request_current_stats) to have been called
/// and a successful [`UserStatsReceived`](./struct.UserStatsReceived.html) callback processed.
pub fn get_stat_i32(&self, name: &str) -> Result<i32, ()> {
let name = CString::new(name).unwrap();
let mut value: i32 = 0;
let success = unsafe {
sys::SteamAPI_ISteamUserStats_GetStatInt32(
self.user_stats,
name.as_ptr() as *const _,
&mut value,
)
};
if success {
Ok(value)
} else {
Err(())
}
}
/// Sets / updates the value of a given stat for the current user
///
/// This call only changes the value in-memory and is very cheap. To commit the stats you
/// must call [`store_stats()`](#method.store_stats)
///
/// The specified stat must exist and match the type set on the Steamworks App Admin website.
///
/// Requires [`request_current_stats()`](#method.request_current_stats) to have been called
/// and a successful [`UserStatsReceived`](./struct.UserStatsReceived.html) callback processed.
pub fn set_stat_i32(&self, name: &str, stat: i32) -> Result<(), ()> {
let name = CString::new(name).unwrap();
let success = unsafe {
sys::SteamAPI_ISteamUserStats_SetStatInt32(
self.user_stats,
name.as_ptr() as *const _,
stat,
)
};
if success {
Ok(())
} else {
Err(())
}
}
/// Gets the value of a given stat for the current user
///
/// The specified stat must exist and match the type set on the Steamworks App Admin website.
///
/// Requires [`request_current_stats()`](#method.request_current_stats) to have been called
/// and a successful [`UserStatsReceived`](./struct.UserStatsReceived.html) callback processed.
pub fn get_stat_f32(&self, name: &str) -> Result<f32, ()> {
let name = CString::new(name).unwrap();
let mut value: f32 = 0.0;
let success = unsafe {
sys::SteamAPI_ISteamUserStats_GetStatFloat(
self.user_stats,
name.as_ptr() as *const _,
&mut value,
)
};
if success {
Ok(value)
} else {
Err(())
}
}
/// Sets / updates the value of a given stat for the current user
///
/// This call only changes the value in-memory and is very cheap. To commit the stats you
/// must call [`store_stats()`](#method.store_stats)
///
/// The specified stat must exist and match the type set on the Steamworks App Admin website.
///
/// Requires [`request_current_stats()`](#method.request_current_stats) to have been called
/// and a successful [`UserStatsReceived`](./struct.UserStatsReceived.html) callback processed.
pub fn set_stat_f32(&self, name: &str, stat: f32) -> Result<(), ()> {
let name = CString::new(name).unwrap();
let success = unsafe {
sys::SteamAPI_ISteamUserStats_SetStatFloat(
self.user_stats,
name.as_ptr() as *const _,
stat,
)
};
if success {
Ok(())
} else {
Err(())
}
}
/// Access achievement API for a given achievement 'API Name'.
///
/// Requires [`request_current_stats()`](#method.request_current_stats) to have been called
/// and a successful [`UserStatsReceived`](./struct.UserStatsReceived.html) callback processed.
#[inline]
#[must_use]
pub fn achievement(&self, name: &str) -> stats::AchievementHelper<'_, Manager> {
stats::AchievementHelper {
name: CString::new(name).unwrap(),
parent: self,
}
}
/// Get the number of achievements defined in the App Admin panel of the Steamworks website.
///
/// This is used for iterating through all of the achievements with GetAchievementName.
///
/// Returns 0 if the current App ID has no achievements.
///
/// *Note: Returns an error for AppId `480` (Spacewar)!*
pub fn get_num_achievements(&self) -> Result<u32, ()> {
unsafe {
let num = sys::SteamAPI_ISteamUserStats_GetNumAchievements(self.user_stats);
if num != 0 {
Ok(num)
} else {
Err(())
}
}
}
/// Returns an array of all achievement names for the current AppId.
///
/// Returns an empty string for an achievement name if `iAchievement` is not a valid index,
/// and the current AppId must have achievements.
pub fn get_achievement_names(&self) -> Option<Vec<String>> {
let num = self
.get_num_achievements()
.expect("Failed to get number of achievements");
let mut names = Vec::new();
for i in 0..num {
unsafe {
let name = sys::SteamAPI_ISteamUserStats_GetAchievementName(self.user_stats, i);
let c_str = CStr::from_ptr(name).to_string_lossy().into_owned();
names.push(c_str);
}
}
Some(names)
}
}
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct LeaderboardEntry {
pub user: SteamId,
pub global_rank: i32,
pub score: i32,
pub details: Vec<i32>,
}
pub enum LeaderboardDataRequest {
Global,
GlobalAroundUser,
Friends,
}
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct LeaderboardScoreUploaded {
pub score: i32,
pub was_changed: bool,
pub global_rank_new: i32,
pub global_rank_previous: i32,
}
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum UploadScoreMethod {
KeepBest,
ForceUpdate,
}
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum LeaderboardSortMethod {
Ascending,
Descending,
}
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum LeaderboardDisplayType {
Numeric,
TimeSeconds,
TimeMilliSeconds,
}
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Leaderboard(u64);
impl Leaderboard {
/// Returns the raw 64 bit value of the leaderboard id
///
/// Useful for serializing leaderboard ids over a
/// network or to a save format.
pub fn raw(&self) -> u64 {
self.0
}
}
#[test]
#[ignore]
#[serial]
fn test() {
let (client, single) = Client::init().unwrap();
let stats = client.user_stats();
stats.find_leaderboard("steamworks_test", |lb| {
println!("Got: {:?}", lb);
});
let c2 = client.clone();
stats.find_or_create_leaderboard(
"steamworks_test_created",
LeaderboardSortMethod::Descending,
LeaderboardDisplayType::TimeMilliSeconds,
move |lb| {
println!("Got: {:?}", lb);
if let Some(lb) = lb.ok().and_then(|v| v) {
c2.user_stats().upload_leaderboard_score(
&lb,
UploadScoreMethod::ForceUpdate,
1337,
&[1, 2, 3, 4],
|v| {
println!("Upload: {:?}", v);
},
);
c2.user_stats().download_leaderboard_entries(
&lb,
LeaderboardDataRequest::Global,
0,
200,
10,
|v| {
println!("Download: {:?}", v);
},
);
}
},
);
for _ in 0..50 {
single.run_callbacks();
::std::thread::sleep(::std::time::Duration::from_millis(100));
}
}