From 65a799071a9c5929b87dba5631ee12108bf18d71 Mon Sep 17 00:00:00 2001 From: Jag <77469789+jag3dagster@users.noreply.github.com> Date: Fri, 21 Jul 2023 04:54:29 -0700 Subject: [PATCH] chore: various fix-ups from docs clean-up (#363) - Add in missing js functions - getCurrentRadialId - requestScaleformMove - Change up math.tohex to maintain lowercase `0x` prefix - Add missing fields - Removed extra whitespaces Co-authored-by: Luke <39926192+LukeWasTakenn@users.noreply.github.com> --- imports/getNearbyObjects/client.lua | 2 +- imports/math/shared.lua | 6 +++--- imports/table/shared.lua | 1 - package/client/resource/interface/radial.ts | 2 ++ package/client/resource/streaming/index.ts | 14 ++++++++------ resource/interface/client/context.lua | 2 ++ resource/interface/client/menu.lua | 5 ++++- resource/interface/client/notify.lua | 6 +++--- resource/vehicleProperties/client.lua | 2 +- 9 files changed, 24 insertions(+), 16 deletions(-) diff --git a/imports/getNearbyObjects/client.lua b/imports/getNearbyObjects/client.lua index d7ffc4e..7e6b0d4 100644 --- a/imports/getNearbyObjects/client.lua +++ b/imports/getNearbyObjects/client.lua @@ -21,7 +21,7 @@ function lib.getNearbyObjects(coords, maxDistance) } end end - + return nearby end diff --git a/imports/math/shared.lua b/imports/math/shared.lua index e4782f1..99cf23d 100644 --- a/imports/math/shared.lua +++ b/imports/math/shared.lua @@ -86,8 +86,8 @@ end ---@param upper? boolean ---@return string function math.tohex(n, upper) - n = ('0x%x'):format(n) - return upper and n:upper() or n + local formatString = ('0x%s'):format(upper and '%X' or '%x') + return formatString:format(n) end ---Converts input number into grouped digits @@ -99,4 +99,4 @@ function math.groupdigits(number, seperator) -- credit http://richard.warburton. return left..(num:reverse():gsub('(%d%d%d)','%1' .. (seperator or ',')):reverse())..right end -return lib.math \ No newline at end of file +return lib.math diff --git a/imports/table/shared.lua b/imports/table/shared.lua index 86598e3..2918f6d 100644 --- a/imports/table/shared.lua +++ b/imports/table/shared.lua @@ -136,5 +136,4 @@ function table.isfrozen(tbl) return getmetatable(tbl) == 'readonly' end - return lib.table diff --git a/package/client/resource/interface/radial.ts b/package/client/resource/interface/radial.ts index 9a66495..dbb6aec 100644 --- a/package/client/resource/interface/radial.ts +++ b/package/client/resource/interface/radial.ts @@ -15,6 +15,8 @@ export const removeRadialItem = (item: string) => exports.ox_lib.removeRadialIte export const registerRadial = (radial: { id: string; items: Omit[] }) => exports.ox_lib.registerRadial(radial); +export const getCurrentRadialId = () => exports.ox_lib.getCurrentRadialId(); + export const hideRadial = () => exports.ox_lib.hideRadial(); export const disableRadial = (state: boolean) => exports.ox_lib.disableRadial(state); diff --git a/package/client/resource/streaming/index.ts b/package/client/resource/streaming/index.ts index 37659c5..5af27cc 100644 --- a/package/client/resource/streaming/index.ts +++ b/package/client/resource/streaming/index.ts @@ -41,12 +41,14 @@ export const requestModel = (model: string | number, timeout?: number): Promise< return streamingRequest(RequestModel, HasModelLoaded, 'model', model, timeout); }; -export const requestStreamedTextureDict = (textureDict: string, timeout?: number): Promise => - streamingRequest(RequestStreamedTextureDict, HasStreamedTextureDictLoaded, 'textureDict', textureDict, timeout); - export const requestNamedPtfxAsset = (ptFxName: string, timeout?: number): Promise => streamingRequest(RequestNamedPtfxAsset, HasNamedPtfxAssetLoaded, 'ptFxName', ptFxName, timeout); -export const requestWeaponAsset = (weaponHash: string | number, timeout?: number, weaponResourceFlags: number = 31, extraWeaponComponentFlags: number = 0): Promise => { - return streamingRequest(RequestWeaponAsset, HasWeaponAssetLoaded, 'weaponHash', weaponHash, timeout, weaponResourceFlags, extraWeaponComponentFlags); -} +export const requestScaleformMovie = (scaleformName: string, timeout?: number): Promise => + streamingRequest(RequestScaleformMovie, HasScaleformMovieLoaded, 'scaleformMovie', scaleformName, timeout); + +export const requestStreamedTextureDict = (textureDict: string, timeout?: number): Promise => + streamingRequest(RequestStreamedTextureDict, HasStreamedTextureDictLoaded, 'textureDict', textureDict, timeout); + +export const requestWeaponAsset = (weaponHash: string | number, timeout?: number, weaponResourceFlags: number = 31, extraWeaponComponentFlags: number = 0): Promise => + streamingRequest(RequestWeaponAsset, HasWeaponAssetLoaded, 'weaponHash', weaponHash, timeout, weaponResourceFlags, extraWeaponComponentFlags); diff --git a/resource/interface/client/context.lua b/resource/interface/client/context.lua index 35905fa..c3e66ea 100644 --- a/resource/interface/client/context.lua +++ b/resource/interface/client/context.lua @@ -6,6 +6,8 @@ local openContextMenu = nil ---@field menu? string ---@field icon? string | {[1]: IconProp, [2]: string}; ---@field iconColor? string +---@field image? string +---@field progress? number ---@field onSelect? fun(args: any) ---@field arrow? boolean ---@field description? string diff --git a/resource/interface/client/menu.lua b/resource/interface/client/menu.lua index eaf7511..60b95dd 100644 --- a/resource/interface/client/menu.lua +++ b/resource/interface/client/menu.lua @@ -8,9 +8,12 @@ local openMenu ---@class MenuOptions ---@field label string +---@field progress? number +---@field colorScheme? string ---@field icon? string | {[1]: IconProp, [2]: string}; ----@field checked? boolean +---@field iconColor? string ---@field values? table +---@field checked? boolean ---@field description? string ---@field defaultIndex? number ---@field args? {[any]: any} diff --git a/resource/interface/client/notify.lua b/resource/interface/client/notify.lua index 2cfb826..5558434 100644 --- a/resource/interface/client/notify.lua +++ b/resource/interface/client/notify.lua @@ -1,5 +1,5 @@ ---@alias NotificationPosition 'top' | 'top-right' | 'top-left' | 'bottom' | 'bottom-right' | 'bottom-left' | 'center-right' | 'center-left' ----@alias NotificationType 'info' | 'warning' | 'success' | 'error' +---@alias NotificationType 'inform' | 'warning' | 'success' | 'error' ---@class NotifyProps ---@field id? string @@ -30,11 +30,11 @@ end ---@param data DefaultNotifyProps function lib.defaultNotify(data) - -- Backwards compat for v3 + -- Backwards compat for v3 data.type = data.status if data.type == 'inform' then data.type = 'info' end return lib.notify(data) end RegisterNetEvent('ox_lib:notify', lib.notify) -RegisterNetEvent('ox_lib:defaultNotify', lib.defaultNotify) \ No newline at end of file +RegisterNetEvent('ox_lib:defaultNotify', lib.defaultNotify) diff --git a/resource/vehicleProperties/client.lua b/resource/vehicleProperties/client.lua index f86fc29..0225b00 100644 --- a/resource/vehicleProperties/client.lua +++ b/resource/vehicleProperties/client.lua @@ -1,7 +1,7 @@ if cache.game == 'redm' then return end ---@class VehicleProperties ----@field model? string +---@field model? number ---@field plate? string ---@field plateIndex? number ---@field bodyHealth? number