From c6505fede958798850bec0adf9a7988249e42519 Mon Sep 17 00:00:00 2001 From: "Nuno \"Omega Leo\" Diogo" Date: Thu, 30 Apr 2026 19:20:40 +0100 Subject: [PATCH] Started working on a Steam library --- OmegaLeo.HelperLib.ConsoleApp/Program.cs | 79 + .../Helpers/DocumentationHelper.cs | 95 +- .../Models/DocumentationStructure.cs | 8 +- OmegaLeo.HelperLib.Steamworks/README.md | 53 + .../SteamExtendedManagers.cs | 401 +++++ OmegaLeo.HelperLib.Steamworks/SteamManager.cs | 76 + .../SteamNativeApi.cs | 1465 +++++++++++++++++ .../SteamRemotePlayManager.cs | 49 + .../SteamUgcItemUpdateOptions.cs | 30 + .../SteamUgcItemUpdateSession.cs | 73 + .../SteamUgcManager.cs | 240 +++ .../Views/Home/Library.cshtml | 35 + .../Views/Shared/_Layout.cshtml | 3 + 13 files changed, 2603 insertions(+), 4 deletions(-) create mode 100644 OmegaLeo.HelperLib.Steamworks/SteamExtendedManagers.cs create mode 100644 OmegaLeo.HelperLib.Steamworks/SteamRemotePlayManager.cs create mode 100644 OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateOptions.cs create mode 100644 OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateSession.cs create mode 100644 OmegaLeo.HelperLib.Steamworks/SteamUgcManager.cs diff --git a/OmegaLeo.HelperLib.ConsoleApp/Program.cs b/OmegaLeo.HelperLib.ConsoleApp/Program.cs index 455dc72..03af9f7 100755 --- a/OmegaLeo.HelperLib.ConsoleApp/Program.cs +++ b/OmegaLeo.HelperLib.ConsoleApp/Program.cs @@ -32,6 +32,85 @@ public class Program steamLogger.LogInformation("Welcome {SteamName}", steam.GetSteamName()); } + steamLogger.LogInformation("--- Steam wrapper smoke tests ---"); + + // Utils (read-only) + steamLogger.LogInformation("Utils available: {Available}", steam.Utils.IsAvailable); + if (steam.Utils.IsAvailable) + { + steamLogger.LogInformation("AppId: {AppId}, Country: {Country}, Overlay: {Overlay}", + steam.Utils.GetAppId(), + steam.Utils.GetIpCountry(), + steam.Utils.IsOverlayEnabled()); + } + + // Friends (read-only) + steamLogger.LogInformation("Friends available: {Available}", steam.Friends.IsAvailable); + if (steam.Friends.IsAvailable) + { + // 65535 tests all friend relationship flags for quick smoke coverage. + var friendCount = steam.Friends.GetFriendCount(65535); + steamLogger.LogInformation("Friend count (all flags): {FriendCount}", friendCount); + } + + // Remote storage (read-only) + steamLogger.LogInformation("RemoteStorage available: {Available}", steam.RemoteStorage.IsAvailable); + if (steam.RemoteStorage.IsAvailable) + { + steamLogger.LogInformation("Cloud enabled: {Enabled}, file count: {Count}", + steam.RemoteStorage.IsCloudEnabledForApp(), + steam.RemoteStorage.GetFileCount()); + } + + // User stats (safe read/request) + steamLogger.LogInformation("UserStats available: {Available}", steam.UserStats.IsAvailable); + if (steam.UserStats.IsAvailable) + { + var globalStatsCall = steam.UserStats.RequestGlobalStats(7); + steamLogger.LogInformation("RequestGlobalStats call handle: {Handle}", globalStatsCall); + } + + // UGC (safe query/subscription read) + steamLogger.LogInformation("UGC subscribed count: {Count}", steam.Ugc.GetNumSubscribedItems()); + var ugcQuery = steam.Ugc.CreateQueryAllUgcRequest(queryType: 0, matchingType: 0, creatorAppId: 480, consumerAppId: 480, page: 1); + if (ugcQuery != 0) + { + var ugcCall = steam.Ugc.SendQueryUgcRequest(ugcQuery); + steamLogger.LogInformation("UGC query handle: {QueryHandle}, call handle: {CallHandle}", ugcQuery, ugcCall); + steam.Ugc.ReleaseQueryUgcRequest(ugcQuery); + } + else + { + steamLogger.LogWarning("UGC query handle returned 0 (unsupported on this runtime or invalid params)."); + } + + // Matchmaking (safe request) + steamLogger.LogInformation("Matchmaking available: {Available}", steam.Matchmaking.IsAvailable); + if (steam.Matchmaking.IsAvailable) + { + steam.Matchmaking.AddRequestLobbyListResultCountFilter(10); + var lobbyListCall = steam.Matchmaking.RequestLobbyList(); + steamLogger.LogInformation("RequestLobbyList call handle: {Handle}", lobbyListCall); + } + + // Remote Play + steamLogger.LogInformation("RemotePlay sessions: {SessionCount}", steam.RemotePlay.GetSessionCount()); + + // Other read-only status checks + steamLogger.LogInformation("Screenshots hooked: {Hooked}", steam.Screenshots.IsScreenshotsHooked()); + steamLogger.LogInformation("Music enabled: {Enabled}, playing: {Playing}, volume: {Volume}", + steam.Music.IsEnabled(), steam.Music.IsPlaying(), steam.Music.GetVolume()); + if (steam.Video.IsBroadcasting(out var viewers)) + { + steamLogger.LogInformation("Video broadcasting viewers: {Viewers}", viewers); + } + else + { + steamLogger.LogInformation("Video broadcasting is not active."); + } + + steamLogger.LogInformation("--- End smoke tests ---"); + // Call this in your game loop (Unity Update, Godot _Process, etc.) steam.Update(); diff --git a/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs b/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs index 3a34b13..8031e77 100755 --- a/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs +++ b/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs @@ -12,6 +12,7 @@ namespace OmegaLeo.HelperLib.Documentation.Helpers { [Changelog("1.2.0", "Migrated DocumentationHelper library from NetFlow.DocumentationHelper.Library to it's own package in OmegaLeo.HelperLib", "January 26, 2026")] + [Changelog("1.3.0", "GenerateDocumentation now includes method parameters and return type in the generated documentation", "April 14, 2026")] public static class DocumentationHelperTool { [Documentation("GenerateDocumentation (bool generateForPackageAssembly)", @@ -21,6 +22,8 @@ namespace OmegaLeo.HelperLib.Documentation.Helpers **Title**: Title what we're generating documentation for **Description**: Description of what we're generating documentation for, this can contain usage examples and can use the args array to pass names(e.g.: This method uses this methodology) **Args**: Array of strings that describe the parameters of the method or class +**MethodParameters**: Reflected parameter signature list for documented methods (e.g. `value: int`, `name: string`) +**ReturnType**: Reflected return type for documented methods (e.g. `bool`, `List`) **CodeExample**: A code example of how to use the method or class *Note: If generateForPackageAssembly is set to true, this will generate documentation for the library as well.*", @@ -146,7 +149,12 @@ DocumentationHelperTool.GenerateDocumentation(false); // Generates documentation var propertyDocs = type.GetProperties().SelectMany(p => p.GetCustomAttributes(typeof(DocumentationAttribute), true).Select(x => (DocumentationAttribute)x)); var methodDocs = type.GetMethods().SelectMany(m => - m.GetCustomAttributes(typeof(DocumentationAttribute), true).Select(x => (DocumentationAttribute)x)); + m.GetCustomAttributes(typeof(DocumentationAttribute), true) + .Select(x => new + { + Method = m, + Attribute = (DocumentationAttribute)x + })); var docStructure = new DocumentationStructure(assemblyName, type.Name); @@ -165,13 +173,94 @@ DocumentationHelperTool.GenerateDocumentation(false); // Generates documentation docStructure.AddDescription(new DocumentationDescription(doc.Title, doc.Description, doc.Args, doc.CodeExample)); } - foreach (var doc in methodDocs) + foreach (var methodDoc in methodDocs) { - docStructure.AddDescription(new DocumentationDescription(doc.Title, doc.Description, doc.Args, doc.CodeExample)); + var reflectedParameters = GetMethodParameters(methodDoc.Method); + var returnType = GetFriendlyTypeName(methodDoc.Method.ReturnType); + + var mergedParameters = (methodDoc.Attribute.Args ?? Array.Empty()) + .Concat(reflectedParameters) + .ToArray(); + + docStructure.AddDescription(new DocumentationDescription( + methodDoc.Attribute.Title, + methodDoc.Attribute.Description, + mergedParameters, + methodDoc.Attribute.CodeExample, + reflectedParameters, + returnType)); } return docStructure; } + + static string[] GetMethodParameters(MethodInfo method) + { + return method.GetParameters() + .Select(parameter => + { + var prefix = parameter.IsOut + ? "out " + : parameter.ParameterType.IsByRef + ? "ref " + : string.Empty; + + var parameterType = parameter.ParameterType.IsByRef + ? parameter.ParameterType.GetElementType() ?? parameter.ParameterType + : parameter.ParameterType; + + return $"{parameter.Name}: {prefix}{GetFriendlyTypeName(parameterType)}"; + }) + .ToArray(); + } + + static string GetFriendlyTypeName(Type type) + { + if (type == typeof(void)) return "void"; + if (type == typeof(bool)) return "bool"; + if (type == typeof(byte)) return "byte"; + if (type == typeof(sbyte)) return "sbyte"; + if (type == typeof(char)) return "char"; + if (type == typeof(decimal)) return "decimal"; + if (type == typeof(double)) return "double"; + if (type == typeof(float)) return "float"; + if (type == typeof(int)) return "int"; + if (type == typeof(uint)) return "uint"; + if (type == typeof(long)) return "long"; + if (type == typeof(ulong)) return "ulong"; + if (type == typeof(short)) return "short"; + if (type == typeof(ushort)) return "ushort"; + if (type == typeof(string)) return "string"; + if (type == typeof(object)) return "object"; + + if (type.IsArray) + { + return $"{GetFriendlyTypeName(type.GetElementType() ?? typeof(object))}[]"; + } + + if (type.IsGenericType) + { + var name = type.Name; + var tickIndex = name.IndexOf('`'); + if (tickIndex > 0) + { + name = name.Substring(0, tickIndex); + } + + var genericArguments = type.GetGenericArguments() + .Select(GetFriendlyTypeName); + + return $"{name}<{string.Join(", ", genericArguments)}>"; + } + + var nullable = Nullable.GetUnderlyingType(type); + if (nullable != null) + { + return $"{GetFriendlyTypeName(nullable)}?"; + } + + return type.Name; + } static Dictionary loadedXmlDocumentation = new Dictionary(); diff --git a/OmegaLeo.HelperLib.Documentation/Models/DocumentationStructure.cs b/OmegaLeo.HelperLib.Documentation/Models/DocumentationStructure.cs index 8bbef75..c155293 100755 --- a/OmegaLeo.HelperLib.Documentation/Models/DocumentationStructure.cs +++ b/OmegaLeo.HelperLib.Documentation/Models/DocumentationStructure.cs @@ -29,6 +29,8 @@ namespace OmegaLeo.HelperLib.Documentation.Models public string Title; public string Description; public string[] Parameters; + public string[] MethodParameters; + public string ReturnType; public string CodeExample = string.Empty; [Documentation(nameof(DocumentationDescription), "Description of the current Documented object", new [] @@ -36,13 +38,17 @@ namespace OmegaLeo.HelperLib.Documentation.Models "title - Name of the object", "description - Description of what the object does", "parameters - The parameters for the object (in case of a method with parameters)", + "methodParameters - Reflected method parameter list when the documented member is a method", + "returnType - Reflected return type when the documented member is a method", "codeExample - Code example of how to use the object" })] - public DocumentationDescription(string title, string description, string[] parameters = default, string codeExample = "") + public DocumentationDescription(string title, string description, string[]? parameters = null, string codeExample = "", string[]? methodParameters = null, string returnType = "") { Title = title; Description = description; Parameters = parameters ?? Array.Empty(); + MethodParameters = methodParameters ?? Array.Empty(); + ReturnType = returnType ?? string.Empty; CodeExample = codeExample; } } diff --git a/OmegaLeo.HelperLib.Steamworks/README.md b/OmegaLeo.HelperLib.Steamworks/README.md index af56817..f679e78 100644 --- a/OmegaLeo.HelperLib.Steamworks/README.md +++ b/OmegaLeo.HelperLib.Steamworks/README.md @@ -9,6 +9,9 @@ This package provides a simple Steam API wrapper for common tasks like initializ - Safe shutdown with `SteamManager.Shutdown()` - Player persona name access with `SteamManager.GetSteamName()` - Achievement helpers via `AchievementManager` +- Steam Workshop (UGC) helpers via `SteamManager.Instance.Ugc` +- Steam Remote Play helpers via `SteamManager.Instance.RemotePlay` +- Additional interface managers: Controller, Friends, GameServer, Input, Inventory, Matchmaking, Parties, RemoteStorage, Screenshots, UserStats, Utils, Video, and more. - Includes native Steam runtime files in NuGet package `runtimes/` ## Installation @@ -35,9 +38,59 @@ steam.Update(); var achievements = new AchievementManager(); achievements.UnlockAchievement("ACH_FIRST_WIN"); +// Steam Workshop (UGC) example +var subscribedIds = steam.Ugc.GetSubscribedItems(); + +// Steam Remote Play example +var remotePlaySessionCount = steam.RemotePlay.GetSessionCount(); + steam.Shutdown(); ``` +## More API Examples +```cs +var steam = SteamManager.Instance; + +// Friends / rich presence +steam.Friends.SetRichPresence("status", "In Match"); +steam.Friends.SetRichPresence("map", "Arena_01"); +var friendName = steam.Friends.GetFriendPersonaName(76561198000000000UL); +var friendStatus = steam.Friends.GetFriendRichPresence(76561198000000000UL, "status"); + +// Remote storage +var saveBytes = System.Text.Encoding.UTF8.GetBytes("save-data-v1"); +steam.RemoteStorage.FileWrite("save_slot_1.dat", saveBytes); +if (steam.RemoteStorage.FileRead("save_slot_1.dat", out var loadedBytes)) +{ + var loadedText = System.Text.Encoding.UTF8.GetString(loadedBytes); +} + +// User stats +steam.UserStats.SetStatInt32("KILLS", 25); +steam.UserStats.StoreStats(); +steam.UserStats.RequestGlobalStats(7); + +// UGC update convenience APIs (existing item) +var options = new SteamUgcItemUpdateOptions +{ + Title = "My Workshop Item", + Description = "Updated description.", + Tags = new[] { "map", "coop" }, + ContentFolder = "/absolute/path/to/content", + PreviewFile = "/absolute/path/to/preview.png" +}; +var submitCallHandle = steam.Ugc.UpdateItem(480, 123456789012345678UL, options, "Updated content", out var failedStep); + +// Fluent session alternative +var session = steam.Ugc.BeginUpdateSession(480, 123456789012345678UL) + .WithTitle("My Workshop Item") + .WithDescription("Updated description") + .WithTags("map", "coop") + .WithContentFolder("/absolute/path/to/content") + .WithPreviewFile("/absolute/path/to/preview.png"); +var submitCallHandle2 = session.Submit("Updated content", out var failedStep2); +``` + ## Notes - Steam must be running and your app must be launched in a valid Steam context. - Configure your AppId before first access to `SteamManager.Instance`. diff --git a/OmegaLeo.HelperLib.Steamworks/SteamExtendedManagers.cs b/OmegaLeo.HelperLib.Steamworks/SteamExtendedManagers.cs new file mode 100644 index 0000000..a281d66 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamExtendedManagers.cs @@ -0,0 +1,401 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamControllerManager), "Provides access checks for ISteamController.", null, null)] + public class SteamControllerManager + { + public bool IsAvailable => SteamNativeApi.IsSteamControllerAvailable(); + } + + [Documentation(nameof(SteamFriendsManager), "Provides access checks for ISteamFriends.", null, null)] + public class SteamFriendsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamFriendsAvailable(); + + [Documentation(nameof(GetFriendCount), "Gets the friend count filtered by Steam friend flags.", new[] { "friendFlags: Bitmask value matching Steam EFriendFlags." }, null)] + public int GetFriendCount(int friendFlags) + { + return SteamNativeApi.GetFriendCount(friendFlags); + } + + [Documentation(nameof(GetFriendPersonaName), "Gets the persona name of a friend by SteamID64.", new[] { "steamIdFriend: Friend SteamID64." }, null)] + public string GetFriendPersonaName(ulong steamIdFriend) + { + return SteamNativeApi.GetFriendPersonaName(steamIdFriend); + } + + [Documentation(nameof(ActivateGameOverlayInviteDialog), "Opens the Steam invite dialog for a lobby.", new[] { "steamIdLobby: Lobby SteamID64." }, null)] + public void ActivateGameOverlayInviteDialog(ulong steamIdLobby) + { + SteamNativeApi.FriendsActivateGameOverlayInviteDialog(steamIdLobby); + } + + [Documentation(nameof(SetRichPresence), "Sets a rich presence key/value pair for the local user.", new[] { "key: Rich presence key.", "value: Rich presence value." }, null)] + public bool SetRichPresence(string key, string value) + { + return SteamNativeApi.FriendsSetRichPresence(key, value); + } + + [Documentation(nameof(ClearRichPresence), "Clears all rich presence values for the local user.", null, null)] + public void ClearRichPresence() + { + SteamNativeApi.FriendsClearRichPresence(); + } + + [Documentation(nameof(GetFriendRichPresence), "Gets a rich presence value for a specific friend.", new[] { "steamIdFriend: Friend SteamID64.", "key: Rich presence key." }, null)] + public string GetFriendRichPresence(ulong steamIdFriend, string key) + { + return SteamNativeApi.FriendsGetFriendRichPresence(steamIdFriend, key); + } + + [Documentation(nameof(InviteUserToGame), "Invites a friend to the current game session using a connect string.", new[] { "steamIdFriend: Friend SteamID64.", "connectString: Game connect string passed through Steam invite." }, null)] + public bool InviteUserToGame(ulong steamIdFriend, string connectString) + { + return SteamNativeApi.FriendsInviteUserToGame(steamIdFriend, connectString); + } + } + + [Documentation(nameof(SteamGameCoordinatorManager), "Provides access checks for ISteamGameCoordinator.", null, null)] + public class SteamGameCoordinatorManager + { + public bool IsAvailable => SteamNativeApi.IsSteamGameCoordinatorAvailable(); + } + + [Documentation(nameof(SteamGameServerManager), "Provides access checks for ISteamGameServer.", null, null)] + public class SteamGameServerManager + { + public bool IsAvailable => SteamNativeApi.IsSteamGameServerAvailable(); + } + + [Documentation(nameof(SteamGameServerStatsManager), "Provides access checks for ISteamGameServerStats.", null, null)] + public class SteamGameServerStatsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamGameServerStatsAvailable(); + } + + [Documentation(nameof(SteamHtmlSurfaceManager), "Provides access checks for ISteamHTMLSurface.", null, null)] + public class SteamHtmlSurfaceManager + { + public bool IsAvailable => SteamNativeApi.IsSteamHtmlSurfaceAvailable(); + } + + [Documentation(nameof(SteamInputManager), "Provides access checks for ISteamInput.", null, null)] + public class SteamInputManager + { + public bool IsAvailable => SteamNativeApi.IsSteamInputAvailable(); + + [Documentation(nameof(Init), "Initializes Steam Input for the application.", new[] { "explicitlyCallRunFrame: Set true when your game will manually call RunFrame each frame." }, null)] + public bool Init(bool explicitlyCallRunFrame = false) + { + return SteamNativeApi.InputInit(explicitlyCallRunFrame); + } + + [Documentation(nameof(Shutdown), "Shuts down Steam Input.", null, null)] + public bool Shutdown() + { + return SteamNativeApi.InputShutdown(); + } + + [Documentation(nameof(RunFrame), "Runs a Steam Input frame update.", null, null)] + public void RunFrame() + { + SteamNativeApi.InputRunFrame(); + } + } + + [Documentation(nameof(SteamInventoryManager), "Provides access checks for ISteamInventory.", null, null)] + public class SteamInventoryManager + { + public bool IsAvailable => SteamNativeApi.IsSteamInventoryAvailable(); + + [Documentation(nameof(LoadItemDefinitions), "Requests latest inventory item definitions from Steam.", null, null)] + public bool LoadItemDefinitions() + { + return SteamNativeApi.InventoryLoadItemDefinitions(); + } + + [Documentation(nameof(GetAllItems), "Requests all inventory items and returns a result handle.", new[] { "inventoryResultHandle: Inventory result handle to use with additional inventory API calls." }, null)] + public bool GetAllItems(out int inventoryResultHandle) + { + return SteamNativeApi.InventoryGetAllItems(out inventoryResultHandle); + } + + [Documentation(nameof(DestroyResult), "Releases an inventory result handle returned from Steam Inventory API calls.", new[] { "inventoryResultHandle: Inventory result handle to release." }, null)] + public void DestroyResult(int inventoryResultHandle) + { + SteamNativeApi.InventoryDestroyResult(inventoryResultHandle); + } + } + + [Documentation(nameof(SteamMatchmakingManager), "Provides access checks for ISteamMatchmaking.", null, null)] + public class SteamMatchmakingManager + { + public bool IsAvailable => SteamNativeApi.IsSteamMatchmakingAvailable(); + + [Documentation(nameof(RequestLobbyList), "Requests a lobby list and returns a Steam API call handle.", null, null)] + public ulong RequestLobbyList() + { + return SteamNativeApi.MatchmakingRequestLobbyList(); + } + + [Documentation(nameof(AddRequestLobbyListResultCountFilter), "Sets the maximum number of lobbies returned by RequestLobbyList.", new[] { "maxResults: Maximum number of lobby results." }, null)] + public void AddRequestLobbyListResultCountFilter(int maxResults) + { + SteamNativeApi.MatchmakingAddRequestLobbyListResultCountFilter(maxResults); + } + + [Documentation(nameof(CreateLobby), "Creates a lobby and returns a Steam API call handle.", new[] { "lobbyType: Numeric ELobbyType value.", "maxMembers: Maximum lobby member count." }, null)] + public ulong CreateLobby(int lobbyType, int maxMembers) + { + return SteamNativeApi.MatchmakingCreateLobby(lobbyType, maxMembers); + } + + [Documentation(nameof(JoinLobby), "Joins a lobby by SteamID64 and returns a Steam API call handle.", new[] { "steamIdLobby: Lobby SteamID64." }, null)] + public ulong JoinLobby(ulong steamIdLobby) + { + return SteamNativeApi.MatchmakingJoinLobby(steamIdLobby); + } + + [Documentation(nameof(LeaveLobby), "Leaves a lobby by SteamID64.", new[] { "steamIdLobby: Lobby SteamID64." }, null)] + public void LeaveLobby(ulong steamIdLobby) + { + SteamNativeApi.MatchmakingLeaveLobby(steamIdLobby); + } + + [Documentation(nameof(GetNumLobbyMembers), "Gets the number of members currently in a lobby.", new[] { "steamIdLobby: Lobby SteamID64." }, null)] + public int GetNumLobbyMembers(ulong steamIdLobby) + { + return SteamNativeApi.MatchmakingGetNumLobbyMembers(steamIdLobby); + } + } + + [Documentation(nameof(SteamMatchmakingServersManager), "Provides access checks for ISteamMatchmakingServers.", null, null)] + public class SteamMatchmakingServersManager + { + public bool IsAvailable => SteamNativeApi.IsSteamMatchmakingServersAvailable(); + } + + [Documentation(nameof(SteamMusicManager), "Provides access checks for ISteamMusic.", null, null)] + public class SteamMusicManager + { + public bool IsAvailable => SteamNativeApi.IsSteamMusicAvailable(); + + [Documentation(nameof(IsEnabled), "Checks whether Steam Music is enabled.", null, null)] + public bool IsEnabled() + { + return SteamNativeApi.MusicIsEnabled(); + } + + [Documentation(nameof(IsPlaying), "Checks whether Steam Music is currently playing.", null, null)] + public bool IsPlaying() + { + return SteamNativeApi.MusicIsPlaying(); + } + + [Documentation(nameof(Play), "Starts Steam Music playback.", null, null)] + public void Play() + { + SteamNativeApi.MusicPlay(); + } + + [Documentation(nameof(Pause), "Pauses Steam Music playback.", null, null)] + public void Pause() + { + SteamNativeApi.MusicPause(); + } + + [Documentation(nameof(PlayNext), "Advances to the next music track.", null, null)] + public void PlayNext() + { + SteamNativeApi.MusicPlayNext(); + } + + [Documentation(nameof(PlayPrevious), "Moves to the previous music track.", null, null)] + public void PlayPrevious() + { + SteamNativeApi.MusicPlayPrevious(); + } + + [Documentation(nameof(GetVolume), "Gets Steam Music volume (0..1 range).", null, null)] + public float GetVolume() + { + return SteamNativeApi.MusicGetVolume(); + } + + [Documentation(nameof(SetVolume), "Sets Steam Music volume (0..1 range).", new[] { "volume: New volume value." }, null)] + public void SetVolume(float volume) + { + SteamNativeApi.MusicSetVolume(volume); + } + } + + [Documentation(nameof(SteamPartiesManager), "Provides access checks for ISteamParties.", null, null)] + public class SteamPartiesManager + { + public bool IsAvailable => SteamNativeApi.IsSteamPartiesAvailable(); + } + + [Documentation(nameof(SteamRemoteStorageManager), "Provides access checks for ISteamRemoteStorage.", null, null)] + public class SteamRemoteStorageManager + { + public bool IsAvailable => SteamNativeApi.IsSteamRemoteStorageAvailable(); + + [Documentation(nameof(FileExists), "Checks whether a file exists in Steam Remote Storage.", new[] { "fileName: Cloud file path/name." }, null)] + public bool FileExists(string fileName) + { + return SteamNativeApi.RemoteStorageFileExists(fileName); + } + + [Documentation(nameof(GetFileCount), "Gets the number of files in Steam Remote Storage for the current app/user context.", null, null)] + public int GetFileCount() + { + return SteamNativeApi.RemoteStorageGetFileCount(); + } + + [Documentation(nameof(IsCloudEnabledForApp), "Checks whether Steam Cloud is enabled for this app.", null, null)] + public bool IsCloudEnabledForApp() + { + return SteamNativeApi.RemoteStorageIsCloudEnabledForApp(); + } + + [Documentation(nameof(FileWrite), "Writes a byte array to a Steam Cloud file.", new[] { "fileName: Cloud file path/name.", "data: Raw file bytes to write." }, null)] + public bool FileWrite(string fileName, byte[] data) + { + return SteamNativeApi.RemoteStorageFileWrite(fileName, data); + } + + [Documentation(nameof(FileRead), "Reads a Steam Cloud file into a byte array.", new[] { "fileName: Cloud file path/name.", "data: Output file bytes when read succeeds." }, null)] + public bool FileRead(string fileName, out byte[] data) + { + return SteamNativeApi.RemoteStorageFileRead(fileName, out data); + } + + [Documentation(nameof(FileDelete), "Deletes a Steam Cloud file.", new[] { "fileName: Cloud file path/name." }, null)] + public bool FileDelete(string fileName) + { + return SteamNativeApi.RemoteStorageFileDelete(fileName); + } + + [Documentation(nameof(GetFileSize), "Gets file size in bytes for a Steam Cloud file.", new[] { "fileName: Cloud file path/name." }, null)] + public int GetFileSize(string fileName) + { + return SteamNativeApi.RemoteStorageGetFileSize(fileName); + } + } + + [Documentation(nameof(SteamScreenshotsManager), "Provides access checks for ISteamScreenshots.", null, null)] + public class SteamScreenshotsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamScreenshotsAvailable(); + + [Documentation(nameof(AddScreenshotToLibrary), "Adds an existing screenshot to the Steam screenshot library.", new[] { "fileNameJpg: Screenshot image path.", "fileNameThumbnail: Thumbnail path.", "width: Image width.", "height: Image height." }, null)] + public uint AddScreenshotToLibrary(string fileNameJpg, string fileNameThumbnail, int width, int height) + { + return SteamNativeApi.ScreenshotsAddScreenshotToLibrary(fileNameJpg, fileNameThumbnail, width, height); + } + + [Documentation(nameof(TriggerScreenshot), "Triggers an in-game screenshot event.", null, null)] + public void TriggerScreenshot() + { + SteamNativeApi.ScreenshotsTriggerScreenshot(); + } + + [Documentation(nameof(HookScreenshots), "Enables or disables screenshot hooks for custom handling.", new[] { "hook: True to hook screenshots." }, null)] + public void HookScreenshots(bool hook) + { + SteamNativeApi.ScreenshotsHookScreenshots(hook); + } + + [Documentation(nameof(IsScreenshotsHooked), "Checks whether screenshot hooks are currently enabled.", null, null)] + public bool IsScreenshotsHooked() + { + return SteamNativeApi.ScreenshotsIsScreenshotsHooked(); + } + } + + [Documentation(nameof(SteamUserStatsManager), "Provides access checks for ISteamUserStats.", null, null)] + public class SteamUserStatsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamUserStatsAvailable(); + + [Documentation(nameof(RequestUserStats), "Requests user stats for a target SteamID64 and returns a Steam API call handle.", new[] { "steamIdUser: Target SteamID64." }, null)] + public ulong RequestUserStats(ulong steamIdUser) + { + return SteamNativeApi.UserStatsRequestUserStats(steamIdUser); + } + + [Documentation(nameof(RequestGlobalStats), "Requests global stats history and returns a Steam API call handle.", new[] { "historyDays: Number of days of history to request." }, null)] + public ulong RequestGlobalStats(int historyDays) + { + return SteamNativeApi.UserStatsRequestGlobalStats(historyDays); + } + + [Documentation(nameof(ResetAllStats), "Resets local user stats, optionally including achievements.", new[] { "achievementsToo: True to also clear achievement state." }, null)] + public bool ResetAllStats(bool achievementsToo) + { + return SteamNativeApi.UserStatsResetAllStats(achievementsToo); + } + + [Documentation(nameof(GetStatInt32), "Gets a named integer stat value.", new[] { "name: Stat API name.", "data: Output integer stat value." }, null)] + public bool GetStatInt32(string name, out int data) + { + return SteamNativeApi.UserStatsGetStatInt32(name, out data); + } + + [Documentation(nameof(SetStatInt32), "Sets a named integer stat value.", new[] { "name: Stat API name.", "data: Integer stat value to set." }, null)] + public bool SetStatInt32(string name, int data) + { + return SteamNativeApi.UserStatsSetStatInt32(name, data); + } + + [Documentation(nameof(StoreStats), "Stores pending stats and achievement changes to Steam.", null, null)] + public bool StoreStats() + { + return SteamNativeApi.StoreStats(); + } + } + + [Documentation(nameof(SteamUtilsManager), "Provides access checks for ISteamUtils.", null, null)] + public class SteamUtilsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamUtilsAvailable(); + + [Documentation(nameof(GetAppId), "Gets the current Steam AppId reported by SteamUtils.", null, null)] + public uint GetAppId() + { + return SteamNativeApi.GetAppId(); + } + + [Documentation(nameof(GetIpCountry), "Gets the two-letter country code inferred by Steam based on the current IP.", null, null)] + public string GetIpCountry() + { + return SteamNativeApi.GetIpCountry(); + } + + [Documentation(nameof(IsOverlayEnabled), "Checks whether Steam Overlay is currently enabled.", null, null)] + public bool IsOverlayEnabled() + { + return SteamNativeApi.IsOverlayEnabled(); + } + } + + [Documentation(nameof(SteamVideoManager), "Provides access checks for ISteamVideo.", null, null)] + public class SteamVideoManager + { + public bool IsAvailable => SteamNativeApi.IsSteamVideoAvailable(); + + [Documentation(nameof(GetVideoUrl), "Requests a video URL for a given Steam video app id.", new[] { "videoAppId: Steam video app id." }, null)] + public void GetVideoUrl(uint videoAppId) + { + SteamNativeApi.VideoGetVideoUrl(videoAppId); + } + + [Documentation(nameof(IsBroadcasting), "Checks whether the user is broadcasting and returns current viewer count.", new[] { "numberOfViewers: Viewer count output when broadcasting." }, null)] + public bool IsBroadcasting(out int numberOfViewers) + { + return SteamNativeApi.VideoIsBroadcasting(out numberOfViewers); + } + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamManager.cs b/OmegaLeo.HelperLib.Steamworks/SteamManager.cs index 7d56fa9..541a04d 100644 --- a/OmegaLeo.HelperLib.Steamworks/SteamManager.cs +++ b/OmegaLeo.HelperLib.Steamworks/SteamManager.cs @@ -17,6 +17,25 @@ steam.Update(); private static SteamManager _instance; private static uint? _configuredAppId; private static ILogger _logger = NullLogger.Instance; + private static readonly SteamUgcManager UgcManager = new SteamUgcManager(); + private static readonly SteamRemotePlayManager RemotePlayManager = new SteamRemotePlayManager(); + private static readonly SteamControllerManager ControllerManager = new SteamControllerManager(); + private static readonly SteamFriendsManager FriendsManager = new SteamFriendsManager(); + private static readonly SteamGameCoordinatorManager GameCoordinatorManager = new SteamGameCoordinatorManager(); + private static readonly SteamGameServerManager GameServerManager = new SteamGameServerManager(); + private static readonly SteamGameServerStatsManager GameServerStatsManager = new SteamGameServerStatsManager(); + private static readonly SteamHtmlSurfaceManager HtmlSurfaceManager = new SteamHtmlSurfaceManager(); + private static readonly SteamInputManager InputManager = new SteamInputManager(); + private static readonly SteamInventoryManager InventoryManager = new SteamInventoryManager(); + private static readonly SteamMatchmakingManager MatchmakingManager = new SteamMatchmakingManager(); + private static readonly SteamMatchmakingServersManager MatchmakingServersManager = new SteamMatchmakingServersManager(); + private static readonly SteamMusicManager MusicManager = new SteamMusicManager(); + private static readonly SteamPartiesManager PartiesManager = new SteamPartiesManager(); + private static readonly SteamRemoteStorageManager RemoteStorageManager = new SteamRemoteStorageManager(); + private static readonly SteamScreenshotsManager ScreenshotsManager = new SteamScreenshotsManager(); + private static readonly SteamUserStatsManager UserStatsManager = new SteamUserStatsManager(); + private static readonly SteamUtilsManager UtilsManager = new SteamUtilsManager(); + private static readonly SteamVideoManager VideoManager = new SteamVideoManager(); [Documentation(nameof(Instance), "Singleton access to the Steam manager.", null, null)] public static SteamManager Instance => _instance ??= new SteamManager(); @@ -50,6 +69,63 @@ steam.Update(); [Documentation(nameof(IsSteamworksInitialized), "Indicates whether Steamworks is initialized and ready for API calls.", null, null)] public bool IsSteamworksInitialized { get; private set; } + [Documentation(nameof(Ugc), "Provides access to Steam Workshop (UGC) helper operations.", null, null)] + public SteamUgcManager Ugc => UgcManager; + + [Documentation(nameof(RemotePlay), "Provides access to Steam Remote Play helper operations.", null, null)] + public SteamRemotePlayManager RemotePlay => RemotePlayManager; + + [Documentation(nameof(Controller), "Provides access to ISteamController bindings.", null, null)] + public SteamControllerManager Controller => ControllerManager; + + [Documentation(nameof(Friends), "Provides access to ISteamFriends bindings.", null, null)] + public SteamFriendsManager Friends => FriendsManager; + + [Documentation(nameof(GameCoordinator), "Provides access to ISteamGameCoordinator bindings.", null, null)] + public SteamGameCoordinatorManager GameCoordinator => GameCoordinatorManager; + + [Documentation(nameof(GameServer), "Provides access to ISteamGameServer bindings.", null, null)] + public SteamGameServerManager GameServer => GameServerManager; + + [Documentation(nameof(GameServerStats), "Provides access to ISteamGameServerStats bindings.", null, null)] + public SteamGameServerStatsManager GameServerStats => GameServerStatsManager; + + [Documentation(nameof(HtmlSurface), "Provides access to ISteamHTMLSurface bindings.", null, null)] + public SteamHtmlSurfaceManager HtmlSurface => HtmlSurfaceManager; + + [Documentation(nameof(Input), "Provides access to ISteamInput bindings.", null, null)] + public SteamInputManager Input => InputManager; + + [Documentation(nameof(Inventory), "Provides access to ISteamInventory bindings.", null, null)] + public SteamInventoryManager Inventory => InventoryManager; + + [Documentation(nameof(Matchmaking), "Provides access to ISteamMatchmaking bindings.", null, null)] + public SteamMatchmakingManager Matchmaking => MatchmakingManager; + + [Documentation(nameof(MatchmakingServers), "Provides access to ISteamMatchmakingServers bindings.", null, null)] + public SteamMatchmakingServersManager MatchmakingServers => MatchmakingServersManager; + + [Documentation(nameof(Music), "Provides access to ISteamMusic bindings.", null, null)] + public SteamMusicManager Music => MusicManager; + + [Documentation(nameof(Parties), "Provides access to ISteamParties bindings.", null, null)] + public SteamPartiesManager Parties => PartiesManager; + + [Documentation(nameof(RemoteStorage), "Provides access to ISteamRemoteStorage bindings.", null, null)] + public SteamRemoteStorageManager RemoteStorage => RemoteStorageManager; + + [Documentation(nameof(Screenshots), "Provides access to ISteamScreenshots bindings.", null, null)] + public SteamScreenshotsManager Screenshots => ScreenshotsManager; + + [Documentation(nameof(UserStats), "Provides access to ISteamUserStats bindings.", null, null)] + public SteamUserStatsManager UserStats => UserStatsManager; + + [Documentation(nameof(Utils), "Provides access to ISteamUtils bindings.", null, null)] + public SteamUtilsManager Utils => UtilsManager; + + [Documentation(nameof(Video), "Provides access to ISteamVideo bindings.", null, null)] + public SteamVideoManager Video => VideoManager; + private SteamManager() { try diff --git a/OmegaLeo.HelperLib.Steamworks/SteamNativeApi.cs b/OmegaLeo.HelperLib.Steamworks/SteamNativeApi.cs index 1519df1..f36535c 100644 --- a/OmegaLeo.HelperLib.Steamworks/SteamNativeApi.cs +++ b/OmegaLeo.HelperLib.Steamworks/SteamNativeApi.cs @@ -1,4 +1,5 @@ using System; +using System.Collections.Generic; using System.IO; using System.Runtime.InteropServices; @@ -19,6 +20,15 @@ namespace OmegaLeo.HelperLib.Steamworks [UnmanagedFunctionPointer(CallingConvention.Cdecl)] private delegate IntPtr SteamUserStatsAccessorDelegate(); + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamUgcAccessorDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamRemotePlayAccessorDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamInterfaceAccessorDelegate(); + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] private delegate IntPtr SteamFriendsGetPersonaNameDelegate(IntPtr steamFriends); @@ -34,6 +44,249 @@ namespace OmegaLeo.HelperLib.Steamworks [return: MarshalAs(UnmanagedType.I1)] private delegate bool SteamUserStatsGetAchievementDelegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.LPStr)] string achievementId, [MarshalAs(UnmanagedType.I1)] out bool achieved); + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcCreateQueryAllRequestDelegate(IntPtr steamUgc, uint queryType, uint matchingType, uint creatorAppId, uint consumerAppId, uint page); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcSendQueryRequestDelegate(IntPtr steamUgc, ulong queryHandle); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcReleaseQueryRequestDelegate(IntPtr steamUgc, ulong queryHandle); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamUgcGetNumSubscribedItemsDelegate(IntPtr steamUgc); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamUgcGetSubscribedItemsDelegate(IntPtr steamUgc, [Out] ulong[] items, uint maxEntries); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcSubscribeItemDelegate(IntPtr steamUgc, ulong publishedFileId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcUnsubscribeItemDelegate(IntPtr steamUgc, ulong publishedFileId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcCreateItemDelegate(IntPtr steamUgc, uint consumerAppId, uint fileType); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcStartItemUpdateDelegate(IntPtr steamUgc, uint consumerAppId, ulong publishedFileId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemTitleDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string title); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemDescriptionDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string description); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemMetadataDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string metadata); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemVisibilityDelegate(IntPtr steamUgc, ulong updateHandle, uint visibility); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemTagsDelegate(IntPtr steamUgc, ulong updateHandle, IntPtr tags); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemContentDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string contentFolder); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemPreviewDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string previewFile); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcSubmitItemUpdateDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string changeNote); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamUgcGetItemUpdateProgressDelegate(IntPtr steamUgc, ulong updateHandle, out ulong bytesProcessed, out ulong bytesTotal); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamRemotePlayGetSessionCountDelegate(IntPtr steamRemotePlay); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamRemotePlayGetSessionIdDelegate(IntPtr steamRemotePlay, int sessionIndex); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamRemotePlayGetSessionSteamIdDelegate(IntPtr steamRemotePlay, uint sessionId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamRemotePlayGetSessionClientNameDelegate(IntPtr steamRemotePlay, uint sessionId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamRemotePlayGetSessionClientFormFactorDelegate(IntPtr steamRemotePlay, uint sessionId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemotePlayGetSessionClientResolutionDelegate(IntPtr steamRemotePlay, uint sessionId, out int resolutionX, out int resolutionY); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamFriendsGetFriendCountDelegate(IntPtr steamFriends, int friendFlags); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamFriendsGetFriendPersonaNameDelegate(IntPtr steamFriends, ulong steamIdFriend); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamFriendsActivateGameOverlayInviteDialogDelegate(IntPtr steamFriends, ulong steamIdLobby); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamFriendsSetRichPresenceDelegate(IntPtr steamFriends, [MarshalAs(UnmanagedType.LPStr)] string key, [MarshalAs(UnmanagedType.LPStr)] string value); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamFriendsClearRichPresenceDelegate(IntPtr steamFriends); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamFriendsGetFriendRichPresenceDelegate(IntPtr steamFriends, ulong steamIdFriend, [MarshalAs(UnmanagedType.LPStr)] string key); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamFriendsInviteUserToGameDelegate(IntPtr steamFriends, ulong steamIdFriend, [MarshalAs(UnmanagedType.LPStr)] string connectString); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamUtilsGetAppIdDelegate(IntPtr steamUtils); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamUtilsGetIpCountryDelegate(IntPtr steamUtils); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUtilsIsOverlayEnabledDelegate(IntPtr steamUtils); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemoteStorageFileExistsDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamRemoteStorageGetFileCountDelegate(IntPtr steamRemoteStorage); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemoteStorageIsCloudEnabledForAppDelegate(IntPtr steamRemoteStorage); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemoteStorageFileWriteDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName, byte[] data, int dataSize); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamRemoteStorageFileReadDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName, [Out] byte[] dataBuffer, int dataToRead); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemoteStorageFileDeleteDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamRemoteStorageGetFileSizeDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamInputInitDelegate(IntPtr steamInput, [MarshalAs(UnmanagedType.I1)] bool explicitlyCallRunFrame); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamInputShutdownDelegate(IntPtr steamInput); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamInputRunFrameDelegate(IntPtr steamInput, [MarshalAs(UnmanagedType.I1)] bool reservedValue); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamInventoryLoadItemDefinitionsDelegate(IntPtr steamInventory); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamInventoryGetAllItemsDelegate(IntPtr steamInventory, out int inventoryResultHandle); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamInventoryDestroyResultDelegate(IntPtr steamInventory, int inventoryResultHandle); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamMatchmakingRequestLobbyListDelegate(IntPtr steamMatchmaking); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMatchmakingAddRequestLobbyListResultCountFilterDelegate(IntPtr steamMatchmaking, int maxResults); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamMatchmakingCreateLobbyDelegate(IntPtr steamMatchmaking, int lobbyType, int maxMembers); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamMatchmakingJoinLobbyDelegate(IntPtr steamMatchmaking, ulong steamIdLobby); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMatchmakingLeaveLobbyDelegate(IntPtr steamMatchmaking, ulong steamIdLobby); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamMatchmakingGetNumLobbyMembersDelegate(IntPtr steamMatchmaking, ulong steamIdLobby); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamScreenshotsAddScreenshotToLibraryDelegate(IntPtr steamScreenshots, [MarshalAs(UnmanagedType.LPStr)] string fileNameJpg, [MarshalAs(UnmanagedType.LPStr)] string fileNameThumbnail, int width, int height); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamScreenshotsTriggerScreenshotDelegate(IntPtr steamScreenshots); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamScreenshotsHookScreenshotsDelegate(IntPtr steamScreenshots, [MarshalAs(UnmanagedType.I1)] bool hook); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamScreenshotsIsScreenshotsHookedDelegate(IntPtr steamScreenshots); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamMusicIsEnabledDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamMusicIsPlayingDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicPlayDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicPauseDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicPlayNextDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicPlayPreviousDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate float SteamMusicGetVolumeDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicSetVolumeDelegate(IntPtr steamMusic, float volume); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamVideoGetVideoUrlDelegate(IntPtr steamVideo, uint videoAppId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamVideoIsBroadcastingDelegate(IntPtr steamVideo, out int numberOfViewers); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUserStatsRequestUserStatsDelegate(IntPtr steamUserStats, ulong steamIdUser); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUserStatsRequestGlobalStatsDelegate(IntPtr steamUserStats, int historyDays); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsResetAllStatsDelegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.I1)] bool achievementsToo); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsGetStatInt32Delegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.LPStr)] string name, out int data); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsSetStatInt32Delegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.LPStr)] string name, int data); + private static readonly object SyncRoot = new object(); private static IntPtr _libraryHandle; @@ -45,13 +298,108 @@ namespace OmegaLeo.HelperLib.Steamworks private static SteamApiVoidDelegate _steamApiRunCallbacks; private static SteamFriendsAccessorDelegate _steamFriendsAccessor; private static SteamUserStatsAccessorDelegate _steamUserStatsAccessor; + private static SteamUgcAccessorDelegate _steamUgcAccessor; + private static SteamRemotePlayAccessorDelegate _steamRemotePlayAccessor; private static SteamFriendsGetPersonaNameDelegate _steamFriendsGetPersonaName; private static SteamUserStatsSetAchievementDelegate _steamUserStatsSetAchievement; private static SteamUserStatsStoreStatsDelegate _steamUserStatsStoreStats; private static SteamUserStatsGetAchievementDelegate _steamUserStatsGetAchievement; + private static SteamUgcCreateQueryAllRequestDelegate _steamUgcCreateQueryAllRequest; + private static SteamUgcSendQueryRequestDelegate _steamUgcSendQueryRequest; + private static SteamUgcReleaseQueryRequestDelegate _steamUgcReleaseQueryRequest; + private static SteamUgcGetNumSubscribedItemsDelegate _steamUgcGetNumSubscribedItems; + private static SteamUgcGetSubscribedItemsDelegate _steamUgcGetSubscribedItems; + private static SteamUgcSubscribeItemDelegate _steamUgcSubscribeItem; + private static SteamUgcUnsubscribeItemDelegate _steamUgcUnsubscribeItem; + private static SteamUgcCreateItemDelegate _steamUgcCreateItem; + private static SteamUgcStartItemUpdateDelegate _steamUgcStartItemUpdate; + private static SteamUgcSetItemTitleDelegate _steamUgcSetItemTitle; + private static SteamUgcSetItemDescriptionDelegate _steamUgcSetItemDescription; + private static SteamUgcSetItemMetadataDelegate _steamUgcSetItemMetadata; + private static SteamUgcSetItemVisibilityDelegate _steamUgcSetItemVisibility; + private static SteamUgcSetItemTagsDelegate _steamUgcSetItemTags; + private static SteamUgcSetItemContentDelegate _steamUgcSetItemContent; + private static SteamUgcSetItemPreviewDelegate _steamUgcSetItemPreview; + private static SteamUgcSubmitItemUpdateDelegate _steamUgcSubmitItemUpdate; + private static SteamUgcGetItemUpdateProgressDelegate _steamUgcGetItemUpdateProgress; + private static SteamRemotePlayGetSessionCountDelegate _steamRemotePlayGetSessionCount; + private static SteamRemotePlayGetSessionIdDelegate _steamRemotePlayGetSessionId; + private static SteamRemotePlayGetSessionSteamIdDelegate _steamRemotePlayGetSessionSteamId; + private static SteamRemotePlayGetSessionClientNameDelegate _steamRemotePlayGetSessionClientName; + private static SteamRemotePlayGetSessionClientFormFactorDelegate _steamRemotePlayGetSessionClientFormFactor; + private static SteamRemotePlayGetSessionClientResolutionDelegate _steamRemotePlayGetSessionClientResolution; + private static SteamFriendsGetFriendCountDelegate _steamFriendsGetFriendCount; + private static SteamFriendsGetFriendPersonaNameDelegate _steamFriendsGetFriendPersonaName; + private static SteamFriendsActivateGameOverlayInviteDialogDelegate _steamFriendsActivateGameOverlayInviteDialog; + private static SteamFriendsSetRichPresenceDelegate _steamFriendsSetRichPresence; + private static SteamFriendsClearRichPresenceDelegate _steamFriendsClearRichPresence; + private static SteamFriendsGetFriendRichPresenceDelegate _steamFriendsGetFriendRichPresence; + private static SteamFriendsInviteUserToGameDelegate _steamFriendsInviteUserToGame; + private static SteamUtilsGetAppIdDelegate _steamUtilsGetAppId; + private static SteamUtilsGetIpCountryDelegate _steamUtilsGetIpCountry; + private static SteamUtilsIsOverlayEnabledDelegate _steamUtilsIsOverlayEnabled; + private static SteamRemoteStorageFileExistsDelegate _steamRemoteStorageFileExists; + private static SteamRemoteStorageGetFileCountDelegate _steamRemoteStorageGetFileCount; + private static SteamRemoteStorageIsCloudEnabledForAppDelegate _steamRemoteStorageIsCloudEnabledForApp; + private static SteamRemoteStorageFileWriteDelegate _steamRemoteStorageFileWrite; + private static SteamRemoteStorageFileReadDelegate _steamRemoteStorageFileRead; + private static SteamRemoteStorageFileDeleteDelegate _steamRemoteStorageFileDelete; + private static SteamRemoteStorageGetFileSizeDelegate _steamRemoteStorageGetFileSize; + private static SteamInputInitDelegate _steamInputInit; + private static SteamInputShutdownDelegate _steamInputShutdown; + private static SteamInputRunFrameDelegate _steamInputRunFrame; + private static SteamInventoryLoadItemDefinitionsDelegate _steamInventoryLoadItemDefinitions; + private static SteamInventoryGetAllItemsDelegate _steamInventoryGetAllItems; + private static SteamInventoryDestroyResultDelegate _steamInventoryDestroyResult; + private static SteamMatchmakingRequestLobbyListDelegate _steamMatchmakingRequestLobbyList; + private static SteamMatchmakingAddRequestLobbyListResultCountFilterDelegate _steamMatchmakingAddRequestLobbyListResultCountFilter; + private static SteamMatchmakingCreateLobbyDelegate _steamMatchmakingCreateLobby; + private static SteamMatchmakingJoinLobbyDelegate _steamMatchmakingJoinLobby; + private static SteamMatchmakingLeaveLobbyDelegate _steamMatchmakingLeaveLobby; + private static SteamMatchmakingGetNumLobbyMembersDelegate _steamMatchmakingGetNumLobbyMembers; + private static SteamScreenshotsAddScreenshotToLibraryDelegate _steamScreenshotsAddScreenshotToLibrary; + private static SteamScreenshotsTriggerScreenshotDelegate _steamScreenshotsTriggerScreenshot; + private static SteamScreenshotsHookScreenshotsDelegate _steamScreenshotsHookScreenshots; + private static SteamScreenshotsIsScreenshotsHookedDelegate _steamScreenshotsIsScreenshotsHooked; + private static SteamMusicIsEnabledDelegate _steamMusicIsEnabled; + private static SteamMusicIsPlayingDelegate _steamMusicIsPlaying; + private static SteamMusicPlayDelegate _steamMusicPlay; + private static SteamMusicPauseDelegate _steamMusicPause; + private static SteamMusicPlayNextDelegate _steamMusicPlayNext; + private static SteamMusicPlayPreviousDelegate _steamMusicPlayPrevious; + private static SteamMusicGetVolumeDelegate _steamMusicGetVolume; + private static SteamMusicSetVolumeDelegate _steamMusicSetVolume; + private static SteamVideoGetVideoUrlDelegate _steamVideoGetVideoUrl; + private static SteamVideoIsBroadcastingDelegate _steamVideoIsBroadcasting; + private static SteamUserStatsRequestUserStatsDelegate _steamUserStatsRequestUserStats; + private static SteamUserStatsRequestGlobalStatsDelegate _steamUserStatsRequestGlobalStats; + private static SteamUserStatsResetAllStatsDelegate _steamUserStatsResetAllStats; + private static SteamUserStatsGetStatInt32Delegate _steamUserStatsGetStatInt32; + private static SteamUserStatsSetStatInt32Delegate _steamUserStatsSetStatInt32; private static IntPtr _steamFriends; private static IntPtr _steamUserStats; + private static IntPtr _steamUgc; + private static IntPtr _steamRemotePlay; + + private static readonly Dictionary AdditionalInterfaceAccessors = new Dictionary(); + private static readonly Dictionary AdditionalInterfacePointers = new Dictionary(); + + private const string InterfaceSteamController = "SteamController"; + private const string InterfaceSteamGameCoordinator = "SteamGameCoordinator"; + private const string InterfaceSteamGameServer = "SteamGameServer"; + private const string InterfaceSteamGameServerStats = "SteamGameServerStats"; + private const string InterfaceSteamHtmlSurface = "SteamHTMLSurface"; + private const string InterfaceSteamInput = "SteamInput"; + private const string InterfaceSteamInventory = "SteamInventory"; + private const string InterfaceSteamMatchmaking = "SteamMatchmaking"; + private const string InterfaceSteamMatchmakingServers = "SteamMatchmakingServers"; + private const string InterfaceSteamMusic = "SteamMusic"; + private const string InterfaceSteamParties = "SteamParties"; + private const string InterfaceSteamRemoteStorage = "SteamRemoteStorage"; + private const string InterfaceSteamScreenshots = "SteamScreenshots"; + private const string InterfaceSteamUtils = "SteamUtils"; + private const string InterfaceSteamVideo = "SteamVideo"; public static bool IsAvailable => EnsureLoaded(); @@ -116,6 +464,9 @@ namespace OmegaLeo.HelperLib.Steamworks _initialized = false; _steamFriends = IntPtr.Zero; _steamUserStats = IntPtr.Zero; + _steamUgc = IntPtr.Zero; + _steamRemotePlay = IntPtr.Zero; + AdditionalInterfacePointers.Clear(); } } @@ -172,6 +523,854 @@ namespace OmegaLeo.HelperLib.Steamworks return _steamUserStatsGetAchievement?.Invoke(_steamUserStats, achievementId, out achieved) ?? false; } + public static ulong CreateQueryAllUgcRequest(uint queryType, uint matchingType, uint creatorAppId, uint consumerAppId, uint page) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcCreateQueryAllRequest?.Invoke(_steamUgc, queryType, matchingType, creatorAppId, consumerAppId, page) ?? 0; + } + + public static ulong SendQueryUgcRequest(ulong queryHandle) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcSendQueryRequest?.Invoke(_steamUgc, queryHandle) ?? 0; + } + + public static bool ReleaseQueryUgcRequest(ulong queryHandle) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcReleaseQueryRequest?.Invoke(_steamUgc, queryHandle) ?? false; + } + + public static uint GetNumSubscribedItems() + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcGetNumSubscribedItems?.Invoke(_steamUgc) ?? 0; + } + + public static ulong[] GetSubscribedItems(uint maxEntries) + { + if (!EnsureUgcReady() || maxEntries == 0) + { + return Array.Empty(); + } + + var buffer = new ulong[maxEntries]; + var count = _steamUgcGetSubscribedItems?.Invoke(_steamUgc, buffer, maxEntries) ?? 0; + if (count == 0) + { + return Array.Empty(); + } + + if (count == buffer.Length) + { + return buffer; + } + + var result = new ulong[count]; + Array.Copy(buffer, result, count); + return result; + } + + public static ulong SubscribeItem(ulong publishedFileId) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcSubscribeItem?.Invoke(_steamUgc, publishedFileId) ?? 0; + } + + public static ulong UnsubscribeItem(ulong publishedFileId) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcUnsubscribeItem?.Invoke(_steamUgc, publishedFileId) ?? 0; + } + + public static ulong CreateItem(uint consumerAppId, uint fileType) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcCreateItem?.Invoke(_steamUgc, consumerAppId, fileType) ?? 0; + } + + public static ulong StartItemUpdate(uint consumerAppId, ulong publishedFileId) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcStartItemUpdate?.Invoke(_steamUgc, consumerAppId, publishedFileId) ?? 0; + } + + public static bool SetItemTitle(ulong updateHandle, string title) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemTitle?.Invoke(_steamUgc, updateHandle, title) ?? false; + } + + public static bool SetItemDescription(ulong updateHandle, string description) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemDescription?.Invoke(_steamUgc, updateHandle, description) ?? false; + } + + public static bool SetItemMetadata(ulong updateHandle, string metadata) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemMetadata?.Invoke(_steamUgc, updateHandle, metadata) ?? false; + } + + public static bool SetItemVisibility(ulong updateHandle, uint visibility) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemVisibility?.Invoke(_steamUgc, updateHandle, visibility) ?? false; + } + + public static bool SetItemTags(ulong updateHandle, string[] tags) + { + if (!EnsureUgcReady() || tags == null) + { + return false; + } + + return WithSteamStringArray(tags, nativePtr => _steamUgcSetItemTags?.Invoke(_steamUgc, updateHandle, nativePtr) ?? false); + } + + public static bool SetItemContent(ulong updateHandle, string contentFolder) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemContent?.Invoke(_steamUgc, updateHandle, contentFolder) ?? false; + } + + public static bool SetItemPreview(ulong updateHandle, string previewFile) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemPreview?.Invoke(_steamUgc, updateHandle, previewFile) ?? false; + } + + public static ulong SubmitItemUpdate(ulong updateHandle, string changeNote) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcSubmitItemUpdate?.Invoke(_steamUgc, updateHandle, changeNote ?? string.Empty) ?? 0; + } + + public static uint GetItemUpdateProgress(ulong updateHandle, out ulong bytesProcessed, out ulong bytesTotal) + { + bytesProcessed = 0; + bytesTotal = 0; + + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcGetItemUpdateProgress?.Invoke(_steamUgc, updateHandle, out bytesProcessed, out bytesTotal) ?? 0; + } + + public static uint GetRemotePlaySessionCount() + { + if (!EnsureRemotePlayReady()) + { + return 0; + } + + return _steamRemotePlayGetSessionCount?.Invoke(_steamRemotePlay) ?? 0; + } + + public static uint GetRemotePlaySessionId(int sessionIndex) + { + if (!EnsureRemotePlayReady()) + { + return 0; + } + + return _steamRemotePlayGetSessionId?.Invoke(_steamRemotePlay, sessionIndex) ?? 0; + } + + public static ulong GetRemotePlaySessionSteamId(uint sessionId) + { + if (!EnsureRemotePlayReady()) + { + return 0; + } + + return _steamRemotePlayGetSessionSteamId?.Invoke(_steamRemotePlay, sessionId) ?? 0; + } + + public static string GetRemotePlaySessionClientName(uint sessionId) + { + if (!EnsureRemotePlayReady()) + { + return string.Empty; + } + + var namePtr = _steamRemotePlayGetSessionClientName?.Invoke(_steamRemotePlay, sessionId) ?? IntPtr.Zero; + return namePtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(namePtr) ?? string.Empty; + } + + public static int GetRemotePlaySessionClientFormFactor(uint sessionId) + { + if (!EnsureRemotePlayReady()) + { + return 0; + } + + return _steamRemotePlayGetSessionClientFormFactor?.Invoke(_steamRemotePlay, sessionId) ?? 0; + } + + public static bool TryGetRemotePlaySessionClientResolution(uint sessionId, out int resolutionX, out int resolutionY) + { + resolutionX = 0; + resolutionY = 0; + + if (!EnsureRemotePlayReady()) + { + return false; + } + + return _steamRemotePlayGetSessionClientResolution?.Invoke(_steamRemotePlay, sessionId, out resolutionX, out resolutionY) ?? false; + } + + public static bool IsSteamControllerAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamController); + + public static bool IsSteamFriendsAvailable() => EnsureFriendsReady(); + + public static bool IsSteamGameCoordinatorAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamGameCoordinator); + + public static bool IsSteamGameServerAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamGameServer); + + public static bool IsSteamGameServerStatsAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamGameServerStats); + + public static bool IsSteamHtmlSurfaceAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamHtmlSurface); + + public static bool IsSteamInputAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamInput); + + public static bool IsSteamInventoryAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamInventory); + + public static bool IsSteamMatchmakingAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking); + + public static bool IsSteamMatchmakingServersAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamMatchmakingServers); + + public static bool IsSteamMusicAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamMusic); + + public static bool IsSteamPartiesAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamParties); + + public static bool IsSteamRemoteStorageAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage); + + public static bool IsSteamScreenshotsAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots); + + public static bool IsSteamUserStatsAvailable() => EnsureUserStatsReady(); + + public static bool IsSteamUgcAvailable() => EnsureUgcReady(); + + public static bool IsSteamRemotePlayAvailable() => EnsureRemotePlayReady(); + + public static bool IsSteamUtilsAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamUtils); + + public static bool IsSteamVideoAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamVideo); + + public static int GetFriendCount(int friendFlags) + { + if (!EnsureFriendsReady()) + { + return 0; + } + + return _steamFriendsGetFriendCount?.Invoke(_steamFriends, friendFlags) ?? 0; + } + + public static string GetFriendPersonaName(ulong steamIdFriend) + { + if (!EnsureFriendsReady()) + { + return string.Empty; + } + + var namePtr = _steamFriendsGetFriendPersonaName?.Invoke(_steamFriends, steamIdFriend) ?? IntPtr.Zero; + return namePtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(namePtr) ?? string.Empty; + } + + public static void FriendsActivateGameOverlayInviteDialog(ulong steamIdLobby) + { + if (!EnsureFriendsReady()) + { + return; + } + + _steamFriendsActivateGameOverlayInviteDialog?.Invoke(_steamFriends, steamIdLobby); + } + + public static bool FriendsSetRichPresence(string key, string value) + { + if (!EnsureFriendsReady()) + { + return false; + } + + return _steamFriendsSetRichPresence?.Invoke(_steamFriends, key, value) ?? false; + } + + public static void FriendsClearRichPresence() + { + if (!EnsureFriendsReady()) + { + return; + } + + _steamFriendsClearRichPresence?.Invoke(_steamFriends); + } + + public static string FriendsGetFriendRichPresence(ulong steamIdFriend, string key) + { + if (!EnsureFriendsReady()) + { + return string.Empty; + } + + var valuePtr = _steamFriendsGetFriendRichPresence?.Invoke(_steamFriends, steamIdFriend, key) ?? IntPtr.Zero; + return valuePtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(valuePtr) ?? string.Empty; + } + + public static bool FriendsInviteUserToGame(ulong steamIdFriend, string connectString) + { + if (!EnsureFriendsReady()) + { + return false; + } + + return _steamFriendsInviteUserToGame?.Invoke(_steamFriends, steamIdFriend, connectString) ?? false; + } + + public static uint GetAppId() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamUtils)) + { + return 0; + } + + var steamUtils = GetAdditionalInterfacePointer(InterfaceSteamUtils); + return _steamUtilsGetAppId?.Invoke(steamUtils) ?? 0; + } + + public static string GetIpCountry() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamUtils)) + { + return string.Empty; + } + + var steamUtils = GetAdditionalInterfacePointer(InterfaceSteamUtils); + var countryPtr = _steamUtilsGetIpCountry?.Invoke(steamUtils) ?? IntPtr.Zero; + return countryPtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(countryPtr) ?? string.Empty; + } + + public static bool IsOverlayEnabled() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamUtils)) + { + return false; + } + + var steamUtils = GetAdditionalInterfacePointer(InterfaceSteamUtils); + return _steamUtilsIsOverlayEnabled?.Invoke(steamUtils) ?? false; + } + + public static bool RemoteStorageFileExists(string fileName) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageFileExists?.Invoke(steamRemoteStorage, fileName) ?? false; + } + + public static int RemoteStorageGetFileCount() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return 0; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageGetFileCount?.Invoke(steamRemoteStorage) ?? 0; + } + + public static bool RemoteStorageIsCloudEnabledForApp() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageIsCloudEnabledForApp?.Invoke(steamRemoteStorage) ?? false; + } + + public static bool RemoteStorageFileWrite(string fileName, byte[] data) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage) || data == null) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageFileWrite?.Invoke(steamRemoteStorage, fileName, data, data.Length) ?? false; + } + + public static bool RemoteStorageFileRead(string fileName, out byte[] data) + { + data = Array.Empty(); + + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + var size = _steamRemoteStorageGetFileSize?.Invoke(steamRemoteStorage, fileName) ?? -1; + if (size <= 0) + { + return false; + } + + var buffer = new byte[size]; + var bytesRead = _steamRemoteStorageFileRead?.Invoke(steamRemoteStorage, fileName, buffer, size) ?? 0; + if (bytesRead <= 0) + { + return false; + } + + if (bytesRead != size) + { + var resized = new byte[bytesRead]; + Array.Copy(buffer, resized, bytesRead); + data = resized; + return true; + } + + data = buffer; + return true; + } + + public static bool RemoteStorageFileDelete(string fileName) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageFileDelete?.Invoke(steamRemoteStorage, fileName) ?? false; + } + + public static int RemoteStorageGetFileSize(string fileName) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return 0; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageGetFileSize?.Invoke(steamRemoteStorage, fileName) ?? 0; + } + + public static bool InputInit(bool explicitlyCallRunFrame) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInput)) + { + return false; + } + + var steamInput = GetAdditionalInterfacePointer(InterfaceSteamInput); + return _steamInputInit?.Invoke(steamInput, explicitlyCallRunFrame) ?? false; + } + + public static bool InputShutdown() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInput)) + { + return false; + } + + var steamInput = GetAdditionalInterfacePointer(InterfaceSteamInput); + return _steamInputShutdown?.Invoke(steamInput) ?? false; + } + + public static void InputRunFrame() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInput)) + { + return; + } + + var steamInput = GetAdditionalInterfacePointer(InterfaceSteamInput); + _steamInputRunFrame?.Invoke(steamInput, false); + } + + public static bool InventoryLoadItemDefinitions() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInventory)) + { + return false; + } + + var steamInventory = GetAdditionalInterfacePointer(InterfaceSteamInventory); + return _steamInventoryLoadItemDefinitions?.Invoke(steamInventory) ?? false; + } + + public static bool InventoryGetAllItems(out int inventoryResultHandle) + { + inventoryResultHandle = 0; + + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInventory)) + { + return false; + } + + var steamInventory = GetAdditionalInterfacePointer(InterfaceSteamInventory); + return _steamInventoryGetAllItems?.Invoke(steamInventory, out inventoryResultHandle) ?? false; + } + + public static void InventoryDestroyResult(int inventoryResultHandle) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInventory)) + { + return; + } + + var steamInventory = GetAdditionalInterfacePointer(InterfaceSteamInventory); + _steamInventoryDestroyResult?.Invoke(steamInventory, inventoryResultHandle); + } + + public static ulong MatchmakingRequestLobbyList() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return 0; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + return _steamMatchmakingRequestLobbyList?.Invoke(steamMatchmaking) ?? 0; + } + + public static void MatchmakingAddRequestLobbyListResultCountFilter(int maxResults) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + _steamMatchmakingAddRequestLobbyListResultCountFilter?.Invoke(steamMatchmaking, maxResults); + } + + public static ulong MatchmakingCreateLobby(int lobbyType, int maxMembers) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return 0; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + return _steamMatchmakingCreateLobby?.Invoke(steamMatchmaking, lobbyType, maxMembers) ?? 0; + } + + public static ulong MatchmakingJoinLobby(ulong steamIdLobby) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return 0; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + return _steamMatchmakingJoinLobby?.Invoke(steamMatchmaking, steamIdLobby) ?? 0; + } + + public static void MatchmakingLeaveLobby(ulong steamIdLobby) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + _steamMatchmakingLeaveLobby?.Invoke(steamMatchmaking, steamIdLobby); + } + + public static int MatchmakingGetNumLobbyMembers(ulong steamIdLobby) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return 0; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + return _steamMatchmakingGetNumLobbyMembers?.Invoke(steamMatchmaking, steamIdLobby) ?? 0; + } + + public static uint ScreenshotsAddScreenshotToLibrary(string fileNameJpg, string fileNameThumbnail, int width, int height) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots)) + { + return 0; + } + + var steamScreenshots = GetAdditionalInterfacePointer(InterfaceSteamScreenshots); + return _steamScreenshotsAddScreenshotToLibrary?.Invoke(steamScreenshots, fileNameJpg, fileNameThumbnail, width, height) ?? 0; + } + + public static void ScreenshotsTriggerScreenshot() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots)) + { + return; + } + + var steamScreenshots = GetAdditionalInterfacePointer(InterfaceSteamScreenshots); + _steamScreenshotsTriggerScreenshot?.Invoke(steamScreenshots); + } + + public static void ScreenshotsHookScreenshots(bool hook) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots)) + { + return; + } + + var steamScreenshots = GetAdditionalInterfacePointer(InterfaceSteamScreenshots); + _steamScreenshotsHookScreenshots?.Invoke(steamScreenshots, hook); + } + + public static bool ScreenshotsIsScreenshotsHooked() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots)) + { + return false; + } + + var steamScreenshots = GetAdditionalInterfacePointer(InterfaceSteamScreenshots); + return _steamScreenshotsIsScreenshotsHooked?.Invoke(steamScreenshots) ?? false; + } + + public static bool MusicIsEnabled() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return false; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + return _steamMusicIsEnabled?.Invoke(steamMusic) ?? false; + } + + public static bool MusicIsPlaying() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return false; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + return _steamMusicIsPlaying?.Invoke(steamMusic) ?? false; + } + + public static void MusicPlay() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicPlay?.Invoke(steamMusic); + } + + public static void MusicPause() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicPause?.Invoke(steamMusic); + } + + public static void MusicPlayNext() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicPlayNext?.Invoke(steamMusic); + } + + public static void MusicPlayPrevious() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicPlayPrevious?.Invoke(steamMusic); + } + + public static float MusicGetVolume() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return 0f; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + return _steamMusicGetVolume?.Invoke(steamMusic) ?? 0f; + } + + public static void MusicSetVolume(float volume) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicSetVolume?.Invoke(steamMusic, volume); + } + + public static void VideoGetVideoUrl(uint videoAppId) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamVideo)) + { + return; + } + + var steamVideo = GetAdditionalInterfacePointer(InterfaceSteamVideo); + _steamVideoGetVideoUrl?.Invoke(steamVideo, videoAppId); + } + + public static bool VideoIsBroadcasting(out int numberOfViewers) + { + numberOfViewers = 0; + + if (!EnsureAdditionalInterfaceReady(InterfaceSteamVideo)) + { + return false; + } + + var steamVideo = GetAdditionalInterfacePointer(InterfaceSteamVideo); + return _steamVideoIsBroadcasting?.Invoke(steamVideo, out numberOfViewers) ?? false; + } + + public static ulong UserStatsRequestUserStats(ulong steamIdUser) + { + if (!EnsureUserStatsReady()) + { + return 0; + } + + return _steamUserStatsRequestUserStats?.Invoke(_steamUserStats, steamIdUser) ?? 0; + } + + public static ulong UserStatsRequestGlobalStats(int historyDays) + { + if (!EnsureUserStatsReady()) + { + return 0; + } + + return _steamUserStatsRequestGlobalStats?.Invoke(_steamUserStats, historyDays) ?? 0; + } + + public static bool UserStatsResetAllStats(bool achievementsToo) + { + if (!EnsureUserStatsReady()) + { + return false; + } + + return _steamUserStatsResetAllStats?.Invoke(_steamUserStats, achievementsToo) ?? false; + } + + public static bool UserStatsGetStatInt32(string name, out int data) + { + data = 0; + + if (!EnsureUserStatsReady()) + { + return false; + } + + return _steamUserStatsGetStatInt32?.Invoke(_steamUserStats, name, out data) ?? false; + } + + public static bool UserStatsSetStatInt32(string name, int data) + { + if (!EnsureUserStatsReady()) + { + return false; + } + + return _steamUserStatsSetStatInt32?.Invoke(_steamUserStats, name, data) ?? false; + } + private static bool EnsureReady() { if (!EnsureLoaded()) @@ -192,6 +1391,92 @@ namespace OmegaLeo.HelperLib.Steamworks return _steamFriends != IntPtr.Zero && _steamUserStats != IntPtr.Zero; } + private static bool EnsureFriendsReady() + { + if (!EnsureLoaded() || !_initialized) + { + return false; + } + + if (_steamFriends == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamFriends != IntPtr.Zero; + } + + private static bool EnsureUserStatsReady() + { + if (!EnsureLoaded() || !_initialized) + { + return false; + } + + if (_steamUserStats == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamUserStats != IntPtr.Zero; + } + + private static bool EnsureUgcReady() + { + if (!EnsureLoaded()) + { + return false; + } + + if (!_initialized) + { + return false; + } + + if (_steamUgc == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamUgc != IntPtr.Zero; + } + + private static bool EnsureRemotePlayReady() + { + if (!EnsureLoaded()) + { + return false; + } + + if (!_initialized) + { + return false; + } + + if (_steamRemotePlay == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamRemotePlay != IntPtr.Zero; + } + + private static bool EnsureAdditionalInterfaceReady(string key) + { + if (!EnsureLoaded() || !_initialized) + { + return false; + } + + if (!AdditionalInterfacePointers.TryGetValue(key, out var pointer) || pointer == IntPtr.Zero) + { + CacheAdditionalInterface(key); + AdditionalInterfacePointers.TryGetValue(key, out pointer); + } + + return pointer != IntPtr.Zero; + } + private static bool EnsureLoaded() { lock (SyncRoot) @@ -232,10 +1517,101 @@ namespace OmegaLeo.HelperLib.Steamworks _steamApiRunCallbacks = Bind("SteamAPI_RunCallbacks"); _steamFriendsAccessor = BindInterfaceAccessor("SteamFriends", "ISteamFriends"); _steamUserStatsAccessor = BindInterfaceAccessor("SteamUserStats", "ISteamUserStats"); + _steamUgcAccessor = BindInterfaceAccessor("SteamUGC", "ISteamUGC"); + _steamRemotePlayAccessor = BindInterfaceAccessor("SteamRemotePlay", "ISteamRemotePlay"); _steamFriendsGetPersonaName = Bind("SteamAPI_ISteamFriends_GetPersonaName"); _steamUserStatsSetAchievement = Bind("SteamAPI_ISteamUserStats_SetAchievement"); _steamUserStatsStoreStats = Bind("SteamAPI_ISteamUserStats_StoreStats"); _steamUserStatsGetAchievement = Bind("SteamAPI_ISteamUserStats_GetAchievement"); + _steamUgcCreateQueryAllRequest = Bind("SteamAPI_ISteamUGC_CreateQueryAllUGCRequest"); + _steamUgcSendQueryRequest = Bind("SteamAPI_ISteamUGC_SendQueryUGCRequest"); + _steamUgcReleaseQueryRequest = Bind("SteamAPI_ISteamUGC_ReleaseQueryUGCRequest"); + _steamUgcGetNumSubscribedItems = Bind("SteamAPI_ISteamUGC_GetNumSubscribedItems"); + _steamUgcGetSubscribedItems = Bind("SteamAPI_ISteamUGC_GetSubscribedItems"); + _steamUgcSubscribeItem = Bind("SteamAPI_ISteamUGC_SubscribeItem"); + _steamUgcUnsubscribeItem = Bind("SteamAPI_ISteamUGC_UnsubscribeItem"); + _steamUgcCreateItem = Bind("SteamAPI_ISteamUGC_CreateItem"); + _steamUgcStartItemUpdate = Bind("SteamAPI_ISteamUGC_StartItemUpdate"); + _steamUgcSetItemTitle = Bind("SteamAPI_ISteamUGC_SetItemTitle"); + _steamUgcSetItemDescription = Bind("SteamAPI_ISteamUGC_SetItemDescription"); + _steamUgcSetItemMetadata = Bind("SteamAPI_ISteamUGC_SetItemMetadata"); + _steamUgcSetItemVisibility = Bind("SteamAPI_ISteamUGC_SetItemVisibility"); + _steamUgcSetItemTags = Bind("SteamAPI_ISteamUGC_SetItemTags"); + _steamUgcSetItemContent = Bind("SteamAPI_ISteamUGC_SetItemContent"); + _steamUgcSetItemPreview = Bind("SteamAPI_ISteamUGC_SetItemPreview"); + _steamUgcSubmitItemUpdate = Bind("SteamAPI_ISteamUGC_SubmitItemUpdate"); + _steamUgcGetItemUpdateProgress = Bind("SteamAPI_ISteamUGC_GetItemUpdateProgress"); + _steamRemotePlayGetSessionCount = Bind("SteamAPI_ISteamRemotePlay_GetSessionCount"); + _steamRemotePlayGetSessionId = Bind("SteamAPI_ISteamRemotePlay_GetSessionID"); + _steamRemotePlayGetSessionSteamId = Bind("SteamAPI_ISteamRemotePlay_GetSessionSteamID"); + _steamRemotePlayGetSessionClientName = Bind("SteamAPI_ISteamRemotePlay_GetSessionClientName"); + _steamRemotePlayGetSessionClientFormFactor = Bind("SteamAPI_ISteamRemotePlay_GetSessionClientFormFactor"); + _steamRemotePlayGetSessionClientResolution = Bind("SteamAPI_ISteamRemotePlay_BGetSessionClientResolution"); + _steamFriendsGetFriendCount = Bind("SteamAPI_ISteamFriends_GetFriendCount"); + _steamFriendsGetFriendPersonaName = Bind("SteamAPI_ISteamFriends_GetFriendPersonaName"); + _steamFriendsActivateGameOverlayInviteDialog = Bind("SteamAPI_ISteamFriends_ActivateGameOverlayInviteDialog"); + _steamFriendsSetRichPresence = Bind("SteamAPI_ISteamFriends_SetRichPresence"); + _steamFriendsClearRichPresence = Bind("SteamAPI_ISteamFriends_ClearRichPresence"); + _steamFriendsGetFriendRichPresence = Bind("SteamAPI_ISteamFriends_GetFriendRichPresence"); + _steamFriendsInviteUserToGame = Bind("SteamAPI_ISteamFriends_InviteUserToGame"); + _steamUtilsGetAppId = Bind("SteamAPI_ISteamUtils_GetAppID"); + _steamUtilsGetIpCountry = Bind("SteamAPI_ISteamUtils_GetIPCountry"); + _steamUtilsIsOverlayEnabled = Bind("SteamAPI_ISteamUtils_IsOverlayEnabled"); + _steamRemoteStorageFileExists = Bind("SteamAPI_ISteamRemoteStorage_FileExists"); + _steamRemoteStorageGetFileCount = Bind("SteamAPI_ISteamRemoteStorage_GetFileCount"); + _steamRemoteStorageIsCloudEnabledForApp = Bind("SteamAPI_ISteamRemoteStorage_IsCloudEnabledForApp"); + _steamRemoteStorageFileWrite = Bind("SteamAPI_ISteamRemoteStorage_FileWrite"); + _steamRemoteStorageFileRead = Bind("SteamAPI_ISteamRemoteStorage_FileRead"); + _steamRemoteStorageFileDelete = Bind("SteamAPI_ISteamRemoteStorage_FileDelete"); + _steamRemoteStorageGetFileSize = Bind("SteamAPI_ISteamRemoteStorage_GetFileSize"); + _steamInputInit = Bind("SteamAPI_ISteamInput_Init"); + _steamInputShutdown = Bind("SteamAPI_ISteamInput_Shutdown"); + _steamInputRunFrame = Bind("SteamAPI_ISteamInput_RunFrame"); + _steamInventoryLoadItemDefinitions = Bind("SteamAPI_ISteamInventory_LoadItemDefinitions"); + _steamInventoryGetAllItems = Bind("SteamAPI_ISteamInventory_GetAllItems"); + _steamInventoryDestroyResult = Bind("SteamAPI_ISteamInventory_DestroyResult"); + _steamMatchmakingRequestLobbyList = Bind("SteamAPI_ISteamMatchmaking_RequestLobbyList"); + _steamMatchmakingAddRequestLobbyListResultCountFilter = Bind("SteamAPI_ISteamMatchmaking_AddRequestLobbyListResultCountFilter"); + _steamMatchmakingCreateLobby = Bind("SteamAPI_ISteamMatchmaking_CreateLobby"); + _steamMatchmakingJoinLobby = Bind("SteamAPI_ISteamMatchmaking_JoinLobby"); + _steamMatchmakingLeaveLobby = Bind("SteamAPI_ISteamMatchmaking_LeaveLobby"); + _steamMatchmakingGetNumLobbyMembers = Bind("SteamAPI_ISteamMatchmaking_GetNumLobbyMembers"); + _steamScreenshotsAddScreenshotToLibrary = Bind("SteamAPI_ISteamScreenshots_AddScreenshotToLibrary"); + _steamScreenshotsTriggerScreenshot = Bind("SteamAPI_ISteamScreenshots_TriggerScreenshot"); + _steamScreenshotsHookScreenshots = Bind("SteamAPI_ISteamScreenshots_HookScreenshots"); + _steamScreenshotsIsScreenshotsHooked = Bind("SteamAPI_ISteamScreenshots_IsScreenshotsHooked"); + _steamMusicIsEnabled = Bind("SteamAPI_ISteamMusic_BIsEnabled"); + _steamMusicIsPlaying = Bind("SteamAPI_ISteamMusic_BIsPlaying"); + _steamMusicPlay = Bind("SteamAPI_ISteamMusic_Play"); + _steamMusicPause = Bind("SteamAPI_ISteamMusic_Pause"); + _steamMusicPlayNext = Bind("SteamAPI_ISteamMusic_PlayNext"); + _steamMusicPlayPrevious = Bind("SteamAPI_ISteamMusic_PlayPrevious"); + _steamMusicGetVolume = Bind("SteamAPI_ISteamMusic_GetVolume"); + _steamMusicSetVolume = Bind("SteamAPI_ISteamMusic_SetVolume"); + _steamVideoGetVideoUrl = Bind("SteamAPI_ISteamVideo_GetVideoURL"); + _steamVideoIsBroadcasting = Bind("SteamAPI_ISteamVideo_IsBroadcasting"); + _steamUserStatsRequestUserStats = Bind("SteamAPI_ISteamUserStats_RequestUserStats"); + _steamUserStatsRequestGlobalStats = Bind("SteamAPI_ISteamUserStats_RequestGlobalStats"); + _steamUserStatsResetAllStats = Bind("SteamAPI_ISteamUserStats_ResetAllStats"); + _steamUserStatsGetStatInt32 = Bind("SteamAPI_ISteamUserStats_GetStatInt32"); + _steamUserStatsSetStatInt32 = Bind("SteamAPI_ISteamUserStats_SetStatInt32"); + + // Additional interface accessors requested for broad API coverage. + BindAdditionalInterfaceAccessor(InterfaceSteamController, "SteamController", "ISteamController"); + BindAdditionalInterfaceAccessor(InterfaceSteamGameCoordinator, "SteamGameCoordinator", "ISteamGameCoordinator"); + BindAdditionalInterfaceAccessor(InterfaceSteamGameServer, "SteamGameServer", "ISteamGameServer"); + BindAdditionalInterfaceAccessor(InterfaceSteamGameServerStats, "SteamGameServerStats", "ISteamGameServerStats"); + BindAdditionalInterfaceAccessor(InterfaceSteamHtmlSurface, "SteamHTMLSurface", "ISteamHTMLSurface"); + BindAdditionalInterfaceAccessor(InterfaceSteamInput, "SteamInput", "ISteamInput"); + BindAdditionalInterfaceAccessor(InterfaceSteamInventory, "SteamInventory", "ISteamInventory"); + BindAdditionalInterfaceAccessor(InterfaceSteamMatchmaking, "SteamMatchmaking", "ISteamMatchmaking"); + BindAdditionalInterfaceAccessor(InterfaceSteamMatchmakingServers, "SteamMatchmakingServers", "ISteamMatchmakingServers"); + BindAdditionalInterfaceAccessor(InterfaceSteamMusic, "SteamMusic", "ISteamMusic"); + BindAdditionalInterfaceAccessor(InterfaceSteamParties, "SteamParties", "ISteamParties"); + BindAdditionalInterfaceAccessor(InterfaceSteamRemoteStorage, "SteamRemoteStorage", "ISteamRemoteStorage"); + BindAdditionalInterfaceAccessor(InterfaceSteamScreenshots, "SteamScreenshots", "ISteamScreenshots"); + BindAdditionalInterfaceAccessor(InterfaceSteamUtils, "SteamUtils", "ISteamUtils"); + BindAdditionalInterfaceAccessor(InterfaceSteamVideo, "SteamVideo", "ISteamVideo"); } private static T Bind(string exportName) where T : class @@ -264,6 +1640,95 @@ namespace OmegaLeo.HelperLib.Steamworks { _steamFriends = _steamFriendsAccessor?.Invoke() ?? IntPtr.Zero; _steamUserStats = _steamUserStatsAccessor?.Invoke() ?? IntPtr.Zero; + _steamUgc = _steamUgcAccessor?.Invoke() ?? IntPtr.Zero; + _steamRemotePlay = _steamRemotePlayAccessor?.Invoke() ?? IntPtr.Zero; + + CacheAdditionalInterfaces(); + } + + private static void BindAdditionalInterfaceAccessor(string key, string friendlyName, string interfaceName) + { + AdditionalInterfaceAccessors[key] = BindInterfaceAccessor(friendlyName, interfaceName); + } + + private static void CacheAdditionalInterfaces() + { + foreach (var key in AdditionalInterfaceAccessors.Keys) + { + CacheAdditionalInterface(key); + } + } + + private static void CacheAdditionalInterface(string key) + { + if (!AdditionalInterfaceAccessors.TryGetValue(key, out var accessor)) + { + AdditionalInterfacePointers[key] = IntPtr.Zero; + return; + } + + AdditionalInterfacePointers[key] = accessor?.Invoke() ?? IntPtr.Zero; + } + + private static IntPtr GetAdditionalInterfacePointer(string key) + { + return AdditionalInterfacePointers.TryGetValue(key, out var pointer) ? pointer : IntPtr.Zero; + } + + [StructLayout(LayoutKind.Sequential)] + private struct SteamParamStringArrayNative + { + public IntPtr Strings; + public int NumStrings; + } + + private static bool WithSteamStringArray(string[] values, Func action) + { + var stringPointers = new IntPtr[values.Length]; + IntPtr arrayPtr = IntPtr.Zero; + IntPtr structPtr = IntPtr.Zero; + + try + { + for (var i = 0; i < values.Length; i++) + { + stringPointers[i] = Marshal.StringToHGlobalAnsi(values[i] ?? string.Empty); + } + + arrayPtr = Marshal.AllocHGlobal(IntPtr.Size * values.Length); + Marshal.Copy(stringPointers, 0, arrayPtr, values.Length); + + var native = new SteamParamStringArrayNative + { + Strings = arrayPtr, + NumStrings = values.Length + }; + + structPtr = Marshal.AllocHGlobal(Marshal.SizeOf()); + Marshal.StructureToPtr(native, structPtr, false); + + return action(structPtr); + } + finally + { + if (structPtr != IntPtr.Zero) + { + Marshal.FreeHGlobal(structPtr); + } + + if (arrayPtr != IntPtr.Zero) + { + Marshal.FreeHGlobal(arrayPtr); + } + + for (var i = 0; i < stringPointers.Length; i++) + { + if (stringPointers[i] != IntPtr.Zero) + { + Marshal.FreeHGlobal(stringPointers[i]); + } + } + } } private static string[] GetLibraryCandidates() diff --git a/OmegaLeo.HelperLib.Steamworks/SteamRemotePlayManager.cs b/OmegaLeo.HelperLib.Steamworks/SteamRemotePlayManager.cs new file mode 100644 index 0000000..1f2841a --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamRemotePlayManager.cs @@ -0,0 +1,49 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamRemotePlayManager), "Provides helper methods for Steam Remote Play session inspection.", null, + @"```csharp +var remotePlay = SteamManager.Instance.RemotePlay; +var sessionCount = remotePlay.GetSessionCount(); +```")] + public class SteamRemotePlayManager + { + [Documentation(nameof(GetSessionCount), "Gets the number of active Remote Play sessions for the current user.", null, null)] + public uint GetSessionCount() + { + return SteamNativeApi.GetRemotePlaySessionCount(); + } + + [Documentation(nameof(GetSessionId), "Gets a Remote Play session ID by zero-based session index.", new[] { "sessionIndex: Zero-based index into the active sessions list." }, null)] + public uint GetSessionId(int sessionIndex) + { + return SteamNativeApi.GetRemotePlaySessionId(sessionIndex); + } + + [Documentation(nameof(GetSessionSteamId), "Gets the SteamID for the remote user in a session.", new[] { "sessionId: Remote Play session ID." }, null)] + public ulong GetSessionSteamId(uint sessionId) + { + return SteamNativeApi.GetRemotePlaySessionSteamId(sessionId); + } + + [Documentation(nameof(GetSessionClientName), "Gets the client device name for a remote session.", new[] { "sessionId: Remote Play session ID." }, null)] + public string GetSessionClientName(uint sessionId) + { + return SteamNativeApi.GetRemotePlaySessionClientName(sessionId); + } + + [Documentation(nameof(GetSessionClientFormFactor), "Gets the client form-factor value for a session (matches Steam's ESteamDeviceFormFactor numeric values).", new[] { "sessionId: Remote Play session ID." }, null)] + public int GetSessionClientFormFactor(uint sessionId) + { + return SteamNativeApi.GetRemotePlaySessionClientFormFactor(sessionId); + } + + [Documentation(nameof(TryGetSessionClientResolution), "Gets the streaming client resolution for a session.", new[] { "sessionId: Remote Play session ID.", "resolutionX: Width output.", "resolutionY: Height output." }, null)] + public bool TryGetSessionClientResolution(uint sessionId, out int resolutionX, out int resolutionY) + { + return SteamNativeApi.TryGetRemotePlaySessionClientResolution(sessionId, out resolutionX, out resolutionY); + } + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateOptions.cs b/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateOptions.cs new file mode 100644 index 0000000..98ccc30 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateOptions.cs @@ -0,0 +1,30 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamUgcItemUpdateOptions), "Declarative update payload for workshop item editing convenience APIs.", null, null)] + public class SteamUgcItemUpdateOptions + { + [Documentation(nameof(Title), "Workshop item title.", null, null)] + public string Title { get; set; } + + [Documentation(nameof(Description), "Workshop item description.", null, null)] + public string Description { get; set; } + + [Documentation(nameof(Metadata), "Workshop item metadata string.", null, null)] + public string Metadata { get; set; } + + [Documentation(nameof(Visibility), "Numeric ERemoteStoragePublishedFileVisibility value.", null, null)] + public uint? Visibility { get; set; } + + [Documentation(nameof(Tags), "Workshop tag list.", null, null)] + public string[] Tags { get; set; } + + [Documentation(nameof(ContentFolder), "Absolute path to workshop content folder.", null, null)] + public string ContentFolder { get; set; } + + [Documentation(nameof(PreviewFile), "Absolute path to workshop preview image.", null, null)] + public string PreviewFile { get; set; } + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateSession.cs b/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateSession.cs new file mode 100644 index 0000000..7409fd8 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateSession.cs @@ -0,0 +1,73 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamUgcItemUpdateSession), "Fluent helper for editing and submitting a workshop item update.", null, null)] + public class SteamUgcItemUpdateSession + { + private readonly SteamUgcManager _ugcManager; + private readonly uint _consumerAppId; + private readonly ulong _publishedFileId; + private readonly SteamUgcItemUpdateOptions _options = new SteamUgcItemUpdateOptions(); + + internal SteamUgcItemUpdateSession(SteamUgcManager ugcManager, uint consumerAppId, ulong publishedFileId) + { + _ugcManager = ugcManager; + _consumerAppId = consumerAppId; + _publishedFileId = publishedFileId; + } + + public SteamUgcItemUpdateSession WithTitle(string title) + { + _options.Title = title; + return this; + } + + public SteamUgcItemUpdateSession WithDescription(string description) + { + _options.Description = description; + return this; + } + + public SteamUgcItemUpdateSession WithMetadata(string metadata) + { + _options.Metadata = metadata; + return this; + } + + public SteamUgcItemUpdateSession WithVisibility(uint visibility) + { + _options.Visibility = visibility; + return this; + } + + public SteamUgcItemUpdateSession WithTags(params string[] tags) + { + _options.Tags = tags; + return this; + } + + public SteamUgcItemUpdateSession WithContentFolder(string contentFolder) + { + _options.ContentFolder = contentFolder; + return this; + } + + public SteamUgcItemUpdateSession WithPreviewFile(string previewFile) + { + _options.PreviewFile = previewFile; + return this; + } + + [Documentation(nameof(Submit), "Submits the fluent update session and returns a Steam API call handle.", new[] + { + "changeNote: Changelog note for this update.", + "failedStep: Name of the failed step if submission returns 0." + }, null)] + public ulong Submit(string changeNote, out string failedStep) + { + return _ugcManager.UpdateItem(_consumerAppId, _publishedFileId, _options, changeNote, out failedStep); + } + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamUgcManager.cs b/OmegaLeo.HelperLib.Steamworks/SteamUgcManager.cs new file mode 100644 index 0000000..7deda32 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamUgcManager.cs @@ -0,0 +1,240 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamUgcManager), "Provides helper methods for common Steam Workshop (UGC) operations such as queries and subscriptions.", null, + @"```csharp +var ugc = new SteamUgcManager(); +var items = ugc.GetSubscribedItems(); +```")] + public class SteamUgcManager + { + [Documentation(nameof(BeginUpdateSession), "Begins a fluent UGC update session for an existing workshop item.", new[] + { + "consumerAppId: Your game AppId.", + "publishedFileId: Existing workshop item ID." + }, null)] + public SteamUgcItemUpdateSession BeginUpdateSession(uint consumerAppId, ulong publishedFileId) + { + return new SteamUgcItemUpdateSession(this, consumerAppId, publishedFileId); + } + + [Documentation(nameof(ApplyItemUpdate), "Applies all non-null/non-empty fields from a UGC update options object to an existing update handle.", new[] + { + "updateHandle: Handle from StartItemUpdate.", + "options: Options object containing fields to apply.", + "failedStep: Name of the field that failed to apply, if any." + }, null)] + public bool ApplyItemUpdate(ulong updateHandle, SteamUgcItemUpdateOptions options, out string failedStep) + { + failedStep = string.Empty; + + if (updateHandle == 0 || options == null) + { + failedStep = "InvalidArguments"; + return false; + } + + if (!string.IsNullOrWhiteSpace(options.Title) && !SetItemTitle(updateHandle, options.Title)) + { + failedStep = nameof(options.Title); + return false; + } + + if (!string.IsNullOrWhiteSpace(options.Description) && !SetItemDescription(updateHandle, options.Description)) + { + failedStep = nameof(options.Description); + return false; + } + + if (!string.IsNullOrWhiteSpace(options.Metadata) && !SetItemMetadata(updateHandle, options.Metadata)) + { + failedStep = nameof(options.Metadata); + return false; + } + + if (options.Visibility.HasValue && !SetItemVisibility(updateHandle, options.Visibility.Value)) + { + failedStep = nameof(options.Visibility); + return false; + } + + if (options.Tags != null && options.Tags.Length > 0 && !SetItemTags(updateHandle, options.Tags)) + { + failedStep = nameof(options.Tags); + return false; + } + + if (!string.IsNullOrWhiteSpace(options.ContentFolder) && !SetItemContent(updateHandle, options.ContentFolder)) + { + failedStep = nameof(options.ContentFolder); + return false; + } + + if (!string.IsNullOrWhiteSpace(options.PreviewFile) && !SetItemPreview(updateHandle, options.PreviewFile)) + { + failedStep = nameof(options.PreviewFile); + return false; + } + + return true; + } + + [Documentation(nameof(UpdateItem), "Convenience method that starts an item update, applies option fields, and submits the update in one call.", new[] + { + "consumerAppId: Your game AppId.", + "publishedFileId: Existing workshop item ID.", + "options: Options object containing fields to update.", + "changeNote: Changelog note for submission.", + "failedStep: Name of the failed step when the call returns 0." + }, null)] + public ulong UpdateItem(uint consumerAppId, ulong publishedFileId, SteamUgcItemUpdateOptions options, string changeNote, out string failedStep) + { + failedStep = string.Empty; + + var updateHandle = StartItemUpdate(consumerAppId, publishedFileId); + if (updateHandle == 0) + { + failedStep = nameof(StartItemUpdate); + return 0; + } + + if (!ApplyItemUpdate(updateHandle, options, out failedStep)) + { + return 0; + } + + var submitHandle = SubmitItemUpdate(updateHandle, changeNote); + if (submitHandle == 0) + { + failedStep = nameof(SubmitItemUpdate); + } + + return submitHandle; + } + + [Documentation(nameof(CreateItem), "Creates a new Workshop item and returns a Steam API call handle.", new[] + { + "consumerAppId: Your game AppId.", + "fileType: Numeric EWorkshopFileType value." + }, null)] + public ulong CreateItem(uint consumerAppId, uint fileType) + { + return SteamNativeApi.CreateItem(consumerAppId, fileType); + } + + [Documentation(nameof(StartItemUpdate), "Starts an update transaction for an existing Workshop item.", new[] + { + "consumerAppId: Your game AppId.", + "publishedFileId: Existing workshop item ID." + }, null)] + public ulong StartItemUpdate(uint consumerAppId, ulong publishedFileId) + { + return SteamNativeApi.StartItemUpdate(consumerAppId, publishedFileId); + } + + [Documentation(nameof(SetItemTitle), "Sets workshop item title for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "title: New item title." }, null)] + public bool SetItemTitle(ulong updateHandle, string title) + { + return SteamNativeApi.SetItemTitle(updateHandle, title); + } + + [Documentation(nameof(SetItemDescription), "Sets workshop item description for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "description: New item description." }, null)] + public bool SetItemDescription(ulong updateHandle, string description) + { + return SteamNativeApi.SetItemDescription(updateHandle, description); + } + + [Documentation(nameof(SetItemMetadata), "Sets workshop item metadata for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "metadata: Metadata string (up to Steam's size limits)." }, null)] + public bool SetItemMetadata(ulong updateHandle, string metadata) + { + return SteamNativeApi.SetItemMetadata(updateHandle, metadata); + } + + [Documentation(nameof(SetItemVisibility), "Sets workshop item visibility for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "visibility: Numeric ERemoteStoragePublishedFileVisibility value." }, null)] + public bool SetItemVisibility(ulong updateHandle, uint visibility) + { + return SteamNativeApi.SetItemVisibility(updateHandle, visibility); + } + + [Documentation(nameof(SetItemTags), "Sets workshop item tags for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "tags: Array of tag strings." }, null)] + public bool SetItemTags(ulong updateHandle, string[] tags) + { + return SteamNativeApi.SetItemTags(updateHandle, tags); + } + + [Documentation(nameof(SetItemContent), "Sets workshop item content folder path for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "contentFolder: Absolute path to content folder." }, null)] + public bool SetItemContent(ulong updateHandle, string contentFolder) + { + return SteamNativeApi.SetItemContent(updateHandle, contentFolder); + } + + [Documentation(nameof(SetItemPreview), "Sets workshop item preview image path for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "previewFile: Absolute path to preview image file." }, null)] + public bool SetItemPreview(ulong updateHandle, string previewFile) + { + return SteamNativeApi.SetItemPreview(updateHandle, previewFile); + } + + [Documentation(nameof(SubmitItemUpdate), "Submits a pending workshop item update and returns a Steam API call handle.", new[] { "updateHandle: Handle from StartItemUpdate.", "changeNote: Changelog note for the update." }, null)] + public ulong SubmitItemUpdate(ulong updateHandle, string changeNote) + { + return SteamNativeApi.SubmitItemUpdate(updateHandle, changeNote); + } + + [Documentation(nameof(GetItemUpdateProgress), "Gets progress state for a pending item update upload.", new[] { "updateHandle: Handle from StartItemUpdate.", "bytesProcessed: Uploaded bytes output.", "bytesTotal: Total bytes output." }, null)] + public uint GetItemUpdateProgress(ulong updateHandle, out ulong bytesProcessed, out ulong bytesTotal) + { + return SteamNativeApi.GetItemUpdateProgress(updateHandle, out bytesProcessed, out bytesTotal); + } + + [Documentation(nameof(CreateQueryAllUgcRequest), "Creates a UGC query request handle for workshop discovery.", new[] + { + "queryType: Numeric EUGCQuery value from Steamworks docs.", + "matchingType: Numeric EUGCMatchingUGCType value from Steamworks docs.", + "creatorAppId: AppId filter for creator app.", + "consumerAppId: AppId filter for consumer app.", + "page: Query page number, starting at 1." + }, null)] + public ulong CreateQueryAllUgcRequest(uint queryType, uint matchingType, uint creatorAppId, uint consumerAppId, uint page = 1) + { + return SteamNativeApi.CreateQueryAllUgcRequest(queryType, matchingType, creatorAppId, consumerAppId, page); + } + + [Documentation(nameof(SendQueryUgcRequest), "Submits an existing UGC query request and returns a Steam API call handle.", new[] { "queryHandle: UGC query handle returned from CreateQueryAllUgcRequest." }, null)] + public ulong SendQueryUgcRequest(ulong queryHandle) + { + return SteamNativeApi.SendQueryUgcRequest(queryHandle); + } + + [Documentation(nameof(ReleaseQueryUgcRequest), "Releases a UGC query handle after you are done with query results.", new[] { "queryHandle: UGC query handle to release." }, null)] + public bool ReleaseQueryUgcRequest(ulong queryHandle) + { + return SteamNativeApi.ReleaseQueryUgcRequest(queryHandle); + } + + [Documentation(nameof(GetNumSubscribedItems), "Gets the number of workshop items the current user is subscribed to.", null, null)] + public uint GetNumSubscribedItems() + { + return SteamNativeApi.GetNumSubscribedItems(); + } + + [Documentation(nameof(GetSubscribedItems), "Gets subscribed workshop item IDs for the current user.", new[] { "maxEntries: Maximum number of subscribed IDs to retrieve." }, null)] + public ulong[] GetSubscribedItems(uint maxEntries = 1024) + { + return SteamNativeApi.GetSubscribedItems(maxEntries); + } + + [Documentation(nameof(SubscribeItem), "Subscribes the current user to a workshop item.", new[] { "publishedFileId: Published file ID of the workshop item." }, null)] + public ulong SubscribeItem(ulong publishedFileId) + { + return SteamNativeApi.SubscribeItem(publishedFileId); + } + + [Documentation(nameof(UnsubscribeItem), "Unsubscribes the current user from a workshop item.", new[] { "publishedFileId: Published file ID of the workshop item." }, null)] + public ulong UnsubscribeItem(ulong publishedFileId) + { + return SteamNativeApi.UnsubscribeItem(publishedFileId); + } + } +} + diff --git a/OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml b/OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml index d896565..7fb739a 100755 --- a/OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml +++ b/OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml @@ -81,9 +81,44 @@ @foreach (var desc in classDoc.Descriptions) { + var methodParameters = desc.MethodParameters ?? Array.Empty(); + var attributeParameters = desc.Parameters ?? Array.Empty(); + var methodParameterSet = new HashSet(methodParameters, StringComparer.OrdinalIgnoreCase); + var filteredAttributeParameters = attributeParameters + .Where(p => !methodParameterSet.Contains(p)) + .Distinct(StringComparer.OrdinalIgnoreCase) + .ToArray(); + @desc.Title @Html.Raw(Markdig.Markdown.ToHtml(desc.Description))
+ @if (desc.ReturnType.IsNotNullOrEmpty()) + { + Returns: @desc.ReturnType
+ } + + @if (methodParameters.Any()) + { + Parameters: +
    + @foreach (var methodParameter in methodParameters) + { +
  • @methodParameter
    • + } +
+ } + + @if (filteredAttributeParameters.Any()) + { + Attribute Args: +
    + @foreach (var attributeParameter in filteredAttributeParameters) + { +
  • @attributeParameter
    • + } +
+ } + @if (desc.CodeExample.IsNotNullOrEmpty()) { Example:
diff --git a/OmegaLeo.HelperLib.Web/Views/Shared/_Layout.cshtml b/OmegaLeo.HelperLib.Web/Views/Shared/_Layout.cshtml index 5cce3cb..8ff3042 100755 --- a/OmegaLeo.HelperLib.Web/Views/Shared/_Layout.cshtml +++ b/OmegaLeo.HelperLib.Web/Views/Shared/_Layout.cshtml @@ -39,6 +39,9 @@
  • Shared Components
    • +
  • + Steamworks +