diff --git a/Barotrauma/BarotraumaShared/Lua/DefaultLib/LibClient.lua b/Barotrauma/BarotraumaShared/Lua/DefaultLib/LibClient.lua index c5f8a45d6..54c68f7bb 100644 --- a/Barotrauma/BarotraumaShared/Lua/DefaultLib/LibClient.lua +++ b/Barotrauma/BarotraumaShared/Lua/DefaultLib/LibClient.lua @@ -43,6 +43,8 @@ defaultLib["GUI"] = { MessageBox = CreateStatic("Barotrauma.GUIMessageBox", true), ColorPicker = CreateStatic("Barotrauma.GUIColorPicker", true), ProgressBar = CreateStatic("Barotrauma.GUIProgressBar", true), + CustomComponent = CreateStatic("Barotrauma.GUICustomComponent", true), + ScissorComponent = CreateStatic("Barotrauma.GUIScissorComponent", true), Screen = CreateStatic("Barotrauma.Screen"), diff --git a/Barotrauma/BarotraumaShared/Lua/DefaultRegister/RegisterClient.lua b/Barotrauma/BarotraumaShared/Lua/DefaultRegister/RegisterClient.lua index bf71b3496..ad165774d 100644 --- a/Barotrauma/BarotraumaShared/Lua/DefaultRegister/RegisterClient.lua +++ b/Barotrauma/BarotraumaShared/Lua/DefaultRegister/RegisterClient.lua @@ -58,7 +58,6 @@ RegisterBarotrauma("GUIButton") RegisterBarotrauma("RectTransform") RegisterBarotrauma("GUIFrame") RegisterBarotrauma("GUITickBox") -RegisterBarotrauma("GUICustomComponent") RegisterBarotrauma("GUIImage") RegisterBarotrauma("GUIListBox") RegisterBarotrauma("GUIScrollBar") @@ -70,5 +69,7 @@ RegisterBarotrauma("GUIFont") RegisterBarotrauma("GUIFontPrefab") RegisterBarotrauma("GUIColorPicker") RegisterBarotrauma("GUIProgressBar") +RegisterBarotrauma("GUICustomComponent") +RegisterBarotrauma("GUIScissorComponent") RegisterBarotrauma("Inventory+SlotReference") \ No newline at end of file diff --git a/docs/lua/Hooks.lua b/docs/lua/Hooks.lua index 79e5709b8..d859802af 100644 --- a/docs/lua/Hooks.lua +++ b/docs/lua/Hooks.lua @@ -144,6 +144,10 @@ function item.combine(item, deconstructor, characterUser, allowRemove) end -- @realm shared function item.deconstructed(item, otherItem, userCharacter) end +--- Gets called every time an item is created. +-- @realm shared +function item.created(item) end + --- Gets called every time an item is moved from one inventory slot to another, return true to cancel -- @realm shared function inventoryPutItem(inventory, item, characterUser, index, removeItemBool) end diff --git a/docs/lua/Steam.lua b/docs/lua/Steam.lua new file mode 100644 index 000000000..7de27caf2 --- /dev/null +++ b/docs/lua/Steam.lua @@ -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