improved docs

docs/lua/generated/CharacterInfo.lua

@@ -0,0 +1,624 @@
+-- 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 = {}
+
+--- RefreshHead
+-- @realm shared
+function RefreshHead() end
+
+--- LoadHeadAttachments
+-- @realm shared
+function LoadHeadAttachments() end
+
+--- AddEmpty
+-- @realm shared
+-- @tparam IEnumerable`1 elements
+-- @tparam WearableType type
+-- @tparam number commonness
+-- @treturn table
+function CharacterInfo.AddEmpty(elements, type, commonness) end
+
+--- GetRandomElement
+-- @realm shared
+-- @tparam IEnumerable`1 elements
+-- @treturn XElement
+function GetRandomElement(elements) end
+
+--- IsValidIndex
+-- @realm shared
+-- @tparam number index
+-- @tparam table list
+-- @treturn bool
+function CharacterInfo.IsValidIndex(index, list) end
+
+--- IncreaseSkillLevel
+-- @realm shared
+-- @tparam string skillIdentifier
+-- @tparam number increase
+-- @tparam bool gainedFromApprenticeship
+function IncreaseSkillLevel(skillIdentifier, increase, gainedFromApprenticeship) end
+
+--- SetSkillLevel
+-- @realm shared
+-- @tparam string skillIdentifier
+-- @tparam number level
+function SetSkillLevel(skillIdentifier, level) end
+
+--- GiveExperience
+-- @realm shared
+-- @tparam number amount
+-- @tparam bool isMissionExperience
+function GiveExperience(amount, isMissionExperience) end
+
+--- SetExperience
+-- @realm shared
+-- @tparam number newExperience
+function SetExperience(newExperience) end
+
+--- GetTotalTalentPoints
+-- @realm shared
+-- @treturn number
+function GetTotalTalentPoints() end
+
+--- GetAvailableTalentPoints
+-- @realm shared
+-- @treturn number
+function GetAvailableTalentPoints() end
+
+--- GetProgressTowardsNextLevel
+-- @realm shared
+-- @treturn number
+function GetProgressTowardsNextLevel() end
+
+--- GetExperienceRequiredForCurrentLevel
+-- @realm shared
+-- @treturn number
+function GetExperienceRequiredForCurrentLevel() end
+
+--- GetExperienceRequiredToLevelUp
+-- @realm shared
+-- @treturn number
+function GetExperienceRequiredToLevelUp() end
+
+--- GetCurrentLevel
+-- @realm shared
+-- @treturn number
+function GetCurrentLevel() 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
+
+--- ApplyHealthData
+-- @realm shared
+-- @tparam Character character
+-- @tparam XElement healthData
+function CharacterInfo.ApplyHealthData(character, healthData) end
+
+--- ClearCurrentOrders
+-- @realm shared
+function ClearCurrentOrders() end
+
+--- Remove
+-- @realm shared
+function Remove() end
+
+--- ClearSavedStatValues
+-- @realm shared
+function ClearSavedStatValues() end
+
+--- ClearSavedStatValues
+-- @realm shared
+-- @tparam StatTypes statType
+function ClearSavedStatValues(statType) end
+
+--- ResetSavedStatValue
+-- @realm shared
+-- @tparam string statIdentifier
+function ResetSavedStatValue(statIdentifier) end
+
+--- GetSavedStatValue
+-- @realm shared
+-- @tparam StatTypes statType
+-- @treturn number
+function GetSavedStatValue(statType) end
+
+--- GetSavedStatValue
+-- @realm shared
+-- @tparam StatTypes statType
+-- @tparam string statIdentifier
+-- @treturn number
+function GetSavedStatValue(statType, statIdentifier) end
+
+--- ChangeSavedStatValue
+-- @realm shared
+-- @tparam StatTypes statType
+-- @tparam number value
+-- @tparam string statIdentifier
+-- @tparam bool removeOnDeath
+-- @tparam bool removeAfterRound
+-- @tparam number maxValue
+-- @tparam bool setValue
+function ChangeSavedStatValue(statType, value, statIdentifier, removeOnDeath, removeAfterRound, maxValue, setValue) 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
+function CharacterInfo.Create(speciesName, name, jobPrefab, ragdollFileName, variant, randSync, npcIdentifier) end
+
+--- ServerWrite
+-- @realm shared
+-- @tparam IWriteMessage msg
+function ServerWrite(msg) end
+
+--- GetUnlockedTalentsInTree
+-- @realm shared
+-- @treturn IEnumerable`1
+function GetUnlockedTalentsInTree() end
+
+--- GetEndocrineTalents
+-- @realm shared
+-- @treturn IEnumerable`1
+function GetEndocrineTalents() end
+
+--- CheckDisguiseStatus
+-- @realm shared
+-- @tparam bool handleBuff
+-- @tparam IdCard idCard
+function CheckDisguiseStatus(handleBuff, idCard) end
+
+--- GetRandomName
+-- @realm shared
+-- @tparam RandSync randSync
+-- @treturn string
+function GetRandomName(randSync) end
+
+--- SelectRandomColor
+-- @realm shared
+-- @tparam ImmutableArray`1& array
+-- @treturn Color
+function CharacterInfo.SelectRandomColor(array) 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
+
+--- IsMatchingGender
+-- @realm shared
+-- @tparam Gender gender
+-- @tparam Gender myGender
+-- @treturn bool
+function CharacterInfo.IsMatchingGender(gender, myGender) end
+
+--- IsMatchingRace
+-- @realm shared
+-- @tparam Race race
+-- @tparam Race myRace
+-- @treturn bool
+function CharacterInfo.IsMatchingRace(race, myRace) end
+
+--- RecreateHead
+-- @realm shared
+-- @tparam HeadInfo headInfo
+function RecreateHead(headInfo) 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
+
+--- 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
+
+---
+-- ExperiencePoints, Field of type number
+-- @realm shared
+-- @number ExperiencePoints
+
+---
+-- UnlockedTalents, Field of type HashSet`1
+-- @realm shared
+-- @HashSet`1 UnlockedTalents
+
+---
+-- AdditionalTalentPoints, Field of type number
+-- @realm shared
+-- @number AdditionalTalentPoints
+
+---
+-- 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
+
+---
+-- HairColor, Field of type Color
+-- @realm shared
+-- @Color HairColor
+
+---
+-- FacialHairColor, Field of type Color
+-- @realm shared
+-- @Color FacialHairColor
+
+---
+-- SkinColor, Field of type Color
+-- @realm shared
+-- @Color SkinColor
+
+---
+-- 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
+
+---
+-- HasRaces, Field of type bool
+-- @realm shared
+-- @bool HasRaces
+
+---
+-- HairColors, Field of type ImmutableArray`1
+-- @realm shared
+-- @ImmutableArray`1 HairColors
+
+---
+-- FacialHairColors, Field of type ImmutableArray`1
+-- @realm shared
+-- @ImmutableArray`1 FacialHairColors
+
+---
+-- SkinColors, Field of type ImmutableArray`1
+-- @realm shared
+-- @ImmutableArray`1 SkinColors
+
+---
+-- MissionsCompletedSinceDeath, Field of type number
+-- @realm shared
+-- @number MissionsCompletedSinceDeath
+
+---
+-- SavedStatValues, Field of type table
+-- @realm shared
+-- @table SavedStatValues
+
+---
+-- CharacterInfo.MaxCurrentOrders, Field of type number
+-- @realm shared
+-- @number CharacterInfo.MaxCurrentOrders
+

docs/lua/generated/Client.lua

@@ -0,0 +1,492 @@
+-- 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
+
+
+--- SetClientCharacter
+-- @realm shared
+-- @tparam Character character
+function SetClientCharacter(character) end
+
+--- Kick
+-- @realm shared
+-- @tparam string reason
+function Kick(reason) end
+
+--- Ban
+-- @realm shared
+-- @tparam string reason
+-- @tparam bool range
+-- @tparam number seconds
+function Ban(reason, range, seconds) end
+
+--- Unban
+-- @realm shared
+-- @tparam string player
+-- @tparam string endpoint
+function Client.Unban(player, endpoint) end
+
+--- CheckPermission
+-- @realm shared
+-- @tparam ClientPermissions permissions
+-- @treturn bool
+function CheckPermission(permissions) end
+
+--- 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
+
+---
+-- Client.ClientList, Field of type table
+-- @realm shared
+-- @table Client.ClientList
+
+---
+-- Character, Field of type Character
+-- @realm shared
+-- @Character Character
+
+---
+-- 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/generated/Entity.Spawner.lua

@@ -0,0 +1,199 @@
+-- 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
+
+
+--- CreateNetworkEvent
+-- @realm shared
+-- @tparam Entity entity
+-- @tparam bool remove
+function CreateNetworkEvent(entity, remove) end
+
+--- ServerWrite
+-- @realm shared
+-- @tparam IWriteMessage message
+-- @tparam Client client
+-- @tparam Object[] extraData
+function ServerWrite(message, client, extraData) end
+
+--- ToString
+-- @realm shared
+-- @treturn string
+function ToString() end
+
+--- AddToSpawnQueue
+-- @realm shared
+-- @tparam ItemPrefab itemPrefab
+-- @tparam Vector2 worldPosition
+-- @tparam Nullable`1 condition
+-- @tparam Nullable`1 quality
+-- @tparam function onSpawned
+function AddToSpawnQueue(itemPrefab, worldPosition, condition, quality, onSpawned) end
+
+--- AddToSpawnQueue
+-- @realm shared
+-- @tparam ItemPrefab itemPrefab
+-- @tparam Vector2 position
+-- @tparam Submarine sub
+-- @tparam Nullable`1 condition
+-- @tparam Nullable`1 quality
+-- @tparam function onSpawned
+function AddToSpawnQueue(itemPrefab, position, sub, condition, quality, onSpawned) end
+
+--- AddToSpawnQueue
+-- @realm shared
+-- @tparam ItemPrefab itemPrefab
+-- @tparam Inventory inventory
+-- @tparam Nullable`1 condition
+-- @tparam Nullable`1 quality
+-- @tparam function onSpawned
+-- @tparam bool spawnIfInventoryFull
+-- @tparam bool ignoreLimbSlots
+-- @tparam InvSlotType slot
+function AddToSpawnQueue(itemPrefab, inventory, condition, quality, onSpawned, spawnIfInventoryFull, ignoreLimbSlots, slot) end
+
+--- AddToSpawnQueue
+-- @realm shared
+-- @tparam string speciesName
+-- @tparam Vector2 worldPosition
+-- @tparam function onSpawn
+function AddToSpawnQueue(speciesName, worldPosition, onSpawn) end
+
+--- AddToSpawnQueue
+-- @realm shared
+-- @tparam string speciesName
+-- @tparam Vector2 position
+-- @tparam Submarine sub
+-- @tparam function onSpawn
+function AddToSpawnQueue(speciesName, position, sub, onSpawn) end
+
+--- AddToSpawnQueue
+-- @realm shared
+-- @tparam string speciesName
+-- @tparam Vector2 worldPosition
+-- @tparam CharacterInfo characterInfo
+-- @tparam function onSpawn
+function AddToSpawnQueue(speciesName, worldPosition, characterInfo, onSpawn) end
+
+--- AddToRemoveQueue
+-- @realm shared
+-- @tparam Entity entity
+function AddToRemoveQueue(entity) end
+
+--- AddToRemoveQueue
+-- @realm shared
+-- @tparam Item item
+function AddToRemoveQueue(item) end
+
+--- IsInSpawnQueue
+-- @realm shared
+-- @tparam Predicate`1 predicate
+-- @treturn bool
+function IsInSpawnQueue(predicate) end
+
+--- CountSpawnQueue
+-- @realm shared
+-- @tparam Predicate`1 predicate
+-- @treturn number
+function CountSpawnQueue(predicate) end
+
+--- IsInRemoveQueue
+-- @realm shared
+-- @tparam Entity entity
+-- @treturn bool
+function IsInRemoveQueue(entity) end
+
+--- Update
+-- @realm shared
+-- @tparam bool createNetworkEvents
+function Update(createNetworkEvents) end
+
+--- Reset
+-- @realm shared
+function Reset() end
+
+--- FreeID
+-- @realm shared
+function FreeID() end
+
+--- Remove
+-- @realm shared
+function Remove() 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
+
+---
+-- Removed, Field of type bool
+-- @realm shared
+-- @bool Removed
+
+---
+-- IdFreed, Field of type bool
+-- @realm shared
+-- @bool IdFreed
+
+---
+-- SimPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 SimPosition
+
+---
+-- Position, Field of type Vector2
+-- @realm shared
+-- @Vector2 Position
+
+---
+-- WorldPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 WorldPosition
+
+---
+-- DrawPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 DrawPosition
+
+---
+-- Submarine, Field of type Submarine
+-- @realm shared
+-- @Submarine Submarine
+
+---
+-- AiTarget, Field of type AITarget
+-- @realm shared
+-- @AITarget AiTarget
+
+---
+-- InDetectable, Field of type bool
+-- @realm shared
+-- @bool InDetectable
+
+---
+-- SpawnTime, Field of type number
+-- @realm shared
+-- @number SpawnTime
+
+---
+-- ID, Field of type number
+-- @realm shared
+-- @number ID
+

docs/lua/generated/Entity.lua

@@ -0,0 +1,156 @@
+-- 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
+
+--- GetEntities
+-- @realm shared
+-- @treturn IEnumerable`1
+function Entity.GetEntities() end
+
+--- FindFreeID
+-- @realm shared
+-- @tparam number idOffset
+-- @treturn number
+function Entity.FindFreeID(idOffset) end
+
+--- FindEntityByID
+-- @realm shared
+-- @tparam number ID
+-- @treturn Entity
+function Entity.FindEntityByID(ID) end
+
+--- RemoveAll
+-- @realm shared
+function Entity.RemoveAll() end
+
+--- FreeID
+-- @realm shared
+function FreeID() end
+
+--- Remove
+-- @realm shared
+function Remove() end
+
+--- DumpIds
+-- @realm shared
+-- @tparam number count
+-- @tparam string filename
+function Entity.DumpIds(count, filename) 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
+
+---
+-- Entity.EntityCount, Field of type number
+-- @realm shared
+-- @number Entity.EntityCount
+
+---
+-- Removed, Field of type bool
+-- @realm shared
+-- @bool Removed
+
+---
+-- IdFreed, Field of type bool
+-- @realm shared
+-- @bool IdFreed
+
+---
+-- SimPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 SimPosition
+
+---
+-- Position, Field of type Vector2
+-- @realm shared
+-- @Vector2 Position
+
+---
+-- WorldPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 WorldPosition
+
+---
+-- DrawPosition, Field of type Vector2
+-- @realm shared
+-- @Vector2 DrawPosition
+
+---
+-- Submarine, Field of type Submarine
+-- @realm shared
+-- @Submarine Submarine
+
+---
+-- AiTarget, Field of type AITarget
+-- @realm shared
+-- @AITarget AiTarget
+
+---
+-- InDetectable, Field of type bool
+-- @realm shared
+-- @bool InDetectable
+
+---
+-- SpawnTime, Field of type number
+-- @realm shared
+-- @number SpawnTime
+
+---
+-- ID, Field of type number
+-- @realm shared
+-- @number ID
+
+---
+-- Entity.Spawner, Field of type EntitySpawner
+-- @realm shared
+-- @EntitySpawner Entity.Spawner
+
+---
+-- Entity.NullEntityID, Field of type number
+-- @realm shared
+-- @number Entity.NullEntityID
+
+---
+-- Entity.EntitySpawnerID, Field of type number
+-- @realm shared
+-- @number Entity.EntitySpawnerID
+
+---
+-- Entity.RespawnManagerID, Field of type number
+-- @realm shared
+-- @number Entity.RespawnManagerID
+
+---
+-- Entity.DummyID, Field of type number
+-- @realm shared
+-- @number Entity.DummyID
+
+---
+-- Entity.ReservedIDStart, Field of type number
+-- @realm shared
+-- @number Entity.ReservedIDStart
+

docs/lua/generated/GameScreen.lua

@@ -0,0 +1,53 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma.GameScreen
+]]
+-- @code Game.GameScreen
+-- @pragma nostrip
+local GameScreen = {}
+
+--- Select
+-- @realm shared
+function Select() end
+
+--- Deselect
+-- @realm shared
+function Deselect() end
+
+--- Update
+-- @realm shared
+-- @tparam number deltaTime
+function Update(deltaTime) 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
+
+---
+-- Cam, Field of type Camera
+-- @realm shared
+-- @Camera Cam
+
+---
+-- GameTime, Field of type number
+-- @realm shared
+-- @number GameTime
+

docs/lua/generated/GameSession.lua

@@ -0,0 +1,227 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma.GameSession
+]]
+-- @code Game.GameSession
+-- @pragma nostrip
+local GameSession = {}
+
+--- LoadPreviousSave
+-- @realm shared
+function LoadPreviousSave() end
+
+--- SwitchSubmarine
+-- @realm shared
+-- @tparam SubmarineInfo newSubmarine
+-- @tparam number cost
+-- @treturn SubmarineInfo
+function SwitchSubmarine(newSubmarine, cost) end
+
+--- PurchaseSubmarine
+-- @realm shared
+-- @tparam SubmarineInfo newSubmarine
+function PurchaseSubmarine(newSubmarine) end
+
+--- IsSubmarineOwned
+-- @realm shared
+-- @tparam SubmarineInfo query
+-- @treturn bool
+function IsSubmarineOwned(query) end
+
+--- IsCurrentLocationRadiated
+-- @realm shared
+-- @treturn bool
+function IsCurrentLocationRadiated() end
+
+--- StartRound
+-- @realm shared
+-- @tparam string levelSeed
+-- @tparam Nullable`1 difficulty
+function StartRound(levelSeed, difficulty) end
+
+--- StartRound
+-- @realm shared
+-- @tparam LevelData levelData
+-- @tparam bool mirrorLevel
+-- @tparam SubmarineInfo startOutpost
+-- @tparam SubmarineInfo endOutpost
+function StartRound(levelData, mirrorLevel, startOutpost, endOutpost) end
+
+--- PlaceSubAtStart
+-- @realm shared
+-- @tparam Level level
+function PlaceSubAtStart(level) end
+
+--- Update
+-- @realm shared
+-- @tparam number deltaTime
+function Update(deltaTime) end
+
+--- GetMission
+-- @realm shared
+-- @tparam number index
+-- @treturn Mission
+function GetMission(index) end
+
+--- GetMissionIndex
+-- @realm shared
+-- @tparam Mission mission
+-- @treturn number
+function GetMissionIndex(mission) end
+
+--- EnforceMissionOrder
+-- @realm shared
+-- @tparam table missionIdentifiers
+function EnforceMissionOrder(missionIdentifiers) end
+
+--- GetSessionCrewCharacters
+-- @realm shared
+-- @treturn IEnumerable`1
+function GameSession.GetSessionCrewCharacters() end
+
+--- EndRound
+-- @realm shared
+-- @tparam string endMessage
+-- @tparam table traitorResults
+-- @tparam TransitionType transitionType
+function EndRound(endMessage, traitorResults, transitionType) end
+
+--- KillCharacter
+-- @realm shared
+-- @tparam Character character
+function KillCharacter(character) end
+
+--- ReviveCharacter
+-- @realm shared
+-- @tparam Character character
+function ReviveCharacter(character) end
+
+--- IsCompatibleWithEnabledContentPackages
+-- @realm shared
+-- @tparam IList`1 contentPackagePaths
+-- @tparam String& errorMsg
+-- @treturn bool
+function GameSession.IsCompatibleWithEnabledContentPackages(contentPackagePaths, errorMsg) end
+
+--- Save
+-- @realm shared
+-- @tparam string filePath
+function Save(filePath) 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
+
+---
+-- Missions, Field of type IEnumerable`1
+-- @realm shared
+-- @IEnumerable`1 Missions
+
+---
+-- IsRunning, Field of type bool
+-- @realm shared
+-- @bool IsRunning
+
+---
+-- RoundEnding, Field of type bool
+-- @realm shared
+-- @bool RoundEnding
+
+---
+-- Level, Field of type Level
+-- @realm shared
+-- @Level Level
+
+---
+-- LevelData, Field of type LevelData
+-- @realm shared
+-- @LevelData LevelData
+
+---
+-- MirrorLevel, Field of type bool
+-- @realm shared
+-- @bool MirrorLevel
+
+---
+-- Map, Field of type Map
+-- @realm shared
+-- @Map Map
+
+---
+-- Campaign, Field of type CampaignMode
+-- @realm shared
+-- @CampaignMode Campaign
+
+---
+-- StartLocation, Field of type Location
+-- @realm shared
+-- @Location StartLocation
+
+---
+-- EndLocation, Field of type Location
+-- @realm shared
+-- @Location EndLocation
+
+---
+-- SubmarineInfo, Field of type SubmarineInfo
+-- @realm shared
+-- @SubmarineInfo SubmarineInfo
+
+---
+-- Submarine, Field of type Submarine
+-- @realm shared
+-- @Submarine Submarine
+
+---
+-- SavePath, Field of type string
+-- @realm shared
+-- @string SavePath
+
+---
+-- EventManager, Field of type EventManager
+-- @realm shared
+-- @EventManager EventManager
+
+---
+-- GameMode, Field of type GameMode
+-- @realm shared
+-- @GameMode GameMode
+
+---
+-- CrewManager, Field of type CrewManager
+-- @realm shared
+-- @CrewManager CrewManager
+
+---
+-- RoundStartTime, Field of type number
+-- @realm shared
+-- @number RoundStartTime
+
+---
+-- WinningTeam, Field of type Nullable`1
+-- @realm shared
+-- @Nullable`1 WinningTeam
+
+---
+-- OwnedSubmarines, Field of type table
+-- @realm shared
+-- @table OwnedSubmarines
+

docs/lua/generated/ItemPrefab.lua

@@ -0,0 +1,634 @@
+-- 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
+
+
+--- RemoveByFile
+-- @realm shared
+-- @tparam string filePath
+function ItemPrefab.RemoveByFile(filePath) end
+
+--- LoadFromFile
+-- @realm shared
+-- @tparam ContentFile file
+function ItemPrefab.LoadFromFile(file) end
+
+--- LoadAll
+-- @realm shared
+-- @tparam IEnumerable`1 files
+function ItemPrefab.LoadAll(files) end
+
+--- InitFabricationRecipes
+-- @realm shared
+function ItemPrefab.InitFabricationRecipes() end
+
+--- GenerateLegacyIdentifier
+-- @realm shared
+-- @tparam string name
+-- @treturn string
+function ItemPrefab.GenerateLegacyIdentifier(name) end
+
+--- GetTreatmentSuitability
+-- @realm shared
+-- @tparam string treatmentIdentifier
+-- @treturn number
+function GetTreatmentSuitability(treatmentIdentifier) end
+
+--- GetPriceInfo
+-- @realm shared
+-- @tparam Location location
+-- @treturn PriceInfo
+function GetPriceInfo(location) end
+
+--- CanBeBoughtAtLocation
+-- @realm shared
+-- @tparam Location location
+-- @tparam PriceInfo& priceInfo
+-- @treturn bool
+function CanBeBoughtAtLocation(location, priceInfo) end
+
+--- Find
+-- @realm shared
+-- @tparam string name
+-- @tparam string identifier
+-- @treturn ItemPrefab
+function ItemPrefab.Find(name, identifier) end
+
+--- GetMinPrice
+-- @realm shared
+-- @treturn Nullable`1
+function GetMinPrice() end
+
+--- GetBuyPricesUnder
+-- @realm shared
+-- @tparam number maxCost
+-- @treturn ImmutableDictionary`2
+function GetBuyPricesUnder(maxCost) end
+
+--- GetSellPricesOver
+-- @realm shared
+-- @tparam number minCost
+-- @tparam bool sellingImportant
+-- @treturn ImmutableDictionary`2
+function GetSellPricesOver(minCost, sellingImportant) end
+
+--- IsContainerPreferred
+-- @realm shared
+-- @tparam Item item
+-- @tparam ItemContainer targetContainer
+-- @tparam Boolean& isPreferencesDefined
+-- @tparam Boolean& isSecondary
+-- @treturn bool
+function IsContainerPreferred(item, targetContainer, isPreferencesDefined, isSecondary) end
+
+--- IsContainerPreferred
+-- @realm shared
+-- @tparam Item item
+-- @tparam String[] identifiersOrTags
+-- @tparam Boolean& isPreferencesDefined
+-- @tparam Boolean& isSecondary
+-- @treturn bool
+function IsContainerPreferred(item, identifiersOrTags, isPreferencesDefined, isSecondary) end
+
+--- IsContainerPreferred
+-- @realm shared
+-- @tparam IEnumerable`1 preferences
+-- @tparam ItemContainer c
+-- @treturn bool
+function ItemPrefab.IsContainerPreferred(preferences, c) end
+
+--- IsContainerPreferred
+-- @realm shared
+-- @tparam IEnumerable`1 preferences
+-- @tparam IEnumerable`1 ids
+-- @treturn bool
+function ItemPrefab.IsContainerPreferred(preferences, ids) end
+
+--- GetItemPrefab
+-- @realm shared
+-- @tparam string itemNameOrId
+-- @treturn ItemPrefab
+function ItemPrefab.GetItemPrefab(itemNameOrId) end
+
+--- AddToSpawnQueue
+-- @realm shared
+-- @tparam ItemPrefab itemPrefab
+-- @tparam Vector2 position
+-- @tparam Object spawned
+function ItemPrefab.AddToSpawnQueue(itemPrefab, position, spawned) end
+
+--- AddToSpawnQueue
+-- @realm shared
+-- @tparam ItemPrefab itemPrefab
+-- @tparam Inventory inventory
+-- @tparam Object spawned
+function ItemPrefab.AddToSpawnQueue(itemPrefab, inventory, spawned) end
+
+--- Dispose
+-- @realm shared
+function Dispose() end
+
+--- GetItemNameTextId
+-- @realm shared
+-- @treturn string
+function GetItemNameTextId() end
+
+--- GetHullNameTextId
+-- @realm shared
+-- @treturn string
+function GetHullNameTextId() end
+
+--- GetAllowedUpgrades
+-- @realm shared
+-- @treturn String[]
+function GetAllowedUpgrades() end
+
+--- HasSubCategory
+-- @realm shared
+-- @tparam string subcategory
+-- @treturn bool
+function HasSubCategory(subcategory) end
+
+--- DebugCreateInstance
+-- @realm shared
+function DebugCreateInstance() end
+
+--- NameMatches
+-- @realm shared
+-- @tparam string name
+-- @tparam StringComparison comparisonType
+-- @treturn bool
+function NameMatches(name, comparisonType) end
+
+--- NameMatches
+-- @realm shared
+-- @tparam IEnumerable`1 allowedNames
+-- @tparam StringComparison comparisonType
+-- @treturn bool
+function NameMatches(allowedNames, comparisonType) end
+
+--- IsLinkAllowed
+-- @realm shared
+-- @tparam MapEntityPrefab target
+-- @treturn bool
+function IsLinkAllowed(target) 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
+
+---
+-- Name, Field of type string
+-- @realm shared
+-- @string Name
+
+---
+-- ConfigElement, Field of type XElement
+-- @realm shared
+-- @XElement ConfigElement
+
+---
+-- DeconstructItems, Field of type table
+-- @realm shared
+-- @table DeconstructItems
+
+---
+-- FabricationRecipes, Field of type table
+-- @realm shared
+-- @table FabricationRecipes
+
+---
+-- DeconstructTime, Field of type number
+-- @realm shared
+-- @number DeconstructTime
+
+---
+-- AllowDeconstruct, Field of type bool
+-- @realm shared
+-- @bool AllowDeconstruct
+
+---
+-- InteractDistance, Field of type number
+-- @realm shared
+-- @number InteractDistance
+
+---
+-- InteractPriority, Field of type number
+-- @realm shared
+-- @number InteractPriority
+
+---
+-- InteractThroughWalls, Field of type bool
+-- @realm shared
+-- @bool InteractThroughWalls
+
+---
+-- HideConditionBar, Field of type bool
+-- @realm shared
+-- @bool HideConditionBar
+
+---
+-- HideConditionInTooltip, Field of type bool
+-- @realm shared
+-- @bool HideConditionInTooltip
+
+---
+-- RequireBodyInsideTrigger, Field of type bool
+-- @realm shared
+-- @bool RequireBodyInsideTrigger
+
+---
+-- RequireCursorInsideTrigger, Field of type bool
+-- @realm shared
+-- @bool RequireCursorInsideTrigger
+
+---
+-- RequireCampaignInteract, Field of type bool
+-- @realm shared
+-- @bool RequireCampaignInteract
+
+---
+-- FocusOnSelected, Field of type bool
+-- @realm shared
+-- @bool FocusOnSelected
+
+---
+-- OffsetOnSelected, Field of type number
+-- @realm shared
+-- @number OffsetOnSelected
+
+---
+-- Health, Field of type number
+-- @realm shared
+-- @number Health
+
+---
+-- AllowSellingWhenBroken, Field of type bool
+-- @realm shared
+-- @bool AllowSellingWhenBroken
+
+---
+-- Indestructible, Field of type bool
+-- @realm shared
+-- @bool Indestructible
+
+---
+-- DamagedByExplosions, Field of type bool
+-- @realm shared
+-- @bool DamagedByExplosions
+
+---
+-- ExplosionDamageMultiplier, Field of type number
+-- @realm shared
+-- @number ExplosionDamageMultiplier
+
+---
+-- DamagedByProjectiles, Field of type bool
+-- @realm shared
+-- @bool DamagedByProjectiles
+
+---
+-- DamagedByMeleeWeapons, Field of type bool
+-- @realm shared
+-- @bool DamagedByMeleeWeapons
+
+---
+-- DamagedByRepairTools, Field of type bool
+-- @realm shared
+-- @bool DamagedByRepairTools
+
+---
+-- DamagedByMonsters, Field of type bool
+-- @realm shared
+-- @bool DamagedByMonsters
+
+---
+-- FireProof, Field of type bool
+-- @realm shared
+-- @bool FireProof
+
+---
+-- WaterProof, Field of type bool
+-- @realm shared
+-- @bool WaterProof
+
+---
+-- ImpactTolerance, Field of type number
+-- @realm shared
+-- @number ImpactTolerance
+
+---
+-- SonarSize, Field of type number
+-- @realm shared
+-- @number SonarSize
+
+---
+-- UseInHealthInterface, Field of type bool
+-- @realm shared
+-- @bool UseInHealthInterface
+
+---
+-- DisableItemUsageWhenSelected, Field of type bool
+-- @realm shared
+-- @bool DisableItemUsageWhenSelected
+
+---
+-- CargoContainerIdentifier, Field of type string
+-- @realm shared
+-- @string CargoContainerIdentifier
+
+---
+-- UseContainedSpriteColor, Field of type bool
+-- @realm shared
+-- @bool UseContainedSpriteColor
+
+---
+-- UseContainedInventoryIconColor, Field of type bool
+-- @realm shared
+-- @bool UseContainedInventoryIconColor
+
+---
+-- AddedRepairSpeedMultiplier, Field of type number
+-- @realm shared
+-- @number AddedRepairSpeedMultiplier
+
+---
+-- CannotRepairFail, Field of type bool
+-- @realm shared
+-- @bool CannotRepairFail
+
+---
+-- EquipConfirmationText, Field of type string
+-- @realm shared
+-- @string EquipConfirmationText
+
+---
+-- AllowRotatingInEditor, Field of type bool
+-- @realm shared
+-- @bool AllowRotatingInEditor
+
+---
+-- ShowContentsInTooltip, Field of type bool
+-- @realm shared
+-- @bool ShowContentsInTooltip
+
+---
+-- PreferredContainers, Field of type table
+-- @realm shared
+-- @table PreferredContainers
+
+---
+-- SwappableItem, Field of type SwappableItem
+-- @realm shared
+-- @SwappableItem SwappableItem
+
+---
+-- LevelCommonness, Field of type table
+-- @realm shared
+-- @table LevelCommonness
+
+---
+-- LevelQuantity, Field of type table
+-- @realm shared
+-- @table LevelQuantity
+
+---
+-- CanFlipX, Field of type bool
+-- @realm shared
+-- @bool CanFlipX
+
+---
+-- CanFlipY, Field of type bool
+-- @realm shared
+-- @bool CanFlipY
+
+---
+-- IsDangerous, Field of type bool
+-- @realm shared
+-- @bool IsDangerous
+
+---
+-- CanSpriteFlipX, Field of type bool
+-- @realm shared
+-- @bool CanSpriteFlipX
+
+---
+-- CanSpriteFlipY, Field of type bool
+-- @realm shared
+-- @bool CanSpriteFlipY
+
+---
+-- MaxStackSize, Field of type number
+-- @realm shared
+-- @number MaxStackSize
+
+---
+-- AllowDroppingOnSwap, Field of type bool
+-- @realm shared
+-- @bool AllowDroppingOnSwap
+
+---
+-- AllowDroppingOnSwapWith, Field of type IEnumerable`1
+-- @realm shared
+-- @IEnumerable`1 AllowDroppingOnSwapWith
+
+---
+-- Size, Field of type Vector2
+-- @realm shared
+-- @Vector2 Size
+
+---
+-- CanBeBought, Field of type bool
+-- @realm shared
+-- @bool CanBeBought
+
+---
+-- CanBeSold, Field of type bool
+-- @realm shared
+-- @bool CanBeSold
+
+---
+-- RandomDeconstructionOutput, Field of type bool
+-- @realm shared
+-- @bool RandomDeconstructionOutput
+
+---
+-- RandomDeconstructionOutputAmount, Field of type number
+-- @realm shared
+-- @number RandomDeconstructionOutputAmount
+
+---
+-- UIntIdentifier, Field of type number
+-- @realm shared
+-- @number UIntIdentifier
+
+---
+-- ResizeHorizontal, Field of type bool
+-- @realm shared
+-- @bool ResizeHorizontal
+
+---
+-- ResizeVertical, Field of type bool
+-- @realm shared
+-- @bool ResizeVertical
+
+---
+-- OriginalName, Field of type string
+-- @realm shared
+-- @string OriginalName
+
+---
+-- Identifier, Field of type string
+-- @realm shared
+-- @string Identifier
+
+---
+-- FilePath, Field of type string
+-- @realm shared
+-- @string FilePath
+
+---
+-- ContentPackage, Field of type ContentPackage
+-- @realm shared
+-- @ContentPackage ContentPackage
+
+---
+-- Tags, Field of type HashSet`1
+-- @realm shared
+-- @HashSet`1 Tags
+
+---
+-- Description, Field of type string
+-- @realm shared
+-- @string Description
+
+---
+-- AllowedUpgrades, Field of type string
+-- @realm shared
+-- @string AllowedUpgrades
+
+---
+-- HideInMenus, Field of type bool
+-- @realm shared
+-- @bool HideInMenus
+
+---
+-- Subcategory, Field of type string
+-- @realm shared
+-- @string Subcategory
+
+---
+-- Linkable, Field of type bool
+-- @realm shared
+-- @bool Linkable
+
+---
+-- AllowedLinks, Field of type table
+-- @realm shared
+-- @table AllowedLinks
+
+---
+-- Category, Field of type MapEntityCategory
+-- @realm shared
+-- @MapEntityCategory Category
+
+---
+-- SpriteColor, Field of type Color
+-- @realm shared
+-- @Color SpriteColor
+
+---
+-- Scale, Field of type number
+-- @realm shared
+-- @number Scale
+
+---
+-- Aliases, Field of type HashSet`1
+-- @realm shared
+-- @HashSet`1 Aliases
+
+---
+-- DefaultPrice, Field of type PriceInfo
+-- @realm shared
+-- @PriceInfo DefaultPrice
+
+---
+-- Triggers, Field of type table
+-- @realm shared
+-- @table Triggers
+
+---
+-- IsOverride, Field of type bool
+-- @realm shared
+-- @bool IsOverride
+
+---
+-- VariantOf, Field of type ItemPrefab
+-- @realm shared
+-- @ItemPrefab VariantOf
+
+---
+-- AllowAsExtraCargo, Field of type Nullable`1
+-- @realm shared
+-- @Nullable`1 AllowAsExtraCargo
+
+---
+-- ItemPrefab.Prefabs, Field of type PrefabCollection`1
+-- @realm shared
+-- @PrefabCollection`1 ItemPrefab.Prefabs
+
+---
+-- sprite, Field of type Sprite
+-- @realm shared
+-- @Sprite sprite
+

docs/lua/generated/Job.lua

@@ -0,0 +1,95 @@
+-- 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 = {}
+
+
+--- Random
+-- @realm shared
+-- @tparam RandSync randSync
+-- @treturn Job
+function Job.Random(randSync) end
+
+--- GetSkillLevel
+-- @realm shared
+-- @tparam string skillIdentifier
+-- @treturn number
+function GetSkillLevel(skillIdentifier) end
+
+--- IncreaseSkillLevel
+-- @realm shared
+-- @tparam string skillIdentifier
+-- @tparam number increase
+-- @tparam bool increasePastMax
+function IncreaseSkillLevel(skillIdentifier, increase, increasePastMax) end
+
+--- GiveJobItems
+-- @realm shared
+-- @tparam Character character
+-- @tparam WayPoint spawnPoint
+function GiveJobItems(character, spawnPoint) end
+
+--- Save
+-- @realm shared
+-- @tparam XElement parentElement
+-- @treturn XElement
+function Save(parentElement) 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
+
+---
+-- Name, Field of type string
+-- @realm shared
+-- @string Name
+
+---
+-- Description, Field of type string
+-- @realm shared
+-- @string Description
+
+---
+-- Prefab, Field of type JobPrefab
+-- @realm shared
+-- @JobPrefab Prefab
+
+---
+-- Skills, Field of type table
+-- @realm shared
+-- @table Skills
+
+---
+-- PrimarySkill, Field of type Skill
+-- @realm shared
+-- @Skill PrimarySkill
+
+---
+-- Variant, Field of type number
+-- @realm shared
+-- @number Variant
+

docs/lua/generated/JobPrefab.lua

@@ -0,0 +1,224 @@
+-- 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 = {}
+
+--- Dispose
+-- @realm shared
+function Dispose() end
+
+--- Get
+-- @realm shared
+-- @tparam string identifier
+-- @treturn JobPrefab
+function JobPrefab.Get(identifier) end
+
+--- Random
+-- @realm shared
+-- @tparam RandSync sync
+-- @treturn JobPrefab
+function JobPrefab.Random(sync) end
+
+--- LoadAll
+-- @realm shared
+-- @tparam IEnumerable`1 files
+function JobPrefab.LoadAll(files) end
+
+--- LoadFromFile
+-- @realm shared
+-- @tparam ContentFile file
+function JobPrefab.LoadFromFile(file) end
+
+--- RemoveByFile
+-- @realm shared
+-- @tparam string filePath
+function JobPrefab.RemoveByFile(filePath) 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
+
+---
+-- JobPrefab.ItemRepairPriorities, Field of type IReadOnlyDictionary`2
+-- @realm shared
+-- @IReadOnlyDictionary`2 JobPrefab.ItemRepairPriorities
+
+---
+-- UIColor, Field of type Color
+-- @realm shared
+-- @Color UIColor
+
+---
+-- Identifier, Field of type string
+-- @realm shared
+-- @string Identifier
+
+---
+-- Name, Field of type string
+-- @realm shared
+-- @string Name
+
+---
+-- IdleBehavior, Field of type BehaviorType
+-- @realm shared
+-- @BehaviorType IdleBehavior
+
+---
+-- OriginalName, Field of type string
+-- @realm shared
+-- @string OriginalName
+
+---
+-- ContentPackage, Field of type ContentPackage
+-- @realm shared
+-- @ContentPackage ContentPackage
+
+---
+-- Description, Field of type string
+-- @realm shared
+-- @string Description
+
+---
+-- OnlyJobSpecificDialog, Field of type bool
+-- @realm shared
+-- @bool OnlyJobSpecificDialog
+
+---
+-- InitialCount, Field of type number
+-- @realm shared
+-- @number InitialCount
+
+---
+-- AllowAlways, Field of type bool
+-- @realm shared
+-- @bool AllowAlways
+
+---
+-- MaxNumber, Field of type number
+-- @realm shared
+-- @number MaxNumber
+
+---
+-- MinNumber, Field of type number
+-- @realm shared
+-- @number MinNumber
+
+---
+-- MinKarma, Field of type number
+-- @realm shared
+-- @number MinKarma
+
+---
+-- PriceMultiplier, Field of type number
+-- @realm shared
+-- @number PriceMultiplier
+
+---
+-- Commonness, Field of type number
+-- @realm shared
+-- @number Commonness
+
+---
+-- VitalityModifier, Field of type number
+-- @realm shared
+-- @number VitalityModifier
+
+---
+-- HiddenJob, Field of type bool
+-- @realm shared
+-- @bool HiddenJob
+
+---
+-- PrimarySkill, Field of type SkillPrefab
+-- @realm shared
+-- @SkillPrefab PrimarySkill
+
+---
+-- FilePath, Field of type string
+-- @realm shared
+-- @string FilePath
+
+---
+-- Element, Field of type XElement
+-- @realm shared
+-- @XElement Element
+
+---
+-- ClothingElement, Field of type XElement
+-- @realm shared
+-- @XElement ClothingElement
+
+---
+-- Variants, Field of type number
+-- @realm shared
+-- @number Variants
+
+---
+-- ItemSets, Field of type table
+-- @realm shared
+-- @table ItemSets
+
+---
+-- PreviewItems, Field of type table
+-- @realm shared
+-- @table PreviewItems
+
+---
+-- Skills, Field of type table
+-- @realm shared
+-- @table Skills
+
+---
+-- AutonomousObjectives, Field of type table
+-- @realm shared
+-- @table AutonomousObjectives
+
+---
+-- AppropriateOrders, Field of type table
+-- @realm shared
+-- @table AppropriateOrders
+
+---
+-- Icon, Field of type Sprite
+-- @realm shared
+-- @Sprite Icon
+
+---
+-- IconSmall, Field of type Sprite
+-- @realm shared
+-- @Sprite IconSmall
+
+---
+-- JobPrefab.Prefabs, Field of type PrefabCollection`1
+-- @realm shared
+-- @PrefabCollection`1 JobPrefab.Prefabs
+
+---
+-- JobPrefab.NoJobElement, Field of type XElement
+-- @realm shared
+-- @XElement JobPrefab.NoJobElement
+

docs/lua/generated/NetLobbyScreen.lua

@@ -0,0 +1,197 @@
+-- luacheck: ignore 111
+
+--[[--
+Barotrauma.NetLobbyScreen
+]]
+-- @code Game.NetLobbyScreen
+-- @pragma nostrip
+local NetLobbyScreen = {}
+
+--- AddCampaignSubmarine
+-- @realm shared
+-- @tparam SubmarineInfo sub
+function AddCampaignSubmarine(sub) end
+
+--- RemoveCampaignSubmarine
+-- @realm shared
+-- @tparam SubmarineInfo sub
+function RemoveCampaignSubmarine(sub) end
+
+--- ChangeServerName
+-- @realm shared
+-- @tparam string n
+function ChangeServerName(n) end
+
+--- ChangeServerMessage
+-- @realm shared
+-- @tparam string m
+function ChangeServerMessage(m) end
+
+--- GetSubList
+-- @realm shared
+-- @treturn table
+function GetSubList() end
+
+--- AddSub
+-- @realm shared
+-- @tparam SubmarineInfo sub
+function AddSub(sub) end
+
+--- ToggleCampaignMode
+-- @realm shared
+-- @tparam bool enabled
+function ToggleCampaignMode(enabled) end
+
+--- Select
+-- @realm shared
+function Select() end
+
+--- RandomizeSettings
+-- @realm shared
+function RandomizeSettings() end
+
+--- SetLevelDifficulty
+-- @realm shared
+-- @tparam number difficulty
+function SetLevelDifficulty(difficulty) end
+
+--- SetRadiationEnabled
+-- @realm shared
+-- @tparam bool enabled
+function SetRadiationEnabled(enabled) end
+
+--- IsRadiationEnabled
+-- @realm shared
+-- @treturn bool
+function IsRadiationEnabled() end
+
+--- SetMaxMissionCount
+-- @realm shared
+-- @tparam number maxMissionCount
+function SetMaxMissionCount(maxMissionCount) end
+
+--- GetMaxMissionCount
+-- @realm shared
+-- @treturn number
+function GetMaxMissionCount() end
+
+--- ToggleTraitorsEnabled
+-- @realm shared
+-- @tparam number dir
+function ToggleTraitorsEnabled(dir) end
+
+--- SetBotCount
+-- @realm shared
+-- @tparam number botCount
+function SetBotCount(botCount) end
+
+--- SetBotSpawnMode
+-- @realm shared
+-- @tparam BotSpawnMode botSpawnMode
+function SetBotSpawnMode(botSpawnMode) end
+
+--- SetTraitorsEnabled
+-- @realm shared
+-- @tparam YesNoMaybe enabled
+function SetTraitorsEnabled(enabled) end
+
+--- Deselect
+-- @realm shared
+function Deselect() end
+
+--- Update
+-- @realm shared
+-- @tparam number deltaTime
+function Update(deltaTime) 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
+
+---
+-- SelectedSub, Field of type SubmarineInfo
+-- @realm shared
+-- @SubmarineInfo SelectedSub
+
+---
+-- SelectedShuttle, Field of type SubmarineInfo
+-- @realm shared
+-- @SubmarineInfo SelectedShuttle
+
+---
+-- CampaignSubmarines, Field of type table
+-- @realm shared
+-- @table CampaignSubmarines
+
+---
+-- GameModes, Field of type GameModePreset[]
+-- @realm shared
+-- @GameModePreset[] GameModes
+
+---
+-- SelectedModeIndex, Field of type number
+-- @realm shared
+-- @number SelectedModeIndex
+
+---
+-- SelectedModeIdentifier, Field of type string
+-- @realm shared
+-- @string SelectedModeIdentifier
+
+---
+-- SelectedMode, Field of type GameModePreset
+-- @realm shared
+-- @GameModePreset SelectedMode
+
+---
+-- MissionType, Field of type MissionType
+-- @realm shared
+-- @MissionType MissionType
+
+---
+-- MissionTypeName, Field of type string
+-- @realm shared
+-- @string MissionTypeName
+
+---
+-- JobPreferences, Field of type table
+-- @realm shared
+-- @table JobPreferences
+
+---
+-- LevelSeed, Field of type string
+-- @realm shared
+-- @string LevelSeed
+
+---
+-- LastUpdateID, Field of type number
+-- @realm shared
+-- @number LastUpdateID
+
+---
+-- Cam, Field of type Camera
+-- @realm shared
+-- @Camera Cam
+
+---
+-- RadiationEnabled, Field of type bool
+-- @realm shared
+-- @bool RadiationEnabled
+

docs/lua/generated/Submarine.lua

@@ -0,0 +1,601 @@
+-- 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 = {}
+
+--- FindContaining
+-- @realm shared
+-- @tparam Vector2 position
+-- @treturn Submarine
+function Submarine.FindContaining(position) end
+
+--- 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
+
+--- 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
+
+---
+-- SubmarineSpecificIDTag, Field of type number
+-- @realm shared
+-- @number SubmarineSpecificIDTag
+
+---
+-- 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
+
+---
+-- InDetectable, Field of type bool
+-- @realm shared
+-- @bool InDetectable
+
+---
+-- 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
+

docs/lua/generated/World.lua

@@ -0,0 +1,478 @@
+-- luacheck: ignore 111
+
+--[[--
+FarseerPhysics.Dynamics.World
+]]
+-- @code Game.World
+-- @pragma nostrip
+local World = {}
+
+--- Add
+-- @realm shared
+-- @tparam Body body
+function Add(body) end
+
+--- Remove
+-- @realm shared
+-- @tparam Body body
+function Remove(body) end
+
+--- Add
+-- @realm shared
+-- @tparam Joint joint
+function Add(joint) end
+
+--- Remove
+-- @realm shared
+-- @tparam Joint joint
+function Remove(joint) end
+
+--- AddAsync
+-- @realm shared
+-- @tparam Body body
+function AddAsync(body) end
+
+--- RemoveAsync
+-- @realm shared
+-- @tparam Body body
+function RemoveAsync(body) end
+
+--- AddAsync
+-- @realm shared
+-- @tparam Joint joint
+function AddAsync(joint) end
+
+--- RemoveAsync
+-- @realm shared
+-- @tparam Joint joint
+function RemoveAsync(joint) end
+
+--- ProcessChanges
+-- @realm shared
+function ProcessChanges() end
+
+--- Step
+-- @realm shared
+-- @tparam TimeSpan dt
+function Step(dt) end
+
+--- Step
+-- @realm shared
+-- @tparam TimeSpan dt
+-- @tparam SolverIterations& iterations
+function Step(dt, iterations) end
+
+--- Step
+-- @realm shared
+-- @tparam number dt
+function Step(dt) end
+
+--- Step
+-- @realm shared
+-- @tparam number dt
+-- @tparam SolverIterations& iterations
+function Step(dt, iterations) end
+
+--- ClearForces
+-- @realm shared
+function ClearForces() end
+
+--- QueryAABB
+-- @realm shared
+-- @tparam function callback
+-- @tparam AABB& aabb
+function QueryAABB(callback, aabb) end
+
+--- QueryAABB
+-- @realm shared
+-- @tparam AABB& aabb
+-- @treturn table
+function QueryAABB(aabb) end
+
+--- RayCast
+-- @realm shared
+-- @tparam function callback
+-- @tparam Vector2 point1
+-- @tparam Vector2 point2
+-- @tparam Category collisionCategory
+function RayCast(callback, point1, point2, collisionCategory) end
+
+--- RayCast
+-- @realm shared
+-- @tparam Vector2 point1
+-- @tparam Vector2 point2
+-- @treturn table
+function RayCast(point1, point2) end
+
+--- Add
+-- @realm shared
+-- @tparam Controller controller
+function Add(controller) end
+
+--- Remove
+-- @realm shared
+-- @tparam Controller controller
+function Remove(controller) end
+
+--- TestPoint
+-- @realm shared
+-- @tparam Vector2 point
+-- @treturn Fixture
+function TestPoint(point) end
+
+--- TestPointAll
+-- @realm shared
+-- @tparam Vector2 point
+-- @treturn table
+function TestPointAll(point) end
+
+--- ShiftOrigin
+-- @realm shared
+-- @tparam Vector2 newOrigin
+function ShiftOrigin(newOrigin) end
+
+--- Clear
+-- @realm shared
+function Clear() end
+
+--- CreateBody
+-- @realm shared
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateBody(position, rotation, bodyType) end
+
+--- CreateEdge
+-- @realm shared
+-- @tparam Vector2 start
+-- @tparam Vector2 endparam
+-- @treturn Body
+function CreateEdge(start, endparam) end
+
+--- CreateChainShape
+-- @realm shared
+-- @tparam Vertices vertices
+-- @tparam Vector2 position
+-- @treturn Body
+function CreateChainShape(vertices, position) end
+
+--- CreateLoopShape
+-- @realm shared
+-- @tparam Vertices vertices
+-- @tparam Vector2 position
+-- @treturn Body
+function CreateLoopShape(vertices, position) end
+
+--- CreateRectangle
+-- @realm shared
+-- @tparam number width
+-- @tparam number height
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateRectangle(width, height, density, position, rotation, bodyType) end
+
+--- CreateCircle
+-- @realm shared
+-- @tparam number radius
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateCircle(radius, density, position, bodyType) end
+
+--- CreateEllipse
+-- @realm shared
+-- @tparam number xRadius
+-- @tparam number yRadius
+-- @tparam number edges
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateEllipse(xRadius, yRadius, edges, density, position, rotation, bodyType) end
+
+--- CreatePolygon
+-- @realm shared
+-- @tparam Vertices vertices
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreatePolygon(vertices, density, position, rotation, bodyType) end
+
+--- CreateCompoundPolygon
+-- @realm shared
+-- @tparam table list
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateCompoundPolygon(list, density, position, rotation, bodyType) end
+
+--- CreateGear
+-- @realm shared
+-- @tparam number radius
+-- @tparam number numberOfTeeth
+-- @tparam number tipPercentage
+-- @tparam number toothHeight
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateGear(radius, numberOfTeeth, tipPercentage, toothHeight, density, position, rotation, bodyType) end
+
+--- CreateCapsule
+-- @realm shared
+-- @tparam number height
+-- @tparam number topRadius
+-- @tparam number topEdges
+-- @tparam number bottomRadius
+-- @tparam number bottomEdges
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateCapsule(height, topRadius, topEdges, bottomRadius, bottomEdges, density, position, rotation, bodyType) end
+
+--- CreateCapsuleHorizontal
+-- @realm shared
+-- @tparam number width
+-- @tparam number endRadius
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateCapsuleHorizontal(width, endRadius, density, position, rotation, bodyType) end
+
+--- CreateCapsule
+-- @realm shared
+-- @tparam number height
+-- @tparam number endRadius
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateCapsule(height, endRadius, density, position, rotation, bodyType) end
+
+--- CreateRoundedRectangle
+-- @realm shared
+-- @tparam number width
+-- @tparam number height
+-- @tparam number xRadius
+-- @tparam number yRadius
+-- @tparam number segments
+-- @tparam number density
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateRoundedRectangle(width, height, xRadius, yRadius, segments, density, position, rotation, bodyType) end
+
+--- CreateLineArc
+-- @realm shared
+-- @tparam number radians
+-- @tparam number sides
+-- @tparam number radius
+-- @tparam bool closed
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateLineArc(radians, sides, radius, closed, position, rotation, bodyType) end
+
+--- CreateSolidArc
+-- @realm shared
+-- @tparam number density
+-- @tparam number radians
+-- @tparam number sides
+-- @tparam number radius
+-- @tparam Vector2 position
+-- @tparam number rotation
+-- @tparam BodyType bodyType
+-- @treturn Body
+function CreateSolidArc(density, radians, sides, radius, position, rotation, bodyType) end
+
+--- CreateChain
+-- @realm shared
+-- @tparam Vector2 start
+-- @tparam Vector2 endparam
+-- @tparam number linkWidth
+-- @tparam number linkHeight
+-- @tparam number numberOfLinks
+-- @tparam number linkDensity
+-- @tparam bool attachRopeJoint
+-- @treturn Path
+function CreateChain(start, endparam, linkWidth, linkHeight, numberOfLinks, linkDensity, attachRopeJoint) 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
+
+---
+-- Fluid, Field of type FluidSystem2
+-- @realm shared
+-- @FluidSystem2 Fluid
+
+---
+-- UpdateTime, Field of type TimeSpan
+-- @realm shared
+-- @TimeSpan UpdateTime
+
+---
+-- ContinuousPhysicsTime, Field of type TimeSpan
+-- @realm shared
+-- @TimeSpan ContinuousPhysicsTime
+
+---
+-- ControllersUpdateTime, Field of type TimeSpan
+-- @realm shared
+-- @TimeSpan ControllersUpdateTime
+
+---
+-- AddRemoveTime, Field of type TimeSpan
+-- @realm shared
+-- @TimeSpan AddRemoveTime
+
+---
+-- NewContactsTime, Field of type TimeSpan
+-- @realm shared
+-- @TimeSpan NewContactsTime
+
+---
+-- ContactsUpdateTime, Field of type TimeSpan
+-- @realm shared
+-- @TimeSpan ContactsUpdateTime
+
+---
+-- SolveUpdateTime, Field of type TimeSpan
+-- @realm shared
+-- @TimeSpan SolveUpdateTime
+
+---
+-- ProxyCount, Field of type number
+-- @realm shared
+-- @number ProxyCount
+
+---
+-- ContactCount, Field of type number
+-- @realm shared
+-- @number ContactCount
+
+---
+-- IsLocked, Field of type bool
+-- @realm shared
+-- @bool IsLocked
+
+---
+-- ContactList, Field of type ContactListHead
+-- @realm shared
+-- @ContactListHead ContactList
+
+---
+-- Enabled, Field of type bool
+-- @realm shared
+-- @bool Enabled
+
+---
+-- Island, Field of type Island
+-- @realm shared
+-- @Island Island
+
+---
+-- Tag, Field of type Object
+-- @realm shared
+-- @Object Tag
+
+---
+-- BodyAdded, Field of type BodyDelegate
+-- @realm shared
+-- @BodyDelegate BodyAdded
+
+---
+-- BodyRemoved, Field of type BodyDelegate
+-- @realm shared
+-- @BodyDelegate BodyRemoved
+
+---
+-- FixtureAdded, Field of type FixtureDelegate
+-- @realm shared
+-- @FixtureDelegate FixtureAdded
+
+---
+-- FixtureRemoved, Field of type FixtureDelegate
+-- @realm shared
+-- @FixtureDelegate FixtureRemoved
+
+---
+-- JointAdded, Field of type JointDelegate
+-- @realm shared
+-- @JointDelegate JointAdded
+
+---
+-- JointRemoved, Field of type JointDelegate
+-- @realm shared
+-- @JointDelegate JointRemoved
+
+---
+-- ControllerAdded, Field of type ControllerDelegate
+-- @realm shared
+-- @ControllerDelegate ControllerAdded
+
+---
+-- ControllerRemoved, Field of type ControllerDelegate
+-- @realm shared
+-- @ControllerDelegate ControllerRemoved
+
+---
+-- ControllerList, Field of type table
+-- @realm shared
+-- @table ControllerList
+
+---
+-- Gravity, Field of type Vector2
+-- @realm shared
+-- @Vector2 Gravity
+
+---
+-- ContactManager, Field of type ContactManager
+-- @realm shared
+-- @ContactManager ContactManager
+
+---
+-- BodyList, Field of type table
+-- @realm shared
+-- @table BodyList
+
+---
+-- JointList, Field of type table
+-- @realm shared
+-- @table JointList
+