updated docs and Scissor component registrar

This commit is contained in:
Evil Factory
2022-05-27 11:54:00 -03:00
parent 00da9ba10c
commit 83bfc50c9e
4 changed files with 43 additions and 1 deletions

35
docs/lua/Steam.lua Normal file
View File

@@ -0,0 +1,35 @@
-- luacheck: ignore 111
--[[--
Provides steam integration.
]]
-- @code Steam
-- @pragma nostrip
local Steam = {}
--- Downloads an item from workshop and places it in a folder.
-- @tparam string itemID
-- @tparam string destinationFolder
-- @tparam function callback
-- @realm shared
-- @usage
-- Steam.DownloadWorkshopItem("2805065898", "LocalMods/MyMod/Temp/Download", function(workshopItem)
-- if workshopItem == nil then print("failed to download workshop item") return end
--
-- print(workshopItem.Title .. " has been successfully downloaded.")
-- end)
function Steam.DownloadWorkshopItem(id, destinationFolder, callback) end
--- Gets information about a workshop item.
-- @tparam string itemID
-- @tparam function callback
-- @realm shared
function Steam.GetWorkshopItem(id, callback) end
--- Callback is called with the list of all workshop items inside the specified collection.
-- @tparam string itemID
-- @tparam function callback
-- @realm shared
function Steam.GetWorkshopCollection(id, callback) end