@tlua/gmod 1.0.1

package/steamworks.d.tlua

@@ -0,0 +1,208 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * Steamworks related functions.
+ * @source https://wiki.facepunch.com/gmod/steamworks
+ */
+declare steamworks: SteamworksLib;
+
+interface SteamworksLib {
+    /**
+     * Refreshes clients addons.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.ApplyAddons
+     */
+    ApplyAddons(): void;
+}
+
+interface SteamworksLib {
+    /**
+     * **NOTE**: You really should be using [steamworks.DownloadUGC](https://wiki.facepunch.com/gmod/steamworks.DownloadUGC) when downloading Steam Workshop items. This is a legacy function for preview images.
+     *
+     *
+     * Downloads a file from the supplied addon and saves it as a `.cache` file in `garrysmod/cache/` folder.
+     *
+     * This is mostly used to download the preview image of the addon.
+     *
+     * In case the retrieved file is an image and you need the [IMaterial](https://wiki.facepunch.com/gmod/IMaterial), use [Global.AddonMaterial](https://wiki.facepunch.com/gmod/Global.AddonMaterial) with the path supplied from the callback.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.Download
+     */
+    Download(workshopPreviewID: string, uncompress: boolean, resultCallback: (path: string) => void): void;
+}
+
+interface SteamworksLib {
+    /**
+     * Downloads the Fire Extinguisher addon from Steam Workshop prints path to its .gma file to be used with [game.MountGMA](https://wiki.facepunch.com/gmod/game.MountGMA).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.DownloadUGC
+     */
+    DownloadUGC(workshopID: string, resultCallback: (path: string, file: file_class) => void): void;
+}
+
+interface SteamworksLib {
+    /**
+     * 		Retrieves info about supplied Steam Workshop addon.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.FileInfo
+     */
+    FileInfo(workshopItemID: string, resultCallback: (data: table) => void, extraInfo?: boolean): void;
+}
+
+interface SteamworksLib {
+    /**
+     * Retrieves a customized list of Steam Workshop addons.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.GetList
+     */
+    GetList(type: string, tags: table, offset: number, numRetrieve: number, days: number, userID?: string, resultCallback?: (data: table) => void, searchText?: string): void;
+}
+
+interface SteamworksLib {
+    /**
+     * Retrieves players name by their 64bit SteamID.
+     *
+     * You must call [steamworks.RequestPlayerInfo](https://wiki.facepunch.com/gmod/steamworks.RequestPlayerInfo) a decent amount of time before calling this function.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.GetPlayerName
+     * @deprecated You should use the callback of steamworks.RequestPlayerInfo instead.
+     */
+    GetPlayerName(steamID64: string): string;
+}
+
+interface SteamworksLib {
+    /**
+     * Returns whenever the client is subscribed to the specified Steam Workshop item.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.IsSubscribed
+     */
+    IsSubscribed(workshopItemID: string): boolean;
+}
+
+interface SteamworksLib {
+    /**
+     * Opens the workshop website in the steam overlay browser.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.OpenWorkshop
+     */
+    OpenWorkshop(): void;
+}
+
+interface SteamworksLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     * Publishes dupes, saves or demos to workshop.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.Publish
+     */
+    Publish(filename: string, image: string, name: string, desc: string, tags: table, callback: (fileID: number, error: string) => void, fileid?: number, changelist?: string): void;
+}
+
+interface SteamworksLib {
+    /**
+     * Requests information of the player with SteamID64 for later use with [steamworks.GetPlayerName](https://wiki.facepunch.com/gmod/steamworks.GetPlayerName).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.RequestPlayerInfo
+     */
+    RequestPlayerInfo(steamID64: string, callback: (name: string) => void): void;
+}
+
+interface SteamworksLib {
+    /**
+     * Sets the workshop item as "completed" by the player. There will be a visual indicator on the Steam Workshop for completed items.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.SetFileCompleted
+     */
+    SetFileCompleted(workshopid: string): string;
+}
+
+interface SteamworksLib {
+    /**
+     * Sets whether you have played this addon or not. This will be shown to the user in the Steam Workshop itself:
+     *
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.SetFilePlayed
+     */
+    SetFilePlayed(workshopid: string): string;
+}
+
+interface SteamworksLib {
+    /**
+     * Sets if an addon should be enabled or disabled. Call [steamworks.ApplyAddons](https://wiki.facepunch.com/gmod/steamworks.ApplyAddons) afterwards to update.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.SetShouldMountAddon
+     */
+    SetShouldMountAddon(workshopItemID: string, shouldMount: boolean): void;
+}
+
+interface SteamworksLib {
+    /**
+     * Returns whenever the specified Steam Workshop addon will be mounted or not.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.ShouldMountAddon
+     */
+    ShouldMountAddon(workshopItemID: string): boolean;
+}
+
+interface SteamworksLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Subscribes to the specified workshop addon. Call [steamworks.ApplyAddons](https://wiki.facepunch.com/gmod/steamworks.ApplyAddons) afterwards to update.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.Subscribe
+     */
+    Subscribe(workshopItemID: string): void;
+}
+
+interface SteamworksLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Unsubscribes to the specified workshop addon. Call [steamworks.ApplyAddons](https://wiki.facepunch.com/gmod/steamworks.ApplyAddons) afterwards to update.
+     *
+     * This function should `never` be called without a user's consent and should not be called if the addon is currently in use (aka: the user is not in the main menu) as it may result in unexpected behaviour.
+     *
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.Unsubscribe
+     */
+    Unsubscribe(workshopItemID: string): void;
+}
+
+interface SteamworksLib {
+    /**
+     * Opens the workshop website for specified Steam Workshop item in the Steam overlay browser.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.ViewFile
+     */
+    ViewFile(workshopItemID: string): void;
+}
+
+interface SteamworksLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *  Makes the user vote for the specified addon
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.Vote
+     */
+    Vote(workshopItemID: string, upOrDown: boolean): void;
+}
+
+interface SteamworksLib {
+    /**
+     * Retrieves vote info of supplied addon.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/steamworks.VoteInfo
+     * @deprecated Use data steamworks.FileInfo instead.
+     */
+    VoteInfo(workshopItemID: string, resultCallback: (data: table) => void): void;
+}
+