Steamworks.NET Extension for .NET 8+, ValueTask callbacks for example. This project is aimed to adapt regular .NET8+ projects's idiom based on `Steamworks.NET`. Extended features list: Convert call-result to ValueTask<TResult>. Spawn automatic steam callback dispatcher thread. Fluent UGC query builder and query result wrapper.
$ dotnet add package FaGe.Steamworks.NET.ExtensionsAs you can see, this project is aimed to extend modern features to Steamworks.NET on regular .NET projects that targeting to up to date framework.
await, achived by ToValueTask<T>() extension method series on SteamAPICall_t.
These methods build on top of original CallResult<T> and can be accessed by using namespace FaGe.Steamworks.NET.Extensions. In current version, there are 2 variants.
ToValueTask<T>() is suitable for those call-results that don't considering cancellation.
Example:
var queryResult = await SteamUGC.SendQueryUGCRequest(queryHandle).ToValueTask<SteamUGCQueryCompleted_t>();
ToValueTaskWithCancellation<T>() returns a ValueTask<T> and carry out a CancellationTokenSource for cancellation,
you can later cancel this operation by that CancellationTokenSource. Example:
// do async operation
var result = SteamUGC.SendQueryUGCRequest(queryHandle).ToValueTaskWithCancellation<SteamUGCQueryCompleted_t>(out var ctsInSomeField);
// somewhere else that want to cancel
ctsInSomeField.Cancel()
SteamAPICallException will thrown if call-result is failed.SteamCallbackDispatch.Singleton.SpawnCallbackDispatchThread() method.
CancellationTokenSource. SteamCallbackDispatch.Singleton.StopDispatchSource is also the same.
Beware, once the thread is stopped, it can't be restarted.FaGe.Steamworks.NET.ExtensionsUgcQueryHandle_t for both query and result.
FaGe.Steamworks.NET.Extensions.Ugc.UgcQueryBuilders.
Each factory method wraps a corresponding .
CreateQuery*UGCRequest()UgcQueryBuildException: query operator is failed to apply.*UgcQueryBuilder.AbandonQuery() to release handle.DetailsUgcQueryBuilder.FilterCloudFileName() will fail
due to unknown reason, no corresponding IPC log found in steam console. Not sure if real application will fail too.UgcQuery.Send() to get result wrapped in UgcQueryResult.
UgcQueryFailedException will thrown for failed query.UgcQueryResult is a collection of query result, each item is a UgcQueryResultItem. Methods like GetDetails()
and GetTags() are used to retrieve information of a single UGC item. There are also some count properties.