chore: various fix-ups from docs clean-up (overextended#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 <[email protected]>

imports/getNearbyObjects/client.lua

@@ -21,7 +21,7 @@ function lib.getNearbyObjects(coords, maxDistance)
             }
         end
 	end
-    
+
 	return nearby
 end
 

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
+return lib.math

imports/table/shared.lua

@@ -136,5 +136,4 @@ function table.isfrozen(tbl)
     return getmetatable(tbl) == 'readonly'
 end
 
-
 return lib.table

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<RadialItem, 'id'>[] }) =>
   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);

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<string> =>
-  streamingRequest(RequestStreamedTextureDict, HasStreamedTextureDictLoaded, 'textureDict', textureDict, timeout);
-
 export const requestNamedPtfxAsset = (ptFxName: string, timeout?: number): Promise<string> =>
   streamingRequest(RequestNamedPtfxAsset, HasNamedPtfxAssetLoaded, 'ptFxName', ptFxName, timeout);
 
-export const requestWeaponAsset = (weaponHash: string | number, timeout?: number, weaponResourceFlags: number = 31, extraWeaponComponentFlags: number = 0): Promise<string | number> => {
-  return streamingRequest(RequestWeaponAsset, HasWeaponAssetLoaded, 'weaponHash', weaponHash, timeout, weaponResourceFlags, extraWeaponComponentFlags);
-}
+export const requestScaleformMovie = (scaleformName: string, timeout?: number): Promise<string> =>
+  streamingRequest(RequestScaleformMovie, HasScaleformMovieLoaded, 'scaleformMovie', scaleformName, timeout);
+
+export const requestStreamedTextureDict = (textureDict: string, timeout?: number): Promise<string> =>
+  streamingRequest(RequestStreamedTextureDict, HasStreamedTextureDictLoaded, 'textureDict', textureDict, timeout);
+
+export const requestWeaponAsset = (weaponHash: string | number, timeout?: number, weaponResourceFlags: number = 31, extraWeaponComponentFlags: number = 0): Promise<string | number> =>
+  streamingRequest(RequestWeaponAsset, HasWeaponAssetLoaded, 'weaponHash', weaponHash, timeout, weaponResourceFlags, extraWeaponComponentFlags);

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

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<string | { label: string, description: string }>
+---@field checked? boolean
 ---@field description? string
 ---@field defaultIndex? number
 ---@field args? {[any]: any}

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)
+RegisterNetEvent('ox_lib:defaultNotify', lib.defaultNotify)

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