added -- @remove, for removing duplicates from docs

This commit is contained in:
Evil Factory
2021-11-24 22:36:33 -03:00
parent 3127bfa037
commit 83a40bad6f
3 changed files with 91 additions and 55 deletions

View File

@@ -10,14 +10,26 @@ Barotrauma source code: [Character.cs](https://github.com/evilfactory/Barotrauma
local Character = {}
-- @remove function Character.Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdoll) end
-- @remove function TeleportTo(worldPos) end
-- @remove function TeleportTo(worldPos) end
--- Creates a Character using CharacterInfo.
-- @realm server
-- @tparam CharacterInfo characterInfo
-- @tparam Vector2 position
-- @tparam string seed
-- @tparam number id
-- @tparam bool isRemotePlayer
-- @tparam bool hasAi
-- @tparam RagdollParams ragdoll
-- @treturn Character
-- @realm server
-- @usage
-- local vsauce = CharacterInfo("human", "VSAUCE HERE")
-- local vsauce = CharacterInfo("human", "custom name")
-- local character = Character.Create(vsauce, Vector2(0, 0), "some random characters")
-- print(character)
function Character.Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdollParams) end
function Character.Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdoll) end
--- Teleports a character to a position.
@@ -25,14 +37,12 @@ function Character.Create(characterInfo, position, seed, id, isRemotePlayer, has
-- @tparam Vector2 position
-- @usage
-- Character.CharacterList[1].TeleportTo(Vector2(0, 0)) -- teleports first created characters to 0, 0
function TeleportTo(position) end
function TeleportTo(worldPos) end
---
-- Character.CharacterList, Table containing all characters.
-- @realm shared
-- @Character Character.CharacterList
-- @table Character.CharacterList
--- Revive
@@ -44,11 +54,6 @@ function Revive(removeAllAfflictions) end
-- @realm shared
function Remove() end
--- TeleportTo
-- @realm shared
-- @tparam Vector2 worldPos
function TeleportTo(worldPos) end
--- SaveInventory
-- @realm shared
-- @tparam Inventory inventory
@@ -634,18 +639,6 @@ function BreakJoints() end
-- @tparam bool log
function Kill(causeOfDeath, causeOfDeathAffliction, isNetworkMessage, log) end
--- Create
-- @realm shared
-- @tparam CharacterInfo characterInfo
-- @tparam Vector2 position
-- @tparam string seed
-- @tparam number id
-- @tparam bool isRemotePlayer
-- @tparam bool hasAi
-- @tparam RagdollParams ragdoll
-- @treturn Character
function Character.Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdoll) end
--- Create
-- @realm shared
-- @tparam string speciesName