From 1e5f3e354e18475668ba23fc685eac4def14e6af Mon Sep 17 00:00:00 2001 From: Garry Newman Date: Fri, 4 Nov 2016 21:07:30 +0000 Subject: [PATCH] Generic docs --- Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md | 4 +++- Facepunch.Steamworks.ServerStats.Commit.md | 4 +++- Facepunch.Steamworks.ServerStats.Refresh.md | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md b/Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md index 8ecc0c6..6730b2c 100644 --- a/Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md +++ b/Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md @@ -4,4 +4,6 @@ void UpdateWhile( Func\ func ) ``` ## Summary -No documentation available +Run Update until func returns false. +This will cause your program to lock up until it finishes. +This is useful for things like tests or command line utilities etc. diff --git a/Facepunch.Steamworks.ServerStats.Commit.md b/Facepunch.Steamworks.ServerStats.Commit.md index dac1608..90ca904 100644 --- a/Facepunch.Steamworks.ServerStats.Commit.md +++ b/Facepunch.Steamworks.ServerStats.Commit.md @@ -4,4 +4,6 @@ void Commit( ulong steamid, Action\ Callback ) ``` ## Summary -No documentation available +Once you've set a stat change on a user you need to commit your changes. +You can do that using this function. The callback will let you know if +your action succeeded, but most of the time you can fire and forget. diff --git a/Facepunch.Steamworks.ServerStats.Refresh.md b/Facepunch.Steamworks.ServerStats.Refresh.md index bdcad09..b9a4a16 100644 --- a/Facepunch.Steamworks.ServerStats.Refresh.md +++ b/Facepunch.Steamworks.ServerStats.Refresh.md @@ -4,4 +4,6 @@ void Refresh( ulong steamid, Action\ Callback ) ``` ## Summary -No documentation available +Retrieve the stats for this user. If you pass a callback function in +this will be called when the stats are recieved, the bool will signify whether +it was successful or not.