better documentation about Character Creation

This commit is contained in:
Evil Factory
2021-09-14 21:08:36 -03:00
parent 6e5de74f37
commit e25e77bcf6
2 changed files with 15 additions and 7 deletions

View File

@@ -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