diff --git a/docs/lua/Character.lua b/docs/lua/Character.lua index 6eeb4e41a..8a46d8e7c 100644 --- a/docs/lua/Character.lua +++ b/docs/lua/Character.lua @@ -16,8 +16,8 @@ local Character = {} -- @treturn Character -- @realm server -- @usage --- local vsauce = CharacterInfo.Create("human", "VSAUCE HERE") --- local character = Character.Create(vsauce, CreateVector2(0, 0), "some random characters") +-- local vsauce = CharacterInfo.__new("human", "VSAUCE HERE") +-- local character = Character.Create(vsauce, Vector2.__new(0, 0), "some random characters") -- print(character) function Character.Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdollParams) end @@ -26,7 +26,7 @@ function Character.Create(characterInfo, position, seed, id, isRemotePlayer, has -- @realm server -- @tparam Vector2 position -- @usage --- Character.CharacterList[1].TeleportTo(CreateVector2(0, 0)) -- teleports first created characters to 0, 0 +-- Character.CharacterList[1].TeleportTo(Vector2.__new(0, 0)) -- teleports first created characters to 0, 0 function TeleportTo(position) end diff --git a/docs/lua/CharacterInfo.lua b/docs/lua/CharacterInfo.lua index d9e6abddd..e69638695 100644 --- a/docs/lua/CharacterInfo.lua +++ b/docs/lua/CharacterInfo.lua @@ -10,11 +10,11 @@ Barotrauma source code: [CharacterInfo.cs](https://github.com/evilfactory/Barotr local CharacterInfo = {} ---- Creates a CharacterInfo. +--- Instantiates a new CharacterInfo. -- @treturn CharacterInfo -- @realm server -- @usage --- local vsauce = CharacterInfo.Create("human", "VSAUCE HERE") --- local character = Character.Create(vsauce, CreateVector2(0, 0), "some random characters") +-- local vsauce = CharacterInfo.__new("human", "VSAUCE HERE") +-- local character = Character.Create(vsauce, Vector2.__new(0, 0), "some random characters") -- print(character) -function CharacterInfo.Create(speciesName, name, jobPrefab, ragdollFileName, variant, randSync, npcIdentifier) end \ No newline at end of file +function CharacterInfo.__new(speciesName, name, jobPrefab, ragdollFileName, variant, randSync, npcIdentifier) end \ No newline at end of file diff --git a/docs/lua/Networking.lua b/docs/lua/Networking.lua index 40a9e177a..16c5d3851 100644 --- a/docs/lua/Networking.lua +++ b/docs/lua/Networking.lua @@ -16,4 +16,21 @@ function Networking.RequestPostHTTP(url, textData, contentType) end --- Send a get HTTP Request. -- treturn string result. -- @realm server -function Networking.RequestGetHTTP(url) end \ No newline at end of file +function Networking.RequestGetHTTP(url) end + +--- Creates a new net message, returns an IWriteMessage +-- treturn IWriteMessage netMessage +-- @realm shared +function Networking.Start(netMessageName) end + +--- Sends a net message to the server. +-- @realm client +function Networking.Send(netMessage, deliveryMethod) end + +--- Sends a net message to a connection, if the connection is null, then it sends the message to all connections +-- @realm server +function Networking.Send(netMessage, connection, deliveryMethod) end + +--- Adds a function to listen for lua net messages +-- @realm shared +function Networking.Receive(netMessageName, callback) end \ No newline at end of file diff --git a/docs/lua/Signal.lua b/docs/lua/Signal.lua index 311763eff..3d02fa9bd 100644 --- a/docs/lua/Signal.lua +++ b/docs/lua/Signal.lua @@ -10,7 +10,37 @@ Barotrauma source code: [Signal.cs](https://github.com/evilfactory/Barotrauma-lu Signal = {} ---- Creates a Signal. +--- Instantiates a new Signal. -- @treturn Signal -- @realm shared -function Signal.Create(stringValue, stepsTaken, characterSender, itemSource, power, strength) end \ No newline at end of file +function Signal.__new(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 \ No newline at end of file diff --git a/docs/lua/Vectors.lua b/docs/lua/Vectors.lua index a5a74d3c4..2d1245ae1 100644 --- a/docs/lua/Vectors.lua +++ b/docs/lua/Vectors.lua @@ -12,17 +12,21 @@ CreateVector2, CreateVector3, CreateVector4 are globals. ]] -- @code Vectors +local Vector2 = {} +local Vector3 = {} +local Vector4 = {} + --- Create Vector2 -- @treturn Vector2 -- @realm shared -function CreateVector2(path) end +function Vector2.__new(x, y) end --- Create Vector3 -- @treturn Vector3 -- @realm shared -function CreateVector3(path) end +function Vector3.__new(x, y, z) end --- Create Vector4 -- @treturn Vector4 -- @realm shared -function CreateVector4(path) end \ No newline at end of file +function Vector4.__new(x, y, z, w) end \ No newline at end of file