update docs

This commit is contained in:
Evil Factory
2021-12-29 21:20:50 -03:00
parent 370ee8f1b3
commit d8d5bcb5fa
14 changed files with 365 additions and 103 deletions

View File

@@ -59,11 +59,12 @@ tparam_alias("Vector2", "Vector2")
tparam_alias("Vector3", "Vector3")
tparam_alias("Vector4", "Vector4")
tparam_alias("CauseOfDeath", "CauseOfDeath")
tparam_alias("CharacterInventory", "CharacterInventory")
tparam_alias("PhysicsBody", "PhysicsBody")
tparam_alias("JobPrefab", "JobPrefab")
tparam_alias("Job", "Job")
tparam_alias("Inventory", "Inventory")
tparam_alias("CharacterInventory", "CharacterInventory")
tparam_alias("ItemInventory", "ItemInventory")
tparam_alias("Camera", "Camera")
tparam_alias("Enumerable", "Enumerable")

View File

@@ -0,0 +1,109 @@
--[[--
DisconnectReason enum.
]]
-- @enum DisconnectReason
---
-- DisconnectReason.Unknown = 0
-- @realm shared
-- @number DisconnectReason.Unknown
---
-- DisconnectReason.Banned = 1
-- @realm shared
-- @number DisconnectReason.Banned
---
-- DisconnectReason.Kicked = 2
-- @realm shared
-- @number DisconnectReason.Kicked
---
-- DisconnectReason.ServerShutdown = 3
-- @realm shared
-- @number DisconnectReason.ServerShutdown
---
-- DisconnectReason.ServerCrashed = 4
-- @realm shared
-- @number DisconnectReason.ServerCrashed
---
-- DisconnectReason.ServerFull = 5
-- @realm shared
-- @number DisconnectReason.ServerFull
---
-- DisconnectReason.AuthenticationRequired = 6
-- @realm shared
-- @number DisconnectReason.AuthenticationRequired
---
-- DisconnectReason.SteamAuthenticationRequired = 7
-- @realm shared
-- @number DisconnectReason.SteamAuthenticationRequired
---
-- DisconnectReason.SteamAuthenticationFailed = 8
-- @realm shared
-- @number DisconnectReason.SteamAuthenticationFailed
---
-- DisconnectReason.SessionTaken = 9
-- @realm shared
-- @number DisconnectReason.SessionTaken
---
-- DisconnectReason.TooManyFailedLogins = 10
-- @realm shared
-- @number DisconnectReason.TooManyFailedLogins
---
-- DisconnectReason.NoName = 11
-- @realm shared
-- @number DisconnectReason.NoName
---
-- DisconnectReason.InvalidName = 12
-- @realm shared
-- @number DisconnectReason.InvalidName
---
-- DisconnectReason.NameTaken = 13
-- @realm shared
-- @number DisconnectReason.NameTaken
---
-- DisconnectReason.InvalidVersion = 14
-- @realm shared
-- @number DisconnectReason.InvalidVersion
---
-- DisconnectReason.MissingContentPackage = 15
-- @realm shared
-- @number DisconnectReason.MissingContentPackage
---
-- DisconnectReason.IncompatibleContentPackage = 16
-- @realm shared
-- @number DisconnectReason.IncompatibleContentPackage
---
-- DisconnectReason.NotOnWhitelist = 17
-- @realm shared
-- @number DisconnectReason.NotOnWhitelist
---
-- DisconnectReason.ExcessiveDesyncOldEvent = 18
-- @realm shared
-- @number DisconnectReason.ExcessiveDesyncOldEvent
---
-- DisconnectReason.ExcessiveDesyncRemovedEvent = 19
-- @realm shared
-- @number DisconnectReason.ExcessiveDesyncRemovedEvent
---
-- DisconnectReason.SyncTimeout = 20
-- @realm shared
-- @number DisconnectReason.SyncTimeout

View File

@@ -0,0 +1,109 @@
--[[--
NetEntityEvent.Type enum.
]]
-- @enum NetEntityEvent.Type
---
-- NetEntityEvent.Type.Invalid = 0
-- @realm shared
-- @number NetEntityEvent.Type.Invalid
---
-- NetEntityEvent.Type.ComponentState = 1
-- @realm shared
-- @number NetEntityEvent.Type.ComponentState
---
-- NetEntityEvent.Type.InventoryState = 2
-- @realm shared
-- @number NetEntityEvent.Type.InventoryState
---
-- NetEntityEvent.Type.Status = 3
-- @realm shared
-- @number NetEntityEvent.Type.Status
---
-- NetEntityEvent.Type.Treatment = 4
-- @realm shared
-- @number NetEntityEvent.Type.Treatment
---
-- NetEntityEvent.Type.ApplyStatusEffect = 5
-- @realm shared
-- @number NetEntityEvent.Type.ApplyStatusEffect
---
-- NetEntityEvent.Type.ChangeProperty = 6
-- @realm shared
-- @number NetEntityEvent.Type.ChangeProperty
---
-- NetEntityEvent.Type.Control = 7
-- @realm shared
-- @number NetEntityEvent.Type.Control
---
-- NetEntityEvent.Type.UpdateSkills = 8
-- @realm shared
-- @number NetEntityEvent.Type.UpdateSkills
---
-- NetEntityEvent.Type.Combine = 9
-- @realm shared
-- @number NetEntityEvent.Type.Combine
---
-- NetEntityEvent.Type.SetAttackTarget = 10
-- @realm shared
-- @number NetEntityEvent.Type.SetAttackTarget
---
-- NetEntityEvent.Type.ExecuteAttack = 11
-- @realm shared
-- @number NetEntityEvent.Type.ExecuteAttack
---
-- NetEntityEvent.Type.Upgrade = 12
-- @realm shared
-- @number NetEntityEvent.Type.Upgrade
---
-- NetEntityEvent.Type.AssignCampaignInteraction = 13
-- @realm shared
-- @number NetEntityEvent.Type.AssignCampaignInteraction
---
-- NetEntityEvent.Type.TeamChange = 14
-- @realm shared
-- @number NetEntityEvent.Type.TeamChange
---
-- NetEntityEvent.Type.ObjectiveManagerState = 15
-- @realm shared
-- @number NetEntityEvent.Type.ObjectiveManagerState
---
-- NetEntityEvent.Type.AddToCrew = 16
-- @realm shared
-- @number NetEntityEvent.Type.AddToCrew
---
-- NetEntityEvent.Type.UpdateExperience = 17
-- @realm shared
-- @number NetEntityEvent.Type.UpdateExperience
---
-- NetEntityEvent.Type.UpdateTalents = 18
-- @realm shared
-- @number NetEntityEvent.Type.UpdateTalents
---
-- NetEntityEvent.Type.UpdateMoney = 19
-- @realm shared
-- @number NetEntityEvent.Type.UpdateMoney
---
-- NetEntityEvent.Type.UpdatePermanentStats = 20
-- @realm shared
-- @number NetEntityEvent.Type.UpdatePermanentStats

View File

@@ -39,6 +39,13 @@ function GetActiveEffect() end
-- @treturn number
function GetVitalityDecrease(characterHealth) end
--- GetVitalityDecrease
-- @realm shared
-- @tparam CharacterHealth characterHealth
-- @tparam number strength
-- @treturn number
function GetVitalityDecrease(characterHealth, strength) end
--- GetScreenGrainStrength
-- @realm shared
-- @treturn number

View File

@@ -44,6 +44,18 @@ function TeleportTo(worldPos) end
-- @table Character.CharacterList
--- BreakJoints
-- @realm shared
function BreakJoints() end
--- Kill
-- @realm shared
-- @tparam CauseOfDeathType causeOfDeath
-- @tparam Affliction causeOfDeathAffliction
-- @tparam bool isNetworkMessage
-- @tparam bool log
function Kill(causeOfDeath, causeOfDeathAffliction, isNetworkMessage, log) end
--- Revive
-- @realm shared
-- @tparam bool removeAllAfflictions
@@ -335,8 +347,9 @@ function HasItem(item, requireEquipped, slotType) end
-- @realm shared
-- @tparam Item item
-- @tparam Nullable`1 slotType
-- @tparam function predicate
-- @treturn bool
function HasEquippedItem(item, slotType) end
function HasEquippedItem(item, slotType, predicate) end
--- HasEquippedItem
-- @realm shared
@@ -453,6 +466,12 @@ function AddAttacker(character, damage) end
-- @tparam Character character
function ForgiveAttacker(character) end
--- GetDamageDoneByAttacker
-- @realm shared
-- @tparam Character otherCharacter
-- @treturn number
function GetDamageDoneByAttacker(otherCharacter) end
--- DespawnNow
-- @realm shared
-- @tparam bool createNetworkEvents
@@ -626,18 +645,6 @@ function SetStun(newStun, allowStunDecrease, isNetworkMessage) end
-- @tparam number deltaTime
function ApplyStatusEffects(actionType, deltaTime) end
--- BreakJoints
-- @realm shared
function BreakJoints() end
--- Kill
-- @realm shared
-- @tparam CauseOfDeathType causeOfDeath
-- @tparam Affliction causeOfDeathAffliction
-- @tparam bool isNetworkMessage
-- @tparam bool log
function Kill(causeOfDeath, causeOfDeathAffliction, isNetworkMessage, log) end
--- Create
-- @realm shared
-- @tparam string speciesName
@@ -1110,6 +1117,11 @@ function GetHashCode() end
-- @realm shared
-- @bool IsUnconscious
---
-- IsArrested, Field of type bool
-- @realm shared
-- @bool IsArrested
---
-- IsPet, Field of type bool
-- @realm shared
@@ -1125,6 +1137,11 @@ function GetHashCode() end
-- @realm shared
-- @number OxygenAvailable
---
-- HullOxygenPercentage, Field of type number
-- @realm shared
-- @number HullOxygenPercentage
---
-- UseHullOxygen, Field of type bool
-- @realm shared
@@ -1480,6 +1497,11 @@ function GetHashCode() end
-- @realm shared
-- @HashSet`1 Latchers
---
-- AttachedProjectiles, Field of type HashSet`1
-- @realm shared
-- @HashSet`1 AttachedProjectiles
---
-- CombatAction, Field of type CombatAction
-- @realm shared

View File

@@ -10,6 +10,17 @@ Barotrauma source code: [CharacterInfo.cs](https://github.com/evilfactory/Barotr
local CharacterInfo = {}
--- 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
@@ -43,8 +54,8 @@ function CharacterInfo.IsValidIndex(index, list) end
-- @realm shared
-- @tparam string skillIdentifier
-- @tparam number increase
-- @tparam bool gainedFromApprenticeship
function IncreaseSkillLevel(skillIdentifier, increase, gainedFromApprenticeship) end
-- @tparam bool gainedFromAbility
function IncreaseSkillLevel(skillIdentifier, increase, gainedFromAbility) end
--- SetSkillLevel
-- @realm shared
@@ -163,6 +174,10 @@ function ClearSavedStatValues() end
-- @tparam StatTypes statType
function ClearSavedStatValues(statType) end
--- RemoveSavedStatValuesOnDeath
-- @realm shared
function RemoveSavedStatValuesOnDeath() end
--- ResetSavedStatValue
-- @realm shared
-- @tparam string statIdentifier
@@ -187,10 +202,9 @@ function GetSavedStatValue(statType, statIdentifier) end
-- @tparam number value
-- @tparam string statIdentifier
-- @tparam bool removeOnDeath
-- @tparam bool removeAfterRound
-- @tparam number maxValue
-- @tparam bool setValue
function ChangeSavedStatValue(statType, value, statIdentifier, removeOnDeath, removeAfterRound, maxValue, setValue) end
function ChangeSavedStatValue(statType, value, statIdentifier, removeOnDeath, maxValue, setValue) end
--- Create
-- @realm shared
@@ -225,6 +239,12 @@ function GetEndocrineTalents() end
-- @tparam IdCard idCard
function CheckDisguiseStatus(handleBuff, idCard) end
--- GetManualOrderPriority
-- @realm shared
-- @tparam Order order
-- @treturn number
function GetManualOrderPriority(order) end
--- GetRandomName
-- @realm shared
-- @tparam RandSync randSync
@@ -300,17 +320,6 @@ function CharacterInfo.IsMatchingRace(race, myRace) end
-- @tparam HeadInfo headInfo
function RecreateHead(headInfo) end
--- RecreateHead
-- @realm shared
-- @tparam number headID
-- @tparam Race race
-- @tparam Gender gender
-- @tparam number hairIndex
-- @tparam number beardIndex
-- @tparam number moustacheIndex
-- @tparam number faceAttachmentIndex
function RecreateHead(headID, race, gender, hairIndex, beardIndex, moustacheIndex, faceAttachmentIndex) end
--- GetType
-- @realm shared
-- @treturn Type

View File

@@ -237,6 +237,16 @@ function GetHashCode() end
-- @realm shared
-- @number LastRecvClientListUpdate
---
-- LastSentServerSettingsUpdate, Field of type number
-- @realm shared
-- @number LastSentServerSettingsUpdate
---
-- LastRecvServerSettingsUpdate, Field of type number
-- @realm shared
-- @number LastRecvServerSettingsUpdate
---
-- LastRecvLobbyUpdate, Field of type number
-- @realm shared

View File

@@ -10,14 +10,14 @@ Barotrauma source code: [Entity.cs](https://github.com/evilfactory/Barotrauma-lu
--- GetEntities
-- @realm shared
-- @treturn Enumerable
-- @treturn IReadOnlyCollection`1
function Entity.GetEntities() end
--- FindFreeID
--- FindFreeIdBlock
-- @realm shared
-- @tparam number idOffset
-- @tparam number minBlockSize
-- @treturn number
function Entity.FindFreeID(idOffset) end
function Entity.FindFreeIdBlock(minBlockSize) end
--- FindEntityByID
-- @realm shared
@@ -154,3 +154,8 @@ function GetHashCode() end
-- @realm shared
-- @number Entity.ReservedIDStart
---
-- Entity.MaxEntityCount, Field of type number
-- @realm shared
-- @number Entity.MaxEntityCount

View File

@@ -38,7 +38,8 @@ function IsCurrentLocationRadiated() end
-- @realm shared
-- @tparam string levelSeed
-- @tparam Nullable`1 difficulty
function StartRound(levelSeed, difficulty) end
-- @tparam LevelGenerationParams levelGenerationParams
function StartRound(levelSeed, difficulty, levelGenerationParams) end
--- StartRound
-- @realm shared

View File

@@ -46,6 +46,22 @@ function SendSignal(signalOrString, connectionOrConnectionName) end
-- @Vector2 WorldPosition
--- FlipX
-- @realm shared
-- @tparam bool relativeToSub
function FlipX(relativeToSub) end
--- FlipY
-- @realm shared
-- @tparam bool relativeToSub
function FlipY(relativeToSub) end
--- GetConnectedComponents
-- @realm shared
-- @tparam bool recursive
-- @treturn table
function GetConnectedComponents(recursive) end
--- GetConnectedComponentsRecursive
-- @realm shared
-- @tparam Connection c
@@ -104,12 +120,12 @@ function CanClientAccess(c) end
--- TryInteract
-- @realm shared
-- @tparam Character picker
-- @tparam Character user
-- @tparam bool ignoreRequiredItems
-- @tparam bool forceSelectKey
-- @tparam bool forceActionKey
-- @tparam bool forceUseKey
-- @treturn bool
function TryInteract(picker, ignoreRequiredItems, forceSelectKey, forceActionKey) end
function TryInteract(user, ignoreRequiredItems, forceSelectKey, forceUseKey) end
--- GetContainedItemConditionPercentage
-- @realm shared
@@ -235,8 +251,9 @@ function IgnoreByAI(character) end
-- @tparam ItemContainer container
-- @tparam Boolean& isPreferencesDefined
-- @tparam Boolean& isSecondary
-- @tparam bool requireConditionRestriction
-- @treturn bool
function IsContainerPreferred(container, isPreferencesDefined, isSecondary) end
function IsContainerPreferred(container, isPreferencesDefined, isSecondary, requireConditionRestriction) end
--- Clone
-- @realm shared
@@ -438,22 +455,6 @@ function Update(deltaTime, cam) end
-- @realm shared
function UpdateTransform() end
--- FlipX
-- @realm shared
-- @tparam bool relativeToSub
function FlipX(relativeToSub) end
--- FlipY
-- @realm shared
-- @tparam bool relativeToSub
function FlipY(relativeToSub) end
--- GetConnectedComponents
-- @realm shared
-- @tparam bool recursive
-- @treturn table
function GetConnectedComponents(recursive) end
--- ServerWrite
-- @realm shared
-- @tparam IWriteMessage msg
@@ -608,6 +609,11 @@ function GetHashCode() end
-- @realm shared
-- @Hull CurrentHull
---
-- HullOxygenPercentage, Field of type number
-- @realm shared
-- @number HullOxygenPercentage
---
-- CampaignInteractionType, Field of type InteractionType
-- @realm shared
@@ -808,6 +814,11 @@ function GetHashCode() end
-- @realm shared
-- @number Condition
---
-- ConditionIncreasedRecently, Field of type bool
-- @realm shared
-- @bool ConditionIncreasedRecently
---
-- Health, Field of type number
-- @realm shared
@@ -829,9 +840,14 @@ function GetHashCode() end
-- @bool InvulnerableToDamage
---
-- SpawnedInOutpost, Field of type bool
-- SpawnedInCurrentOutpost, Field of type bool
-- @realm shared
-- @bool SpawnedInOutpost
-- @bool SpawnedInCurrentOutpost
---
-- AllowStealing, Field of type bool
-- @realm shared
-- @bool AllowStealing
---
-- OriginalOutpost, Field of type string
@@ -1108,11 +1124,6 @@ function GetHashCode() end
-- @realm shared
-- @bool StolenDuringRound
---
-- AllowStealing, Field of type bool
-- @realm shared
-- @bool AllowStealing
---
-- AvailableSwaps, Field of type HashSet`1
-- @realm shared

View File

@@ -111,8 +111,9 @@ function GetSellPricesOver(minCost, sellingImportant) end
-- @tparam ItemContainer targetContainer
-- @tparam Boolean& isPreferencesDefined
-- @tparam Boolean& isSecondary
-- @tparam bool requireConditionRequirement
-- @treturn bool
function IsContainerPreferred(item, targetContainer, isPreferencesDefined, isSecondary) end
function IsContainerPreferred(item, targetContainer, isPreferencesDefined, isSecondary, requireConditionRequirement) end
--- IsContainerPreferred
-- @realm shared
@@ -402,6 +403,11 @@ function GetHashCode() end
-- @realm shared
-- @number AddedRepairSpeedMultiplier
---
-- AddedPickingSpeedMultiplier, Field of type number
-- @realm shared
-- @number AddedPickingSpeedMultiplier
---
-- CannotRepairFail, Field of type bool
-- @realm shared

View File

@@ -7,16 +7,6 @@ Barotrauma.NetLobbyScreen
-- @pragma nostrip
local NetLobbyScreen = {}
--- AddCampaignSubmarine
-- @realm shared
-- @tparam SubmarineInfo sub
function AddCampaignSubmarine(sub) end
--- RemoveCampaignSubmarine
-- @realm shared
-- @tparam SubmarineInfo sub
function RemoveCampaignSubmarine(sub) end
--- ChangeServerName
-- @realm shared
-- @tparam string n
@@ -29,7 +19,7 @@ function ChangeServerMessage(m) end
--- GetSubList
-- @realm shared
-- @treturn table
-- @treturn IReadOnlyList`1
function GetSubList() end
--- AddSub
@@ -55,26 +45,6 @@ function RandomizeSettings() end
-- @tparam number difficulty
function SetLevelDifficulty(difficulty) end
--- SetRadiationEnabled
-- @realm shared
-- @tparam bool enabled
function SetRadiationEnabled(enabled) end
--- IsRadiationEnabled
-- @realm shared
-- @treturn bool
function IsRadiationEnabled() end
--- SetMaxMissionCount
-- @realm shared
-- @tparam number maxMissionCount
function SetMaxMissionCount(maxMissionCount) end
--- GetMaxMissionCount
-- @realm shared
-- @treturn number
function GetMaxMissionCount() end
--- ToggleTraitorsEnabled
-- @realm shared
-- @tparam number dir

View File

@@ -242,10 +242,6 @@ function EnableMaintainPosition() end
-- @realm shared
function NeutralizeBallast() end
--- WarmStartPower
-- @realm shared
function WarmStartPower() end
--- SetPrevTransform
-- @realm shared
-- @tparam Vector2 position
@@ -444,6 +440,11 @@ function GetHashCode() end
-- @realm shared
-- @Rectangle Borders
---
-- VisibleBorders, Field of type Rectangle
-- @realm shared
-- @Rectangle VisibleBorders
---
-- Position, Field of type Vector2
-- @realm shared
@@ -504,11 +505,6 @@ function GetHashCode() end
-- @realm shared
-- @bool AtDamageDepth
---
-- Removed, Field of type bool
-- @realm shared
-- @bool Removed
---
-- ImmuneToBallastFlora, Field of type bool
-- @realm shared
@@ -529,6 +525,11 @@ function GetHashCode() end
-- @realm shared
-- @bool Submarine.Unloading
---
-- Removed, Field of type bool
-- @realm shared
-- @bool Removed
---
-- IdFreed, Field of type bool
-- @realm shared

View File

@@ -30,8 +30,9 @@ function ConnectTo(wayPoint2) end
-- @tparam Submarine sub
-- @tparam bool useSyncedRand
-- @tparam string spawnPointTag
-- @tparam bool ignoreSubmarine
-- @treturn WayPoint
function WayPoint.GetRandom(spawnType, assignedJob, sub, useSyncedRand, spawnPointTag) end
function WayPoint.GetRandom(spawnType, assignedJob, sub, useSyncedRand, spawnPointTag, ignoreSubmarine) end
--- SelectCrewSpawnPoints
-- @realm shared