docs update

This commit is contained in:
Evil Factory
2021-09-15 12:52:14 -03:00
parent e25e77bcf6
commit 5678f81326
12 changed files with 77 additions and 50 deletions

View File

@@ -6,21 +6,24 @@ Barotrauma Item class with some additional functions and fields
Barotrauma source code: [Item.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Items/Item.cs)
]]
-- @code Item
-- @pragma nostrip
Item = {}
--- Adds to remove queue, use this instead of Remove, to prevent desync.
-- @realm server
function AddToRemoveQueue(item) end
function Item.AddToRemoveQueue(item) end
--- Gets a component from an item by a string name.
-- @treturn Component component
-- @realm server
function GetComponentString(componentName) end
function Item:GetComponentString(componentName) end
--- Sends a signal.
-- @realm server
function SendSignal(signalOrString, connectionOrConnectionName) end
function Item:SendSignal(signalOrString, connectionOrConnectionName) end
--- List of all items.
-- @treturn table
-- @realm shared
ItemList = {}
Item.ItemList = {}