FumeNodes/ox_lib
1
0
Fork 0
mirror of https://github.com/CommunityOx/ox_lib.git synced 2026-08-17 06:56:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor(timer): adjust module return and types

Browse Source
This commit is contained in:
Linden
2024-04-20 06:55:56 +10:00
parent b6632ad789
commit 3959f76aae
1 changed files with 12 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
imports/timer/shared.lua
View File

@@ -8,8 +8,7 @@
---@field paused boolean the pause state of the timer ---@field paused boolean the pause state of the timer
---@class OxTimer : OxClass ---@class OxTimer : OxClass
---@field private TimerPrivateProps ---@field private private TimerPrivateProps
---@field constructor fun(self: self, time: number, onEnd: fun(), async: boolean)
---@field start fun(self: self, async?: boolean) starts the timer ---@field start fun(self: self, async?: boolean) starts the timer
---@field forceEnd fun(self: self, triggerOnEnd: boolean) end timer early and optionally trigger the onEnd function still ---@field forceEnd fun(self: self, triggerOnEnd: boolean) end timer early and optionally trigger the onEnd function still
---@field isPaused fun(self: self): boolean returns wether the timer is paused or not ---@field isPaused fun(self: self): boolean returns wether the timer is paused or not
@@ -18,6 +17,10 @@
---@field getTimeLeft fun(self: self, format?: 'ms' | 's' | 'm' | 'h'): number | table returns the time left on the timer with the specified format rounded to 2 decimal places (miliseconds, seconds, minutes, hours). returns a table of all if not specified. ---@field getTimeLeft fun(self: self, format?: 'ms' | 's' | 'm' | 'h'): number | table returns the time left on the timer with the specified format rounded to 2 decimal places (miliseconds, seconds, minutes, hours). returns a table of all if not specified.
local timer = lib.class('OxTimer') local timer = lib.class('OxTimer')
---@private
---@param time number
---@param onEnd fun(self: OxTimer)
---@param async? boolean
function timer:constructor(time, onEnd, async) function timer:constructor(time, onEnd, async)
assert(type(time) == "number" and time > 0, "Time must be a positive number") assert(type(time) == "number" and time > 0, "Time must be a positive number")
assert(onEnd == nil or type(onEnd) == "function", "onEnd must be a function or nil") assert(onEnd == nil or type(onEnd) == "function", "onEnd must be a function or nil")
@@ -140,16 +143,11 @@ function timer:getTimeLeft(format)
} }
end end
lib.timer = { ---@param time number
async = function(time, onEnd) ---@param onEnd fun(self: OxTimer)
return timer:new(time, onEnd, true) ---@param async? boolean
end function lib.timer(time, onEnd, async)
} return timer:new(time, onEnd, async)
end
setmetatable(lib.timer, { return lib.timer
__call = function(t, time, onEnd)
return timer:new(time, onEnd)
end
})
return lib.timer