Files
LuaCsForBarotraumaEP/luacs-docs/lua/lua/Signal.lua
peelz 1bb7843811 Move docs to luacs-docs/{lua,cs,landing-page}
luacs-docs/cs also has a proper http server for testing locally
2022-08-10 05:36:16 -04:00

46 lines
850 B
Lua

-- luacheck: ignore 111
--[[--
Barotrauma Signal struct with some additional functions and fields
Barotrauma source code: [Signal.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Items/Components/Signal/Signal.cs)
]]
-- @code Signal
-- @pragma nostrip
Signal = {}
--- Instantiates a new Signal.
-- @treturn Signal
-- @realm shared
function Signal(stringValue, stepsTaken, characterSender, itemSource, power, strength) end
---
-- value, String value of the signal.
-- @realm shared
-- @string value
---
-- stepsTaken = 1
-- @realm shared
-- @number stepsTaken
---
-- sender = nil
-- @realm shared
-- @Character sender
---
-- source = nil
-- @realm shared
-- @Item source
---
-- power = 0
-- @realm shared
-- @number power
---
-- strength = 1
-- @realm shared
-- @number strength