improved docs

docs/baseluadocs/Character.lua

@@ -0,0 +1,35 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma Character class with some additional functions and fields
+
+Barotrauma source code: [Character.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Characters/Character.cs)
+]]
+-- @code Character
+-- @pragma nostrip
+
+local Character = {}
+
+--- Creates a Character using CharacterInfo.
+-- @treturn Character
+-- @realm server 
+-- @usage 
+-- local vsauce = CharacterInfo("human", "VSAUCE HERE")
+-- local character = Character.Create(vsauce, Vector2(0, 0), "some random characters")
+-- print(character)
+function Character.Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdollParams) end
+
+
+--- Teleports a character to a position.
+-- @realm server 
+-- @tparam Vector2 position
+-- @usage 
+-- Character.CharacterList[1].TeleportTo(Vector2(0, 0)) -- teleports first created characters to 0, 0
+function TeleportTo(position) end
+
+
+---
+-- Character.CharacterList, Table containing all characters.
+-- @realm shared
+-- @Character Character.CharacterList
+

docs/baseluadocs/CharacterInfo.lua

@@ -0,0 +1,11 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma CharacterInfo class with some additional functions and fields
+
+Barotrauma source code: [CharacterInfo.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Characters/CharacterInfo.cs)
+]]
+-- @code CharacterInfo
+-- @pragma nostrip
+
+local CharacterInfo = {}

docs/baseluadocs/Client.lua

@@ -0,0 +1,31 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma Character class with some additional functions and fields
+
+Barotrauma source code: [Client.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Networking/Client.cs)
+]]
+-- @code Client
+-- @pragma nostrip
+
+local Client = {}
+
+--- Sets the client character.
+-- @realm server 
+function SetClientCharacter(character) end
+
+--- Kick a client.
+-- @realm server 
+function Kick(reason) end
+
+--- Ban a client.
+-- @realm server 
+function Ban(reason, range, seconds) end
+
+--- Checks permissions, Client.Permissions.
+-- @realm server 
+function CheckPermission(permissions) end
+
+--- Unban a client.
+-- @realm server 
+function Client.Unban(player, endpoint) end

docs/baseluadocs/Entity.Spawner.lua

@@ -0,0 +1,9 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma EntitySpawner class with some additional functions and fields
+
+Barotrauma source code: [EntitySpawner.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Networking/EntitySpawner.cs)
+]]
+-- @code Entity.Spawner
+-- @pragma nostrip

docs/baseluadocs/Entity.lua

@@ -0,0 +1,9 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma Entity class with some additional functions and fields
+
+Barotrauma source code: [Entity.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Map/Entity.cs)
+]]
+-- @code Entity
+-- @pragma nostrip

docs/baseluadocs/GameScreen.lua

@@ -0,0 +1,8 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma.GameScreen
+]]
+-- @code Game.GameScreen
+-- @pragma nostrip
+local GameScreen = {}

docs/baseluadocs/GameSession.lua

@@ -0,0 +1,8 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma.GameSession
+]]
+-- @code Game.GameSession
+-- @pragma nostrip
+local GameSession = {}

docs/baseluadocs/Item.lua

@@ -0,0 +1,46 @@
+-- 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 GetComponentString(componentName) end
+
+--- Sends a signal.
+-- @realm server 
+function SendSignal(signalOrString, connectionOrConnectionName) end
+
+---
+-- Physics body of the item.
+-- @realm shared
+-- @PhysicsBody body
+-- @usage
+-- Item.ItemList[1].body.position = CreateVector2(0, 0) -- teleports first item created to 0, 0 of the level
+
+---
+-- Item.ItemList, Table containing all items.
+-- @realm shared
+-- @Item Item.ItemList
+
+---
+-- Prefab, ItemPrefab containing the original prefab of the item.
+-- @realm shared
+-- @ItemPrefab Prefab
+
+---
+-- WorldPosition, Vector2 position of the item in the world
+-- @realm shared
+-- @Vector2 WorldPosition

docs/baseluadocs/ItemPrefab.lua

@@ -0,0 +1,36 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma ItemPrefab class with some additional functions and fields
+
+Barotrauma source code: [ItemPrefab.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Items/ItemPrefab.cs)
+]]
+-- @code ItemPrefab
+-- @pragma nostrip
+
+local ItemPrefab = {}
+
+--- Add ItemPrefab to spawn queue and spawns it at the specified position
+-- @tparam ItemPrefab itemPrefab
+-- @tparam Vector2 position
+-- @tparam function spawned
+-- @realm server 
+function ItemPrefab.AddToSpawnQueue(itemPrefab, position, spawned) end
+
+--- Add ItemPrefab to spawn queue and spawns it inside the specified inventory
+-- @tparam ItemPrefab itemPrefab
+-- @tparam Inventory inventory
+-- @tparam function spawned
+-- @realm server 
+function ItemPrefab.AddToSpawnQueue(itemPrefab, inventory, spawned) end
+
+--- Get a item prefab via name or id
+-- @tparam string itemNameOrId
+-- @treturn ItemPrefab
+-- @realm shared 
+function ItemPrefab.GetItemPrefab(itemNameOrId) end
+
+---
+-- Identifier, the identifier of the prefab.
+-- @realm shared
+-- @string Identifier

docs/baseluadocs/Job.lua

@@ -0,0 +1,11 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma Job class with some additional functions and fields
+
+Barotrauma source code: [Job.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Characters/Jobs/Job.cs)
+]]
+-- @code Job
+-- @pragma nostrip
+
+local Job = {}

docs/baseluadocs/JobPrefab.lua

@@ -0,0 +1,11 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma JobPrefab class with some additional functions and fields
+
+Barotrauma source code: [JobPrefab.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Characters/Jobs/JobPrefab.cs)
+]]
+-- @code JobPrefab
+-- @pragma nostrip
+
+local JobPrefab = {}

docs/baseluadocs/NetLobbyScreen.lua

@@ -0,0 +1,8 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma.NetLobbyScreen
+]]
+-- @code Game.NetLobbyScreen
+-- @pragma nostrip
+local NetLobbyScreen = {}

docs/baseluadocs/Submarine.lua

@@ -0,0 +1,13 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma Submarine class with some additional functions and fields
+
+Barotrauma source code: [Submarine.cs](https://github.com/evilfactory/Barotrauma-lua-attempt/blob/master/Barotrauma/BarotraumaShared/SharedSource/Map/Submarine.cs)
+
+Not all fields and methods will work, this doc was autogenerated.
+]]
+-- @code Submarine
+-- @pragma nostrip
+
+local Submarine = {}

docs/baseluadocs/World.lua

@@ -0,0 +1,8 @@
+-- luacheck: ignore 111
+
+--[[--
+FarseerPhysics.Dynamics.World
+]]
+-- @code Game.World
+-- @pragma nostrip
+local World = {}