new docs generator and docs update: electric boogaloo

Barotrauma/BarotraumaShared/SharedSource/Lua/LuaDocs.cs

@@ -0,0 +1,151 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using MoonSharp.Interpreter;
+using Microsoft.Xna.Framework;
+using Barotrauma.Networking;
+using System.Threading.Tasks;
+using Barotrauma.Items.Components;
+using System.IO;
+using System.Net;
+using System.Linq;
+using System.Xml.Linq;
+using System.Reflection;
+
+namespace Barotrauma
+{
+
+	public static class LuaDocs
+	{
+
+		public static string ConvertTypeName(string type)
+		{
+			switch (type)
+			{
+				case "Boolean":
+					return "bool";
+				case "String":
+					return "string";
+				case "int":
+					return "number";
+				case "Single":
+					return "number";
+				case "Double":
+					return "number";
+				case "float":
+					return "number";
+				case "UInt16":
+					return "number";
+				case "UInt32":
+					return "number";
+				case "UInt64":
+					return "number";
+				case "Int32":
+					return "number";
+				case "List`1":
+					return "table";
+				case "Dictionary`2":
+					return "table";
+			}
+
+			return type;
+		}
+
+		public static void GenerateDocs(Type type)
+		{
+			var sb = new StringBuilder();
+
+			var members = type.GetMembers();
+
+			foreach(var member in members)
+			{
+				Console.WriteLine("'{0}' is a {1}", member.Name, member.MemberType);
+				
+				if (member.MemberType == MemberTypes.Method)
+				{
+					var method = (MethodInfo)member;
+
+					if (method.Name.StartsWith("get_") || method.Name.StartsWith("set_"))
+						continue;
+
+					sb.Append($"--- {method.Name}\n");
+					sb.Append($"-- @realm shared\n");
+
+					var paramNames = "";
+
+					var parameters = method.GetParameters();
+					for(var i=0; i < parameters.Length; i++)
+					{
+						var parameter = parameters[i];
+
+						if(i == parameters.Length - 1)
+							paramNames = paramNames + parameter.Name;
+						else
+							paramNames = paramNames + parameter.Name + ", ";
+
+						sb.Append($"-- @tparam {ConvertTypeName(parameter.ParameterType.Name)} {parameter.Name}\n");
+					}
+
+					if (method.ReturnType != typeof(void))
+					{
+						sb.Append($"-- @treturn {ConvertTypeName(method.ReturnType.Name)}\n");
+					}
+
+					if (method.IsStatic)
+						sb.Append($"function {type.Name}.{method.Name}({paramNames})");
+					else
+						sb.Append($"function {method.Name}({paramNames})");
+					sb.Append(" end\n");
+
+					sb.Append("\n");
+				}
+
+				if (member.MemberType == MemberTypes.Field)
+				{
+					var field = (FieldInfo)member;
+
+					sb.Append($"---\n");
+					sb.Append($"-- ");
+
+					var name = field.Name;
+
+					var returnName = ConvertTypeName(field.FieldType.Name);
+
+					if (field.IsStatic)
+						name = type.Name + "." + field.Name;
+
+					sb.Append(name);
+					sb.Append($", Field of type {returnName}\n");
+					sb.Append($"-- @realm shared\n");
+					sb.Append($"-- @{returnName} {name}\n");
+
+					sb.Append("\n");
+				}
+
+				if (member.MemberType == MemberTypes.Property)
+				{
+					var property = (PropertyInfo)member;
+
+					sb.Append($"---\n");
+					sb.Append($"-- ");
+
+					var name = property.Name;
+
+					var returnName = ConvertTypeName(property.PropertyType.Name);
+
+					if (property.GetGetMethod().IsStatic)
+						name = type.Name + "." + property.Name;
+
+					sb.Append(name);
+					sb.Append($", Field of type {returnName}\n");
+					sb.Append($"-- @realm shared\n");
+					sb.Append($"-- @{returnName} {name}\n");
+
+					sb.Append("\n");
+				}
+			}
+
+			File.WriteAllText("luadocs.lua", sb.ToString());
+		}
+	}
+}

docs/lua/CharacterInfo.lua

@@ -10,11 +10,427 @@ Barotrauma source code: [CharacterInfo.cs](https://github.com/evilfactory/Barotr
 
 local CharacterInfo = {}
 
---- Instantiates a new CharacterInfo.
+--- ApplyHealthData
+-- @realm shared
+-- @tparam Character character
+-- @tparam XElement healthData
+function CharacterInfo.ApplyHealthData(character, healthData) end
+
+--- ReloadHeadAttachments
+-- @realm shared
+function ReloadHeadAttachments() end
+
+--- ResetHeadAttachments
+-- @realm shared
+function ResetHeadAttachments() end
+
+--- ClearCurrentOrders
+-- @realm shared
+function ClearCurrentOrders() end
+
+--- Remove
+-- @realm shared
+function Remove() end
+
+--- Create
+-- @realm shared
+-- @tparam string speciesName
+-- @tparam string name
+-- @tparam JobPrefab jobPrefab
+-- @tparam string ragdollFileName
+-- @tparam number variant
+-- @tparam RandSync randSync
+-- @tparam string npcIdentifier
 -- @treturn CharacterInfo
--- @realm server 
 -- @usage 
 -- local vsauce = CharacterInfo("human", "VSAUCE HERE")
 -- local character = Character.Create(vsauce, Vector2(0, 0), "some random characters")
 -- print(character)
 function CharacterInfo(speciesName, name, jobPrefab, ragdollFileName, variant, randSync, npcIdentifier) end
+
+--- ServerWrite
+-- @realm shared
+-- @tparam IWriteMessage msg
+function ServerWrite(msg) end
+
+--- CheckDisguiseStatus
+-- @realm shared
+-- @tparam bool handleBuff
+-- @tparam IdCard idCard
+function CheckDisguiseStatus(handleBuff, idCard) end
+
+--- GetRandomGender
+-- @realm shared
+-- @tparam RandSync randSync
+-- @treturn Gender
+function GetRandomGender(randSync) end
+
+--- GetRandomRace
+-- @realm shared
+-- @tparam RandSync randSync
+-- @treturn Race
+function GetRandomRace(randSync) end
+
+--- GetRandomHeadID
+-- @realm shared
+-- @tparam RandSync randSync
+-- @treturn number
+function GetRandomHeadID(randSync) end
+
+--- GetIdentifier
+-- @realm shared
+-- @treturn number
+function GetIdentifier() end
+
+--- GetIdentifierUsingOriginalName
+-- @realm shared
+-- @treturn number
+function GetIdentifierUsingOriginalName() end
+
+--- FilterByTypeAndHeadID
+-- @realm shared
+-- @tparam IEnumerable`1 elements
+-- @tparam WearableType targetType
+-- @tparam number headSpriteId
+-- @treturn IEnumerable`1
+function FilterByTypeAndHeadID(elements, targetType, headSpriteId) end
+
+--- FilterElementsByGenderAndRace
+-- @realm shared
+-- @tparam IEnumerable`1 elements
+-- @tparam Gender gender
+-- @tparam Race race
+-- @treturn IEnumerable`1
+function FilterElementsByGenderAndRace(elements, gender, race) end
+
+--- RecreateHead
+-- @realm shared
+-- @tparam number headID
+-- @tparam Race race
+-- @tparam Gender gender
+-- @tparam number hairIndex
+-- @tparam number beardIndex
+-- @tparam number moustacheIndex
+-- @tparam number faceAttachmentIndex
+function RecreateHead(headID, race, gender, hairIndex, beardIndex, moustacheIndex, faceAttachmentIndex) end
+
+--- LoadHeadSprite
+-- @realm shared
+function LoadHeadSprite() end
+
+--- LoadHeadAttachments
+-- @realm shared
+function LoadHeadAttachments() end
+
+--- IncreaseSkillLevel
+-- @realm shared
+-- @tparam string skillIdentifier
+-- @tparam number increase
+-- @tparam Vector2 pos
+function IncreaseSkillLevel(skillIdentifier, increase, pos) end
+
+--- SetSkillLevel
+-- @realm shared
+-- @tparam string skillIdentifier
+-- @tparam number level
+-- @tparam Vector2 pos
+function SetSkillLevel(skillIdentifier, level, pos) end
+
+--- Rename
+-- @realm shared
+-- @tparam string newName
+function Rename(newName) end
+
+--- ResetName
+-- @realm shared
+function ResetName() end
+
+--- Save
+-- @realm shared
+-- @tparam XElement parentElement
+-- @treturn XElement
+function Save(parentElement) end
+
+--- SaveOrders
+-- @realm shared
+-- @tparam XElement parentElement
+-- @tparam OrderInfo[] orders
+function CharacterInfo.SaveOrders(parentElement, orders) end
+
+--- SaveOrderData
+-- @realm shared
+-- @tparam CharacterInfo characterInfo
+-- @tparam XElement parentElement
+function CharacterInfo.SaveOrderData(characterInfo, parentElement) end
+
+--- SaveOrderData
+-- @realm shared
+function SaveOrderData() end
+
+--- ApplyOrderData
+-- @realm shared
+-- @tparam Character character
+-- @tparam XElement orderData
+function CharacterInfo.ApplyOrderData(character, orderData) end
+
+--- ApplyOrderData
+-- @realm shared
+function ApplyOrderData() end
+
+--- LoadOrders
+-- @realm shared
+-- @tparam XElement ordersElement
+-- @treturn table
+function CharacterInfo.LoadOrders(ordersElement) end
+
+--- GetType
+-- @realm shared
+-- @treturn Type
+function GetType() end
+
+--- ToString
+-- @realm shared
+-- @treturn string
+function ToString() end
+
+--- Equals
+-- @realm shared
+-- @tparam Object obj
+-- @treturn bool
+function Equals(obj) end
+
+--- GetHashCode
+-- @realm shared
+-- @treturn number
+function GetHashCode() end
+
+---
+-- Head, Field of type HeadInfo
+-- @realm shared
+-- @HeadInfo Head
+
+---
+-- Heads, Field of type table
+-- @realm shared
+-- @table Heads
+
+---
+-- HasNickname, Field of type bool
+-- @realm shared
+-- @bool HasNickname
+
+---
+-- OriginalName, Field of type string
+-- @realm shared
+-- @string OriginalName
+
+---
+-- DisplayName, Field of type string
+-- @realm shared
+-- @string DisplayName
+
+---
+-- SpeciesName, Field of type string
+-- @realm shared
+-- @string SpeciesName
+
+---
+-- HeadSprite, Field of type Sprite
+-- @realm shared
+-- @Sprite HeadSprite
+
+---
+-- Portrait, Field of type Sprite
+-- @realm shared
+-- @Sprite Portrait
+
+---
+-- AttachmentSprites, Field of type table
+-- @realm shared
+-- @table AttachmentSprites
+
+---
+-- CharacterConfigElement, Field of type XElement
+-- @realm shared
+-- @XElement CharacterConfigElement
+
+---
+-- CharacterInfo.HighestManualOrderPriority, Field of type number
+-- @realm shared
+-- @number CharacterInfo.HighestManualOrderPriority
+
+---
+-- CurrentOrders, Field of type table
+-- @realm shared
+-- @table CurrentOrders
+
+---
+-- SpriteTags, Field of type table
+-- @realm shared
+-- @table SpriteTags
+
+---
+-- PersonalityTrait, Field of type NPCPersonalityTrait
+-- @realm shared
+-- @NPCPersonalityTrait PersonalityTrait
+
+---
+-- HeadSpriteId, Field of type number
+-- @realm shared
+-- @number HeadSpriteId
+
+---
+-- Gender, Field of type Gender
+-- @realm shared
+-- @Gender Gender
+
+---
+-- Race, Field of type Race
+-- @realm shared
+-- @Race Race
+
+---
+-- HairIndex, Field of type number
+-- @realm shared
+-- @number HairIndex
+
+---
+-- BeardIndex, Field of type number
+-- @realm shared
+-- @number BeardIndex
+
+---
+-- MoustacheIndex, Field of type number
+-- @realm shared
+-- @number MoustacheIndex
+
+---
+-- FaceAttachmentIndex, Field of type number
+-- @realm shared
+-- @number FaceAttachmentIndex
+
+---
+-- HairElement, Field of type XElement
+-- @realm shared
+-- @XElement HairElement
+
+---
+-- BeardElement, Field of type XElement
+-- @realm shared
+-- @XElement BeardElement
+
+---
+-- MoustacheElement, Field of type XElement
+-- @realm shared
+-- @XElement MoustacheElement
+
+---
+-- FaceAttachment, Field of type XElement
+-- @realm shared
+-- @XElement FaceAttachment
+
+---
+-- Ragdoll, Field of type RagdollParams
+-- @realm shared
+-- @RagdollParams Ragdoll
+
+---
+-- IsAttachmentsLoaded, Field of type bool
+-- @realm shared
+-- @bool IsAttachmentsLoaded
+
+---
+-- Wearables, Field of type IEnumerable`1
+-- @realm shared
+-- @IEnumerable`1 Wearables
+
+---
+-- InventoryData, Field of type XElement
+-- @realm shared
+-- @XElement InventoryData
+
+---
+-- HealthData, Field of type XElement
+-- @realm shared
+-- @XElement HealthData
+
+---
+-- OrderData, Field of type XElement
+-- @realm shared
+-- @XElement OrderData
+
+---
+-- Name, Field of type string
+-- @realm shared
+-- @string Name
+
+---
+-- Character, Field of type Character
+-- @realm shared
+-- @Character Character
+
+---
+-- Job, Field of type Job
+-- @realm shared
+-- @Job Job
+
+---
+-- Salary, Field of type number
+-- @realm shared
+-- @number Salary
+
+---
+-- OmitJobInPortraitClothing, Field of type bool
+-- @realm shared
+-- @bool OmitJobInPortraitClothing
+
+---
+-- IsDisguised, Field of type bool
+-- @realm shared
+-- @bool IsDisguised
+
+---
+-- IsDisguisedAsAnother, Field of type bool
+-- @realm shared
+-- @bool IsDisguisedAsAnother
+
+---
+-- ragdollFileName, Field of type string
+-- @realm shared
+-- @string ragdollFileName
+
+---
+-- StartItemsGiven, Field of type bool
+-- @realm shared
+-- @bool StartItemsGiven
+
+---
+-- IsNewHire, Field of type bool
+-- @realm shared
+-- @bool IsNewHire
+
+---
+-- CauseOfDeath, Field of type CauseOfDeath
+-- @realm shared
+-- @CauseOfDeath CauseOfDeath
+
+---
+-- TeamID, Field of type CharacterTeamType
+-- @realm shared
+-- @CharacterTeamType TeamID
+
+---
+-- ID, Field of type number
+-- @realm shared
+-- @number ID
+
+---
+-- HasGenders, Field of type bool
+-- @realm shared
+-- @bool HasGenders
+
+---
+-- CharacterInfo.MaxCurrentOrders, Field of type number
+-- @realm shared
+-- @number CharacterInfo.MaxCurrentOrders
+

docs/lua/Client.lua

@@ -12,19 +12,19 @@ local Client = {}
 
 --- Sets the client character.
 -- @realm server 
-function Client:SetClientCharacter(character) end
+function SetClientCharacter(character) end
 
 --- Kick a client.
 -- @realm server 
-function Client:Kick(reason) end
+function Kick(reason) end
 
 --- Ban a client.
 -- @realm server 
-function Client:Ban(reason, range, seconds) end
+function Ban(reason, range, seconds) end
 
 --- Checks permissions, Client.Permissions.
 -- @realm server 
-function Client:CheckPermission(permissions) end
+function CheckPermission(permissions) end
 
 --- Unban a client.
 -- @realm server 
@@ -43,3 +43,439 @@ function Client.Unban(player, endpoint) end
 -- @Character Character
 
 
+----------- AUTODOCS --------------
+
+
+--- InitClientSync
+-- @realm shared
+
+function InitClientSync() end
+
+--- IsValidName
+-- @realm shared
+-- @tparam string name
+-- @tparam ServerSettings serverSettings
+-- @treturn bool
+function Client.IsValidName(name, serverSettings) end
+
+--- EndpointMatches
+-- @realm shared
+-- @tparam string endPoint
+-- @treturn bool
+function EndpointMatches(endPoint) end
+
+--- SetPermissions
+-- @realm shared
+-- @tparam ClientPermissions permissions
+-- @tparam table permittedConsoleCommands
+
+function SetPermissions(permissions, permittedConsoleCommands) end
+
+--- GivePermission
+-- @realm shared
+-- @tparam ClientPermissions permission
+
+function GivePermission(permission) end
+
+--- RemovePermission
+-- @realm shared
+-- @tparam ClientPermissions permission
+
+function RemovePermission(permission) end
+
+--- HasPermission
+-- @realm shared
+-- @tparam ClientPermissions permission
+-- @treturn bool
+function HasPermission(permission) end
+
+--- GetVote
+-- @realm shared
+-- @tparam VoteType voteType
+-- @treturn T
+function GetVote(voteType) end
+
+--- SetVote
+-- @realm shared
+-- @tparam VoteType voteType
+-- @tparam Object value
+
+function SetVote(voteType, value) end
+
+--- ResetVotes
+-- @realm shared
+
+function ResetVotes() end
+
+--- AddKickVote
+-- @realm shared
+-- @tparam Client voter
+
+function AddKickVote(voter) end
+
+--- RemoveKickVote
+-- @realm shared
+-- @tparam Client voter
+
+function RemoveKickVote(voter) end
+
+--- HasKickVoteFrom
+-- @realm shared
+-- @tparam Client voter
+-- @treturn bool
+function HasKickVoteFrom(voter) end
+
+--- HasKickVoteFromID
+-- @realm shared
+-- @tparam number id
+-- @treturn bool
+function HasKickVoteFromID(id) end
+
+--- UpdateKickVotes
+-- @realm shared
+-- @tparam table connectedClients
+
+function Client.UpdateKickVotes(connectedClients) end
+
+--- WritePermissions
+-- @realm shared
+-- @tparam IWriteMessage msg
+
+function WritePermissions(msg) end
+
+--- ReadPermissions
+-- @realm shared
+-- @tparam IReadMessage inc
+-- @tparam ClientPermissions& permissions
+-- @tparam List`1& permittedCommands
+
+function Client.ReadPermissions(inc, permissions, permittedCommands) end
+
+--- ReadPermissions
+-- @realm shared
+-- @tparam IReadMessage inc
+
+function ReadPermissions(inc) end
+
+--- SanitizeName
+-- @realm shared
+-- @tparam string name
+-- @treturn string
+function Client.SanitizeName(name) end
+
+--- Dispose
+-- @realm shared
+
+function Dispose() end
+
+--- GetType
+-- @realm shared
+-- @treturn Type
+function GetType() end
+
+--- ToString
+-- @realm shared
+-- @treturn string
+function ToString() end
+
+--- Equals
+-- @realm shared
+-- @tparam Object obj
+-- @treturn bool
+function Equals(obj) end
+
+--- GetHashCode
+-- @realm shared
+-- @treturn number
+function GetHashCode() end
+
+---
+-- CharacterInfo, Field of type CharacterInfo
+-- @realm shared
+-- @CharacterInfo CharacterInfo
+
+---
+-- Connection, Field of type NetworkConnection
+-- @realm shared
+-- @NetworkConnection Connection
+
+---
+-- Karma, Field of type number
+-- @realm shared
+-- @number Karma
+
+---
+-- SpectatePos, Field of type Nullable`1
+-- @realm shared
+-- @Nullable`1 SpectatePos
+
+---
+-- Spectating, Field of type bool
+-- @realm shared
+-- @bool Spectating
+
+---
+-- Muted, Field of type bool
+-- @realm shared
+-- @bool Muted
+
+---
+-- VoipQueue, Field of type VoipQueue
+-- @realm shared
+-- @VoipQueue VoipQueue
+
+---
+-- InGame, Field of type bool
+-- @realm shared
+-- @bool InGame
+
+---
+-- PermittedConsoleCommands, Field of type table
+-- @realm shared
+-- @table PermittedConsoleCommands
+
+---
+-- KickVoteCount, Field of type number
+-- @realm shared
+-- @number KickVoteCount
+
+---
+-- VoiceEnabled, Field of type bool
+-- @realm shared
+-- @bool VoiceEnabled
+
+---
+-- LastRecvClientListUpdate, Field of type number
+-- @realm shared
+-- @number LastRecvClientListUpdate
+
+---
+-- LastRecvLobbyUpdate, Field of type number
+-- @realm shared
+-- @number LastRecvLobbyUpdate
+
+---
+-- LastSentChatMsgID, Field of type number
+-- @realm shared
+-- @number LastSentChatMsgID
+
+---
+-- LastRecvChatMsgID, Field of type number
+-- @realm shared
+-- @number LastRecvChatMsgID
+
+---
+-- LastSentEntityEventID, Field of type number
+-- @realm shared
+-- @number LastSentEntityEventID
+
+---
+-- LastRecvEntityEventID, Field of type number
+-- @realm shared
+-- @number LastRecvEntityEventID
+
+---
+-- LastRecvCampaignUpdate, Field of type number
+-- @realm shared
+-- @number LastRecvCampaignUpdate
+
+---
+-- LastRecvCampaignSave, Field of type number
+-- @realm shared
+-- @number LastRecvCampaignSave
+
+---
+-- LastCampaignSaveSendTime, Field of type Pair`2
+-- @realm shared
+-- @Pair`2 LastCampaignSaveSendTime
+
+---
+-- ChatMsgQueue, Field of type table
+-- @realm shared
+-- @table ChatMsgQueue
+
+---
+-- LastChatMsgQueueID, Field of type number
+-- @realm shared
+-- @number LastChatMsgQueueID
+
+---
+-- LastSentChatMessages, Field of type table
+-- @realm shared
+-- @table LastSentChatMessages
+
+---
+-- ChatSpamSpeed, Field of type number
+-- @realm shared
+-- @number ChatSpamSpeed
+
+---
+-- ChatSpamTimer, Field of type number
+-- @realm shared
+-- @number ChatSpamTimer
+
+---
+-- ChatSpamCount, Field of type number
+-- @realm shared
+-- @number ChatSpamCount
+
+---
+-- RoundsSincePlayedAsTraitor, Field of type number
+-- @realm shared
+-- @number RoundsSincePlayedAsTraitor
+
+---
+-- KickAFKTimer, Field of type number
+-- @realm shared
+-- @number KickAFKTimer
+
+---
+-- MidRoundSyncTimeOut, Field of type number
+-- @realm shared
+-- @number MidRoundSyncTimeOut
+
+---
+-- NeedsMidRoundSync, Field of type bool
+-- @realm shared
+-- @bool NeedsMidRoundSync
+
+---
+-- UnreceivedEntityEventCount, Field of type number
+-- @realm shared
+-- @number UnreceivedEntityEventCount
+
+---
+-- FirstNewEventID, Field of type number
+-- @realm shared
+-- @number FirstNewEventID
+
+---
+-- EntityEventLastSent, Field of type table
+-- @realm shared
+-- @table EntityEventLastSent
+
+---
+-- PositionUpdateLastSent, Field of type table
+-- @realm shared
+-- @table PositionUpdateLastSent
+
+---
+-- PendingPositionUpdates, Field of type Queue`1
+-- @realm shared
+-- @Queue`1 PendingPositionUpdates
+
+---
+-- ReadyToStart, Field of type bool
+-- @realm shared
+-- @bool ReadyToStart
+
+---
+-- JobPreferences, Field of type table
+-- @realm shared
+-- @table JobPreferences
+
+---
+-- AssignedJob, Field of type Pair`2
+-- @realm shared
+-- @Pair`2 AssignedJob
+
+---
+-- DeleteDisconnectedTimer, Field of type number
+-- @realm shared
+-- @number DeleteDisconnectedTimer
+
+---
+-- SpectateOnly, Field of type bool
+-- @realm shared
+-- @bool SpectateOnly
+
+---
+-- WaitForNextRoundRespawn, Field of type Nullable`1
+-- @realm shared
+-- @Nullable`1 WaitForNextRoundRespawn
+
+---
+-- KarmaKickCount, Field of type number
+-- @realm shared
+-- @number KarmaKickCount
+
+---
+-- Name, Field of type string
+-- @realm shared
+-- @string Name
+
+---
+-- NameID, Field of type number
+-- @realm shared
+-- @number NameID
+
+---
+-- ID, Field of type Byte
+-- @realm shared
+-- @Byte ID
+
+---
+-- SteamID, Field of type number
+-- @realm shared
+-- @number SteamID
+
+---
+-- OwnerSteamID, Field of type number
+-- @realm shared
+-- @number OwnerSteamID
+
+---
+-- Language, Field of type string
+-- @realm shared
+-- @string Language
+
+---
+-- Ping, Field of type number
+-- @realm shared
+-- @number Ping
+
+---
+-- PreferredJob, Field of type string
+-- @realm shared
+-- @string PreferredJob
+
+---
+-- TeamID, Field of type CharacterTeamType
+-- @realm shared
+-- @CharacterTeamType TeamID
+
+---
+-- PreferredTeam, Field of type CharacterTeamType
+-- @realm shared
+-- @CharacterTeamType PreferredTeam
+
+---
+-- CharacterID, Field of type number
+-- @realm shared
+-- @number CharacterID
+
+---
+-- HasPermissions, Field of type bool
+-- @realm shared
+-- @bool HasPermissions
+
+---
+-- HasSpawned, Field of type bool
+-- @realm shared
+-- @bool HasSpawned
+
+---
+-- GivenAchievements, Field of type HashSet`1
+-- @realm shared
+-- @HashSet`1 GivenAchievements
+
+---
+-- Permissions, Field of type ClientPermissions
+-- @realm shared
+-- @ClientPermissions Permissions
+
+---
+-- Client.MaxNameLength, Field of type number
+-- @realm shared
+-- @number Client.MaxNameLength
+

docs/lua/Submarine.lua

@@ -0,0 +1,591 @@
+-- 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 = {}
+
+--- GetBorders
+-- @realm shared
+-- @tparam XElement submarineElement
+-- @treturn Rectangle
+function Submarine.GetBorders(submarineElement) end
+
+--- Load
+-- @realm shared
+-- @tparam SubmarineInfo info
+-- @tparam bool unloadPrevious
+-- @tparam IdRemap linkedRemap
+-- @treturn Submarine
+function Submarine.Load(info, unloadPrevious, linkedRemap) end
+
+--- RepositionEntities
+-- @realm shared
+-- @tparam Vector2 moveAmount
+-- @tparam IEnumerable`1 entities
+function Submarine.RepositionEntities(moveAmount, entities) end
+
+--- SaveToXElement
+-- @realm shared
+-- @tparam XElement element
+function SaveToXElement(element) end
+
+--- SaveAs
+-- @realm shared
+-- @tparam string filePath
+-- @tparam MemoryStream previewImage
+-- @treturn bool
+function SaveAs(filePath, previewImage) end
+
+--- Unload
+-- @realm shared
+function Submarine.Unload() end
+
+--- Remove
+-- @realm shared
+function Remove() end
+
+--- Dispose
+-- @realm shared
+function Dispose() end
+
+--- DisableObstructedWayPoints
+-- @realm shared
+function DisableObstructedWayPoints() end
+
+--- DisableObstructedWayPoints
+-- @realm shared
+-- @tparam Submarine otherSub
+function DisableObstructedWayPoints(otherSub) end
+
+--- EnableObstructedWaypoints
+-- @realm shared
+-- @tparam Submarine otherSub
+function EnableObstructedWaypoints(otherSub) end
+
+--- RefreshOutdoorNodes
+-- @realm shared
+function RefreshOutdoorNodes() end
+
+--- ServerWrite
+-- @realm shared
+-- @tparam IWriteMessage msg
+-- @tparam Client c
+-- @tparam Object[] extraData
+function ServerWrite(msg, c, extraData) end
+
+--- ToString
+-- @realm shared
+-- @treturn string
+function ToString() end
+
+--- CalculateBasePrice
+-- @realm shared
+-- @treturn number
+function CalculateBasePrice() end
+
+--- AttemptBallastFloraInfection
+-- @realm shared
+-- @tparam string identifier
+-- @tparam number deltaTime
+-- @tparam number probability
+function AttemptBallastFloraInfection(identifier, deltaTime, probability) end
+
+--- MakeWreck
+-- @realm shared
+function MakeWreck() end
+
+--- CreateWreckAI
+-- @realm shared
+-- @treturn bool
+function CreateWreckAI() end
+
+--- DisableWreckAI
+-- @realm shared
+function DisableWreckAI() end
+
+--- GetDockedBorders
+-- @realm shared
+-- @tparam table checkd
+-- @treturn Rectangle
+function GetDockedBorders(checkd) end
+
+--- GetConnectedSubs
+-- @realm shared
+-- @treturn table
+function GetConnectedSubs() end
+
+--- FindSpawnPos
+-- @realm shared
+-- @tparam Vector2 spawnPos
+-- @tparam Nullable`1 submarineSize
+-- @tparam number subDockingPortOffset
+-- @tparam number verticalMoveDir
+-- @treturn Vector2
+function FindSpawnPos(spawnPos, submarineSize, subDockingPortOffset, verticalMoveDir) end
+
+--- UpdateTransform
+-- @realm shared
+-- @tparam bool interpolate
+function UpdateTransform(interpolate) end
+
+--- VectorToWorldGrid
+-- @realm shared
+-- @tparam Vector2 position
+-- @treturn Vector2
+function Submarine.VectorToWorldGrid(position) end
+
+--- CalculateDimensions
+-- @realm shared
+-- @tparam bool onlyHulls
+-- @treturn Rectangle
+function CalculateDimensions(onlyHulls) end
+
+--- AbsRect
+-- @realm shared
+-- @tparam Vector2 pos
+-- @tparam Vector2 size
+-- @treturn Rectangle
+function Submarine.AbsRect(pos, size) end
+
+--- RectContains
+-- @realm shared
+-- @tparam Rectangle rect
+-- @tparam Vector2 pos
+-- @tparam bool inclusive
+-- @treturn bool
+function Submarine.RectContains(rect, pos, inclusive) end
+
+--- RectsOverlap
+-- @realm shared
+-- @tparam Rectangle rect1
+-- @tparam Rectangle rect2
+-- @tparam bool inclusive
+-- @treturn bool
+function Submarine.RectsOverlap(rect1, rect2, inclusive) end
+
+--- PickBody
+-- @realm shared
+-- @tparam Vector2 rayStart
+-- @tparam Vector2 rayEnd
+-- @tparam IEnumerable`1 ignoredBodies
+-- @tparam Nullable`1 collisionCategory
+-- @tparam bool ignoreSensors
+-- @tparam Predicate`1 customPredicate
+-- @tparam bool allowInsideFixture
+-- @treturn Body
+function Submarine.PickBody(rayStart, rayEnd, ignoredBodies, collisionCategory, ignoreSensors, customPredicate, allowInsideFixture) end
+
+--- LastPickedBodyDist
+-- @realm shared
+-- @tparam Body body
+-- @treturn number
+function Submarine.LastPickedBodyDist(body) end
+
+--- PickBodies
+-- @realm shared
+-- @tparam Vector2 rayStart
+-- @tparam Vector2 rayEnd
+-- @tparam IEnumerable`1 ignoredBodies
+-- @tparam Nullable`1 collisionCategory
+-- @tparam bool ignoreSensors
+-- @tparam Predicate`1 customPredicate
+-- @tparam bool allowInsideFixture
+-- @treturn IEnumerable`1
+function Submarine.PickBodies(rayStart, rayEnd, ignoredBodies, collisionCategory, ignoreSensors, customPredicate, allowInsideFixture) end
+
+--- CheckVisibility
+-- @realm shared
+-- @tparam Vector2 rayStart
+-- @tparam Vector2 rayEnd
+-- @tparam bool ignoreLevel
+-- @tparam bool ignoreSubs
+-- @tparam bool ignoreSensors
+-- @tparam bool ignoreDisabledWalls
+-- @tparam bool ignoreBranches
+-- @treturn Body
+function Submarine.CheckVisibility(rayStart, rayEnd, ignoreLevel, ignoreSubs, ignoreSensors, ignoreDisabledWalls, ignoreBranches) end
+
+--- FlipX
+-- @realm shared
+-- @tparam table parents
+function FlipX(parents) end
+
+--- Update
+-- @realm shared
+-- @tparam number deltaTime
+function Update(deltaTime) end
+
+--- ApplyForce
+-- @realm shared
+-- @tparam Vector2 force
+function ApplyForce(force) end
+
+--- EnableMaintainPosition
+-- @realm shared
+function EnableMaintainPosition() end
+
+--- NeutralizeBallast
+-- @realm shared
+function NeutralizeBallast() end
+
+--- WarmStartPower
+-- @realm shared
+function WarmStartPower() end
+
+--- SetPrevTransform
+-- @realm shared
+-- @tparam Vector2 position
+function SetPrevTransform(position) end
+
+--- SetPosition
+-- @realm shared
+-- @tparam Vector2 position
+-- @tparam table checkd
+-- @tparam bool forceUndockFromStaticSubmarines
+function SetPosition(position, checkd, forceUndockFromStaticSubmarines) end
+
+--- CalculateDockOffset
+-- @realm shared
+-- @tparam Submarine sub
+-- @tparam Submarine dockedSub
+-- @treturn Nullable`1
+function Submarine.CalculateDockOffset(sub, dockedSub) end
+
+--- Translate
+-- @realm shared
+-- @tparam Vector2 amount
+function Translate(amount) end
+
+--- FindClosest
+-- @realm shared
+-- @tparam Vector2 worldPosition
+-- @tparam bool ignoreOutposts
+-- @tparam bool ignoreOutsideLevel
+-- @tparam bool ignoreRespawnShuttle
+-- @tparam Nullable`1 teamType
+-- @treturn Submarine
+function Submarine.FindClosest(worldPosition, ignoreOutposts, ignoreOutsideLevel, ignoreRespawnShuttle, teamType) end
+
+--- IsConnectedTo
+-- @realm shared
+-- @tparam Submarine otherSub
+-- @treturn bool
+function IsConnectedTo(otherSub) end
+
+--- GetHulls
+-- @realm shared
+-- @tparam bool alsoFromConnectedSubs
+-- @treturn table
+function GetHulls(alsoFromConnectedSubs) end
+
+--- GetGaps
+-- @realm shared
+-- @tparam bool alsoFromConnectedSubs
+-- @treturn table
+function GetGaps(alsoFromConnectedSubs) end
+
+--- GetItems
+-- @realm shared
+-- @tparam bool alsoFromConnectedSubs
+-- @treturn table
+function GetItems(alsoFromConnectedSubs) end
+
+--- GetWaypoints
+-- @realm shared
+-- @tparam bool alsoFromConnectedSubs
+-- @treturn table
+function GetWaypoints(alsoFromConnectedSubs) end
+
+--- GetWalls
+-- @realm shared
+-- @tparam bool alsoFromConnectedSubs
+-- @treturn table
+function GetWalls(alsoFromConnectedSubs) end
+
+--- GetEntities
+-- @realm shared
+-- @tparam bool includingConnectedSubs
+-- @tparam table list
+-- @treturn table
+function GetEntities(includingConnectedSubs, list) end
+
+--- GetCargoContainers
+-- @realm shared
+-- @treturn table
+function GetCargoContainers() end
+
+--- GetEntities
+-- @realm shared
+-- @tparam bool includingConnectedSubs
+-- @tparam IEnumerable`1 list
+-- @treturn IEnumerable`1
+function GetEntities(includingConnectedSubs, list) end
+
+--- IsEntityFoundOnThisSub
+-- @realm shared
+-- @tparam MapEntity entity
+-- @tparam bool includingConnectedSubs
+-- @tparam bool allowDifferentTeam
+-- @tparam bool allowDifferentType
+-- @treturn bool
+function IsEntityFoundOnThisSub(entity, includingConnectedSubs, allowDifferentTeam, allowDifferentType) end
+
+--- FindContaining
+-- @realm shared
+-- @tparam Vector2 position
+-- @treturn Submarine
+function Submarine.FindContaining(position) end
+
+--- FreeID
+-- @realm shared
+function FreeID() end
+
+--- GetType
+-- @realm shared
+-- @treturn Type
+function GetType() end
+
+--- Equals
+-- @realm shared
+-- @tparam Object obj
+-- @treturn bool
+function Equals(obj) end
+
+--- GetHashCode
+-- @realm shared
+-- @treturn number
+function GetHashCode() end
+
+---
+-- Info, Field of type SubmarineInfo
+-- @realm shared
+-- @SubmarineInfo Info
+
+---
+-- HiddenSubPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 HiddenSubPosition
+
+---
+-- IdOffset, Field of type number
+-- @realm shared
+-- @number IdOffset
+
+---
+-- Submarine.MainSub, Field of type Submarine
+-- @realm shared
+-- @Submarine Submarine.MainSub
+
+---
+-- Submarine.VisibleEntities, Field of type IEnumerable`1
+-- @realm shared
+-- @IEnumerable`1 Submarine.VisibleEntities
+
+---
+-- DockedTo, Field of type IEnumerable`1
+-- @realm shared
+-- @IEnumerable`1 DockedTo
+
+---
+-- Submarine.LastPickedPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 Submarine.LastPickedPosition
+
+---
+-- Submarine.LastPickedFraction, Field of type number
+-- @realm shared
+-- @number Submarine.LastPickedFraction
+
+---
+-- Submarine.LastPickedFixture, Field of type Fixture
+-- @realm shared
+-- @Fixture Submarine.LastPickedFixture
+
+---
+-- Submarine.LastPickedNormal, Field of type Vector2
+-- @realm shared
+-- @Vector2 Submarine.LastPickedNormal
+
+---
+-- Loading, Field of type bool
+-- @realm shared
+-- @bool Loading
+
+---
+-- GodMode, Field of type bool
+-- @realm shared
+-- @bool GodMode
+
+---
+-- Submarine.Loaded, Field of type table
+-- @realm shared
+-- @table Submarine.Loaded
+
+---
+-- SubBody, Field of type SubmarineBody
+-- @realm shared
+-- @SubmarineBody SubBody
+
+---
+-- PhysicsBody, Field of type PhysicsBody
+-- @realm shared
+-- @PhysicsBody PhysicsBody
+
+---
+-- Borders, Field of type Rectangle
+-- @realm shared
+-- @Rectangle Borders
+
+---
+-- Position, Field of type Vector2
+-- @realm shared
+-- @Vector2 Position
+
+---
+-- WorldPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 WorldPosition
+
+---
+-- RealWorldCrushDepth, Field of type number
+-- @realm shared
+-- @number RealWorldCrushDepth
+
+---
+-- RealWorldDepth, Field of type number
+-- @realm shared
+-- @number RealWorldDepth
+
+---
+-- AtEndExit, Field of type bool
+-- @realm shared
+-- @bool AtEndExit
+
+---
+-- AtStartExit, Field of type bool
+-- @realm shared
+-- @bool AtStartExit
+
+---
+-- DrawPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 DrawPosition
+
+---
+-- SimPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 SimPosition
+
+---
+-- Velocity, Field of type Vector2
+-- @realm shared
+-- @Vector2 Velocity
+
+---
+-- HullVertices, Field of type table
+-- @realm shared
+-- @table HullVertices
+
+---
+-- AtDamageDepth, Field of type bool
+-- @realm shared
+-- @bool AtDamageDepth
+
+---
+-- Removed, Field of type bool
+-- @realm shared
+-- @bool Removed
+
+---
+-- ImmuneToBallastFlora, Field of type bool
+-- @realm shared
+-- @bool ImmuneToBallastFlora
+
+---
+-- WreckAI, Field of type WreckAI
+-- @realm shared
+-- @WreckAI WreckAI
+
+---
+-- FlippedX, Field of type bool
+-- @realm shared
+-- @bool FlippedX
+
+---
+-- Submarine.Unloading, Field of type bool
+-- @realm shared
+-- @bool Submarine.Unloading
+
+---
+-- IdFreed, Field of type bool
+-- @realm shared
+-- @bool IdFreed
+
+---
+-- Submarine, Field of type Submarine
+-- @realm shared
+-- @Submarine Submarine
+
+---
+-- AiTarget, Field of type AITarget
+-- @realm shared
+-- @AITarget AiTarget
+
+---
+-- SpawnTime, Field of type number
+-- @realm shared
+-- @number SpawnTime
+
+---
+-- TeamID, Field of type CharacterTeamType
+-- @realm shared
+-- @CharacterTeamType TeamID
+
+---
+-- ConnectedDockingPorts, Field of type table
+-- @realm shared
+-- @table ConnectedDockingPorts
+
+---
+-- ShowSonarMarker, Field of type bool
+-- @realm shared
+-- @bool ShowSonarMarker
+
+---
+-- Submarine.HiddenSubStartPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 Submarine.HiddenSubStartPosition
+
+---
+-- Submarine.LockX, Field of type bool
+-- @realm shared
+-- @bool Submarine.LockX
+
+---
+-- Submarine.LockY, Field of type bool
+-- @realm shared
+-- @bool Submarine.LockY
+
+---
+-- Submarine.GridSize, Field of type Vector2
+-- @realm shared
+-- @Vector2 Submarine.GridSize
+
+---
+-- Submarine.MainSubs, Field of type Submarine[]
+-- @realm shared
+-- @Submarine[] Submarine.MainSubs
+
+---
+-- ID, Field of type number
+-- @realm shared
+-- @number ID
+