Files
LuaCsForBarotraumaEP/docs/lua/Item.lua
Evil Factory 5678f81326 docs update
2021-09-15 12:52:14 -03:00

29 lines
778 B
Lua

-- luacheck: ignore 111
--[[--
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 Item.AddToRemoveQueue(item) end
--- Gets a component from an item by a string name.
-- @treturn Component component
-- @realm server
function Item:GetComponentString(componentName) end
--- Sends a signal.
-- @realm server
function Item:SendSignal(signalOrString, connectionOrConnectionName) end
--- List of all items.
-- @treturn table
-- @realm shared
Item.ItemList = {}