chore(callbacks): update annotations

This commit is contained in:
Linden
2021-11-11 07:56:15 +11:00
parent ab4807fee0
commit 9a60f3bd1d
3 changed files with 10 additions and 6 deletions

View File

@@ -12,9 +12,9 @@ end
local ServerCallback = table.create(0, 2) local ServerCallback = table.create(0, 2)
--- Sends an event to the server and halts the current thread until a response is returned.
---@param event string ---@param event string
---@param delay number ---@param delay number
--- Sends an event to the server and halts the current thread until a response is returned.
ServerCallback.Await = function(resource, event, delay, ...) ServerCallback.Await = function(resource, event, delay, ...)
CallbackTimer(event, delay) CallbackTimer(event, delay)
event = ('__cb_%s:%s'):format(resource, event) event = ('__cb_%s:%s'):format(resource, event)
@@ -27,9 +27,9 @@ ServerCallback.Await = function(resource, event, delay, ...)
return table.unpack(Citizen.Await(promise)) return table.unpack(Citizen.Await(promise))
end end
--- Sends an event to the server and triggers a callback function once the response is returned.
---@param event string ---@param event string
---@param delay number ---@param delay number
--- Sends an event to the server and triggers a callback function once the response is returned.
ServerCallback.Async = function(resource, event, delay, cb, ...) ServerCallback.Async = function(resource, event, delay, cb, ...)
CallbackTimer(event, delay) CallbackTimer(event, delay)
event = ('__cb_%s:%s'):format(resource, event) event = ('__cb_%s:%s'):format(resource, event)

View File

@@ -1,5 +1,9 @@
local ServerCallback = { local ServerCallback = {}
Register = function(name, callback)
---@param name string
---@param callback function
--- Registers an event handler and callback function to respond to client requests.
ServerCallback.Register = function(name, callback)
name = ('__cb_%s:%s'):format(GetCurrentResourceName(), name) name = ('__cb_%s:%s'):format(GetCurrentResourceName(), name)
RegisterServerEvent(name, function(...) RegisterServerEvent(name, function(...)

View File

@@ -6,7 +6,7 @@ local LIBRARY = 'pe-lualib'
local SERVICE = IsDuplicityVersion() and 'server' or 'client' local SERVICE = IsDuplicityVersion() and 'server' or 'client'
local IMPORTS = {} local IMPORTS = {}
local function loadFile(file) local function LoadFile(file)
local dir = ('imports/%s'):format(file) local dir = ('imports/%s'):format(file)
local chunk = LoadResourceFile(LIBRARY, ('%s/%s.lua'):format(dir, SERVICE)) local chunk = LoadResourceFile(LIBRARY, ('%s/%s.lua'):format(dir, SERVICE))
local shared = LoadResourceFile(LIBRARY, ('%s/shared.lua'):format(dir)) local shared = LoadResourceFile(LIBRARY, ('%s/shared.lua'):format(dir))
@@ -29,7 +29,7 @@ end
---@param file string ---@param file string
---@return table ---@return table
function import(file) function import(file)
if not IMPORTS[file] then loadFile(file) end if not IMPORTS[file] then LoadFile(file) end
return IMPORTS[file] return IMPORTS[file]
end end