From 928428cabdf8154ee641bcfd63497e3dcb9916dc Mon Sep 17 00:00:00 2001
From: Evil Factory <36804725+evilfactory@users.noreply.github.com>
Date: Tue, 19 Apr 2022 22:54:34 -0300
Subject: [PATCH] update docs
---
config.ld | 1 +
docs/baseluadocs/Client.lua | 2 +-
docs/lua/generated/Affliction.lua | 8 +-
docs/lua/generated/AfflictionPrefab.lua | 186 ++++----
docs/lua/generated/AnimController.lua | 19 +-
docs/lua/generated/Character.lua | 417 +++++++++++-------
docs/lua/generated/CharacterHealth.lua | 37 +-
docs/lua/generated/CharacterInfo.lua | 387 +++++++---------
docs/lua/generated/CharacterInventory.lua | 28 +-
docs/lua/generated/Client.lua | 24 +-
docs/lua/generated/Entity.Spawner.lua | 64 +--
docs/lua/generated/Entity.lua | 15 +
docs/lua/generated/GameScreen.lua | 5 +
docs/lua/generated/GameSession.lua | 22 +-
docs/lua/generated/Hull.lua | 104 +++--
docs/lua/generated/Inventory.lua | 23 +-
docs/lua/generated/Item.lua | 212 +++++----
docs/lua/generated/ItemInventory.lua | 23 +-
docs/lua/generated/ItemPrefab.lua | 339 +++++++-------
docs/lua/generated/Job.lua | 12 +-
docs/lua/generated/JobPrefab.lua | 96 ++--
docs/lua/generated/Level.lua | 21 +-
docs/lua/generated/NetLobbyScreen.lua | 9 +-
docs/lua/generated/Submarine.lua | 29 +-
docs/lua/generated/SubmarineInfo.lua | 18 +-
docs/lua/generated/WayPoint.lua | 38 +-
docs/manual/common-questions.md | 5 +-
docs/manual/getting-started.md | 13 +
.../installing-lua-for-barotrauma-manually.md | 43 +-
29 files changed, 1209 insertions(+), 991 deletions(-)
diff --git a/config.ld b/config.ld
index e43e3fbf0..1e1815bb2 100644
--- a/config.ld
+++ b/config.ld
@@ -67,6 +67,7 @@ tparam_alias("CharacterInventory", "CharacterInventory")
tparam_alias("ItemInventory", "ItemInventory")
tparam_alias("Camera", "Camera")
tparam_alias("Enumerable", "Enumerable")
+tparam_alias("Identifier", "Identifier")
tparam_alias("string", "string")
diff --git a/docs/baseluadocs/Client.lua b/docs/baseluadocs/Client.lua
index c6d1d8ef3..2e53ec794 100644
--- a/docs/baseluadocs/Client.lua
+++ b/docs/baseluadocs/Client.lua
@@ -1,7 +1,7 @@
-- luacheck: ignore 111
--[[--
-Barotrauma Character class with some additional functions and fields
+Barotrauma Client 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)
]]
diff --git a/docs/lua/generated/Affliction.lua b/docs/lua/generated/Affliction.lua
index f8725e97a..111690a3b 100644
--- a/docs/lua/generated/Affliction.lua
+++ b/docs/lua/generated/Affliction.lua
@@ -98,9 +98,9 @@ function CalculateDamagePerSecond(currentVitalityDecrease) end
--- GetResistance
-- @realm shared
--- @tparam AfflictionPrefab affliction
+-- @tparam Identifier afflictionId
-- @treturn number
-function GetResistance(affliction) end
+function GetResistance(afflictionId) end
--- GetSpeedMultiplier
-- @realm shared
@@ -201,9 +201,9 @@ function GetHashCode() end
-- @number NonClampedStrength
---
--- Identifier, Field of type string
+-- Identifier, Field of type Identifier
-- @realm shared
--- @string Identifier
+-- @Identifier Identifier
---
-- Probability, Field of type number
diff --git a/docs/lua/generated/AfflictionPrefab.lua b/docs/lua/generated/AfflictionPrefab.lua
index f685c422a..cae17b477 100644
--- a/docs/lua/generated/AfflictionPrefab.lua
+++ b/docs/lua/generated/AfflictionPrefab.lua
@@ -11,20 +11,21 @@ local AfflictionPrefab = {}
-- @realm shared
function Dispose() end
---- LoadAll
+--- LoadAllEffects
-- @realm shared
--- @tparam Enumerable files
-function AfflictionPrefab.LoadAll(files) end
+function AfflictionPrefab.LoadAllEffects() end
---- LoadFromFile
+--- ClearAllEffects
-- @realm shared
--- @tparam ContentFile file
-function AfflictionPrefab.LoadFromFile(file) end
+function AfflictionPrefab.ClearAllEffects() end
---- RemoveByFile
+--- LoadEffects
-- @realm shared
--- @tparam string filePath
-function AfflictionPrefab.RemoveByFile(filePath) end
+function LoadEffects() end
+
+--- ClearEffects
+-- @realm shared
+function ClearEffects() end
--- ToString
-- @realm shared
@@ -66,36 +67,56 @@ function Equals(obj) end
-- @treturn number
function GetHashCode() end
+---
+-- AfflictionPrefab.InternalDamage, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.InternalDamage
+
+---
+-- AfflictionPrefab.ImpactDamage, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.ImpactDamage
+
+---
+-- AfflictionPrefab.Bleeding, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.Bleeding
+
+---
+-- AfflictionPrefab.Burn, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.Burn
+
+---
+-- AfflictionPrefab.OxygenLow, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.OxygenLow
+
+---
+-- AfflictionPrefab.Bloodloss, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.Bloodloss
+
+---
+-- AfflictionPrefab.Pressure, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.Pressure
+
+---
+-- AfflictionPrefab.Stun, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.Stun
+
+---
+-- AfflictionPrefab.RadiationSickness, Field of type AfflictionPrefab
+-- @realm shared
+-- @AfflictionPrefab AfflictionPrefab.RadiationSickness
+
---
-- AfflictionPrefab.List, Field of type Enumerable
-- @realm shared
-- @Enumerable AfflictionPrefab.List
----
--- FilePath, Field of type string
--- @realm shared
--- @string FilePath
-
----
--- UIntIdentifier, Field of type number
--- @realm shared
--- @number UIntIdentifier
-
----
--- Identifier, Field of type string
--- @realm shared
--- @string Identifier
-
----
--- OriginalName, Field of type string
--- @realm shared
--- @string OriginalName
-
----
--- ContentPackage, Field of type ContentPackage
--- @realm shared
--- @ContentPackage ContentPackage
-
---
-- Effects, Field of type Enumerable
-- @realm shared
@@ -112,14 +133,24 @@ function GetHashCode() end
-- @Enumerable TreatmentSuitability
---
--- AfflictionPrefab.ListArray, Field of type AfflictionPrefab[]
+-- UintIdentifier, Field of type number
-- @realm shared
--- @AfflictionPrefab[] AfflictionPrefab.ListArray
+-- @number UintIdentifier
---
--- AfflictionType, Field of type string
+-- ContentPackage, Field of type ContentPackage
-- @realm shared
--- @string AfflictionType
+-- @ContentPackage ContentPackage
+
+---
+-- FilePath, Field of type ContentPath
+-- @realm shared
+-- @ContentPath FilePath
+
+---
+-- AfflictionType, Field of type Identifier
+-- @realm shared
+-- @Identifier AfflictionType
---
-- LimbSpecific, Field of type bool
@@ -132,19 +163,19 @@ function GetHashCode() end
-- @LimbType IndicatorLimb
---
--- Name, Field of type string
+-- Name, Field of type LocalizedString
-- @realm shared
--- @string Name
+-- @LocalizedString Name
---
--- Description, Field of type string
+-- Description, Field of type LocalizedString
-- @realm shared
--- @string Description
+-- @LocalizedString Description
---
--- TranslationOverride, Field of type string
+-- TranslationIdentifier, Field of type Identifier
-- @realm shared
--- @string TranslationOverride
+-- @Identifier TranslationIdentifier
---
-- IsBuff, Field of type bool
@@ -167,14 +198,14 @@ function GetHashCode() end
-- @number BaseHealCost
---
--- CauseOfDeathDescription, Field of type string
+-- CauseOfDeathDescription, Field of type LocalizedString
-- @realm shared
--- @string CauseOfDeathDescription
+-- @LocalizedString CauseOfDeathDescription
---
--- SelfCauseOfDeathDescription, Field of type string
+-- SelfCauseOfDeathDescription, Field of type LocalizedString
-- @realm shared
--- @string SelfCauseOfDeathDescription
+-- @LocalizedString SelfCauseOfDeathDescription
---
-- ActivationThreshold, Field of type number
@@ -227,9 +258,9 @@ function GetHashCode() end
-- @number DamageOverlayAlpha
---
--- AchievementOnRemoved, Field of type string
+-- AchievementOnRemoved, Field of type Identifier
-- @realm shared
--- @string AchievementOnRemoved
+-- @Identifier AchievementOnRemoved
---
-- Icon, Field of type Sprite
@@ -251,53 +282,18 @@ function GetHashCode() end
-- @realm shared
-- @bool AfflictionOverlayAlphaIsLinear
----
--- AfflictionPrefab.InternalDamage, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.InternalDamage
-
----
--- AfflictionPrefab.ImpactDamage, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.ImpactDamage
-
----
--- AfflictionPrefab.Bleeding, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.Bleeding
-
----
--- AfflictionPrefab.Burn, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.Burn
-
----
--- AfflictionPrefab.OxygenLow, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.OxygenLow
-
----
--- AfflictionPrefab.Bloodloss, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.Bloodloss
-
----
--- AfflictionPrefab.Pressure, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.Pressure
-
----
--- AfflictionPrefab.Stun, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.Stun
-
----
--- AfflictionPrefab.RadiationSickness, Field of type AfflictionPrefab
--- @realm shared
--- @AfflictionPrefab AfflictionPrefab.RadiationSickness
-
---
-- AfflictionPrefab.Prefabs, Field of type PrefabCollection`1
-- @realm shared
-- @PrefabCollection`1 AfflictionPrefab.Prefabs
+---
+-- Identifier, Field of type Identifier
+-- @realm shared
+-- @Identifier Identifier
+
+---
+-- ContentFile, Field of type ContentFile
+-- @realm shared
+-- @ContentFile ContentFile
+
diff --git a/docs/lua/generated/AnimController.lua b/docs/lua/generated/AnimController.lua
index 80a045faf..7348c574a 100644
--- a/docs/lua/generated/AnimController.lua
+++ b/docs/lua/generated/AnimController.lua
@@ -93,6 +93,13 @@ function ApplyTestPose() end
-- @tparam RagdollParams ragdollParams
function Recreate(ragdollParams) end
+--- GetLimb
+-- @realm shared
+-- @tparam LimbType limbType
+-- @tparam bool excludeSevered
+-- @treturn Limb
+function GetLimb(limbType, excludeSevered) end
+
--- GetMouthPosition
-- @realm shared
-- @treturn Nullable`1
@@ -223,6 +230,11 @@ function Update(deltaTime, cam) end
-- @realm shared
function ForceRefreshFloorY() end
+--- GetSurfaceY
+-- @realm shared
+-- @treturn number
+function GetSurfaceY() end
+
--- SetPosition
-- @realm shared
-- @tparam Vector2 simPosition
@@ -236,13 +248,6 @@ function SetPosition(simPosition, lerp, ignorePlatforms, forceMainLimbToCollider
-- @realm shared
function Hang() end
---- GetLimb
--- @realm shared
--- @tparam LimbType limbType
--- @tparam bool excludeSevered
--- @treturn Limb
-function GetLimb(limbType, excludeSevered) end
-
--- GetType
-- @realm shared
-- @treturn Type
diff --git a/docs/lua/generated/Character.lua b/docs/lua/generated/Character.lua
index 9c955fc39..5dfe4cfaa 100644
--- a/docs/lua/generated/Character.lua
+++ b/docs/lua/generated/Character.lua
@@ -44,6 +44,79 @@ function TeleportTo(worldPos) end
-- @table Character.CharacterList
+--- TrySeverLimbJoints
+-- @realm shared
+-- @tparam Limb targetLimb
+-- @tparam number severLimbsProbability
+-- @tparam number damage
+-- @tparam bool allowBeheading
+-- @tparam Character attacker
+function TrySeverLimbJoints(targetLimb, severLimbsProbability, damage, allowBeheading, attacker) end
+
+--- AddDamage
+-- @realm shared
+-- @tparam Vector2 worldPosition
+-- @tparam Enumerable afflictions
+-- @tparam number stun
+-- @tparam bool playSound
+-- @tparam number attackImpulse
+-- @tparam Character attacker
+-- @tparam number damageMultiplier
+-- @treturn AttackResult
+function AddDamage(worldPosition, afflictions, stun, playSound, attackImpulse, attacker, damageMultiplier) end
+
+--- AddDamage
+-- @realm shared
+-- @tparam Vector2 worldPosition
+-- @tparam Enumerable afflictions
+-- @tparam number stun
+-- @tparam bool playSound
+-- @tparam number attackImpulse
+-- @tparam Limb& hitLimb
+-- @tparam Character attacker
+-- @tparam number damageMultiplier
+-- @treturn AttackResult
+function AddDamage(worldPosition, afflictions, stun, playSound, attackImpulse, hitLimb, attacker, damageMultiplier) end
+
+--- RecordKill
+-- @realm shared
+-- @tparam Character target
+function RecordKill(target) end
+
+--- AddEncounter
+-- @realm shared
+-- @tparam Character other
+function AddEncounter(other) end
+
+--- DamageLimb
+-- @realm shared
+-- @tparam Vector2 worldPosition
+-- @tparam Limb hitLimb
+-- @tparam Enumerable afflictions
+-- @tparam number stun
+-- @tparam bool playSound
+-- @tparam number attackImpulse
+-- @tparam Character attacker
+-- @tparam number damageMultiplier
+-- @tparam bool allowStacking
+-- @tparam number penetration
+-- @tparam bool shouldImplode
+-- @treturn AttackResult
+function DamageLimb(worldPosition, hitLimb, afflictions, stun, playSound, attackImpulse, attacker, damageMultiplier, allowStacking, penetration, shouldImplode) end
+
+--- TryAdjustAttackerSkill
+-- @realm shared
+-- @tparam Character attacker
+-- @tparam number healthChange
+function TryAdjustAttackerSkill(attacker, healthChange) end
+
+--- SetStun
+-- @realm shared
+-- @tparam number newStun
+-- @tparam bool allowStunDecrease
+-- @tparam bool isNetworkMessage
+function SetStun(newStun, allowStunDecrease, isNetworkMessage) end
+
--- ApplyStatusEffects
-- @realm shared
-- @tparam function actionType
@@ -84,7 +157,7 @@ function SaveInventory() end
--- SpawnInventoryItems
-- @realm shared
-- @tparam Inventory inventory
--- @tparam XElement itemData
+-- @tparam ContentXElement itemData
function SpawnInventoryItems(inventory, itemData) end
--- GetAttackContexts
@@ -121,7 +194,7 @@ function LoadTalents() end
--- GiveTalent
-- @realm shared
--- @tparam string talentIdentifier
+-- @tparam Identifier talentIdentifier
-- @tparam bool addingFirstTime
-- @treturn bool
function GiveTalent(talentIdentifier, addingFirstTime) end
@@ -142,7 +215,7 @@ function GiveTalent(talentPrefab, addingFirstTime) end
--- HasTalent
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @treturn bool
function HasTalent(identifier) end
@@ -175,7 +248,7 @@ function CheckTalents(abilityEffectType) end
--- HasRecipeForItem
-- @realm shared
--- @tparam string recipeIdentifier
+-- @tparam Identifier recipeIdentifier
-- @treturn bool
function HasRecipeForItem(recipeIdentifier) end
@@ -184,11 +257,6 @@ function HasRecipeForItem(recipeIdentifier) end
-- @tparam number amount
function GiveMoney(amount) end
---- SetMoney
--- @realm shared
--- @tparam number amount
-function SetMoney(amount) end
-
--- GetStatValue
-- @realm shared
-- @tparam StatTypes statType
@@ -205,12 +273,6 @@ function OnWearablesChanged() end
-- @tparam number value
function ChangeStat(statType, value) end
---- GetSkillStatType
--- @realm shared
--- @tparam string skillIdentifier
--- @treturn StatTypes
-function Character.GetSkillStatType(skillIdentifier) end
-
--- AddAbilityFlag
-- @realm shared
-- @tparam AbilityFlags abilityFlag
@@ -235,7 +297,7 @@ function GetAbilityResistance(affliction) end
--- ChangeAbilityResistance
-- @realm shared
--- @tparam string resistanceId
+-- @tparam Identifier resistanceId
-- @tparam number value
function ChangeAbilityResistance(resistanceId, value) end
@@ -256,6 +318,43 @@ function Character.IsFriendly(me, other) end
-- @realm shared
function ResetNetState() end
+--- ClearInput
+-- @realm shared
+-- @tparam InputType inputType
+function ClearInput(inputType) end
+
+--- ClearInputs
+-- @realm shared
+function ClearInputs() end
+
+--- ToString
+-- @realm shared
+-- @treturn string
+function ToString() end
+
+--- GiveJobItems
+-- @realm shared
+-- @tparam WayPoint spawnPoint
+function GiveJobItems(spawnPoint) end
+
+--- GiveIdCardTags
+-- @realm shared
+-- @tparam WayPoint spawnPoint
+-- @tparam bool createNetworkEvent
+function GiveIdCardTags(spawnPoint, createNetworkEvent) end
+
+--- GetSkillLevel
+-- @realm shared
+-- @tparam string skillIdentifier
+-- @treturn number
+function GetSkillLevel(skillIdentifier) end
+
+--- GetSkillLevel
+-- @realm shared
+-- @tparam Identifier skillIdentifier
+-- @treturn number
+function GetSkillLevel(skillIdentifier) end
+
--- GetTargetMovement
-- @realm shared
-- @treturn Vector2
@@ -370,6 +469,14 @@ function HasEquippedItem(item, slotType, predicate) end
-- @treturn bool
function HasEquippedItem(tagOrIdentifier, allowBroken, slotType) end
+--- HasEquippedItem
+-- @realm shared
+-- @tparam Identifier tagOrIdentifier
+-- @tparam bool allowBroken
+-- @tparam Nullable`1 slotType
+-- @treturn bool
+function HasEquippedItem(tagOrIdentifier, allowBroken, slotType) end
+
--- GetEquippedItem
-- @realm shared
-- @tparam string tagOrIdentifier
@@ -431,7 +538,7 @@ function CanInteractWith(item, distanceToItem, checkLinked) end
--- SetCustomInteract
-- @realm shared
-- @tparam function onCustomInteract
--- @tparam string hudText
+-- @tparam LocalizedString hudText
function SetCustomInteract(onCustomInteract, hudText) end
--- SelectCharacter
@@ -502,32 +609,26 @@ function CanHearCharacter(speaker) end
--- SetOrder
-- @realm shared
-- @tparam Order order
--- @tparam string orderOption
--- @tparam number priority
--- @tparam Character orderGiver
+-- @tparam bool isNewOrder
-- @tparam bool speak
-- @tparam bool force
-function SetOrder(order, orderOption, priority, orderGiver, speak, force) end
-
---- SetOrder
--- @realm shared
--- @tparam OrderInfo orderInfo
--- @tparam Character orderGiver
--- @tparam bool speak
--- @tparam bool force
-function SetOrder(orderInfo, orderGiver, speak, force) end
+function SetOrder(order, isNewOrder, speak, force) end
--- GetCurrentOrderWithTopPriority
-- @realm shared
--- @treturn Nullable`1
+-- @treturn Order
function GetCurrentOrderWithTopPriority() end
--- GetCurrentOrder
-- @realm shared
-- @tparam Order order
--- @tparam string option
--- @treturn Nullable`1
-function GetCurrentOrder(order, option) end
+-- @treturn Order
+function GetCurrentOrder(order) end
+
+--- DisableLine
+-- @realm shared
+-- @tparam Identifier identifier
+function DisableLine(identifier) end
--- DisableLine
-- @realm shared
@@ -539,7 +640,7 @@ function DisableLine(identifier) end
-- @tparam string message
-- @tparam Nullable`1 messageType
-- @tparam number delay
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @tparam number minDurationBetweenSimilar
function Speak(message, messageType, delay, identifier, minDurationBetweenSimilar) end
@@ -578,79 +679,6 @@ function AddDamage(attacker, worldPosition, attack, deltaTime, playSound) end
-- @treturn AttackResult
function ApplyAttack(attacker, worldPosition, attack, deltaTime, playSound, targetLimb, penetration) end
---- TrySeverLimbJoints
--- @realm shared
--- @tparam Limb targetLimb
--- @tparam number severLimbsProbability
--- @tparam number damage
--- @tparam bool allowBeheading
--- @tparam Character attacker
-function TrySeverLimbJoints(targetLimb, severLimbsProbability, damage, allowBeheading, attacker) end
-
---- AddDamage
--- @realm shared
--- @tparam Vector2 worldPosition
--- @tparam Enumerable afflictions
--- @tparam number stun
--- @tparam bool playSound
--- @tparam number attackImpulse
--- @tparam Character attacker
--- @tparam number damageMultiplier
--- @treturn AttackResult
-function AddDamage(worldPosition, afflictions, stun, playSound, attackImpulse, attacker, damageMultiplier) end
-
---- AddDamage
--- @realm shared
--- @tparam Vector2 worldPosition
--- @tparam Enumerable afflictions
--- @tparam number stun
--- @tparam bool playSound
--- @tparam number attackImpulse
--- @tparam Limb& hitLimb
--- @tparam Character attacker
--- @tparam number damageMultiplier
--- @treturn AttackResult
-function AddDamage(worldPosition, afflictions, stun, playSound, attackImpulse, hitLimb, attacker, damageMultiplier) end
-
---- RecordKill
--- @realm shared
--- @tparam Character target
-function RecordKill(target) end
-
---- AddEncounter
--- @realm shared
--- @tparam Character other
-function AddEncounter(other) end
-
---- DamageLimb
--- @realm shared
--- @tparam Vector2 worldPosition
--- @tparam Limb hitLimb
--- @tparam Enumerable afflictions
--- @tparam number stun
--- @tparam bool playSound
--- @tparam number attackImpulse
--- @tparam Character attacker
--- @tparam number damageMultiplier
--- @tparam bool allowStacking
--- @tparam number penetration
--- @tparam bool shouldImplode
--- @treturn AttackResult
-function DamageLimb(worldPosition, hitLimb, afflictions, stun, playSound, attackImpulse, attacker, damageMultiplier, allowStacking, penetration, shouldImplode) end
-
---- TryAdjustAttackerSkill
--- @realm shared
--- @tparam Character attacker
--- @tparam number healthChange
-function TryAdjustAttackerSkill(attacker, healthChange) end
-
---- SetStun
--- @realm shared
--- @tparam number newStun
--- @tparam bool allowStunDecrease
--- @tparam bool isNetworkMessage
-function SetStun(newStun, allowStunDecrease, isNetworkMessage) end
-
--- Create
-- @realm shared
-- @tparam string speciesName
@@ -665,6 +693,34 @@ function SetStun(newStun, allowStunDecrease, isNetworkMessage) end
-- @treturn Character
function Character.Create(speciesName, position, seed, characterInfo, id, isRemotePlayer, hasAi, createNetworkEvent, ragdoll) end
+--- Create
+-- @realm shared
+-- @tparam Identifier speciesName
+-- @tparam Vector2 position
+-- @tparam string seed
+-- @tparam CharacterInfo characterInfo
+-- @tparam number id
+-- @tparam bool isRemotePlayer
+-- @tparam bool hasAi
+-- @tparam bool createNetworkEvent
+-- @tparam RagdollParams ragdoll
+-- @treturn Character
+function Character.Create(speciesName, position, seed, characterInfo, id, isRemotePlayer, hasAi, createNetworkEvent, ragdoll) end
+
+--- Create
+-- @realm shared
+-- @tparam CharacterPrefab prefab
+-- @tparam Vector2 position
+-- @tparam string seed
+-- @tparam CharacterInfo characterInfo
+-- @tparam number id
+-- @tparam bool isRemotePlayer
+-- @tparam bool hasAi
+-- @tparam bool createNetworkEvent
+-- @tparam RagdollParams ragdoll
+-- @treturn Character
+function Character.Create(prefab, position, seed, characterInfo, id, isRemotePlayer, hasAi, createNetworkEvent, ragdoll) end
+
--- ReloadHead
-- @realm shared
-- @tparam Nullable`1 headId
@@ -697,56 +753,36 @@ function IsKeyDown(inputType) end
-- @tparam bool held
function SetInput(inputType, hit, held) end
---- ClearInput
--- @realm shared
--- @tparam InputType inputType
-function ClearInput(inputType) end
-
---- ClearInputs
--- @realm shared
-function ClearInputs() end
-
---- ToString
--- @realm shared
--- @treturn string
-function ToString() end
-
---- GiveJobItems
--- @realm shared
--- @tparam WayPoint spawnPoint
-function GiveJobItems(spawnPoint) end
-
---- GiveIdCardTags
--- @realm shared
--- @tparam WayPoint spawnPoint
--- @tparam bool createNetworkEvent
-function GiveIdCardTags(spawnPoint, createNetworkEvent) end
-
---- GetSkillLevel
--- @realm shared
--- @tparam string skillIdentifier
--- @treturn number
-function GetSkillLevel(skillIdentifier) end
-
--- GetPositionUpdateInterval
-- @realm shared
-- @tparam Client recipient
-- @treturn number
function GetPositionUpdateInterval(recipient) end
---- ServerRead
+--- ServerReadInput
-- @realm shared
--- @tparam ClientNetObject type
-- @tparam IReadMessage msg
-- @tparam Client c
-function ServerRead(type, msg, c) end
+function ServerReadInput(msg, c) end
---- ServerWrite
+--- ServerEventRead
+-- @realm shared
+-- @tparam IReadMessage msg
+-- @tparam Client c
+function ServerEventRead(msg, c) end
+
+--- ServerWritePosition
-- @realm shared
-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWrite(msg, c, extraData) end
+function ServerWritePosition(msg, c) end
+
+--- ServerEventWrite
+-- @realm shared
+-- @tparam IWriteMessage msg
+-- @tparam Client c
+-- @tparam IData extraData
+function ServerEventWrite(msg, c, extraData) end
--- WriteSpawnData
-- @realm shared
@@ -755,6 +791,10 @@ function ServerWrite(msg, c, extraData) end
-- @tparam bool restrictMessageSize
function WriteSpawnData(msg, entityId, restrictMessageSize) end
+--- ThrowIfAccessingWalletsInSingleplayer
+-- @realm shared
+function Character.ThrowIfAccessingWalletsInSingleplayer() end
+
--- SetOriginalTeam
-- @realm shared
-- @tparam CharacterTeamType newTeam
@@ -803,6 +843,11 @@ function Equals(obj) end
-- @treturn number
function GetHashCode() end
+---
+-- Character.Controlled, Field of type Character
+-- @realm shared
+-- @Character Character.Controlled
+
---
-- Enabled, Field of type bool
-- @realm shared
@@ -858,6 +903,11 @@ function GetHashCode() end
-- @realm shared
-- @CharacterTeamType TeamID
+---
+-- Wallet, Field of type Wallet
+-- @realm shared
+-- @Wallet Wallet
+
---
-- IsOnPlayerTeam, Field of type bool
-- @realm shared
@@ -894,14 +944,14 @@ function GetHashCode() end
-- @table ItemSelectedDurations
---
--- SpeciesName, Field of type string
+-- SpeciesName, Field of type Identifier
-- @realm shared
--- @string SpeciesName
+-- @Identifier SpeciesName
---
--- Group, Field of type string
+-- Group, Field of type Identifier
-- @realm shared
--- @string Group
+-- @Identifier Group
---
-- IsHumanoid, Field of type bool
@@ -913,6 +963,16 @@ function GetHashCode() end
-- @realm shared
-- @bool IsHusk
+---
+-- IsMale, Field of type bool
+-- @realm shared
+-- @bool IsMale
+
+---
+-- IsFemale, Field of type bool
+-- @realm shared
+-- @bool IsFemale
+
---
-- BloodDecalName, Field of type string
-- @realm shared
@@ -958,16 +1018,6 @@ function GetHashCode() end
-- @realm shared
-- @bool IsHuman
----
--- IsMale, Field of type bool
--- @realm shared
--- @bool IsMale
-
----
--- IsFemale, Field of type bool
--- @realm shared
--- @bool IsFemale
-
---
-- CurrentOrders, Field of type table
-- @realm shared
@@ -994,9 +1044,9 @@ function GetHashCode() end
-- @CharacterInfo Info
---
--- VariantOf, Field of type string
+-- VariantOf, Field of type Identifier
-- @realm shared
--- @string VariantOf
+-- @Identifier VariantOf
---
-- Name, Field of type string
@@ -1033,6 +1083,11 @@ function GetHashCode() end
-- @realm shared
-- @CharacterInventory Inventory
+---
+-- CustomInteractHUDText, Field of type LocalizedString
+-- @realm shared
+-- @LocalizedString CustomInteractHUDText
+
---
-- AllowCustomInteract, Field of type bool
-- @realm shared
@@ -1458,6 +1513,11 @@ function GetHashCode() end
-- @realm shared
-- @number SpawnTime
+---
+-- ErrorLine, Field of type string
+-- @realm shared
+-- @string ErrorLine
+
---
-- OwnerClientEndPoint, Field of type string
-- @realm shared
@@ -1499,9 +1559,9 @@ function GetHashCode() end
-- @table Properties
---
--- Prefab, Field of type HumanPrefab
+-- HumanPrefab, Field of type HumanPrefab
-- @realm shared
--- @HumanPrefab Prefab
+-- @HumanPrefab HumanPrefab
---
-- Latchers, Field of type HashSet`1
@@ -1543,26 +1603,26 @@ function GetHashCode() end
-- @realm shared
-- @number InvisibleTimer
+---
+-- Prefab, Field of type CharacterPrefab
+-- @realm shared
+-- @CharacterPrefab Prefab
+
---
-- Params, Field of type CharacterParams
-- @realm shared
-- @CharacterParams Params
---
--- TraitorCurrentObjective, Field of type string
+-- TraitorCurrentObjective, Field of type LocalizedString
-- @realm shared
--- @string TraitorCurrentObjective
+-- @LocalizedString TraitorCurrentObjective
---
-- ResetInteract, Field of type bool
-- @realm shared
-- @bool ResetInteract
----
--- customInteractHUDText, Field of type string
--- @realm shared
--- @string customInteractHUDText
-
---
-- ActiveConversation, Field of type ConversationAction
-- @realm shared
@@ -1608,6 +1668,11 @@ function GetHashCode() end
-- @realm shared
-- @InteractionType CampaignInteractionType
+---
+-- MerchantIdentifier, Field of type Identifier
+-- @realm shared
+-- @Identifier MerchantIdentifier
+
---
-- OnDeath, Field of type OnDeathHandler
-- @realm shared
@@ -1639,9 +1704,9 @@ function GetHashCode() end
-- @bool isSynced
---
--- Character.Controlled, Field of type Character
+-- Character.CharacterUpdateInterval, Field of type number
-- @realm shared
--- @Character Character.Controlled
+-- @number Character.CharacterUpdateInterval
---
-- Character.KnockbackCooldown, Field of type number
@@ -1653,3 +1718,13 @@ function GetHashCode() end
-- @realm shared
-- @number ID
+---
+-- CreationStackTrace, Field of type string
+-- @realm shared
+-- @string CreationStackTrace
+
+---
+-- CreationIndex, Field of type number
+-- @realm shared
+-- @number CreationIndex
+
diff --git a/docs/lua/generated/CharacterHealth.lua b/docs/lua/generated/CharacterHealth.lua
index a046a34b3..149801a17 100644
--- a/docs/lua/generated/CharacterHealth.lua
+++ b/docs/lua/generated/CharacterHealth.lua
@@ -25,9 +25,16 @@ function GetAllAfflictions(limbHealthFilter) end
-- @treturn Affliction
function GetAffliction(identifier, allowLimbAfflictions) end
+--- GetAffliction
+-- @realm shared
+-- @tparam Identifier identifier
+-- @tparam bool allowLimbAfflictions
+-- @treturn Affliction
+function GetAffliction(identifier, allowLimbAfflictions) end
+
--- GetAfflictionOfType
-- @realm shared
--- @tparam string afflictionType
+-- @tparam Identifier afflictionType
-- @tparam bool allowLimbAfflictions
-- @treturn Affliction
function GetAfflictionOfType(afflictionType, allowLimbAfflictions) end
@@ -92,13 +99,33 @@ function GetStatValue(statType) end
-- @treturn bool
function HasFlag(flagType) end
---- ReduceAffliction
+--- ReduceAllAfflictionsOnAllLimbs
-- @realm shared
--- @tparam Limb targetLimb
--- @tparam string afflictionIdentifier
-- @tparam number amount
-- @tparam Nullable`1 treatmentAction
-function ReduceAffliction(targetLimb, afflictionIdentifier, amount, treatmentAction) end
+function ReduceAllAfflictionsOnAllLimbs(amount, treatmentAction) end
+
+--- ReduceAfflictionOnAllLimbs
+-- @realm shared
+-- @tparam Identifier affliction
+-- @tparam number amount
+-- @tparam Nullable`1 treatmentAction
+function ReduceAfflictionOnAllLimbs(affliction, amount, treatmentAction) end
+
+--- ReduceAllAfflictionsOnLimb
+-- @realm shared
+-- @tparam Limb targetLimb
+-- @tparam number amount
+-- @tparam Nullable`1 treatmentAction
+function ReduceAllAfflictionsOnLimb(targetLimb, amount, treatmentAction) end
+
+--- ReduceAfflictionOnLimb
+-- @realm shared
+-- @tparam Limb targetLimb
+-- @tparam Identifier affliction
+-- @tparam number amount
+-- @tparam Nullable`1 treatmentAction
+function ReduceAfflictionOnLimb(targetLimb, affliction, amount, treatmentAction) end
--- ApplyDamage
-- @realm shared
diff --git a/docs/lua/generated/CharacterInfo.lua b/docs/lua/generated/CharacterInfo.lua
index 01963e526..701f0d741 100644
--- a/docs/lua/generated/CharacterInfo.lua
+++ b/docs/lua/generated/CharacterInfo.lua
@@ -10,95 +10,6 @@ Barotrauma source code: [CharacterInfo.cs](https://github.com/evilfactory/Barotr
local CharacterInfo = {}
---- 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
-
---- RefreshHead
--- @realm shared
-function RefreshHead() end
-
---- LoadHeadAttachments
--- @realm shared
-function LoadHeadAttachments() end
-
---- AddEmpty
--- @realm shared
--- @tparam Enumerable elements
--- @tparam WearableType type
--- @tparam number commonness
--- @treturn table
-function CharacterInfo.AddEmpty(elements, type, commonness) end
-
---- GetRandomElement
--- @realm shared
--- @tparam Enumerable 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 gainedFromAbility
-function IncreaseSkillLevel(skillIdentifier, increase, gainedFromAbility) 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
@@ -127,7 +38,7 @@ function Save(parentElement) end
--- SaveOrders
-- @realm shared
-- @tparam XElement parentElement
--- @tparam OrderInfo[] orders
+-- @tparam Order[] orders
function CharacterInfo.SaveOrders(parentElement, orders) end
--- SaveOrderData
@@ -162,6 +73,10 @@ function CharacterInfo.LoadOrders(ordersElement) end
-- @tparam XElement healthData
function CharacterInfo.ApplyHealthData(character, healthData) end
+--- ReloadHeadAttachments
+-- @realm shared
+function ReloadHeadAttachments() end
+
--- ClearCurrentOrders
-- @realm shared
function ClearCurrentOrders() end
@@ -197,7 +112,7 @@ function GetSavedStatValue(statType) end
--- GetSavedStatValue
-- @realm shared
-- @tparam StatTypes statType
--- @tparam string statIdentifier
+-- @tparam Identifier statIdentifier
-- @treturn number
function GetSavedStatValue(statType, statIdentifier) end
@@ -211,18 +126,6 @@ function GetSavedStatValue(statType, statIdentifier) end
-- @tparam bool setValue
function ChangeSavedStatValue(statType, value, statIdentifier, removeOnDeath, 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
@@ -250,6 +153,20 @@ function CheckDisguiseStatus(handleBuff, idCard) end
-- @treturn number
function GetManualOrderPriority(order) end
+--- GetValidAttachmentElements
+-- @realm shared
+-- @tparam Enumerable elements
+-- @tparam HeadPreset headPreset
+-- @tparam Nullable`1 wearableType
+-- @treturn Enumerable
+function GetValidAttachmentElements(elements, headPreset, wearableType) end
+
+--- CountValidAttachmentsOfType
+-- @realm shared
+-- @tparam WearableType wearableType
+-- @treturn number
+function CountValidAttachmentsOfType(wearableType) end
+
--- GetRandomName
-- @realm shared
-- @tparam RandSync randSync
@@ -259,26 +176,9 @@ function GetRandomName(randSync) end
--- SelectRandomColor
-- @realm shared
-- @tparam ImmutableArray`1& array
+-- @tparam RandSync randSync
-- @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
+function CharacterInfo.SelectRandomColor(array, randSync) end
--- GetIdentifier
-- @realm shared
@@ -290,35 +190,106 @@ function GetIdentifier() end
-- @treturn number
function GetIdentifierUsingOriginalName() end
---- FilterByTypeAndHeadID
+--- FilterElements
-- @realm shared
-- @tparam Enumerable elements
--- @tparam WearableType targetType
--- @tparam number headSpriteId
+-- @tparam ImmutableHashSet`1 tags
+-- @tparam Nullable`1 targetType
-- @treturn Enumerable
-function FilterByTypeAndHeadID(elements, targetType, headSpriteId) end
+function FilterElements(elements, tags, targetType) end
---- FilterElementsByGenderAndRace
+--- RecreateHead
+-- @realm shared
+-- @tparam ImmutableHashSet`1 tags
+-- @tparam number hairIndex
+-- @tparam number beardIndex
+-- @tparam number moustacheIndex
+-- @tparam number faceAttachmentIndex
+function RecreateHead(tags, hairIndex, beardIndex, moustacheIndex, faceAttachmentIndex) end
+
+--- ReplaceVars
+-- @realm shared
+-- @tparam string str
+-- @treturn string
+function ReplaceVars(str) end
+
+--- RecreateHead
+-- @realm shared
+-- @tparam HeadInfo headInfo
+function RecreateHead(headInfo) end
+
+--- RefreshHead
+-- @realm shared
+function RefreshHead() end
+
+--- LoadHeadAttachments
+-- @realm shared
+function LoadHeadAttachments() end
+
+--- AddEmpty
-- @realm shared
-- @tparam Enumerable elements
--- @tparam Gender gender
--- @tparam Race race
--- @treturn Enumerable
-function FilterElementsByGenderAndRace(elements, gender, race) end
+-- @tparam WearableType type
+-- @tparam number commonness
+-- @treturn table
+function CharacterInfo.AddEmpty(elements, type, commonness) end
---- IsMatchingGender
+--- GetRandomElement
-- @realm shared
--- @tparam Gender gender
--- @tparam Gender myGender
--- @treturn bool
-function CharacterInfo.IsMatchingGender(gender, myGender) end
+-- @tparam Enumerable elements
+-- @treturn ContentXElement
+function GetRandomElement(elements) end
---- IsMatchingRace
+--- IsValidIndex
-- @realm shared
--- @tparam Race race
--- @tparam Race myRace
+-- @tparam number index
+-- @tparam table list
-- @treturn bool
-function CharacterInfo.IsMatchingRace(race, myRace) end
+function CharacterInfo.IsValidIndex(index, list) end
+
+--- IncreaseSkillLevel
+-- @realm shared
+-- @tparam Identifier skillIdentifier
+-- @tparam number increase
+-- @tparam bool gainedFromAbility
+function IncreaseSkillLevel(skillIdentifier, increase, gainedFromAbility) end
+
+--- SetSkillLevel
+-- @realm shared
+-- @tparam Identifier 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
--- GetType
-- @realm shared
@@ -347,9 +318,19 @@ function GetHashCode() end
-- @HeadInfo Head
---
--- Heads, Field of type table
+-- IsMale, Field of type bool
-- @realm shared
--- @table Heads
+-- @bool IsMale
+
+---
+-- IsFemale, Field of type bool
+-- @realm shared
+-- @bool IsFemale
+
+---
+-- Prefab, Field of type CharacterInfoPrefab
+-- @realm shared
+-- @CharacterInfoPrefab Prefab
---
-- HasNickname, Field of type bool
@@ -367,9 +348,9 @@ function GetHashCode() end
-- @string DisplayName
---
--- SpeciesName, Field of type string
+-- SpeciesName, Field of type Identifier
-- @realm shared
--- @string SpeciesName
+-- @Identifier SpeciesName
---
-- ExperiencePoints, Field of type number
@@ -402,9 +383,14 @@ function GetHashCode() end
-- @table AttachmentSprites
---
--- CharacterConfigElement, Field of type XElement
+-- CharacterConfigElement, Field of type ContentXElement
-- @realm shared
--- @XElement CharacterConfigElement
+-- @ContentXElement CharacterConfigElement
+
+---
+-- PersonalityTrait, Field of type NPCPersonalityTrait
+-- @realm shared
+-- @NPCPersonalityTrait PersonalityTrait
---
-- CharacterInfo.HighestManualOrderPriority, Field of type number
@@ -421,81 +407,6 @@ function GetHashCode() end
-- @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
@@ -506,6 +417,26 @@ function GetHashCode() end
-- @realm shared
-- @bool IsAttachmentsLoaded
+---
+-- Hairs, Field of type IReadOnlyList`1
+-- @realm shared
+-- @IReadOnlyList`1 Hairs
+
+---
+-- Beards, Field of type IReadOnlyList`1
+-- @realm shared
+-- @IReadOnlyList`1 Beards
+
+---
+-- Moustaches, Field of type IReadOnlyList`1
+-- @realm shared
+-- @IReadOnlyList`1 Moustaches
+
+---
+-- FaceAttachments, Field of type IReadOnlyList`1
+-- @realm shared
+-- @IReadOnlyList`1 FaceAttachments
+
---
-- Wearables, Field of type Enumerable
-- @realm shared
@@ -592,14 +523,9 @@ function GetHashCode() end
-- @number ID
---
--- HasGenders, Field of type bool
+-- HasSpecifierTags, Field of type bool
-- @realm shared
--- @bool HasGenders
-
----
--- HasRaces, Field of type bool
--- @realm shared
--- @bool HasRaces
+-- @bool HasSpecifierTags
---
-- HairColors, Field of type ImmutableArray`1
@@ -626,6 +552,11 @@ function GetHashCode() end
-- @realm shared
-- @table SavedStatValues
+---
+-- CharacterInfo.MaxAdditionalTalentPoints, Field of type number
+-- @realm shared
+-- @number CharacterInfo.MaxAdditionalTalentPoints
+
---
-- CharacterInfo.MaxCurrentOrders, Field of type number
-- @realm shared
diff --git a/docs/lua/generated/CharacterInventory.lua b/docs/lua/generated/CharacterInventory.lua
index bfad8e58f..e5c14951b 100644
--- a/docs/lua/generated/CharacterInventory.lua
+++ b/docs/lua/generated/CharacterInventory.lua
@@ -98,19 +98,18 @@ function CheckIfAnySlotAvailable(item, inWrongSlot) end
-- @treturn bool
function TryPutItem(item, index, allowSwapping, allowCombine, user, createNetworkEvent, ignoreCondition) end
---- ServerRead
+--- ServerEventRead
-- @realm shared
--- @tparam ClientNetObject type
-- @tparam IReadMessage msg
-- @tparam Client c
-function ServerRead(type, msg, c) end
+function ServerEventRead(msg, c) end
---- ServerWrite
+--- ServerEventWrite
-- @realm shared
-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWrite(msg, c, extraData) end
+-- @tparam IData extraData
+function ServerEventWrite(msg, c, extraData) end
--- Contains
-- @realm shared
@@ -226,14 +225,14 @@ function FindAllItems(predicate, recursive, list) end
--- FindItemByTag
-- @realm shared
--- @tparam string tag
+-- @tparam Identifier tag
-- @tparam bool recursive
-- @treturn Item
function FindItemByTag(tag, recursive) end
--- FindItemByIdentifier
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @tparam bool recursive
-- @treturn Item
function FindItemByIdentifier(identifier, recursive) end
@@ -250,10 +249,16 @@ function ForceToSlot(item, index) end
-- @tparam number index
function ForceRemoveFromSlot(item, index) end
+--- SharedRead
+-- @realm shared
+-- @tparam IReadMessage msg
+-- @tparam List`1[]& newItemIds
+function SharedRead(msg, newItemIds) end
+
--- SharedWrite
-- @realm shared
-- @tparam IWriteMessage msg
--- @tparam Object[] extraData
+-- @tparam IData extraData
function SharedWrite(msg, extraData) end
--- DeleteAllItems
@@ -291,6 +296,11 @@ function GetHashCode() end
-- @realm shared
-- @bool AccessibleWhenAlive
+---
+-- AccessibleByOwner, Field of type bool
+-- @realm shared
+-- @bool AccessibleByOwner
+
---
-- AllItems, Field of type Enumerable
-- @realm shared
diff --git a/docs/lua/generated/Client.lua b/docs/lua/generated/Client.lua
index dab2b8e11..991451452 100644
--- a/docs/lua/generated/Client.lua
+++ b/docs/lua/generated/Client.lua
@@ -1,7 +1,7 @@
-- luacheck: ignore 111
--[[--
-Barotrauma Character class with some additional functions and fields
+Barotrauma Client 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)
]]
@@ -215,6 +215,11 @@ function GetHashCode() end
-- @realm shared
-- @bool Muted
+---
+-- HasPermissions, Field of type bool
+-- @realm shared
+-- @bool HasPermissions
+
---
-- VoipQueue, Field of type VoipQueue
-- @realm shared
@@ -381,9 +386,9 @@ function GetHashCode() end
-- @table JobPreferences
---
--- AssignedJob, Field of type Pair`2
+-- AssignedJob, Field of type JobVariant
-- @realm shared
--- @Pair`2 AssignedJob
+-- @JobVariant AssignedJob
---
-- DeleteDisconnectedTimer, Field of type number
@@ -431,9 +436,9 @@ function GetHashCode() end
-- @number OwnerSteamID
---
--- Language, Field of type string
+-- Language, Field of type LanguageIdentifier
-- @realm shared
--- @string Language
+-- @LanguageIdentifier Language
---
-- Ping, Field of type number
@@ -441,9 +446,9 @@ function GetHashCode() end
-- @number Ping
---
--- PreferredJob, Field of type string
+-- PreferredJob, Field of type Identifier
-- @realm shared
--- @string PreferredJob
+-- @Identifier PreferredJob
---
-- TeamID, Field of type CharacterTeamType
@@ -460,11 +465,6 @@ function GetHashCode() end
-- @realm shared
-- @number CharacterID
----
--- HasPermissions, Field of type bool
--- @realm shared
--- @bool HasPermissions
-
---
-- HasSpawned, Field of type bool
-- @realm shared
diff --git a/docs/lua/generated/Entity.Spawner.lua b/docs/lua/generated/Entity.Spawner.lua
index 1309f6b7b..4ab359510 100644
--- a/docs/lua/generated/Entity.Spawner.lua
+++ b/docs/lua/generated/Entity.Spawner.lua
@@ -11,32 +11,31 @@ Barotrauma source code: [EntitySpawner.cs](https://github.com/evilfactory/Barotr
--- CreateNetworkEvent
-- @realm shared
--- @tparam Entity entity
--- @tparam bool remove
-function CreateNetworkEvent(entity, remove) end
+-- @tparam SpawnOrRemove spawnOrRemove
+function CreateNetworkEvent(spawnOrRemove) end
---- ServerWrite
+--- ServerEventWrite
-- @realm shared
-- @tparam IWriteMessage message
-- @tparam Client client
--- @tparam Object[] extraData
-function ServerWrite(message, client, extraData) end
+-- @tparam IData extraData
+function ServerEventWrite(message, client, extraData) end
--- ToString
-- @realm shared
-- @treturn string
function ToString() end
---- AddToSpawnQueue
+--- AddItemToSpawnQueue
-- @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
+function AddItemToSpawnQueue(itemPrefab, worldPosition, condition, quality, onSpawned) end
---- AddToSpawnQueue
+--- AddItemToSpawnQueue
-- @realm shared
-- @tparam ItemPrefab itemPrefab
-- @tparam Vector2 position
@@ -44,9 +43,9 @@ function AddToSpawnQueue(itemPrefab, worldPosition, condition, quality, onSpawne
-- @tparam Nullable`1 condition
-- @tparam Nullable`1 quality
-- @tparam function onSpawned
-function AddToSpawnQueue(itemPrefab, position, sub, condition, quality, onSpawned) end
+function AddItemToSpawnQueue(itemPrefab, position, sub, condition, quality, onSpawned) end
---- AddToSpawnQueue
+--- AddItemToSpawnQueue
-- @realm shared
-- @tparam ItemPrefab itemPrefab
-- @tparam Inventory inventory
@@ -56,40 +55,40 @@ function AddToSpawnQueue(itemPrefab, position, sub, condition, quality, onSpawne
-- @tparam bool spawnIfInventoryFull
-- @tparam bool ignoreLimbSlots
-- @tparam InvSlotType slot
-function AddToSpawnQueue(itemPrefab, inventory, condition, quality, onSpawned, spawnIfInventoryFull, ignoreLimbSlots, slot) end
+function AddItemToSpawnQueue(itemPrefab, inventory, condition, quality, onSpawned, spawnIfInventoryFull, ignoreLimbSlots, slot) end
---- AddToSpawnQueue
+--- AddCharacterToSpawnQueue
-- @realm shared
--- @tparam string speciesName
+-- @tparam Identifier speciesName
-- @tparam Vector2 worldPosition
-- @tparam function onSpawn
-function AddToSpawnQueue(speciesName, worldPosition, onSpawn) end
+function AddCharacterToSpawnQueue(speciesName, worldPosition, onSpawn) end
---- AddToSpawnQueue
+--- AddCharacterToSpawnQueue
-- @realm shared
--- @tparam string speciesName
+-- @tparam Identifier speciesName
-- @tparam Vector2 position
-- @tparam Submarine sub
-- @tparam function onSpawn
-function AddToSpawnQueue(speciesName, position, sub, onSpawn) end
+function AddCharacterToSpawnQueue(speciesName, position, sub, onSpawn) end
---- AddToSpawnQueue
+--- AddCharacterToSpawnQueue
-- @realm shared
--- @tparam string speciesName
+-- @tparam Identifier speciesName
-- @tparam Vector2 worldPosition
-- @tparam CharacterInfo characterInfo
-- @tparam function onSpawn
-function AddToSpawnQueue(speciesName, worldPosition, characterInfo, onSpawn) end
+function AddCharacterToSpawnQueue(speciesName, worldPosition, characterInfo, onSpawn) end
---- AddToRemoveQueue
+--- AddEntityToRemoveQueue
-- @realm shared
-- @tparam Entity entity
-function AddToRemoveQueue(entity) end
+function AddEntityToRemoveQueue(entity) end
---- AddToRemoveQueue
+--- AddItemToRemoveQueue
-- @realm shared
-- @tparam Item item
-function AddToRemoveQueue(item) end
+function AddItemToRemoveQueue(item) end
--- IsInSpawnQueue
-- @realm shared
@@ -192,8 +191,23 @@ function GetHashCode() end
-- @realm shared
-- @number SpawnTime
+---
+-- ErrorLine, Field of type string
+-- @realm shared
+-- @string ErrorLine
+
---
-- ID, Field of type number
-- @realm shared
-- @number ID
+---
+-- CreationStackTrace, Field of type string
+-- @realm shared
+-- @string CreationStackTrace
+
+---
+-- CreationIndex, Field of type number
+-- @realm shared
+-- @number CreationIndex
+
diff --git a/docs/lua/generated/Entity.lua b/docs/lua/generated/Entity.lua
index ab5c3d7c7..95abcc8ce 100644
--- a/docs/lua/generated/Entity.lua
+++ b/docs/lua/generated/Entity.lua
@@ -119,11 +119,26 @@ function GetHashCode() end
-- @realm shared
-- @number SpawnTime
+---
+-- ErrorLine, Field of type string
+-- @realm shared
+-- @string ErrorLine
+
---
-- ID, Field of type number
-- @realm shared
-- @number ID
+---
+-- CreationStackTrace, Field of type string
+-- @realm shared
+-- @string CreationStackTrace
+
+---
+-- CreationIndex, Field of type number
+-- @realm shared
+-- @number CreationIndex
+
---
-- Entity.Spawner, Field of type EntitySpawner
-- @realm shared
diff --git a/docs/lua/generated/GameScreen.lua b/docs/lua/generated/GameScreen.lua
index 233f769e2..b517db72e 100644
--- a/docs/lua/generated/GameScreen.lua
+++ b/docs/lua/generated/GameScreen.lua
@@ -51,3 +51,8 @@ function GetHashCode() end
-- @realm shared
-- @number GameTime
+---
+-- IsEditor, Field of type bool
+-- @realm shared
+-- @bool IsEditor
+
diff --git a/docs/lua/generated/GameSession.lua b/docs/lua/generated/GameSession.lua
index 2ea84874f..4bc210e3f 100644
--- a/docs/lua/generated/GameSession.lua
+++ b/docs/lua/generated/GameSession.lua
@@ -15,13 +15,15 @@ function LoadPreviousSave() end
-- @realm shared
-- @tparam SubmarineInfo newSubmarine
-- @tparam number cost
+-- @tparam Client client
-- @treturn SubmarineInfo
-function SwitchSubmarine(newSubmarine, cost) end
+function SwitchSubmarine(newSubmarine, cost, client) end
--- PurchaseSubmarine
-- @realm shared
-- @tparam SubmarineInfo newSubmarine
-function PurchaseSubmarine(newSubmarine) end
+-- @tparam Client client
+function PurchaseSubmarine(newSubmarine, client) end
--- IsSubmarineOwned
-- @realm shared
@@ -78,8 +80,9 @@ function EnforceMissionOrder(missionIdentifiers) end
--- GetSessionCrewCharacters
-- @realm shared
--- @treturn Enumerable
-function GameSession.GetSessionCrewCharacters() end
+-- @tparam CharacterType type
+-- @treturn ImmutableHashSet`1
+function GameSession.GetSessionCrewCharacters(type) end
--- EndRound
-- @realm shared
@@ -105,10 +108,10 @@ function ReviveCharacter(character) end
--- IsCompatibleWithEnabledContentPackages
-- @realm shared
--- @tparam IList`1 contentPackagePaths
--- @tparam String& errorMsg
+-- @tparam IList`1 contentPackageNames
+-- @tparam LocalizedString& errorMsg
-- @treturn bool
-function GameSession.IsCompatibleWithEnabledContentPackages(contentPackagePaths, errorMsg) end
+function GameSession.IsCompatibleWithEnabledContentPackages(contentPackageNames, errorMsg) end
--- Save
-- @realm shared
@@ -141,6 +144,11 @@ function GetHashCode() end
-- @realm shared
-- @Enumerable Missions
+---
+-- Casualties, Field of type Enumerable
+-- @realm shared
+-- @Enumerable Casualties
+
---
-- IsRunning, Field of type bool
-- @realm shared
diff --git a/docs/lua/generated/Hull.lua b/docs/lua/generated/Hull.lua
index 6af7ffd8f..accedfd36 100644
--- a/docs/lua/generated/Hull.lua
+++ b/docs/lua/generated/Hull.lua
@@ -7,11 +7,21 @@ Barotrauma.Hull
-- @pragma nostrip
local Hull = {}
---- DirtySections
+--- IncreaseSectionColorOrStrength
-- @realm shared
--- @tparam table sections
--- @tparam number dirtyVal
-function DirtySections(sections, dirtyVal) end
+-- @tparam BackgroundSection section
+-- @tparam Nullable`1 color
+-- @tparam Nullable`1 strength
+-- @tparam bool requiresUpdate
+-- @tparam bool isCleaning
+function IncreaseSectionColorOrStrength(section, color, strength, requiresUpdate, isCleaning) end
+
+--- SetSectionColorOrStrength
+-- @realm shared
+-- @tparam BackgroundSection section
+-- @tparam Nullable`1 color
+-- @tparam Nullable`1 strength
+function SetSectionColorOrStrength(section, color, strength) end
--- CleanSection
-- @realm shared
@@ -22,7 +32,7 @@ function CleanSection(section, cleanVal, updateRequired) end
--- Load
-- @realm shared
--- @tparam XElement element
+-- @tparam ContentXElement element
-- @tparam Submarine submarine
-- @tparam IdRemap idRemap
-- @treturn Hull
@@ -40,19 +50,18 @@ function Save(parentElement) end
-- @treturn bool
function IsMouseOn(position) end
---- ServerWrite
+--- ServerEventWrite
-- @realm shared
--- @tparam IWriteMessage message
+-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWrite(message, c, extraData) end
+-- @tparam IData extraData
+function ServerEventWrite(msg, c, extraData) end
---- ServerRead
+--- ServerEventRead
-- @realm shared
--- @tparam ClientNetObject type
-- @tparam IReadMessage msg
-- @tparam Client c
-function ServerRead(type, msg, c) end
+function ServerEventRead(msg, c) end
--- GetBorders
-- @realm shared
@@ -241,11 +250,6 @@ function GetBackgroundSection(worldPosition) end
-- @treturn Enumerable
function GetBackgroundSectionsViaContaining(rectArea) end
---- RefreshSubmergedSections
--- @realm shared
--- @tparam Rectangle waterArea
-function RefreshSubmergedSections(waterArea) end
-
--- DoesSectionMatch
-- @realm shared
-- @tparam number index
@@ -253,21 +257,10 @@ function RefreshSubmergedSections(waterArea) end
-- @treturn bool
function DoesSectionMatch(index, row) end
---- IncreaseSectionColorOrStrength
+--- AddLinked
-- @realm shared
--- @tparam BackgroundSection section
--- @tparam Nullable`1 color
--- @tparam Nullable`1 strength
--- @tparam bool requiresUpdate
--- @tparam bool isCleaning
-function IncreaseSectionColorOrStrength(section, color, strength, requiresUpdate, isCleaning) end
-
---- SetSectionColorOrStrength
--- @realm shared
--- @tparam BackgroundSection section
--- @tparam Nullable`1 color
--- @tparam Nullable`1 strength
-function SetSectionColorOrStrength(section, color, strength) end
+-- @tparam MapEntity entity
+function AddLinked(entity) end
--- ResolveLinks
-- @realm shared
@@ -276,13 +269,13 @@ function ResolveLinks(childRemap) end
--- HasUpgrade
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @treturn bool
function HasUpgrade(identifier) end
--- GetUpgrade
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @treturn Upgrade
function GetUpgrade(identifier) end
@@ -352,11 +345,6 @@ function Equals(obj) end
-- @treturn number
function GetHashCode() end
----
--- Hull.EntityGrids, Field of type table
--- @realm shared
--- @table Hull.EntityGrids
-
---
-- SerializableProperties, Field of type table
-- @realm shared
@@ -368,9 +356,9 @@ function GetHashCode() end
-- @string Name
---
--- DisplayName, Field of type string
+-- DisplayName, Field of type LocalizedString
-- @realm shared
--- @string DisplayName
+-- @LocalizedString DisplayName
---
-- OutpostModuleTags, Field of type Enumerable
@@ -538,9 +526,9 @@ function GetHashCode() end
-- @bool DrawOverWater
---
--- AllowedLinks, Field of type table
+-- AllowedLinks, Field of type Enumerable
-- @realm shared
--- @table AllowedLinks
+-- @Enumerable AllowedLinks
---
-- ResizeHorizontal, Field of type bool
@@ -657,6 +645,11 @@ function GetHashCode() end
-- @realm shared
-- @number SpawnTime
+---
+-- ErrorLine, Field of type string
+-- @realm shared
+-- @string ErrorLine
+
---
-- properties, Field of type table
-- @realm shared
@@ -688,9 +681,14 @@ function GetHashCode() end
-- @number yBackgroundMax
---
--- Hull.hullList, Field of type table
+-- Hull.HullList, Field of type table
-- @realm shared
--- @table Hull.hullList
+-- @table Hull.HullList
+
+---
+-- Hull.EntityGrids, Field of type table
+-- @realm shared
+-- @table Hull.EntityGrids
---
-- Hull.ShowHulls, Field of type bool
@@ -763,9 +761,9 @@ function GetHashCode() end
-- @number Hull.MaxDecalsPerHull
---
--- prefab, Field of type MapEntityPrefab
+-- Prefab, Field of type MapEntityPrefab
-- @realm shared
--- @MapEntityPrefab prefab
+-- @MapEntityPrefab Prefab
---
-- unresolvedLinkedToID, Field of type table
@@ -773,9 +771,9 @@ function GetHashCode() end
-- @table unresolvedLinkedToID
---
--- disallowedUpgrades, Field of type HashSet`1
+-- DisallowedUpgradeSet, Field of type HashSet`1
-- @realm shared
--- @HashSet`1 disallowedUpgrades
+-- @HashSet`1 DisallowedUpgradeSet
---
-- linkedTo, Field of type table
@@ -807,3 +805,13 @@ function GetHashCode() end
-- @realm shared
-- @number ID
+---
+-- CreationStackTrace, Field of type string
+-- @realm shared
+-- @string CreationStackTrace
+
+---
+-- CreationIndex, Field of type number
+-- @realm shared
+-- @number CreationIndex
+
diff --git a/docs/lua/generated/Inventory.lua b/docs/lua/generated/Inventory.lua
index 0b7a6e93b..bc009be5a 100644
--- a/docs/lua/generated/Inventory.lua
+++ b/docs/lua/generated/Inventory.lua
@@ -7,19 +7,18 @@ Barotrauma.Inventory
-- @pragma nostrip
local Inventory = {}
---- ServerRead
+--- ServerEventRead
-- @realm shared
--- @tparam ClientNetObject type
-- @tparam IReadMessage msg
-- @tparam Client c
-function ServerRead(type, msg, c) end
+function ServerEventRead(msg, c) end
---- ServerWrite
+--- ServerEventWrite
-- @realm shared
-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWrite(msg, c, extraData) end
+-- @tparam IData extraData
+function ServerEventWrite(msg, c, extraData) end
--- Contains
-- @realm shared
@@ -174,14 +173,14 @@ function FindAllItems(predicate, recursive, list) end
--- FindItemByTag
-- @realm shared
--- @tparam string tag
+-- @tparam Identifier tag
-- @tparam bool recursive
-- @treturn Item
function FindItemByTag(tag, recursive) end
--- FindItemByIdentifier
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @tparam bool recursive
-- @treturn Item
function FindItemByIdentifier(identifier, recursive) end
@@ -203,10 +202,16 @@ function ForceToSlot(item, index) end
-- @tparam number index
function ForceRemoveFromSlot(item, index) end
+--- SharedRead
+-- @realm shared
+-- @tparam IReadMessage msg
+-- @tparam List`1[]& newItemIds
+function SharedRead(msg, newItemIds) end
+
--- SharedWrite
-- @realm shared
-- @tparam IWriteMessage msg
--- @tparam Object[] extraData
+-- @tparam IData extraData
function SharedWrite(msg, extraData) end
--- DeleteAllItems
diff --git a/docs/lua/generated/Item.lua b/docs/lua/generated/Item.lua
index ce65e697e..ce6899b67 100644
--- a/docs/lua/generated/Item.lua
+++ b/docs/lua/generated/Item.lua
@@ -46,6 +46,54 @@ function SendSignal(signalOrString, connectionOrConnectionName) end
-- @Vector2 WorldPosition
+--- ApplyStatusEffects
+-- @realm shared
+-- @tparam function type
+-- @tparam number deltaTime
+-- @tparam Character character
+-- @tparam Limb limb
+-- @tparam Entity useTarget
+-- @tparam bool isNetworkEvent
+-- @tparam Nullable`1 worldPosition
+function ApplyStatusEffects(type, deltaTime, character, limb, useTarget, isNetworkEvent, worldPosition) end
+
+--- ApplyStatusEffect
+-- @realm shared
+-- @tparam StatusEffect effect
+-- @tparam function type
+-- @tparam number deltaTime
+-- @tparam Character character
+-- @tparam Limb limb
+-- @tparam Entity useTarget
+-- @tparam bool isNetworkEvent
+-- @tparam bool checkCondition
+-- @tparam Nullable`1 worldPosition
+function ApplyStatusEffect(effect, type, deltaTime, character, limb, useTarget, isNetworkEvent, checkCondition, worldPosition) end
+
+--- AddDamage
+-- @realm shared
+-- @tparam Character attacker
+-- @tparam Vector2 worldPosition
+-- @tparam Attack attack
+-- @tparam number deltaTime
+-- @tparam bool playSound
+-- @treturn AttackResult
+function AddDamage(attacker, worldPosition, attack, deltaTime, playSound) end
+
+--- SendPendingNetworkUpdates
+-- @realm shared
+function SendPendingNetworkUpdates() end
+
+--- CreateStatusEvent
+-- @realm shared
+function CreateStatusEvent() end
+
+--- Update
+-- @realm shared
+-- @tparam number deltaTime
+-- @tparam Camera cam
+function Update(deltaTime, cam) end
+
--- UpdateTransform
-- @realm shared
function UpdateTransform() end
@@ -63,26 +111,28 @@ function FlipY(relativeToSub) end
--- GetConnectedComponents
-- @realm shared
-- @tparam bool recursive
+-- @tparam bool allowTraversingBackwards
-- @treturn table
-function GetConnectedComponents(recursive) end
+function GetConnectedComponents(recursive, allowTraversingBackwards) end
--- GetConnectedComponentsRecursive
-- @realm shared
-- @tparam Connection c
-- @tparam bool ignoreInactiveRelays
+-- @tparam bool allowTraversingBackwards
-- @treturn table
-function GetConnectedComponentsRecursive(c, ignoreInactiveRelays) end
+function GetConnectedComponentsRecursive(c, ignoreInactiveRelays, allowTraversingBackwards) end
--- FindController
-- @realm shared
--- @tparam String[] tags
+-- @tparam Nullable`1 tags
-- @treturn Controller
function FindController(tags) end
--- TryFindController
-- @realm shared
-- @tparam Controller& controller
--- @tparam String[] tags
+-- @tparam Nullable`1 tags
-- @treturn bool
function TryFindController(controller, tags) end
@@ -168,7 +218,8 @@ function Combine(item, user) end
-- @realm shared
-- @tparam Character dropper
-- @tparam bool createNetworkEvent
-function Drop(dropper, createNetworkEvent) end
+-- @tparam bool setTransform
+function Drop(dropper, createNetworkEvent, setTransform) end
--- Equip
-- @realm shared
@@ -187,7 +238,7 @@ function GetProperties() end
--- Load
-- @realm shared
--- @tparam XElement element
+-- @tparam ContentXElement element
-- @tparam Submarine submarine
-- @tparam IdRemap idRemap
-- @treturn Item
@@ -195,7 +246,7 @@ function Item.Load(element, submarine, idRemap) end
--- Load
-- @realm shared
--- @tparam XElement element
+-- @tparam ContentXElement element
-- @tparam Submarine submarine
-- @tparam bool createNetworkEvent
-- @tparam IdRemap idRemap
@@ -229,11 +280,6 @@ function Remove() end
-- @tparam ItemPrefab prefab
function Item.RemoveByPrefab(prefab) end
---- AddToRemoveQueue
--- @realm shared
--- @tparam Item item
-function Item.AddToRemoveQueue(item) end
-
--- GetComponentString
-- @realm shared
-- @tparam string component
@@ -357,11 +403,11 @@ function FindHull() end
-- @treturn Item
function GetRootContainer() end
---- IsThisOrAnyContainerIgnoredByAI
+--- HasAccess
-- @realm shared
-- @tparam Character character
-- @treturn bool
-function IsThisOrAnyContainerIgnoredByAI(character) end
+function HasAccess(character) end
--- IsOwnedBy
-- @realm shared
@@ -389,18 +435,35 @@ function SetContainedItemPositions() end
-- @tparam string tag
function AddTag(tag) end
+--- AddTag
+-- @realm shared
+-- @tparam Identifier tag
+function AddTag(tag) end
+
--- HasTag
-- @realm shared
-- @tparam string tag
-- @treturn bool
function HasTag(tag) end
+--- HasTag
+-- @realm shared
+-- @tparam Identifier tag
+-- @treturn bool
+function HasTag(tag) end
+
--- ReplaceTag
-- @realm shared
-- @tparam string tag
-- @tparam string newTag
function ReplaceTag(tag, newTag) end
+--- ReplaceTag
+-- @realm shared
+-- @tparam Identifier tag
+-- @tparam Identifier newTag
+function ReplaceTag(tag, newTag) end
+
--- GetTags
-- @realm shared
-- @treturn Enumerable
@@ -412,63 +475,18 @@ function GetTags() end
-- @treturn bool
function HasTag(allowedTags) end
---- ApplyStatusEffects
--- @realm shared
--- @tparam function type
--- @tparam number deltaTime
--- @tparam Character character
--- @tparam Limb limb
--- @tparam Entity useTarget
--- @tparam bool isNetworkEvent
--- @tparam Nullable`1 worldPosition
-function ApplyStatusEffects(type, deltaTime, character, limb, useTarget, isNetworkEvent, worldPosition) end
-
---- ApplyStatusEffect
--- @realm shared
--- @tparam StatusEffect effect
--- @tparam function type
--- @tparam number deltaTime
--- @tparam Character character
--- @tparam Limb limb
--- @tparam Entity useTarget
--- @tparam bool isNetworkEvent
--- @tparam bool checkCondition
--- @tparam Nullable`1 worldPosition
-function ApplyStatusEffect(effect, type, deltaTime, character, limb, useTarget, isNetworkEvent, checkCondition, worldPosition) end
-
---- AddDamage
--- @realm shared
--- @tparam Character attacker
--- @tparam Vector2 worldPosition
--- @tparam Attack attack
--- @tparam number deltaTime
--- @tparam bool playSound
--- @treturn AttackResult
-function AddDamage(attacker, worldPosition, attack, deltaTime, playSound) end
-
---- SendPendingNetworkUpdates
--- @realm shared
-function SendPendingNetworkUpdates() end
-
---- Update
--- @realm shared
--- @tparam number deltaTime
--- @tparam Camera cam
-function Update(deltaTime, cam) end
-
---- ServerWrite
+--- ServerEventWrite
-- @realm shared
-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWrite(msg, c, extraData) end
+-- @tparam IData extraData
+function ServerEventWrite(msg, c, extraData) end
---- ServerRead
+--- ServerEventRead
-- @realm shared
--- @tparam ClientNetObject type
-- @tparam IReadMessage msg
-- @tparam Client c
-function ServerRead(type, msg, c) end
+function ServerEventRead(msg, c) end
--- WriteSpawnData
-- @realm shared
@@ -476,7 +494,8 @@ function ServerRead(type, msg, c) end
-- @tparam number entityID
-- @tparam number originalInventoryID
-- @tparam Byte originalItemContainerIndex
-function WriteSpawnData(msg, entityID, originalInventoryID, originalItemContainerIndex) end
+-- @tparam number originalSlotIndex
+function WriteSpawnData(msg, entityID, originalInventoryID, originalItemContainerIndex, originalSlotIndex) end
--- GetPositionUpdateInterval
-- @realm shared
@@ -488,8 +507,7 @@ function GetPositionUpdateInterval(recipient) end
-- @realm shared
-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWritePosition(msg, c, extraData) end
+function ServerWritePosition(msg, c) end
--- CreateServerEvent
-- @realm shared
@@ -499,7 +517,7 @@ function CreateServerEvent(ic) end
--- CreateServerEvent
-- @realm shared
-- @tparam T ic
--- @tparam Object[] extraData
+-- @tparam IEventData extraData
function CreateServerEvent(ic, extraData) end
--- CreateServerEventString
@@ -521,6 +539,11 @@ function CreateServerEventString(component, extraData) end
-- @treturn bool
function IsInteractable(character) end
+--- AddLinked
+-- @realm shared
+-- @tparam MapEntity entity
+function AddLinked(entity) end
+
--- ResolveLinks
-- @realm shared
-- @tparam IdRemap childRemap
@@ -534,13 +557,13 @@ function IsMouseOn(position) end
--- HasUpgrade
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @treturn bool
function HasUpgrade(identifier) end
--- GetUpgrade
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @treturn Upgrade
function GetUpgrade(identifier) end
@@ -741,9 +764,9 @@ function GetHashCode() end
-- @Color ContainerColor
---
--- ContainerIdentifier, Field of type string
+-- ContainerIdentifier, Field of type Identifier
-- @realm shared
--- @string ContainerIdentifier
+-- @Identifier ContainerIdentifier
---
-- SonarLabel, Field of type string
@@ -896,9 +919,9 @@ function GetHashCode() end
-- @table LastSentSignalRecipients
---
--- ConfigFile, Field of type string
+-- ConfigFilePath, Field of type ContentPath
-- @realm shared
--- @string ConfigFile
+-- @ContentPath ConfigFilePath
---
-- AllowedSlots, Field of type Enumerable
@@ -970,6 +993,16 @@ function GetHashCode() end
-- @realm shared
-- @bool OrderedToBeIgnored
+---
+-- HasBallastFloraInHull, Field of type bool
+-- @realm shared
+-- @bool HasBallastFloraInHull
+
+---
+-- IsClaimedByBallastFlora, Field of type bool
+-- @realm shared
+-- @bool IsClaimedByBallastFlora
+
---
-- DisallowedUpgrades, Field of type string
-- @realm shared
@@ -1011,9 +1044,9 @@ function GetHashCode() end
-- @bool DrawOverWater
---
--- AllowedLinks, Field of type table
+-- AllowedLinks, Field of type Enumerable
-- @realm shared
--- @table AllowedLinks
+-- @Enumerable AllowedLinks
---
-- ResizeHorizontal, Field of type bool
@@ -1105,6 +1138,11 @@ function GetHashCode() end
-- @realm shared
-- @number SpawnTime
+---
+-- ErrorLine, Field of type string
+-- @realm shared
+-- @string ErrorLine
+
---
-- PreviousParentInventory, Field of type Inventory
-- @realm shared
@@ -1151,14 +1189,14 @@ function GetHashCode() end
-- @bool Item.ShowLinks
---
--- Item.connectionPairs, Field of type ValueTuple`2[]
+-- Item.connectionPairs, Field of type ImmutableArray`1
-- @realm shared
--- @ValueTuple`2[] Item.connectionPairs
+-- @ImmutableArray`1 Item.connectionPairs
---
--- prefab, Field of type MapEntityPrefab
+-- Prefab, Field of type MapEntityPrefab
-- @realm shared
--- @MapEntityPrefab prefab
+-- @MapEntityPrefab Prefab
---
-- unresolvedLinkedToID, Field of type table
@@ -1166,9 +1204,9 @@ function GetHashCode() end
-- @table unresolvedLinkedToID
---
--- disallowedUpgrades, Field of type HashSet`1
+-- DisallowedUpgradeSet, Field of type HashSet`1
-- @realm shared
--- @HashSet`1 disallowedUpgrades
+-- @HashSet`1 DisallowedUpgradeSet
---
-- linkedTo, Field of type table
@@ -1200,3 +1238,13 @@ function GetHashCode() end
-- @realm shared
-- @number ID
+---
+-- CreationStackTrace, Field of type string
+-- @realm shared
+-- @string CreationStackTrace
+
+---
+-- CreationIndex, Field of type number
+-- @realm shared
+-- @number CreationIndex
+
diff --git a/docs/lua/generated/ItemInventory.lua b/docs/lua/generated/ItemInventory.lua
index ead78cde7..f7b914b4e 100644
--- a/docs/lua/generated/ItemInventory.lua
+++ b/docs/lua/generated/ItemInventory.lua
@@ -76,19 +76,18 @@ function CreateNetworkEvent() end
-- @tparam Item item
function RemoveItem(item) end
---- ServerRead
+--- ServerEventRead
-- @realm shared
--- @tparam ClientNetObject type
-- @tparam IReadMessage msg
-- @tparam Client c
-function ServerRead(type, msg, c) end
+function ServerEventRead(msg, c) end
---- ServerWrite
+--- ServerEventWrite
-- @realm shared
-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWrite(msg, c, extraData) end
+-- @tparam IData extraData
+function ServerEventWrite(msg, c, extraData) end
--- Contains
-- @realm shared
@@ -179,14 +178,14 @@ function FindAllItems(predicate, recursive, list) end
--- FindItemByTag
-- @realm shared
--- @tparam string tag
+-- @tparam Identifier tag
-- @tparam bool recursive
-- @treturn Item
function FindItemByTag(tag, recursive) end
--- FindItemByIdentifier
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @tparam bool recursive
-- @treturn Item
function FindItemByIdentifier(identifier, recursive) end
@@ -203,10 +202,16 @@ function ForceToSlot(item, index) end
-- @tparam number index
function ForceRemoveFromSlot(item, index) end
+--- SharedRead
+-- @realm shared
+-- @tparam IReadMessage msg
+-- @tparam List`1[]& newItemIds
+function SharedRead(msg, newItemIds) end
+
--- SharedWrite
-- @realm shared
-- @tparam IWriteMessage msg
--- @tparam Object[] extraData
+-- @tparam IData extraData
function SharedWrite(msg, extraData) end
--- DeleteAllItems
diff --git a/docs/lua/generated/ItemPrefab.lua b/docs/lua/generated/ItemPrefab.lua
index 1f91c7774..5fe67ba45 100644
--- a/docs/lua/generated/ItemPrefab.lua
+++ b/docs/lua/generated/ItemPrefab.lua
@@ -36,56 +36,36 @@ function ItemPrefab.GetItemPrefab(itemNameOrId) end
-- @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 Enumerable files
-function ItemPrefab.LoadAll(files) end
-
---- InitFabricationRecipes
--- @realm shared
-function ItemPrefab.InitFabricationRecipes() end
-
--- GenerateLegacyIdentifier
-- @realm shared
-- @tparam string name
--- @treturn string
+-- @treturn Identifier
function ItemPrefab.GenerateLegacyIdentifier(name) end
--- GetTreatmentSuitability
-- @realm shared
--- @tparam string treatmentIdentifier
+-- @tparam Identifier treatmentIdentifier
-- @treturn number
function GetTreatmentSuitability(treatmentIdentifier) end
--- GetPriceInfo
-- @realm shared
--- @tparam Location location
+-- @tparam StoreInfo store
-- @treturn PriceInfo
-function GetPriceInfo(location) end
+function GetPriceInfo(store) end
---- CanBeBoughtAtLocation
+--- CanBeBoughtFrom
-- @realm shared
--- @tparam Location location
+-- @tparam StoreInfo store
-- @tparam PriceInfo& priceInfo
-- @treturn bool
-function CanBeBoughtAtLocation(location, priceInfo) end
+function CanBeBoughtFrom(store, priceInfo) end
---- Find
+--- CanBeBoughtFrom
-- @realm shared
--- @tparam string name
--- @tparam string identifier
--- @treturn ItemPrefab
-function ItemPrefab.Find(name, identifier) end
+-- @tparam Location location
+-- @treturn bool
+function CanBeBoughtFrom(location) end
--- GetMinPrice
-- @realm shared
@@ -105,6 +85,13 @@ function GetBuyPricesUnder(maxCost) end
-- @treturn ImmutableDictionary`2
function GetSellPricesOver(minCost, sellingImportant) end
+--- Find
+-- @realm shared
+-- @tparam string name
+-- @tparam Identifier identifier
+-- @treturn ItemPrefab
+function ItemPrefab.Find(name, identifier) end
+
--- IsContainerPreferred
-- @realm shared
-- @tparam Item item
@@ -118,7 +105,7 @@ function IsContainerPreferred(item, targetContainer, isPreferencesDefined, isSec
--- IsContainerPreferred
-- @realm shared
-- @tparam Item item
--- @tparam String[] identifiersOrTags
+-- @tparam Identifier[] identifiersOrTags
-- @tparam Boolean& isPreferencesDefined
-- @tparam Boolean& isSecondary
-- @treturn bool
@@ -138,6 +125,15 @@ function ItemPrefab.IsContainerPreferred(preferences, c) end
-- @treturn bool
function ItemPrefab.IsContainerPreferred(preferences, ids) end
+--- Dispose
+-- @realm shared
+function Dispose() end
+
+--- InheritFrom
+-- @realm shared
+-- @tparam ItemPrefab parent
+function InheritFrom(parent) end
+
--- ToString
-- @realm shared
-- @treturn string
@@ -149,24 +145,6 @@ function ToString() end
-- @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
@@ -179,7 +157,7 @@ function GetHullNameTextId() end
--- GetAllowedUpgrades
-- @realm shared
--- @treturn String[]
+-- @treturn Enumerable
function GetAllowedUpgrades() end
--- HasSubCategory
@@ -229,24 +207,49 @@ function Equals(obj) end
function GetHashCode() end
---
--- Name, Field of type string
+-- Size, Field of type Vector2
-- @realm shared
--- @string Name
+-- @Vector2 Size
---
--- ConfigElement, Field of type XElement
+-- DefaultPrice, Field of type PriceInfo
-- @realm shared
--- @XElement ConfigElement
+-- @PriceInfo DefaultPrice
---
--- DeconstructItems, Field of type table
+-- CanBeBought, Field of type bool
-- @realm shared
--- @table DeconstructItems
+-- @bool CanBeBought
---
--- FabricationRecipes, Field of type table
+-- CanBeSold, Field of type bool
-- @realm shared
--- @table FabricationRecipes
+-- @bool CanBeSold
+
+---
+-- Triggers, Field of type ImmutableArray`1
+-- @realm shared
+-- @ImmutableArray`1 Triggers
+
+---
+-- IsOverride, Field of type bool
+-- @realm shared
+-- @bool IsOverride
+
+---
+-- ConfigElement, Field of type ContentXElement
+-- @realm shared
+-- @ContentXElement ConfigElement
+
+---
+-- DeconstructItems, Field of type ImmutableArray`1
+-- @realm shared
+-- @ImmutableArray`1 DeconstructItems
+
+---
+-- FabricationRecipes, Field of type ImmutableDictionary`2
+-- @realm shared
+-- @ImmutableDictionary`2 FabricationRecipes
---
-- DeconstructTime, Field of type number
@@ -258,6 +261,86 @@ function GetHashCode() end
-- @realm shared
-- @bool AllowDeconstruct
+---
+-- PreferredContainers, Field of type ImmutableArray`1
+-- @realm shared
+-- @ImmutableArray`1 PreferredContainers
+
+---
+-- SwappableItem, Field of type SwappableItem
+-- @realm shared
+-- @SwappableItem SwappableItem
+
+---
+-- LevelCommonness, Field of type ImmutableDictionary`2
+-- @realm shared
+-- @ImmutableDictionary`2 LevelCommonness
+
+---
+-- LevelQuantity, Field of type ImmutableDictionary`2
+-- @realm shared
+-- @ImmutableDictionary`2 LevelQuantity
+
+---
+-- CanSpriteFlipX, Field of type bool
+-- @realm shared
+-- @bool CanSpriteFlipX
+
+---
+-- CanSpriteFlipY, Field of type bool
+-- @realm shared
+-- @bool CanSpriteFlipY
+
+---
+-- AllowAsExtraCargo, Field of type Nullable`1
+-- @realm shared
+-- @Nullable`1 AllowAsExtraCargo
+
+---
+-- RandomDeconstructionOutput, Field of type bool
+-- @realm shared
+-- @bool RandomDeconstructionOutput
+
+---
+-- RandomDeconstructionOutputAmount, Field of type number
+-- @realm shared
+-- @number RandomDeconstructionOutputAmount
+
+---
+-- Sprite, Field of type Sprite
+-- @realm shared
+-- @Sprite Sprite
+
+---
+-- OriginalName, Field of type string
+-- @realm shared
+-- @string OriginalName
+
+---
+-- Name, Field of type LocalizedString
+-- @realm shared
+-- @LocalizedString Name
+
+---
+-- Tags, Field of type ImmutableHashSet`1
+-- @realm shared
+-- @ImmutableHashSet`1 Tags
+
+---
+-- AllowedLinks, Field of type ImmutableHashSet`1
+-- @realm shared
+-- @ImmutableHashSet`1 AllowedLinks
+
+---
+-- Category, Field of type MapEntityCategory
+-- @realm shared
+-- @MapEntityCategory Category
+
+---
+-- Aliases, Field of type ImmutableHashSet`1
+-- @realm shared
+-- @ImmutableHashSet`1 Aliases
+
---
-- InteractDistance, Field of type number
-- @realm shared
@@ -433,26 +516,6 @@ function GetHashCode() end
-- @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
@@ -468,16 +531,6 @@ function GetHashCode() end
-- @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
@@ -489,39 +542,14 @@ function GetHashCode() end
-- @bool AllowDroppingOnSwap
---
--- AllowDroppingOnSwapWith, Field of type Enumerable
+-- AllowDroppingOnSwapWith, Field of type ImmutableHashSet`1
-- @realm shared
--- @Enumerable AllowDroppingOnSwapWith
+-- @ImmutableHashSet`1 AllowDroppingOnSwapWith
---
--- Size, Field of type Vector2
+-- VariantOf, Field of type Identifier
-- @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
+-- @Identifier VariantOf
---
-- ResizeHorizontal, Field of type bool
@@ -534,34 +562,9 @@ function GetHashCode() end
-- @bool ResizeVertical
---
--- OriginalName, Field of type string
+-- Description, Field of type LocalizedString
-- @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
+-- @LocalizedString Description
---
-- AllowedUpgrades, Field of type string
@@ -583,16 +586,6 @@ function GetHashCode() end
-- @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
@@ -604,34 +597,19 @@ function GetHashCode() end
-- @number Scale
---
--- Aliases, Field of type HashSet`1
+-- UintIdentifier, Field of type number
-- @realm shared
--- @HashSet`1 Aliases
+-- @number UintIdentifier
---
--- DefaultPrice, Field of type PriceInfo
+-- ContentPackage, Field of type ContentPackage
-- @realm shared
--- @PriceInfo DefaultPrice
+-- @ContentPackage ContentPackage
---
--- Triggers, Field of type table
+-- FilePath, Field of type ContentPath
-- @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
+-- @ContentPath FilePath
---
-- ItemPrefab.Prefabs, Field of type PrefabCollection`1
@@ -639,7 +617,12 @@ function GetHashCode() end
-- @PrefabCollection`1 ItemPrefab.Prefabs
---
--- sprite, Field of type Sprite
+-- Identifier, Field of type Identifier
-- @realm shared
--- @Sprite sprite
+-- @Identifier Identifier
+
+---
+-- ContentFile, Field of type ContentFile
+-- @realm shared
+-- @ContentFile ContentFile
diff --git a/docs/lua/generated/Job.lua b/docs/lua/generated/Job.lua
index a2bf13fe2..60accda26 100644
--- a/docs/lua/generated/Job.lua
+++ b/docs/lua/generated/Job.lua
@@ -19,13 +19,13 @@ function Job.Random(randSync) end
--- GetSkillLevel
-- @realm shared
--- @tparam string skillIdentifier
+-- @tparam Identifier skillIdentifier
-- @treturn number
function GetSkillLevel(skillIdentifier) end
--- IncreaseSkillLevel
-- @realm shared
--- @tparam string skillIdentifier
+-- @tparam Identifier skillIdentifier
-- @tparam number increase
-- @tparam bool increasePastMax
function IncreaseSkillLevel(skillIdentifier, increase, increasePastMax) end
@@ -64,14 +64,14 @@ function Equals(obj) end
function GetHashCode() end
---
--- Name, Field of type string
+-- Name, Field of type LocalizedString
-- @realm shared
--- @string Name
+-- @LocalizedString Name
---
--- Description, Field of type string
+-- Description, Field of type LocalizedString
-- @realm shared
--- @string Description
+-- @LocalizedString Description
---
-- Prefab, Field of type JobPrefab
diff --git a/docs/lua/generated/JobPrefab.lua b/docs/lua/generated/JobPrefab.lua
index 33defe6f1..f81b4b359 100644
--- a/docs/lua/generated/JobPrefab.lua
+++ b/docs/lua/generated/JobPrefab.lua
@@ -26,21 +26,6 @@ function JobPrefab.Get(identifier) end
-- @treturn JobPrefab
function JobPrefab.Random(sync) end
---- LoadAll
--- @realm shared
--- @tparam Enumerable 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
@@ -72,36 +57,11 @@ function GetHashCode() end
-- @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
@@ -158,34 +118,44 @@ function GetHashCode() end
-- @SkillPrefab PrimarySkill
---
--- FilePath, Field of type string
+-- Element, Field of type ContentXElement
-- @realm shared
--- @string FilePath
+-- @ContentXElement Element
---
--- Element, Field of type XElement
+-- ClothingElement, Field of type ContentXElement
-- @realm shared
--- @XElement Element
-
----
--- ClothingElement, Field of type XElement
--- @realm shared
--- @XElement ClothingElement
+-- @ContentXElement ClothingElement
---
-- Variants, Field of type number
-- @realm shared
-- @number Variants
+---
+-- UintIdentifier, Field of type number
+-- @realm shared
+-- @number UintIdentifier
+
+---
+-- ContentPackage, Field of type ContentPackage
+-- @realm shared
+-- @ContentPackage ContentPackage
+
+---
+-- FilePath, Field of type ContentPath
+-- @realm shared
+-- @ContentPath FilePath
+
---
-- ItemSets, Field of type table
-- @realm shared
-- @table ItemSets
---
--- PreviewItems, Field of type table
+-- PreviewItems, Field of type ImmutableDictionary`2
-- @realm shared
--- @table PreviewItems
+-- @ImmutableDictionary`2 PreviewItems
---
-- Skills, Field of type table
@@ -202,6 +172,16 @@ function GetHashCode() end
-- @realm shared
-- @table AppropriateOrders
+---
+-- Name, Field of type LocalizedString
+-- @realm shared
+-- @LocalizedString Name
+
+---
+-- Description, Field of type LocalizedString
+-- @realm shared
+-- @LocalizedString Description
+
---
-- Icon, Field of type Sprite
-- @realm shared
@@ -218,7 +198,17 @@ function GetHashCode() end
-- @PrefabCollection`1 JobPrefab.Prefabs
---
--- JobPrefab.NoJobElement, Field of type XElement
+-- JobPrefab.NoJobElement, Field of type ContentXElement
-- @realm shared
--- @XElement JobPrefab.NoJobElement
+-- @ContentXElement JobPrefab.NoJobElement
+
+---
+-- Identifier, Field of type Identifier
+-- @realm shared
+-- @Identifier Identifier
+
+---
+-- ContentFile, Field of type ContentFile
+-- @realm shared
+-- @ContentFile ContentFile
diff --git a/docs/lua/generated/Level.lua b/docs/lua/generated/Level.lua
index e849cbbea..f4d1f7d3e 100644
--- a/docs/lua/generated/Level.lua
+++ b/docs/lua/generated/Level.lua
@@ -154,12 +154,12 @@ function DebugSetEndLocation(newEndLocation) end
-- @realm shared
function Remove() end
---- ServerWrite
+--- ServerEventWrite
-- @realm shared
-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWrite(msg, c, extraData) end
+-- @tparam IData extraData
+function ServerEventWrite(msg, c, extraData) end
--- Generate
-- @realm shared
@@ -477,6 +477,11 @@ function GetHashCode() end
-- @realm shared
-- @number SpawnTime
+---
+-- ErrorLine, Field of type string
+-- @realm shared
+-- @string ErrorLine
+
---
-- AbyssIslands, Field of type table
-- @realm shared
@@ -542,3 +547,13 @@ function GetHashCode() end
-- @realm shared
-- @number ID
+---
+-- CreationStackTrace, Field of type string
+-- @realm shared
+-- @string CreationStackTrace
+
+---
+-- CreationIndex, Field of type number
+-- @realm shared
+-- @number CreationIndex
+
diff --git a/docs/lua/generated/NetLobbyScreen.lua b/docs/lua/generated/NetLobbyScreen.lua
index 2ec0c1944..cb348987b 100644
--- a/docs/lua/generated/NetLobbyScreen.lua
+++ b/docs/lua/generated/NetLobbyScreen.lua
@@ -116,9 +116,9 @@ function GetHashCode() end
-- @number SelectedModeIndex
---
--- SelectedModeIdentifier, Field of type string
+-- SelectedModeIdentifier, Field of type Identifier
-- @realm shared
--- @string SelectedModeIdentifier
+-- @Identifier SelectedModeIdentifier
---
-- SelectedMode, Field of type GameModePreset
@@ -155,6 +155,11 @@ function GetHashCode() end
-- @realm shared
-- @Camera Cam
+---
+-- IsEditor, Field of type bool
+-- @realm shared
+-- @bool IsEditor
+
---
-- RadiationEnabled, Field of type bool
-- @realm shared
diff --git a/docs/lua/generated/Submarine.lua b/docs/lua/generated/Submarine.lua
index 27b479da9..5faa65415 100644
--- a/docs/lua/generated/Submarine.lua
+++ b/docs/lua/generated/Submarine.lua
@@ -80,12 +80,18 @@ function EnableObstructedWaypoints(otherSub) end
-- @realm shared
function RefreshOutdoorNodes() end
---- ServerWrite
+--- ServerWritePosition
-- @realm shared
-- @tparam IWriteMessage msg
-- @tparam Client c
--- @tparam Object[] extraData
-function ServerWrite(msg, c, extraData) end
+function ServerWritePosition(msg, c) end
+
+--- ServerEventWrite
+-- @realm shared
+-- @tparam IWriteMessage msg
+-- @tparam Client c
+-- @tparam IData extraData
+function ServerEventWrite(msg, c, extraData) end
--- ToString
-- @realm shared
@@ -99,7 +105,7 @@ function CalculateBasePrice() end
--- AttemptBallastFloraInfection
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @tparam number deltaTime
-- @tparam number probability
function AttemptBallastFloraInfection(identifier, deltaTime, probability) end
@@ -555,6 +561,11 @@ function GetHashCode() end
-- @realm shared
-- @number SpawnTime
+---
+-- ErrorLine, Field of type string
+-- @realm shared
+-- @string ErrorLine
+
---
-- TeamID, Field of type CharacterTeamType
-- @realm shared
@@ -600,3 +611,13 @@ function GetHashCode() end
-- @realm shared
-- @number ID
+---
+-- CreationStackTrace, Field of type string
+-- @realm shared
+-- @string CreationStackTrace
+
+---
+-- CreationIndex, Field of type number
+-- @realm shared
+-- @number CreationIndex
+
diff --git a/docs/lua/generated/SubmarineInfo.lua b/docs/lua/generated/SubmarineInfo.lua
index 1f1dc10d9..9bf39fed4 100644
--- a/docs/lua/generated/SubmarineInfo.lua
+++ b/docs/lua/generated/SubmarineInfo.lua
@@ -72,6 +72,11 @@ function SaveAs(filePath, previewImage) end
-- @tparam SubmarineInfo subInfo
function SubmarineInfo.AddToSavedSubs(subInfo) end
+--- RemoveSavedSub
+-- @realm shared
+-- @tparam string filePath
+function SubmarineInfo.RemoveSavedSub(filePath) end
+
--- RefreshSavedSub
-- @realm shared
-- @tparam string filePath
@@ -131,14 +136,14 @@ function GetHashCode() end
-- @string Name
---
--- DisplayName, Field of type string
+-- DisplayName, Field of type LocalizedString
-- @realm shared
--- @string DisplayName
+-- @LocalizedString DisplayName
---
--- Description, Field of type string
+-- Description, Field of type LocalizedString
-- @realm shared
--- @string Description
+-- @LocalizedString Description
---
-- Price, Field of type number
@@ -300,8 +305,3 @@ function GetHashCode() end
-- @realm shared
-- @table OutpostNPCs
----
--- SubmarineInfo.SavePath, Field of type string
--- @realm shared
--- @string SubmarineInfo.SavePath
-
diff --git a/docs/lua/generated/WayPoint.lua b/docs/lua/generated/WayPoint.lua
index 0ee8b8492..ea7cde27f 100644
--- a/docs/lua/generated/WayPoint.lua
+++ b/docs/lua/generated/WayPoint.lua
@@ -55,7 +55,7 @@ function InitializeLinks() end
--- Load
-- @realm shared
--- @tparam XElement element
+-- @tparam ContentXElement element
-- @tparam Submarine submarine
-- @tparam IdRemap idRemap
-- @treturn WayPoint
@@ -75,6 +75,11 @@ function ShallowRemove() end
-- @realm shared
function Remove() end
+--- AddLinked
+-- @realm shared
+-- @tparam MapEntity entity
+function AddLinked(entity) end
+
--- ResolveLinks
-- @realm shared
-- @tparam IdRemap childRemap
@@ -93,13 +98,13 @@ function IsMouseOn(position) end
--- HasUpgrade
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @treturn bool
function HasUpgrade(identifier) end
--- GetUpgrade
-- @realm shared
--- @tparam string identifier
+-- @tparam Identifier identifier
-- @treturn Upgrade
function GetUpgrade(identifier) end
@@ -276,9 +281,9 @@ function GetHashCode() end
-- @bool Linkable
---
--- AllowedLinks, Field of type table
+-- AllowedLinks, Field of type Enumerable
-- @realm shared
--- @table AllowedLinks
+-- @Enumerable AllowedLinks
---
-- ResizeHorizontal, Field of type bool
@@ -395,6 +400,11 @@ function GetHashCode() end
-- @realm shared
-- @number SpawnTime
+---
+-- ErrorLine, Field of type string
+-- @realm shared
+-- @string ErrorLine
+
---
-- Ladders, Field of type Ladder
-- @realm shared
@@ -441,9 +451,9 @@ function GetHashCode() end
-- @number WayPoint.LadderWaypointInterval
---
--- prefab, Field of type MapEntityPrefab
+-- Prefab, Field of type MapEntityPrefab
-- @realm shared
--- @MapEntityPrefab prefab
+-- @MapEntityPrefab Prefab
---
-- unresolvedLinkedToID, Field of type table
@@ -451,9 +461,9 @@ function GetHashCode() end
-- @table unresolvedLinkedToID
---
--- disallowedUpgrades, Field of type HashSet`1
+-- DisallowedUpgradeSet, Field of type HashSet`1
-- @realm shared
--- @HashSet`1 disallowedUpgrades
+-- @HashSet`1 DisallowedUpgradeSet
---
-- linkedTo, Field of type table
@@ -485,3 +495,13 @@ function GetHashCode() end
-- @realm shared
-- @number ID
+---
+-- CreationStackTrace, Field of type string
+-- @realm shared
+-- @string CreationStackTrace
+
+---
+-- CreationIndex, Field of type number
+-- @realm shared
+-- @number CreationIndex
+
diff --git a/docs/manual/common-questions.md b/docs/manual/common-questions.md
index 307a2cda5..46a937be7 100644
--- a/docs/manual/common-questions.md
+++ b/docs/manual/common-questions.md
@@ -67,12 +67,12 @@ local prefab = ItemPrefab.GetItemPrefab("screwdriver")
local firstPlayerCharacter = Client.ClientList[1].Character
-- Spawn on the world
-Entity.Spawner.AddToSpawnQueue(prefab, firstPlayerCharacter.WorldPosition, nil, nil, function(item)
+Entity.Spawner.AddItemToSpawnQueue(prefab, firstPlayerCharacter.WorldPosition, nil, nil, function(item)
print(item.Name .. " Has been spawned.")
end)
-- Spawn inside an inventory
-Entity.Spawner.AddToSpawnQueue(prefab, firstPlayerCharacter.Inventory, nil, nil, function(item)
+Entity.Spawner.AddItemToSpawnQueue(prefab, firstPlayerCharacter.Inventory, nil, nil, function(item)
print(item.Name .. " Has been spawned.")
end)
```
@@ -104,5 +104,6 @@ print(char.CharacterHealth.GetAffliction("burn", char.AnimController.Limbs[1]))
```
local chatMessage = ChatMessage.Create("Sender name", "text here", ChatMessageType.MessageBox, nil, nil)
+chatMessage.Color = Color(255, 255, 0, 255)
Game.SendDirectChatMessage(chatMessage, ChatMessageType.MessageBox)
```
\ No newline at end of file
diff --git a/docs/manual/getting-started.md b/docs/manual/getting-started.md
index 9eafd0124..89c2cd25b 100644
--- a/docs/manual/getting-started.md
+++ b/docs/manual/getting-started.md
@@ -10,6 +10,19 @@ When creating a new Lua mod, you will need to create a new folder on the **Mods*
Now you can open **test.lua** in your favorite text editor (VSCode with the Lua Sumneko extension recommended) and type in **print("Hello, world")**, now start the server by hosting a game or running the server executable manually, you will see in your console a text appear with the text that you entered in print, you can now type in the server console `reloadlua`, this will re-execute all the Lua scripts. You can also type in `lua yourscript` to run a short lua snippet, like this `lua print('Hello, world')`, remember to remove double quotes, because Barotrauma console automatically formats those.
+## Including other files
+
+If you wish to separate your Lua scripts into multiple files, you can do it by either having multiple scripts in the Autorun folder, or having a single script that is responsible for executing the rest of your Lua scripts, for that you will need to get relative paths to your mod, here's an example of how to do it:
+
+```lua
+-- this variable will be accessible to any other script, so you can use it to get the mod's path.
+MyModGlobal = {}
+
+MyModGlobal.Path = table.pack(...)[1]
+
+dofile(MyModGlobal.Path .. "/Lua/yourscript.lua")
+```
+
## Learning the libraries
In the sidebar of the documentation, you can see a tab named Code, in there you can check out all the functions and fields that each class has, each one of them has a box with a color on it, where means Server-Side, means Client-Side and means both Server-Side and Client-Side, by clicking on them you can learn more about them. Not everything is documented here, theres stuff missing that still needs to be added, if you want to find more in-depth functions and fields in the Barotrauma classes, you should check the Barotrauma source code.
diff --git a/docs/manual/installing-lua-for-barotrauma-manually.md b/docs/manual/installing-lua-for-barotrauma-manually.md
index 0d29ef51c..6ecf87b8c 100644
--- a/docs/manual/installing-lua-for-barotrauma-manually.md
+++ b/docs/manual/installing-lua-for-barotrauma-manually.md
@@ -1,21 +1,30 @@
# Installing Lua For Barotrauma Manually
+### Notice: Using the LuaForBarotrauma package is not required if it's installed manually, but you may use it anyway if you wish to support the mod, since players automatically download packages when joining the server.
+
## Adding Lua For Barotrauma to an existing server
1 - Download [latest version of LuaForBarotrauma](https://github.com/evilfactory/Barotrauma-lua-attempt/releases/tag/latest), choose the correct platform in the assets drop down.
2 - Extract the zip file
3 - Copy the following files inside the extracted zip:
-- **DedicatedServer.deps.json**
-- **DedicatedServer.dll**
-- **DedicatedServer.pdb**
-- **0Harmony.dll**
-- **MoonSharp.Interpreter.dll**
+- **DedicatedServer.deps.json**
+- **DedicatedServer.dll**
+- **DedicatedServer.pdb**
+- **0Harmony.dll**
+- **MoonSharp.Interpreter.dll**
- **MonoMod.Common.dll**
- **Mono.Cecil.dll**
- **Mono.Cecil.Mdb.dll**
- **Mono.Cecil.Pdb.dll**
- **Mono.Cecil.Rocks.dll**
-- file that starts with **mscordaccore_amd64_amd64_**
+- **Microsoft.CodeAnalysis.CSharp.Scripting.dll**
+- **Microsoft.CodeAnalysis.CSharp.dll**
+- **Microsoft.CodeAnalysis.dll**
+- **Microsoft.CodeAnalysis.Scripting.dll**
+- **System.Collections.Immutable.dll**
+- **System.Reflection.Metadata.dll**
+- **System.Runtime.CompilerServices.Unsafe.dll**
+- file that starts with **mscordaccoreamd64amd64_**
- and the **Lua/** folder
4 - Paste them to your existing server, and let it replace the files
@@ -24,16 +33,24 @@
Same as above, but instead you need to copy/replace the following files:
-- **Barotrauma.deps.json**
-- **Barotrauma.dll**
-- **0Harmony.dll**
-- **MoonSharp.Interpreter.dll**
+- **Barotrauma.deps.json**
+- **Barotrauma.dll**
+- **Barotrauma.pdb**
+- **0Harmony.dll**
+- **MoonSharp.Interpreter.dll**
- **MonoMod.Common.dll**
- **Mono.Cecil.dll**
- **Mono.Cecil.Mdb.dll**
- **Mono.Cecil.Pdb.dll**
- **Mono.Cecil.Rocks.dll**
-- file that starts with **mscordaccore_amd64_amd64_**
+- **Microsoft.CodeAnalysis.CSharp.Scripting.dll**
+- **Microsoft.CodeAnalysis.CSharp.dll**
+- **Microsoft.CodeAnalysis.dll**
+- **Microsoft.CodeAnalysis.Scripting.dll**
+- **System.Collections.Immutable.dll**
+- **System.Reflection.Metadata.dll**
+- **System.Runtime.CompilerServices.Unsafe.dll**
+- file that starts with **mscordaccoreamd64amd64_**
- and the **Lua/** folder
@@ -53,7 +70,7 @@ Same as above, but instead you need to copy/replace the following files:
-6 - Optional: Copy config_player.xml
+6 - Optional: Copy config_player.xml from your original game so it retains your configurations.
7 - Done! Now run DedicatedServer.exe to run the modded server or run Barotrauma.exe to run the modded client.
@@ -64,4 +81,4 @@ Sometimes you will get steam initialization errors, most of the time it's becaus
## Checking if everything is working
-If the commands `reloadlua` or `cl_reloadlua` work, it means you successfully installed the mod.
\ No newline at end of file
+If the commands `reloadlua` or `cl_reloadlua` work without errors, it means you successfully installed the mod.
\ No newline at end of file