Skip to content

Commit

Permalink
Append Async to some async method names
Browse files Browse the repository at this point in the history
  • Loading branch information
@garrynewman
garrynewman committed May 27, 2019
1 parent c60612b commit 2ad31e1
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 21 deletions.
27 changes: 11 additions & 16 deletions Facepunch.Steamworks.Test/UserStatsTest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,25 +61,25 @@ public async Task StoreStats()
[TestMethod]
public async Task CreateLeaderboard()
{
var leaderboard = await SteamUserStats.FindOrCreateLeaderboard( "Testleaderboard", Data.LeaderboardSort.Ascending, Data.LeaderboardDisplay.Numeric );
var leaderboard = await SteamUserStats.FindOrCreateLeaderboardAsync( "Testleaderboard", Data.LeaderboardSort.Ascending, Data.LeaderboardDisplay.Numeric );

Assert.IsTrue( leaderboard.HasValue );
}

[TestMethod]
public async Task FindLeaderboard()
{
var leaderboard = await SteamUserStats.FindLeaderboard( "Testleaderboard" );
var leaderboard = await SteamUserStats.FindLeaderboardAsync( "Testleaderboard" );
Assert.IsTrue( leaderboard.HasValue );
}

[TestMethod]
public async Task SubmitScore()
{
var leaderboard = await SteamUserStats.FindLeaderboard( "Testleaderboard" );
var leaderboard = await SteamUserStats.FindLeaderboardAsync( "Testleaderboard" );
Assert.IsTrue( leaderboard.HasValue );

var result = await leaderboard.Value.SubmitScore( 576 );
var result = await leaderboard.Value.SubmitScoreAsync( 576 );
Assert.IsTrue( result.HasValue );

Console.WriteLine( $"result.Changed: {result?.Changed}" );
Expand All @@ -92,7 +92,7 @@ public async Task SubmitScore()
[TestMethod]
public async Task ReplaceScore()
{
var leaderboard = await SteamUserStats.FindLeaderboard( "Testleaderboard" );
var leaderboard = await SteamUserStats.FindLeaderboardAsync( "Testleaderboard" );
Assert.IsTrue( leaderboard.HasValue );

var result = await leaderboard.Value.ReplaceScore( 576 );
Expand All @@ -108,15 +108,10 @@ public async Task ReplaceScore()
[TestMethod]
public async Task GetScoresFromFriends()
{
var leaderboard = await SteamUserStats.FindLeaderboard( "Testleaderboard" );
Assert.IsTrue( leaderboard.HasValue );
var leaderboard = await SteamUserStats.FindLeaderboardAsync( "Testleaderboard" );

// Get entries around user
var friendScores = await leaderboard.Value.GetScoresFromFriends();
Assert.IsNotNull( friendScores );
var friendScores = await leaderboard.Value.GetScoresFromFriendsAsync();

Console.WriteLine( $"" );
Console.WriteLine( $"Friend Scores:" );
foreach ( var e in friendScores )
{
Console.WriteLine( $"{e.GlobalRank}: {e.Score} {e.User}" );
Expand All @@ -126,7 +121,7 @@ public async Task GetScoresFromFriends()
[TestMethod]
public async Task GetScoresAroundUserAsync()
{
var leaderboard = await SteamUserStats.FindLeaderboard( "Testleaderboard" );
var leaderboard = await SteamUserStats.FindLeaderboardAsync( "Testleaderboard" );
Assert.IsTrue( leaderboard.HasValue );

for ( int i = 1; i < 10; i++ )
Expand All @@ -147,7 +142,7 @@ public async Task GetScoresAroundUserAsync()
[TestMethod]
public async Task GetScoresAsync()
{
var leaderboard = await SteamUserStats.FindLeaderboard( "Testleaderboard" );
var leaderboard = await SteamUserStats.FindLeaderboardAsync( "Testleaderboard" );
Assert.IsTrue( leaderboard.HasValue );

// Get top 20 global scores
Expand Down Expand Up @@ -176,7 +171,7 @@ public void GetStatInt()
public async Task GetStatGlobalInt()
{
var deaths = new Stat( "deaths" );
await deaths.GetGlobalIntDays( 5 );
await deaths.GetGlobalIntDaysAsync( 5 );

var totalStartups = deaths.GetGlobalInt();
Assert.AreNotEqual( 0, totalStartups );
Expand All @@ -188,7 +183,7 @@ public async Task GetStatGlobalHistoryInt()
{
var deaths = new Stat( "deaths" );

var history = await deaths.GetGlobalIntDays( 10 );
var history = await deaths.GetGlobalIntDaysAsync( 10 );
Assert.AreNotEqual( 0, history.Length );

for ( int i=0; i< history.Length; i++ )
Expand Down
4 changes: 2 additions & 2 deletions Facepunch.Steamworks/SteamUserStats.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ public static bool RequestCurrentStats()
/// the Steamworks website and using FindLeaderboard unless you're expected to have a large amount of
/// dynamically created leaderboards.
/// </summary>
public static async Task<Leaderboard?> FindOrCreateLeaderboard( string name, LeaderboardSort sort, LeaderboardDisplay display )
public static async Task<Leaderboard?> FindOrCreateLeaderboardAsync( string name, LeaderboardSort sort, LeaderboardDisplay display )
{
var result = await Internal.FindOrCreateLeaderboard( name, sort, display );
if ( !result.HasValue || result.Value.LeaderboardFound == 0 )
Expand All @@ -149,7 +149,7 @@ public static bool RequestCurrentStats()
}


public static async Task<Leaderboard?> FindLeaderboard( string name )
public static async Task<Leaderboard?> FindLeaderboardAsync( string name )
{
var result = await Internal.FindLeaderboard( name );
if ( !result.HasValue || result.Value.LeaderboardFound == 0 )
Expand Down
4 changes: 2 additions & 2 deletions Facepunch.Steamworks/Structs/Leaderboard.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public struct Leaderboard
/// <summary>
/// Submit your new score, but won't replace your high score if it's lower
/// </summary>
public async Task<LeaderboardUpdate?> SubmitScore( int score, int[] details = null )
public async Task<LeaderboardUpdate?> SubmitScoreAsync( int score, int[] details = null )
{
if ( details == null ) details = noDetails;

Expand Down Expand Up @@ -90,7 +90,7 @@ public async Task<LeaderboardEntry[]> GetScoresAroundUserAsync( int start = -10,
/// <summary>
/// Used to retrieve all leaderboard entries for friends of the current user
/// </summary>
public async Task<LeaderboardEntry[]> GetScoresFromFriends()
public async Task<LeaderboardEntry[]> GetScoresFromFriendsAsync()
{
var r = await SteamUserStats.Internal.DownloadLeaderboardEntries( Id, LeaderboardDataRequest.Friends, 0, 0 );
if ( !r.HasValue )
Expand Down
2 changes: 1 addition & 1 deletion Facepunch.Steamworks/Structs/Stat.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public long GetGlobalInt()
return val;
}

public async Task<long[]> GetGlobalIntDays( int days )
public async Task<long[]> GetGlobalIntDaysAsync( int days )
{
var result = await SteamUserStats.Internal.RequestGlobalStats( days );
if ( result?.Result != Result.OK ) return null;
Expand Down

0 comments on commit 2ad31e1

Please sign in to comment.