Steamworks Library
Steamworks Library
Helpers for integrating with the Steamworks API
OmegaLeo.HelperLib.Steamworks
AchievementManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
AchievementManager |
Provides helper methods for unlocking and querying Steam achievements. Example: var achievements = new AchievementManager(logger); achievements.UnlockAchievement("ACH_WIN_ONE_GAME"); |
UnlockAchievement |
Attempts to unlock the provided achievement and store user stats. Returns: voidParameters:
|
IsAchievementUnlocked |
Checks whether a Steam achievement is currently unlocked. Returns: boolParameters:
|
SteamApiCallResult
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamApiCallResult |
The completed result of an asynchronous Steam API call (SteamAPICall_t). |
ApiCall |
The SteamAPICall_t handle this result belongs to. |
CallbackId |
The callback id of the result struct (for example SteamCallbackIds.SubmitItemUpdateResult). |
IoFailure |
True when Steam reported a failure fetching the result, or Steam was shut down before it completed. The payload is then not valid. |
Payload |
Raw bytes of the native callback struct, copied before Steam frees it. |
ReadByte |
Reads a byte at the given offset, or 0 when out of range. Returns: byteParameters:
|
ReadBoolean |
Reads a one-byte C++ bool at the given offset. Returns: boolParameters:
|
ReadInt32 |
Reads a 32-bit signed integer at the given offset, or 0 when out of range. Returns: intParameters:
|
ReadUInt32 |
Reads a 32-bit unsigned integer at the given offset, or 0 when out of range. Returns: uintParameters:
|
ReadUInt64 |
Reads a 64-bit unsigned integer at the given offset, or 0 when out of range. Returns: ulongParameters:
|
ReadString |
Reads a NUL-terminated UTF-8 char array field. Returns: stringParameters:
|
SteamAppsManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamAppsManager |
Provides ownership, DLC and language queries from ISteamApps. Example: var apps = SteamManager.Instance.Apps; if (apps.BIsSubscribedApp(5498630)) { /* user owns the demo */ } var language = apps.GetCurrentGameLanguage(); // e.g. "english" |
BIsSubscribed |
Checks whether the current user owns (is subscribed to) the running app. Returns: bool |
BIsSubscribedApp |
Checks whether the current user owns the given app, for example a related demo or another of your games. Returns: boolParameters:
|
BIsDlcInstalled |
Checks whether the user owns the given DLC and it is installed. Returns: boolParameters:
|
BIsAppInstalled |
Checks whether the given app is installed on this machine. Returns: boolParameters:
|
GetCurrentGameLanguage |
Gets the language the user selected for this game in Steam (API language code such as "english"), or an empty string when unavailable. Returns: string |
GetAvailableGameLanguages |
Gets a comma-separated list of the languages the game supports. Returns: string |
GetAppBuildId |
Gets the Steam build id of the installed depot. Returns: int |
SteamCallbackData
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamCallbackData |
A Steam callback received through manual dispatch. |
CallbackId |
The callback id (k_iCallback) of the native struct. |
SteamUser |
The HSteamUser the callback was posted for. |
Payload |
Raw bytes of the native callback struct, copied before Steam frees it. |
ReadByte |
Reads a byte at the given offset, or 0 when out of range. Returns: byteParameters:
|
ReadBoolean |
Reads a one-byte C++ bool at the given offset. Returns: boolParameters:
|
ReadInt32 |
Reads a 32-bit signed integer at the given offset, or 0 when out of range. Returns: intParameters:
|
ReadUInt32 |
Reads a 32-bit unsigned integer at the given offset, or 0 when out of range. Returns: uintParameters:
|
ReadUInt64 |
Reads a 64-bit unsigned integer at the given offset, or 0 when out of range. Returns: ulongParameters:
|
ReadString |
Reads a NUL-terminated UTF-8 char array field. Returns: stringParameters:
|
SteamCallbackDispatcher
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamCallbackDispatcher |
Runs the Steam manual callback dispatch loop and delivers callbacks and async call results. Access it through SteamManager.Instance.Callbacks; it is pumped by SteamManager.Update(). Example: var steam = SteamManager.Instance; steam.Callbacks.OverlayActivated += overlay => Pause(overlay.Active); using var sub = steam.Callbacks.Subscribe(SteamCallbackIds.GameOverlayActivated, data => Log(data.ReadBoolean(0))); var result = await steam.Callbacks.WaitForCallResultAsync(apiCallHandle); |
UsesLargeCallbackPack |
True when Steam callback structs use 8-byte packing (Windows). Linux, Steam Deck and macOS use 4-byte packing, which moves 64-bit fields in some structs. |
IsManualDispatchActive |
True when manual dispatch is running, so callbacks and async call results are delivered. |
PendingCallResultCount |
Number of async call handles still waiting for a result. |
Subscribe |
Subscribes to every callback with the given id. The handler receives a copy of the raw payload. Dispose the returned object to unsubscribe. Returns: IDisposableParameters:
|
Unsubscribe |
Removes a handler added with Subscribe. Returns: boolParameters:
|
RegisterCallResult |
Registers a handler for the result of an async Steam API call. The handler runs once, from SteamManager.Update(). Returns false when the handle is invalid or manual dispatch is not active. Returns: boolParameters:
|
WaitForCallResultAsync |
Returns a task that completes with the result of an async Steam API call. Keep calling SteamManager.Update() while waiting. Faults with InvalidOperationException when manual dispatch is not active. Returns: Task<SteamApiCallResult>Parameters:
|
SteamCallbackIds
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamCallbackIds |
Steamworks callback ids (the k_iCallback value of each callback struct) used by this library. |
GameOverlayActivated |
GameOverlayActivated_t (k_iSteamFriendsCallbacks + 31). |
SteamApiCallCompleted |
SteamAPICallCompleted_t (k_iSteamUtilsCallbacks + 3). Handled internally to deliver async call results. |
SteamUgcQueryCompleted |
SteamUGCQueryCompleted_t (k_iSteamUGCCallbacks + 1), the result of SendQueryUGCRequest. |
CreateItemResult |
CreateItemResult_t (k_iSteamUGCCallbacks + 3), the result of CreateItem. |
SubmitItemUpdateResult |
SubmitItemUpdateResult_t (k_iSteamUGCCallbacks + 4), the result of SubmitItemUpdate. |
SteamCallbackPayload
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamCallbackPayload |
Base class for a copied Steam callback payload with little-endian field readers. Offsets follow the native struct layout for the current platform (see SteamCallbackDispatcher.UsesLargeCallbackPack). |
Payload |
Raw bytes of the native callback struct, copied before Steam frees it. |
ReadByte |
Reads a byte at the given offset, or 0 when out of range. Returns: byteParameters:
|
ReadBoolean |
Reads a one-byte C++ bool at the given offset. Returns: boolParameters:
|
ReadInt32 |
Reads a 32-bit signed integer at the given offset, or 0 when out of range. Returns: intParameters:
|
ReadUInt32 |
Reads a 32-bit unsigned integer at the given offset, or 0 when out of range. Returns: uintParameters:
|
ReadUInt64 |
Reads a 64-bit unsigned integer at the given offset, or 0 when out of range. Returns: ulongParameters:
|
ReadString |
Reads a NUL-terminated UTF-8 char array field. Returns: stringParameters:
|
SteamControllerManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamControllerManager |
Provides access checks for ISteamController. |
SteamFriendsManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamFriendsManager |
Provides access checks for ISteamFriends. |
GetFriendCount |
Gets the friend count filtered by Steam friend flags. Returns: intParameters:
|
GetFriendPersonaName |
Gets the persona name of a friend by SteamID64. Returns: stringParameters:
|
ActivateGameOverlayInviteDialog |
Opens the Steam invite dialog for a lobby. Returns: voidParameters:
|
SetRichPresence |
Sets a rich presence key/value pair for the local user. Returns: boolParameters:
|
ClearRichPresence |
Clears all rich presence values for the local user. Returns: void |
GetFriendRichPresence |
Gets a rich presence value for a specific friend. Returns: stringParameters:
|
InviteUserToGame |
Invites a friend to the current game session using a connect string. Returns: boolParameters:
|
SteamGameCoordinatorManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamGameCoordinatorManager |
Provides access checks for ISteamGameCoordinator. |
SteamGameServerManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamGameServerManager |
Provides access checks for ISteamGameServer. |
SteamGameServerStatsManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamGameServerStatsManager |
Provides access checks for ISteamGameServerStats. |
SteamHtmlSurfaceManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamHtmlSurfaceManager |
Provides access checks for ISteamHTMLSurface. |
SteamInputManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamInputManager |
Provides access checks for ISteamInput. |
Init |
Initializes Steam Input for the application. Returns: boolParameters:
|
Shutdown |
Shuts down Steam Input. Returns: bool |
RunFrame |
Runs a Steam Input frame update. Returns: void |
SteamInventoryManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamInventoryManager |
Provides access checks for ISteamInventory. |
LoadItemDefinitions |
Requests latest inventory item definitions from Steam. Returns: bool |
GetAllItems |
Requests all inventory items and returns a result handle. Returns: boolParameters:
|
DestroyResult |
Releases an inventory result handle returned from Steam Inventory API calls. Returns: voidParameters:
|
SteamManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamManager |
Manages Steamworks initialization, callback dispatch, and shutdown for applications using the Steam API. Example: SteamManager.ConfigureLogger(logger); SteamManager.ConfigureLibraryPath(pluginFolder); if (SteamManager.RestartAppIfNecessary(480)) { Quit(); return; } var steam = SteamManager.Instance; steam.OverlayActivated += overlay => Pause(overlay.Active); steam.Update(); |
Instance |
Singleton access to the Steam manager. |
IsSteamworksInitialized |
Indicates whether Steamworks is initialized and ready for API calls. |
InitErrorMessage |
The reason initialization failed, as reported by SteamAPI_InitFlat when available. Empty after a successful init. |
Callbacks |
Provides callback subscriptions and async call results through manual dispatch. |
Apps |
Provides access to ISteamApps bindings (ownership, DLC, language). |
Ugc |
Provides access to Steam Workshop (UGC) helper operations. |
RemotePlay |
Provides access to Steam Remote Play helper operations. |
Controller |
Provides access to ISteamController bindings. |
Friends |
Provides access to ISteamFriends bindings. |
GameCoordinator |
Provides access to ISteamGameCoordinator bindings. |
GameServer |
Provides access to ISteamGameServer bindings. |
GameServerStats |
Provides access to ISteamGameServerStats bindings. |
HtmlSurface |
Provides access to ISteamHTMLSurface bindings. |
Input |
Provides access to ISteamInput bindings. |
Inventory |
Provides access to ISteamInventory bindings. |
Matchmaking |
Provides access to ISteamMatchmaking bindings. |
MatchmakingServers |
Provides access to ISteamMatchmakingServers bindings. |
Music |
Provides access to ISteamMusic bindings. |
Parties |
Provides access to ISteamParties bindings. |
RemoteStorage |
Provides access to ISteamRemoteStorage bindings. |
Screenshots |
Provides access to ISteamScreenshots bindings. |
UserStats |
Provides access to ISteamUserStats bindings. |
Utils |
Provides access to ISteamUtils bindings. |
Video |
Provides access to ISteamVideo bindings. |
ConfigureLogger |
Configures the logger used by Steamworks helper classes. Returns: voidParameters:
|
ConfigureLibraryPath |
Adds a folder (or full file path) to search first for the Steam API native library (steam_api64.dll / libsteam_api.so / libsteam_api.dylib). Can be called several times; paths are tried in order, then the default locations. Must be called before Instance or RestartAppIfNecessary. Returns false when the library is already loaded. Returns: boolParameters:
SteamManager.ConfigureLibraryPath(Path.Combine(gameDataFolder, "Plugins", "x86_64")); |
ConfigureManualDispatch |
Enables or disables manual callback dispatch (enabled by default). When disabled, Update() uses SteamAPI_RunCallbacks and no callback events or async call results are delivered. Must be called before Instance. Returns: boolParameters:
|
RestartAppIfNecessary |
Calls SteamAPI_RestartAppIfNecessary. Returns true when the game was not launched through Steam and Steam is relaunching it: quit immediately in that case. Call it before Instance and before ConfigureAppId (steam_appid.txt, and possibly the SteamAppId environment variable, suppress the relaunch). Returns false when the native library cannot be loaded. Returns: boolParameters:
if (SteamManager.RestartAppIfNecessary(480)) { Quit(); return; } |
ConfigureAppId |
Configures the Steam AppId used during initialization by setting the SteamAppId/SteamGameId environment variables. Does not write steam_appid.txt. Must be called before accessing the singleton instance. Returns: boolParameters:
|
ConfigureAppId |
Configures the Steam AppId used during initialization. Optionally writes steam_appid.txt next to the executable and in the working directory (useful in editors and development builds; leave false for shipped builds). Must be called before accessing the singleton instance. Returns: boolParameters:
|
Update |
Executes Steamworks callbacks (manual dispatch, or SteamAPI_RunCallbacks when manual dispatch is unavailable) and delivers events and async call results. Call every frame from your game loop's main thread. Returns: void |
Shutdown |
Shuts down Steamworks and clears the initialized state. Pending async call results complete with IoFailure = true. Returns: void |
GetSteamName |
Gets the current Steam persona name. Returns "Player" when Steamworks is unavailable. Returns: string |
SteamMatchmakingManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamMatchmakingManager |
Provides access checks for ISteamMatchmaking. |
RequestLobbyList |
Requests a lobby list and returns a Steam API call handle. Returns: ulong |
AddRequestLobbyListResultCountFilter |
Sets the maximum number of lobbies returned by RequestLobbyList. Returns: voidParameters:
|
CreateLobby |
Creates a lobby and returns a Steam API call handle. Returns: ulongParameters:
|
JoinLobby |
Joins a lobby by SteamID64 and returns a Steam API call handle. Returns: ulongParameters:
|
LeaveLobby |
Leaves a lobby by SteamID64. Returns: voidParameters:
|
GetNumLobbyMembers |
Gets the number of members currently in a lobby. Returns: intParameters:
|
SteamMatchmakingServersManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamMatchmakingServersManager |
Provides access checks for ISteamMatchmakingServers. |
SteamMusicManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamMusicManager |
Provides access checks for ISteamMusic. |
IsEnabled |
Checks whether Steam Music is enabled. Returns: bool |
IsPlaying |
Checks whether Steam Music is currently playing. Returns: bool |
Play |
Starts Steam Music playback. Returns: void |
Pause |
Pauses Steam Music playback. Returns: void |
PlayNext |
Advances to the next music track. Returns: void |
PlayPrevious |
Moves to the previous music track. Returns: void |
GetVolume |
Gets Steam Music volume (0..1 range). Returns: float |
SetVolume |
Sets Steam Music volume (0..1 range). Returns: voidParameters:
|
SteamOverlayActivated
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamOverlayActivated |
Data from GameOverlayActivated_t, raised when the Steam overlay opens or closes. |
Active |
True when the overlay was opened, false when it was closed. |
UserInitiated |
True when the user opened the overlay (as opposed to the game or Steam). |
AppId |
The AppId the overlay was activated for. |
SteamPartiesManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamPartiesManager |
Provides access checks for ISteamParties. |
SteamRemotePlayManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamRemotePlayManager |
Provides helper methods for Steam Remote Play session inspection. Example: var remotePlay = SteamManager.Instance.RemotePlay; var sessionCount = remotePlay.GetSessionCount(); |
GetSessionCount |
Gets the number of active Remote Play sessions for the current user. Returns: uint |
GetSessionId |
Gets a Remote Play session ID by zero-based session index. Returns: uintParameters:
|
GetSessionSteamId |
Gets the SteamID for the remote user in a session. Returns: ulongParameters:
|
GetSessionClientName |
Gets the client device name for a remote session. Returns: stringParameters:
|
GetSessionClientFormFactor |
Gets the client form-factor value for a session (matches Steam's ESteamDeviceFormFactor numeric values). Returns: intParameters:
|
TryGetSessionClientResolution |
Gets the streaming client resolution for a session. Returns: boolParameters:
|
SteamRemoteStorageManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamRemoteStorageManager |
Provides access checks for ISteamRemoteStorage. |
FileExists |
Checks whether a file exists in Steam Remote Storage. Returns: boolParameters:
|
GetFileCount |
Gets the number of files in Steam Remote Storage for the current app/user context. Returns: int |
IsCloudEnabledForApp |
Checks whether Steam Cloud is enabled for this app. Returns: bool |
FileWrite |
Writes a byte array to a Steam Cloud file. Returns: boolParameters:
|
FileRead |
Reads a Steam Cloud file into a byte array. Returns: boolParameters:
|
FileDelete |
Deletes a Steam Cloud file. Returns: boolParameters:
|
GetFileSize |
Gets file size in bytes for a Steam Cloud file. Returns: intParameters:
|
SteamScreenshotsManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamScreenshotsManager |
Provides access checks for ISteamScreenshots. |
AddScreenshotToLibrary |
Adds an existing screenshot to the Steam screenshot library. Returns: uintParameters:
|
TriggerScreenshot |
Triggers an in-game screenshot event. Returns: void |
HookScreenshots |
Enables or disables screenshot hooks for custom handling. Returns: voidParameters:
|
IsScreenshotsHooked |
Checks whether screenshot hooks are currently enabled. Returns: bool |
SteamUgcCreateItemResult
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamUgcCreateItemResult |
Result of ISteamUGC::CreateItem (CreateItemResult_t). |
Result |
Numeric EResult value (1 = OK). |
PublishedFileId |
The new Workshop item ID. Pass it to StartItemUpdate to upload content. |
UserNeedsToAcceptWorkshopLegalAgreement |
True when the user must accept the Workshop legal agreement before the item becomes visible. |
IoFailure |
True when the result could not be retrieved; the other fields are then not valid. |
IsSuccess |
True when the result was retrieved and EResult is OK. |
SteamUgcItemUpdateOptions
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamUgcItemUpdateOptions |
Declarative update payload for workshop item editing convenience APIs. |
Title |
Workshop item title. |
Description |
Workshop item description. |
Metadata |
Workshop item metadata string. |
Visibility |
Numeric ERemoteStoragePublishedFileVisibility value. |
Tags |
Workshop tag list. |
ContentFolder |
Absolute path to workshop content folder. |
PreviewFile |
Absolute path to workshop preview image. |
SteamUgcItemUpdateSession
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamUgcItemUpdateSession |
Fluent helper for editing and submitting a workshop item update. |
Submit |
Submits the fluent update session and returns a Steam API call handle. Returns: ulongParameters:
|
Submit |
Submits the fluent update session and calls onCompleted with the upload result from SteamManager.Update(). Returns: ulongParameters:
|
SteamUgcManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamUgcManager |
Provides helper methods for common Steam Workshop (UGC) operations such as queries and subscriptions. Example: var ugc = new SteamUgcManager(); var items = ugc.GetSubscribedItems(); |
BeginUpdateSession |
Begins a fluent UGC update session for an existing workshop item. Returns: SteamUgcItemUpdateSessionParameters:
|
ApplyItemUpdate |
Applies all non-null/non-empty fields from a UGC update options object to an existing update handle. Returns: boolParameters:
|
UpdateItem |
Convenience method that starts an item update, applies option fields, and submits the update in one call. Returns: ulongParameters:
|
UpdateItem |
Starts an item update, applies option fields, submits it, and calls onCompleted with the upload result from SteamManager.Update(). Returns: ulongParameters:
|
CreateItem |
Creates a new Workshop item and returns a Steam API call handle. Returns: ulongParameters:
|
CreateItem |
Creates a new Workshop item and calls onCompleted with the CreateItemResult_t from SteamManager.Update(). Returns the Steam API call handle, or 0 on failure. Returns: ulongParameters:
|
CreateItemAsync |
Creates a new Workshop item and returns a task with the CreateItemResult_t. Keep calling SteamManager.Update() while waiting. Returns: Task<SteamUgcCreateItemResult>Parameters:
|
StartItemUpdate |
Starts an update transaction for an existing Workshop item. Returns: ulongParameters:
|
SetItemTitle |
Sets workshop item title for a pending update. Returns: boolParameters:
|
SetItemDescription |
Sets workshop item description for a pending update. Returns: boolParameters:
|
SetItemMetadata |
Sets workshop item metadata for a pending update. Returns: boolParameters:
|
SetItemVisibility |
Sets workshop item visibility for a pending update. Returns: boolParameters:
|
SetItemTags |
Sets workshop item tags for a pending update. Returns: boolParameters:
|
SetItemContent |
Sets workshop item content folder path for a pending update. Returns: boolParameters:
|
SetItemPreview |
Sets workshop item preview image path for a pending update. Returns: boolParameters:
|
SubmitItemUpdate |
Submits a pending workshop item update and returns a Steam API call handle. Returns: ulongParameters:
|
SubmitItemUpdate |
Submits a pending workshop item update and calls onCompleted with the SubmitItemUpdateResult_t from SteamManager.Update(). Returns the Steam API call handle, or 0 when submission failed. Returns: ulongParameters:
|
SubmitItemUpdateAsync |
Submits a pending workshop item update and returns a task with the SubmitItemUpdateResult_t. Keep calling SteamManager.Update() while waiting. Returns: Task<SteamUgcSubmitItemUpdateResult>Parameters:
|
GetItemUpdateProgress |
Gets progress state for a pending item update upload. Returns: uintParameters:
|
CreateQueryAllUgcRequest |
Creates a UGC query request handle for workshop discovery. Returns: ulongParameters:
|
SendQueryUgcRequest |
Submits an existing UGC query request and returns a Steam API call handle. Returns: ulongParameters:
|
SendQueryUgcRequest |
Submits a UGC query and calls onCompleted with the SteamUGCQueryCompleted_t from SteamManager.Update(). Returns the Steam API call handle, or 0 on failure. Returns: ulongParameters:
|
SendQueryUgcRequestAsync |
Submits a UGC query and returns a task with the SteamUGCQueryCompleted_t. Keep calling SteamManager.Update() while waiting. Returns: Task<SteamUgcQueryCompletedResult>Parameters:
|
ReleaseQueryUgcRequest |
Releases a UGC query handle after you are done with query results. Returns: boolParameters:
|
GetNumSubscribedItems |
Gets the number of workshop items the current user is subscribed to. Returns: uint |
GetSubscribedItems |
Gets subscribed workshop item IDs for the current user. Returns: ulong[]Parameters:
|
SubscribeItem |
Subscribes the current user to a workshop item. Returns: ulongParameters:
|
UnsubscribeItem |
Unsubscribes the current user from a workshop item. Returns: ulongParameters:
|
SteamUgcQueryCompletedResult
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamUgcQueryCompletedResult |
Result of ISteamUGC::SendQueryUGCRequest (SteamUGCQueryCompleted_t). Release the query handle with ReleaseQueryUgcRequest when done. |
QueryHandle |
The UGC query handle the results belong to. |
Result |
Numeric EResult value (1 = OK). |
NumResultsReturned |
Number of items returned in this page. |
TotalMatchingResults |
Total number of items matching the query. |
CachedData |
True when the results came from the local cache. |
NextCursor |
Cursor for the next page (cursor-based queries only). |
IoFailure |
True when the result could not be retrieved; the other fields are then not valid. |
IsSuccess |
True when the result was retrieved and EResult is OK. |
SteamUgcSubmitItemUpdateResult
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamUgcSubmitItemUpdateResult |
Result of ISteamUGC::SubmitItemUpdate (SubmitItemUpdateResult_t). |
Result |
Numeric EResult value (1 = OK). |
UserNeedsToAcceptWorkshopLegalAgreement |
True when the user must accept the Workshop legal agreement before the item becomes visible. |
PublishedFileId |
The updated Workshop item ID. |
IoFailure |
True when the result could not be retrieved; the other fields are then not valid. |
IsSuccess |
True when the result was retrieved and EResult is OK. |
SteamUserStatsManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamUserStatsManager |
Provides access checks for ISteamUserStats. |
RequestUserStats |
Requests user stats for a target SteamID64 and returns a Steam API call handle. Returns: ulongParameters:
|
RequestGlobalStats |
Requests global stats history and returns a Steam API call handle. Returns: ulongParameters:
|
ResetAllStats |
Resets local user stats, optionally including achievements. Returns: boolParameters:
|
GetStatInt32 |
Gets a named integer stat value. Returns: boolParameters:
|
SetStatInt32 |
Sets a named integer stat value. Returns: boolParameters:
|
StoreStats |
Stores pending stats and achievement changes to Steam. Returns: bool |
SteamUtilsManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamUtilsManager |
Provides access checks for ISteamUtils. |
GetAppId |
Gets the current Steam AppId reported by SteamUtils. Returns: uint |
GetIpCountry |
Gets the two-letter country code inferred by Steam based on the current IP. Returns: string |
IsOverlayEnabled |
Checks whether Steam Overlay is currently enabled. Returns: bool |
SteamVideoManager
OmegaLeo.HelperLib.Steamworks| Member | Documentation |
|---|---|
SteamVideoManager |
Provides access checks for ISteamVideo. |
GetVideoUrl |
Requests a video URL for a given Steam video app id. Returns: voidParameters:
|
IsBroadcasting |
Checks whether the user is broadcasting and returns current viewer count. Returns: boolParameters:
|