Fix parameter mismatch errors in lua docs

This commit is contained in:
peelz
2022-08-03 21:34:42 -04:00
parent b393a4e00f
commit 545c38c26c
3 changed files with 9 additions and 9 deletions

View File

@@ -33,7 +33,7 @@ function Character.Create(characterInfo, position, seed, id, isRemotePlayer, has
--- Teleports a character to a position.
-- @realm server
-- @tparam Vector2 position
-- @tparam Vector2 worldPos
-- @usage
-- Character.CharacterList[1].TeleportTo(Vector2(0, 0)) -- teleports first created characters to 0, 0
function TeleportTo(worldPos) end

View File

@@ -10,8 +10,8 @@ local Hook = {}
--- Adds a hook.
-- @tparam string eventname event name
-- @tparam string hookname hook name
-- @tparam string eventName event name
-- @tparam string hookName hook name
-- @tparam function func callback
-- @realm shared
-- @usage
@@ -21,15 +21,15 @@ local Hook = {}
function Hook.Add(eventName, hookName, func) end
--- Removes a hook.
-- @tparam string eventname event name
-- @tparam string hookname hook name
-- @tparam string eventName event name
-- @tparam string hookName hook name
-- @realm shared
-- @usage
-- Hook.Remove("character.death", "characterDeathExample")
function Hook.Remove(eventName, hookName) end
--- Calls a hook.
-- @tparam string eventname event name
-- @tparam string eventName event name
-- @tparam table parameters parameters to be passed in
-- @realm shared
-- @usage

View File

@@ -10,7 +10,7 @@ local Steam = {}
--- Downloads an item from workshop and places it in a folder.
-- @tparam string itemID
-- @tparam string id
-- @tparam string destinationFolder
-- @tparam function callback
-- @realm shared
@@ -23,13 +23,13 @@ local Steam = {}
function Steam.DownloadWorkshopItem(id, destinationFolder, callback) end
--- Gets information about a workshop item.
-- @tparam string itemID
-- @tparam string id
-- @tparam function callback
-- @realm shared
function Steam.GetWorkshopItem(id, callback) end
--- Callback is called with the list of all workshop items inside the specified collection.
-- @tparam string itemID
-- @tparam string id
-- @tparam function callback
-- @realm shared
function Steam.GetWorkshopCollection(id, callback) end