diff --git a/docs/lua/Character.lua b/docs/lua/Character.lua index 97a086257..2d6c3f074 100644 --- a/docs/lua/Character.lua +++ b/docs/lua/Character.lua @@ -7,11 +7,15 @@ Barotrauma source code: [Character.cs](https://github.com/evilfactory/Barotrauma ]] -- @code Character - ---- Creates a CharacterInfo. --- @treturn CharacterInfo +--- Creates a Character using CharacterInfo. +-- @treturn Character -- @realm server -function Create(speciesName, name, jobPrefab, ragdollFileName, variant, randSync, npcIdentifier) end +-- @usage +-- local vsauce = CharacterInfo.Create("human", "VSAUCE HERE") +-- local character = Character.Create(vsauce, CreateVector2(0, 0), "some random characters") +-- print(character) +function Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdollParams) end + --- List of all characters. -- @treturn table diff --git a/docs/lua/CharacterInfo.lua b/docs/lua/CharacterInfo.lua index fcbd342a8..2ba06e6e6 100644 --- a/docs/lua/CharacterInfo.lua +++ b/docs/lua/CharacterInfo.lua @@ -7,7 +7,11 @@ Barotrauma source code: [CharacterInfo.cs](https://github.com/evilfactory/Barotr ]] -- @code CharacterInfo ---- Creates a Character using CharacterInfo. --- @treturn Character +--- Creates a CharacterInfo. +-- @treturn CharacterInfo -- @realm server -function Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdollParams) end \ No newline at end of file +-- @usage +-- local vsauce = CharacterInfo.Create("human", "VSAUCE HERE") +-- local character = Character.Create(vsauce, CreateVector2(0, 0), "some random characters") +-- print(character) +function Create(speciesName, name, jobPrefab, ragdollFileName, variant, randSync, npcIdentifier) end \ No newline at end of file