diff --git a/lib/entities/client/entity_base.lua b/lib/entities/client/entity_base.lua index f778a86..1ac6022 100644 --- a/lib/entities/client/entity_base.lua +++ b/lib/entities/client/entity_base.lua @@ -1,4 +1,3 @@ - -- Objects Utility = Utility or Require("lib/utility/client/utility.lua") Ids = Ids or Require("lib/utility/shared/ids.lua") @@ -25,7 +24,7 @@ function BaseEntity.Create(id, model, coords, rotation, meta) self.Spawn = self.Spawn or function() end self.Remove = self.Remove or function() end - + return Point.Register(self.id, self.coords, 50.0, self.Spawn, self.Remove, nil, self) end diff --git a/lib/generators/server/ItemsBuilder.lua b/lib/generators/server/ItemsBuilder.lua index f088318..c2c6b1c 100644 --- a/lib/generators/server/ItemsBuilder.lua +++ b/lib/generators/server/ItemsBuilder.lua @@ -2,7 +2,9 @@ ItemsBuilder = ItemsBuilder or {} ItemsBuilder = {} - +---This will generate the items in the formats of qb_core, qb_core_old and ox_inventory. It will then build a lua file in the generateditems folder of the community_bridge. +---@param invoking string +---@param itemsTable table ItemsBuilder.Generate = function(invoking, itemsTable) if not invoking or not itemsTable then return end diff --git a/lib/logs/server/logs.lua b/lib/logs/server/logs.lua index 4a89dd1..fa353f6 100644 --- a/lib/logs/server/logs.lua +++ b/lib/logs/server/logs.lua @@ -3,6 +3,10 @@ Logs = Logs or {} local WebhookURL = "" local LogoForEmbed = "" +---This will send a log to the configured webhook or log system. +---@param src number +---@param message string +---@return nil Logs.Send = function(src, message) if not src or not message then return end if BridgeServerConfig.LogSystem == "builtin" then diff --git a/lib/raycast/client/raycast.lua b/lib/raycast/client/raycast.lua index abc6bfe..f067f6e 100644 --- a/lib/raycast/client/raycast.lua +++ b/lib/raycast/client/raycast.lua @@ -3,12 +3,12 @@ Raycast = {} --Rework of oxs Raycast system function Raycast.GetForwardVector(rotation) local camRot = rotation or GetFinalRenderedCamRot(2) - + -- Convert each component to radians local rx = math.rad(camRot.x) local ry = math.rad(camRot.y) local rz = math.rad(camRot.z) - + -- Calculate sin and cos for each axis local sx = math.sin(rx) local cx = math.cos(rx) @@ -16,12 +16,12 @@ function Raycast.GetForwardVector(rotation) local cy = math.cos(ry) local sz = math.sin(rz) local cz = math.cos(rz) - + -- Create forward vector components local x = -sz * math.abs(cx) local y = cz * math.abs(cx) local z = sx - + return vector3(x, y, z) end @@ -34,7 +34,7 @@ function Raycast.ToCoords(startCoords, endCoords, flag, ignore) retval, entity, finalCoords, normals, material = GetShapeTestResultIncludingMaterial(probe) timeout = timeout - 1 Wait(0) - end + end return retval, entity, finalCoords, normals, material end diff --git a/lib/utility/client/utility.lua b/lib/utility/client/utility.lua index c6263b3..dcca2e6 100644 --- a/lib/utility/client/utility.lua +++ b/lib/utility/client/utility.lua @@ -1,20 +1,43 @@ Utility = Utility or {} local blipIDs = {} local spawnedPeds = {} -local ActivePoints = {} +---commentThis will create a prop with the passed model string at the coords and heading specified optionally networked or not. +---@param model string | number +---@param coords table +---@param heading number +---@param networked boolean +---@return number | nil Utility.CreateProp = function(model, coords, heading, networked) Utility.LoadModel(model) - if not HasModelLoaded(model) then return Prints.Error("Model Has Not Loaded") end + if not HasModelLoaded(model) then return nil, Prints.Error("Model Has Not Loaded") end local propEntity = CreateObject(model, coords.x, coords.y, coords.z, networked, false, false) SetEntityHeading(propEntity, heading) SetModelAsNoLongerNeeded(model) return propEntity end +---This will get the street name and crossing name at the specified coordinates. +---@param coords table +---@return string +---@return string +Utility.GetStreetNameAtCoords = function(coords) + local streetHash, crossingHash = GetStreetNameAtCoord(coords.x, coords.y, coords.z) + local streetName = GetStreetNameFromHashKey(streetHash) + local crossingName = GetStreetNameFromHashKey(crossingHash) + return streetName, crossingName +end + +---This will create a vehicle with the passed model string at the coords and heading specified. +---@param model string +---@param coords table +---@param heading number +---@param networked boolean +---@return number| nil +---@return table Utility.CreateVehicle = function(model, coords, heading, networked) Utility.LoadModel(model) - if not HasModelLoaded(model) then return Prints.Error("Model Has Not Loaded") end + if not HasModelLoaded(model) then return nil, {}, Prints.Error("Model Has Not Loaded") end local vehicle = CreateVehicle(model, coords.x, coords.y, coords.z, heading, networked, false) SetVehicleHasBeenOwnedByPlayer(vehicle, true) SetVehicleNeedsToBeHotwired(vehicle, false) @@ -23,15 +46,24 @@ Utility.CreateVehicle = function(model, coords, heading, networked) return vehicle, { networkid = NetworkGetNetworkIdFromEntity(vehicle) or 0, coords = GetEntityCoords(vehicle), heading = GetEntityHeading(vehicle), } end +---This will create a ped with the passed model string at the coords and heading specified. +---@param model string +---@param coords table +---@param heading number +---@param networked boolean +---@return number| nil Utility.CreatePed = function(model, coords, heading, networked, settings) Utility.LoadModel(model) - if not HasModelLoaded(model) then return Prints.Error("Model Has Not Loaded") end + if not HasModelLoaded(model) then return nil, Prints.Error("Model Has Not Loaded") end local spawnedEntity = CreatePed(0, model, coords.x, coords.y, coords.z, heading, networked, false) SetModelAsNoLongerNeeded(model) table.insert(spawnedPeds, spawnedEntity) return spawnedEntity end +---This will display a busy spinner with the passed text. +---@param text string +---@return boolean Utility.StartBusySpinner = function(text) AddTextEntry(text, text) BeginTextCommandBusyString(text) @@ -40,6 +72,8 @@ Utility.StartBusySpinner = function(text) return true end +---This will stop a busy spinner if one is currently active. +---@return boolean Utility.StopBusySpinner = function() if BusyspinnerIsOn() then BusyspinnerOff() @@ -48,6 +82,15 @@ Utility.StopBusySpinner = function() return false end +---comment Creates a blip at the specified coordinates with the specified parameters. If sprite/color/scale/label are not provided, default values will be used. +---@param coords table +---@param sprite number +---@param color number +---@param scale number +---@param label string +---@param shortRange boolean +---@param displayType number +---@return integer Utility.CreateBlip = function(coords, sprite, color, scale, label, shortRange, displayType) local blip = AddBlipForCoord(coords.x, coords.y, coords.z) SetBlipSprite(blip, sprite or 8) @@ -62,6 +105,9 @@ Utility.CreateBlip = function(coords, sprite, color, scale, label, shortRange, d return blip end +---This will remove a blip if it exists in the blipIDs table. +---@param blip number +---@return boolean Utility.RemoveBlip = function(blip) local success = false for i, storedBlip in ipairs(blipIDs) do @@ -75,6 +121,9 @@ Utility.RemoveBlip = function(blip) return success end +---Loads a model into memory. If the model is not valid or not in the game files, it will return false. +---@param model string | number +---@return boolean Utility.LoadModel = function(model) if type(model) ~= 'number' then model = joaat(model) end if not IsModelValid(model) and not IsModelInCdimage(model) then return false end @@ -87,6 +136,9 @@ Utility.LoadModel = function(model) return HasModelLoaded(model) end +---This function will request an animation dictionary and wait until it is loaded. If the dictionary is not valid, it will return false. +---@param dict string +---@return boolean Utility.RequestAnimDict = function(dict) RequestAnimDict(dict) local count = 0 @@ -97,6 +149,9 @@ Utility.RequestAnimDict = function(dict) return HasAnimDictLoaded(dict) end +---This will remove a ped if it exists in the spawnedPeds table. It will also delete the entity if it exists. +---@param entity number +---@return boolean Utility.RemovePed = function(entity) local success = false if DoesEntityExist(entity) then @@ -112,6 +167,10 @@ Utility.RemovePed = function(entity) return success end +---This will use a native text input menu to allow the user to enter text. It will return the entered text or false if cancelled. +---@param text string +---@param length number +---@return string Utility.NativeInputMenu = function(text, length) local maxLength = Math.Clamp(length, 1, 50) local menutText = text or 'enter text' @@ -128,6 +187,9 @@ Utility.NativeInputMenu = function(text, length) return false end +---This will get the current skin data of the entity passed. It will return a table with the clothing and props data. +---@param entity number +---@return table Utility.GetEntitySkinData = function(entity) local skinData = {} for i = 0, 11 do @@ -139,6 +201,10 @@ Utility.GetEntitySkinData = function(entity) return skinData end +---This will set the skin data of the entity passed. It will set the clothing and props data from the skinData table. +---@param entity number +---@param skinData table +---@return boolean Utility.SetEntitySkinData = function(entity, skinData) for i = 0, 11 do SetPedComponentVariation(entity, i, skinData.clothing[i][1], skinData.clothing[i][2], 0) @@ -149,6 +215,8 @@ Utility.SetEntitySkinData = function(entity, skinData) return true end +---This will reload the skin data of the entity passed. It will set the clothing and props data from the skinData table and delete any attached objects. +---@return boolean Utility.ReloadSkin = function() local skinData = Utility.GetEntitySkinData(cache.ped) Utility.SetEntitySkinData(cache.ped, skinData) @@ -162,18 +230,27 @@ Utility.ReloadSkin = function() return true end +---This will display a native help text on the screen. It will add a text entry and display it for the specified duration. +---@param text string +---@param duration number Utility.HelpText = function(text, duration) AddTextEntry(text, text) BeginTextCommandDisplayHelp(text) EndTextCommandDisplayHelp(0, false, true, duration or 5000) end +---This will display a native help text on the screen. It will add a text entry and display it for the specified duration. +---@param text string Utility.NotifyText = function(text) AddTextEntry(text, text) SetNotificationTextEntry(text) DrawNotification(false, true) end +---This will teleport a player to the specified coordinates. If a condition function is passed it will verify that condition is met and then it will fade the screen out and in, freeze the player during the teleport to allow for collisions to load, and call the afterTeleportFunction if provided. +---@param coords table +---@param conditionFunction function | optional +---@param afterTeleportFunction function | optional Utility.TeleportPlayer = function(coords, conditionFunction, afterTeleportFunction) if conditionFunction ~= nil then if not conditionFunction() then @@ -200,11 +277,21 @@ Utility.TeleportPlayer = function(coords, conditionFunction, afterTeleportFuncti end end +---This will get a model hash from a string or number. +---@param model string | number +---@return number Utility.GetEntityHashFromModel = function(model) if type(model) ~= 'number' then model = joaat(model) end return model end +---commentThis will get the closest player, the distance to that player from the coords and the server ID of that player. +---@param coords table +---@param distanceScope number +---@param includeMe boolean +---@return integer +---@return integer +---@return integer Utility.GetClosestPlayer = function(coords, distanceScope, includeMe) local players = GetActivePlayers() local closestPlayer = 0 @@ -227,7 +314,7 @@ Utility.GetClosestPlayer = function(coords, distanceScope, includeMe) return closestPlayer, closestDistance, GetPlayerServerId(closestPlayer) end ----This function is used to register a point on the map, functions are fired when in the distance/exiting the area +---This function is is deprecated and will be removed in the future. Please use Pont.Register instead. ---@param pointID string ---@param pointCoords table ---@param pointDistance number @@ -235,41 +322,26 @@ end ---@param _onExit function ---@param _nearby function Utility.RegisterPoint = function(pointID, pointCoords, pointDistance, _onEnter, _onExit, _nearby) - ActivePoints[pointID] = lib.points.new({ - coords = pointCoords, - distance = pointDistance, - onEnter = function(self) - _onEnter(self) - end, - onExit = function(self) - _onExit(self) - end, - nearby = function(self) - if _nearby then - _nearby(self) - end - end - }) + return Point.Register(pointID, pointCoords, pointDistance, nil, _onEnter, _onExit, _nearby) end --- Function to retrieve the zone by the pointID +---This function is is deprecated and will be removed in the future. Please use Point.Get instead. ---@param pointID string Utility.GetPointById = function(pointID) - return ActivePoints[pointID] + return Point.Get(pointID) end +---This function is is deprecated and will be removed in the future. Please use Point.GetAll instead. ---@return table | nil Utility.GetActivePoints = function() - return ActivePoints + return Point.GetAll() end ----Pass the point ID to remove the point from the map + +---This function is is deprecated and will be removed in the future. Please use Point.Remove instead. ---@param pointID string ----@return boolean +---@return nil Utility.RemovePoint = function(pointID) - if not ActivePoints[pointID] then return false end - ActivePoints[pointID]:remove() - ActivePoints[pointID] = nil - return true + return Point.Remove(pointID) end AddEventHandler('onResourceStop', function(resource) diff --git a/lib/utility/shared/callbacks.lua b/lib/utility/shared/callbacks.lua index 4834b62..f0b7965 100644 --- a/lib/utility/shared/callbacks.lua +++ b/lib/utility/shared/callbacks.lua @@ -40,7 +40,7 @@ RegisterNetEvent(clientToServerName, function(name, cbId, ...) local func = data.callback if not func then return end local toAll = data.toAll and -1 or src - + -- Create response handler local packed = table.pack(func(src, ...)) TriggerClientEvent(clientToServerBackToClientName, toAll, name, cbId, table.unpack(packed)) @@ -49,22 +49,22 @@ end) -- Server to client trigger function - supports both callback and direct return function Callback.Trigger(name, src, callbackOrArg, ...) if src == nil then src = -1 end - + -- Determine if the third parameter is a callback function or an argument local hasCallback = type(callbackOrArg) == 'function' or (type(callbackOrArg) == 'table' and rawget(callbackOrArg, '__cfx_functionReference')) local callback = hasCallback and callbackOrArg or nil -- Adjust args based on whether the callback is present local args = hasCallback and {...} or {callbackOrArg, ...} - + local cbId = name .. '_' .. math.random(1000000, 9999999) local p = promise.new() - + -- Store promise data - cbData[cbId] = { - cb = callback, - p = p + cbData[cbId] = { + cb = callback, + p = p } - + -- Trigger for single player or multiple players if type(src) == 'table' then for i, d in pairs(src) do @@ -73,7 +73,7 @@ function Callback.Trigger(name, src, callbackOrArg, ...) else TriggerClientEvent(serverToClientName, tonumber(src), name, cbId, table.unpack(args)) end - + -- If no callback was provided, wait for the promise and return directly local result = Citizen.Await(p) @@ -90,7 +90,7 @@ end RegisterNetEvent(serverToClientBackToServerName, function(name, cbId, ...) local data = cbData[cbId] if not data then return end - + -- Process callback if provided if data.cb then @@ -129,19 +129,19 @@ function Callback.Trigger(name, callbackOrArg, ...) local callback = hasCallback and callbackOrArg or nil -- Adjust args based on whether the callback is present local args = hasCallback and {...} or {callbackOrArg, ...} - + local cbId = name .. '_' .. math.random(1000000, 9999999) local p = promise.new() - + -- Store promise data cbData[cbId] = { cb = callback, p = p } - + -- Trigger the server event TriggerServerEvent(clientToServerName, name, cbId, table.unpack(args)) - + -- If no callback was provided, wait for the promise and return directly if not hasCallback then local result = Citizen.Await(p) @@ -152,7 +152,7 @@ function Callback.Trigger(name, callbackOrArg, ...) return table.unpack(result) end end - + -- Otherwise, return nothing (callback will handle it) return nil end @@ -164,16 +164,16 @@ RegisterNetEvent(clientToServerBackToClientName, function(name, cbId, ...) if clientRebound then clientRebound(...) end - + -- Handle the specific callback instance local data = cbData[cbId] if not data then return end - + -- Process callback if provided if data.cb then data.cb(...) end - + -- Always resolve the promise with all args for direct returns data.p:resolve({...}) cbData[cbId] = nil @@ -185,7 +185,7 @@ RegisterNetEvent(serverToClientName, function(name, cbId, ...) if not data then return end local func = data.callback if not func then return end - + -- Create response handler TriggerServerEvent(serverToClientBackToServerName, name, cbId, func(...)) end) diff --git a/modules/clothing/_default/client.lua b/modules/clothing/_default/client.lua index 9d72391..b406e5a 100644 --- a/modules/clothing/_default/client.lua +++ b/modules/clothing/_default/client.lua @@ -1,3 +1,5 @@ +--[[This module is incomplete]]-- + Clothing = Clothing or {} ClothingBackup = {} diff --git a/modules/clothing/_default/server.lua b/modules/clothing/_default/server.lua index 2ec1460..8689800 100644 --- a/modules/clothing/_default/server.lua +++ b/modules/clothing/_default/server.lua @@ -1,3 +1,5 @@ +--[[This module is incomplete]]-- + Clothing = Clothing or {} Clothing.SetAppearance = function(src, data) @@ -13,8 +15,6 @@ Clothing.ReloadSkin = function(src) end - - RegisterNetEvent('community_bridge:client:SetAppearance', function(data) Clothing.SetAppearance(data) end) diff --git a/modules/clothing/esx_skin/client.lua b/modules/clothing/esx_skin/client.lua deleted file mode 100644 index d3261e0..0000000 --- a/modules/clothing/esx_skin/client.lua +++ /dev/null @@ -1,142 +0,0 @@ -if GetResourceState('esx_skin') ~= 'started' then return end - -Clothing = Clothing or {} - -local clothingData = { - male = { - components = { - face = {component_id = 0, texture = 0, drawable = 2}, - mask = {component_id = 1, texture = 0, drawable = 2}, - hair = {component_id = 2, texture = 0, drawable = 2}, - arms = {component_id = 3, texture = 0, drawable = 2}, - pants = {component_id = 4, texture = 0, drawable = 22}, - bag = {component_id = 5, texture = 1, drawable = 33}, - shoes = {component_id = 6, texture = 1, drawable = 33}, - accessory = {component_id = 7, texture = 1, drawable = 33}, - shirt = {component_id = 8, texture = 1, drawable = 11}, - bodyarmor = {component_id = 9, texture = 1, drawable = 33}, - decals = {component_id = 10, texture = 1, drawable = 33}, - jacket = {component_id = 11, texture = 2, drawable = 4}, - }, - props = { - hats = {prop_id = 0, texture = 2, drawable = 4}, - glasses = {prop_id = 1, texture = 2, drawable = 4}, - ears = {prop_id = 2, texture = 2, drawable = 4}, - watches = {prop_id = 6, texture = 2, drawable = 4}, - bracelets = {prop_id = 7, texture = 2, drawable = 4}, - } - }, - female = { - components = { - face = {component_id = 0, texture = 0, drawable = 2}, - mask = {component_id = 1, texture = 0, drawable = 2}, - hair = {component_id = 2, texture = 0, drawable = 2}, - arms = {component_id = 3, texture = 0, drawable = 2}, - pants = {component_id = 4, texture = 0, drawable = 22}, - bag = {component_id = 5, texture = 1, drawable = 33}, - shoes = {component_id = 6, texture = 1, drawable = 33}, - accessory = {component_id = 7, texture = 1, drawable = 33}, - shirt = {component_id = 8, texture = 1, drawable = 11}, - bodyarmor = {component_id = 9, texture = 1, drawable = 33}, - decals = {component_id = 10, texture = 1, drawable = 33}, - jacket = {component_id = 11, texture = 2, drawable = 4}, - }, - props = { - hats = {prop_id = 0, texture = 2, drawable = 4}, - glasses = {prop_id = 1, texture = 2, drawable = 4}, - ears = {prop_id = 2, texture = 2, drawable = 4}, - watches = {prop_id = 6, texture = 2, drawable = 4}, - bracelets = {prop_id = 7, texture = 2, drawable = 4}, - } - }, -} - -local function convertDataToFormat(characterData) - local gender = characterData.sex - - local repackedClothingData = { - [gender] = { - components = {}, - props = {} - } - } - - local componentMap = { - tshirt_1 = 8, -- shirt - torso_1 = 11, -- jacket - decals_1 = 10, -- decals - arms = 3, -- arms - pants_1 = 4, -- pants - shoes_1 = 6, -- shoes - mask_1 = 1, -- mask - bproof_1 = 9, -- body armor - chain_1 = 7, -- accessory (could be a necklace) - bags_1 = 5, -- bag - } - - for componentName, componentId in pairs(componentMap) do - if characterData[componentName] then - repackedClothingData[gender].components[componentName] = { - component_id = componentId, - texture = characterData[componentName.."_2"], - drawable = characterData[componentName.."_1"], - } - end - end - - local propMap = { - {"helmet_1", 0}, -- helmet - {"glasses_1", 1}, -- glasses - {"ears_1", 2}, -- ears - {"watches_1", 6}, -- watches - {"bracelets_1", 7} -- bracelets - } - - for _, prop in ipairs(propMap) do - local propName = prop[1] - local propId = prop[2] - - if characterData[propName] then - repackedClothingData[gender].props[propName] = { - prop_id = propId, - texture = characterData[propName.."_2"], - drawable = characterData[propName.."_1"], - } - end - end - return repackedClothingData -end - -Clothing.SetAppearance = function(clothingData) - if GetEntityModel(cache.ped) == `mp_m_freemode_01` then - clothingData = clothingData.male - clothingData.sex = 0 - else - clothingData = clothingData.female - clothingData.sex = 1 - end - local repackedClothingData = convertDataToFormat(clothingData) - StoredOldClothing = Clothing.GetAppearance - TriggerEvent('skinchanger:loadSkin', repackedClothingData) - return true -end - -Clothing.GetAppearance = function() - ESX.TriggerServerCallback('esx_skin:getPlayerSkin', function(skin) - StoredOldClothing = skin - end) - return true -end - -Clothing.RestoreAppearance = function() - ESX.TriggerServerCallback('esx_skin:getPlayerSkin', function(skin) - TriggerEvent('skinchanger:loadSkin', skin) - end) - return true -end - -Clothing.ReloadSkin = function() - local tableCheck = Table.TableContains(StoredOldClothing, "sex") - if not tableCheck then return Clothing.RestoreAppearance() end - return TriggerEvent('skinchanger:loadSkin', StoredOldClothing) -end \ No newline at end of file diff --git a/modules/clothing/fivem-appearance/client.lua b/modules/clothing/fivem-appearance/client.lua deleted file mode 100644 index 96dc98f..0000000 --- a/modules/clothing/fivem-appearance/client.lua +++ /dev/null @@ -1,31 +0,0 @@ -if GetResourceState('fivem-appearance') ~= 'started' then return end -Clothing = Clothing or {} - -Clothing.SetAppearance = function(data) - local clothing = {} - if GetEntityModel(cache.ped) == `mp_m_freemode_01` then - clothing = data.male - else - clothing = data.female - end - ClothingBackup = exports['fivem-appearance']:getPedAppearance(cache.ped) - exports['fivem-appearance']:setPedAppearance(cache.ped, clothing) - return true -end - -Clothing.GetAppearance = function() - return exports['fivem-appearance']:getPedAppearance(cache.ped) -end - -Clothing.RestoreAppearance = function() - if not next(ClothingBackup) then - return false - end - exports['fivem-appearance']:setPedAppearance(cache.ped, ClothingBackup) - return true -end - -Clothing.ReloadSkin = function() - TriggerEvent("fivem-appearance:client:reloadSkin", true) - return true -end \ No newline at end of file diff --git a/modules/clothing/illenium-appearance/client.lua b/modules/clothing/illenium-appearance/client.lua deleted file mode 100644 index 92736ab..0000000 --- a/modules/clothing/illenium-appearance/client.lua +++ /dev/null @@ -1,42 +0,0 @@ -if GetResourceState('illenium-appearance') ~= 'started' then return end -Clothing = Clothing or {} - -Clothing.SetAppearance = function(clothingData) - local clothing = {} - if GetEntityModel(cache.ped) == `mp_m_freemode_01` then - clothingData = clothingData.male - else - clothingData = clothingData.female - end - clothing.components = exports['illenium-appearance']:getPedComponents(cache.ped) - clothing.props = exports['illenium-appearance']:getPedProps(cache.ped) - - Prints.Debug(json.encode(clothingData, {indent = true})) - ClothingBackup = clothing - exports['illenium-appearance']:setPedComponents(cache.ped, clothingData.components) - exports['illenium-appearance']:setPedProp(cache.ped, clothingData.props) - return true -end - -Clothing.GetAppearance = function() - local clothing = {} - if GetEntityModel(cache.ped) == `mp_m_freemode_01` then - clothing = clothing.male - else - clothing = clothing.female - end - clothing.components = exports['illenium-appearance']:getPedComponents(cache.ped) - clothing.props = exports['illenium-appearance']:getPedProps(cache.ped) - - return clothing -end - -Clothing.RestoreAppearance = function() - exports['illenium-appearance']:setPedComponents(cache.ped, ClothingBackup.components) - exports['illenium-appearance']:setPedProp(cache.ped, ClothingBackup.props) - return true -end - -Clothing.ReloadSkin = function() - TriggerEvent("illenium-appearance:client:reloadSkin", true) -end diff --git a/modules/clothing/qb-clothing/client.lua b/modules/clothing/qb-clothing/client.lua deleted file mode 100644 index 6d96122..0000000 --- a/modules/clothing/qb-clothing/client.lua +++ /dev/null @@ -1,75 +0,0 @@ -if GetResourceState('qb-clothing') ~= 'started' then return end - -Clothing = Clothing or {} - -Clothing.SetAppearance = function(data) - local clothingData = {} - local repackedTable = {} - if GetEntityModel(cache.ped) == `mp_m_freemode_01` then - clothingData = data.male - else - clothingData = data.female - end - ClothingBackup = Clothing.GetAppearance - local componentMap = { - [1] = 'mask', - [3] = 'arms', - [4] = 'pants', - [5] = 'bag', - [6] = 'shoes', - [7] = 'accessory', - [8] = 't-shirt', - [9] = 'vest', - [10] = 'decals', - [11] = 'torso2' - } - - local propMap = { - [0] = 'hat', - [1] = 'glass', - [2] = 'ear', - [6] = 'watch', - [7] = 'bracelet' - } - - local specialMap = { - eye_color_id = 'eye_color', - moles_id = 'moles', - ageing_id = 'ageing', - hair_id = 'hair', - face_id = 'face' - } - - for _, v in pairs(clothingData) do - if componentMap[v.component_id] then - repackedTable[componentMap[v.component_id]] = {drawable = v.drawable, texture = v.texture} - elseif propMap[v.prop_id] then - repackedTable[propMap[v.prop_id]] = {drawable = v.drawable, texture = v.texture} - elseif specialMap[v.eye_color_id] then - repackedTable[specialMap[v.eye_color_id]] = {drawable = v.drawable, texture = v.texture} - elseif specialMap[v.moles_id] then - repackedTable[specialMap[v.moles_id]] = {drawable = v.drawable, texture = v.texture} - elseif specialMap[v.ageing_id] then - repackedTable[specialMap[v.ageing_id]] = {drawable = v.drawable, texture = v.texture} - elseif specialMap[v.hair_id] then - repackedTable[specialMap[v.hair_id]] = {drawable = v.drawable, texture = v.texture} - elseif specialMap[v.face_id] then - repackedTable[specialMap[v.face_id]] = {drawable = v.drawable, texture = v.texture} - end - end - TriggerEvent('qb-clothing:client:loadOutfit', repackedTable) - return true -end - -Clothing.GetAppearance = function() - ClothingBackup = Utility.GetEntitySkinData(cache.ped) - return Utility.GetEntitySkinData(cache.ped) -end - -Clothing.RestoreAppearance = function() - return Utility.SetEntitySkinData(cache.ped, ClothingBackup) -end - -Clothing.ReloadSkin = function() - return exports['qb-clothing']:reloadSkin(GetEntityHealth(cache.ped)) -end \ No newline at end of file diff --git a/modules/clothing/qb-clothing/server.lua b/modules/clothing/qb-clothing/server.lua deleted file mode 100644 index c95f1bc..0000000 --- a/modules/clothing/qb-clothing/server.lua +++ /dev/null @@ -1,8 +0,0 @@ -if GetResourceState('qb-clothing') ~= 'started' then return end - -RegisterNetEvent('qb-clothing:saveSkin', function(model, skin) - local src = source - if model and skin then - TriggerClientEvent('community_bridge:client:updateClothingBackup', src, skin) - end -end) \ No newline at end of file diff --git a/modules/dialogue/default/client/client.lua b/modules/dialogue/default/client/client.lua index 5cbb940..97ce769 100644 --- a/modules/dialogue/default/client/client.lua +++ b/modules/dialogue/default/client/client.lua @@ -1,3 +1,6 @@ +--[[This module is incomplete]]-- + + local promises = {} local activeDialogue = nil local pendingCameraDestroy = false diff --git a/modules/dispatch/lb-tablet/client/client.lua b/modules/dispatch/lb-tablet/client/client.lua new file mode 100644 index 0000000..85083ff --- /dev/null +++ b/modules/dispatch/lb-tablet/client/client.lua @@ -0,0 +1,38 @@ +if GetResourceState('lb-tablet') ~= 'started' then return end +Dispatch = Dispatch or {} + +local function getPriorityLevel(priority) + if priority == 1 then + return 'low' + elseif priority == 2 then + return 'medium' + elseif priority == 3 then + return 'high' + else + return 'medium' + end +end + +Dispatch.SendAlert = function(data) + local streetName, _ = Utility.GetStreetNameAtCoords(data.coords) + local priority = getPriorityLevel(data.priority) + if type(data.jobs) == 'table' then + data.jobs = data.jobs[1] + end + if data.time and data.time > 1000 then + data.time = math.floor((data.time / 1000) + 0.5) + end + local alertData = { + priority = priority, + code = data.code or '10-80', + title = 'Dispatch Alert!', + description = data.message, + location = { + label = streetName, + coords = vec2(data.coords.x, data.coords.y) + }, + time = data.time or 10000, + job = data.jobs, + } + TriggerServerEvent("community_bridge:server:dispatch:sendAlert", alertData) +end \ No newline at end of file diff --git a/modules/dispatch/lb-tablet/server/server.lua b/modules/dispatch/lb-tablet/server/server.lua new file mode 100644 index 0000000..ec8befc --- /dev/null +++ b/modules/dispatch/lb-tablet/server/server.lua @@ -0,0 +1,6 @@ +if GetResourceState('lb-tablet') ~= 'started' then return end +Dispatch = Dispatch or {} + +RegisterNetEvent("community_bridge:server:dispatch:sendAlert", function(data) + exports["lb-tablet"]:AddDispatch(data) -- this has a return value but we dont really have a use for it atm. +end) \ No newline at end of file diff --git a/modules/dispatch/ps-dispatch/client/client.lua b/modules/dispatch/ps-dispatch/client/client.lua index 7a27093..cbf06a3 100644 --- a/modules/dispatch/ps-dispatch/client/client.lua +++ b/modules/dispatch/ps-dispatch/client/client.lua @@ -1,4 +1,5 @@ if GetResourceState('ps-dispatch') ~= 'started' then return end +if GetResourceState('lb-tablet') == 'started' then return end Dispatch = Dispatch or {} Dispatch.SendAlert = function(data) diff --git a/modules/dispatch/ps-dispatch/server/server.lua b/modules/dispatch/ps-dispatch/server/server.lua index b19a475..b75b55e 100644 --- a/modules/dispatch/ps-dispatch/server/server.lua +++ b/modules/dispatch/ps-dispatch/server/server.lua @@ -1,2 +1,3 @@ if GetResourceState('ps-dispatch') ~= 'started' then return end +if GetResourceState('lb-tablet') == 'started' then return end Dispatch = Dispatch or {} diff --git a/modules/locales/shared.lua b/modules/locales/shared.lua index 1e49843..4074ac2 100644 --- a/modules/locales/shared.lua +++ b/modules/locales/shared.lua @@ -47,29 +47,4 @@ function Language.Locale(str, ...) return current end - - - -if BridgeSharedConfig.DebugLevel == 2 then - -- if outside this resource, use local whatever = Require("modules/locales/shared.lua") - -- whatever.Locales("some-index-in-language-.json-file") - -- Files must be stored in "locales" folder, within the resource. - -- Instead of using Require you can also import it via the manifest. - -- The Lang variable is available globally, which tells you what the server is using. - -- print("Language: ", Lang) - -- print("Locale: ", Language.Locale("locale-unit-test")) - - -- Example outside community bridge resource: - - -- local Language = Require('modules/locales/shared.lua') - -- print("Language: ", Lang) - -- print("Locale: ", Language.Locale("locale-unit-test")) - RegisterCommand("lang", function(source, args, raw) - print(Language.Locale("UNITTEST.UNITTEST.UNITTESTA")) - print(Language.Locale("UNITTEST.UNITTESTA", "Devil", "GERRRRRRR!")) - - print( "Oh also this works", Language.Locale("place_object_scroll_down")) - end) -end - return Language \ No newline at end of file diff --git a/modules/managment/Renewed-Banking/server.lua b/modules/managment/Renewed-Banking/server.lua index 4a952de..3c4bf5b 100644 --- a/modules/managment/Renewed-Banking/server.lua +++ b/modules/managment/Renewed-Banking/server.lua @@ -1,14 +1,25 @@ if GetResourceState('Renewed-Banking') ~= 'started' then return end Managment = Managment or {} +---This will return a table with account details +---@param account string +---@return table Managment.GetAccountMoney = function(account) return exports['Renewed-Banking']:getAccountMoney(account) end +---This will add money to the specified account of the passed amount +---@param account string +---@param amount number +---@return boolean Managment.AddAccountMoney = function(account, amount) return exports['Renewed-Banking']:addAccountMoney(account, amount) end +---This will remove money from the specified account of the passed amount +---@param account string +---@param amount number +---@return boolean Managment.RemoveAccountMoney = function(account, amount) return exports['Renewed-Banking']:removeAccountMoney(account, amount) end \ No newline at end of file diff --git a/modules/managment/okokBanking/server.lua b/modules/managment/okokBanking/server.lua index 90ad050..34582c3 100644 --- a/modules/managment/okokBanking/server.lua +++ b/modules/managment/okokBanking/server.lua @@ -1,14 +1,25 @@ if GetResourceState('okokBanking') ~= 'started' then return end Managment = Managment or {} +---This will return a table with account details +---@param account string +---@return table Managment.GetAccountMoney = function(account) return exports['okokBanking']:GetAccount(account) end +---This will add money to the specified account of the passed amount +---@param account string +---@param amount number +---@return boolean Managment.AddAccountMoney = function(account, amount) return exports['okokBanking']:AddMoney(account, amount) end +---This will remove money from the specified account of the passed amount +---@param account string +---@param amount number +---@return boolean Managment.RemoveAccountMoney = function(account, amount) return exports['okokBanking']:RemoveMoney(account, amount) end \ No newline at end of file diff --git a/modules/managment/qb-banking/server.lua b/modules/managment/qb-banking/server.lua index 5a7facf..25d168a 100644 --- a/modules/managment/qb-banking/server.lua +++ b/modules/managment/qb-banking/server.lua @@ -1,14 +1,25 @@ if GetResourceState('qb-banking') ~= 'started' then return end Managment = Managment or {} +---This will return a table with account details +---@param account string +---@return table Managment.GetAccountMoney = function(account) return exports['qb-banking']:GetAccountBalance(account) end +---This will add money to the specified account of the passed amount +---@param account string +---@param amount number +---@return boolean Managment.AddAccountMoney = function(account, amount) return exports['qb-banking']:AddMoney(account, amount) end +---This will remove money from the specified account of the passed amount +---@param account string +---@param amount number +---@return boolean Managment.RemoveAccountMoney = function(account, amount) return exports['qb-banking']:RemoveMoney(account, amount) end \ No newline at end of file diff --git a/modules/notify/_default/client.lua b/modules/notify/_default/client.lua index 743e348..a857aeb 100644 --- a/modules/notify/_default/client.lua +++ b/modules/notify/_default/client.lua @@ -2,7 +2,7 @@ Notify = Notify or {} local notifyType = BridgeClientConfig.NotifySystem local helptextType = BridgeClientConfig.ShowHelpText ----comment +---This will send a notify message of the type and time passed ---@param message string ---@param _type string ---@param time number @@ -34,7 +34,7 @@ Notify.SendNotify = function(message, _type, time) end end ----comment +---This will show a help text message at the screen position passed ---@param message string ---@param _position string ---@return nil @@ -61,6 +61,8 @@ Notify.ShowHelpText = function(message, _position) end end +---This will hide the help text message on the screen +---@return nil Notify.HideHelpText = function() if helptextType == 'ox' then return exports.ox_lib:hideTextUI() diff --git a/modules/notify/_default/server.lua b/modules/notify/_default/server.lua index 759bdb2..9f7cb47 100644 --- a/modules/notify/_default/server.lua +++ b/modules/notify/_default/server.lua @@ -1,6 +1,6 @@ Notify = Notify or {} ----comment +---This will send a notification to the specified player of the passed message and type ---@param src number ---@param message string ---@param _type string @@ -9,7 +9,7 @@ Notify.SendNotify = function(src, message, _type, time) TriggerClientEvent('community_bridge:Client:Notify', src, message, _type, time) end ----comment +---This will show a help text message to the specified player at the screen position passed ---@param src number ---@param message string ---@param position string @@ -17,6 +17,8 @@ Notify.ShowHelpText = function(src, message, position) TriggerClientEvent('community_bridge:Client:ShowHelpText', src, message, position) end +---This will hide the help text message on the screen for the specified player +---@param src number Notify.HideHelpText = function(src) TriggerClientEvent('community_bridge:Client:HideHelpText', src) end \ No newline at end of file diff --git a/modules/shops/_default/client.lua b/modules/shops/_default/client.lua index e68c3b4..cc7e377 100644 --- a/modules/shops/_default/client.lua +++ b/modules/shops/_default/client.lua @@ -7,30 +7,7 @@ RegisterNetEvent('community_bridge:openShop', function(_type, _title, shopData) Shops.OpenShop(_title, shopData.inventory) end) -Shops.FinalizeCheckOut = function(shopName, item, itemLabel, price) - if not shopName and not item and not itemLabel and not price then return end - local generatedID = Ids.CreateUniqueId() - local buildMenu = { - { - title = locale('Shops.PayByCash')..tostring(price), - description = locale('Shops.AreYouSure') .. itemLabel, - icon = "fa-solid fa-money-bill-wave", - onSelect = function(_, __, ___) - TriggerServerEvent('community_bridge:completeCheckout', shopName, item, "cash") - end - }, - { - title = locale('Shops.PayByCard')..tostring(price), - description = locale('Shops.AreYouSure') .. itemLabel, - icon = "fa-solid fa-building-column", - onSelect = function(_, __, ___) - TriggerServerEvent('community_bridge:completeCheckout', shopName, item, "bank") - end - } - } - Bridge.Menu.Open({ id = generatedID, title = locale("Shops.Confirm"), options = buildMenu }, false) -end - +---This is an internal event that is used to complete a transaction and offer cash/card pay Shops.FinalizeCheckOut = function(shopName, item, itemLabel, price, amount) if not shopName and not item and not itemLabel and not price then return end local mathStuff = tonumber(price) * tonumber(amount) @@ -56,6 +33,11 @@ Shops.FinalizeCheckOut = function(shopName, item, itemLabel, price, amount) Menu.Open({ id = generatedID, title = locale("Shops.Input"), options = buildMenu }, false) end +---This is an internal event that is used to open the amount select menu +---@param shopName string +---@param item string +---@param itemLabel string +---@param price number Shops.AmountSelect = function(shopName, item, itemLabel, price) if not shopName and not item and not itemLabel and not price then return end local numberOptions = {} @@ -71,6 +53,11 @@ Shops.AmountSelect = function(shopName, item, itemLabel, price) end end +---This will open a shop with the passed title and data. It will create a menu with the items in the shopData table. The items will be clickable and will open a checkout menu. +---This also verifies the shop exsists and was made first server side. This will not work when only used client side and the server side verifies the item exsists in the table as well as the shop id. +---@param title any +---@param shopData any +---@return nil Shops.OpenShop = function(title, shopData) if not title and not shopData and not title then return print("No Title Passed") end local generatedID = Ids.CreateUniqueId() diff --git a/modules/shops/_default/server.lua b/modules/shops/_default/server.lua index edf4737..708c6fd 100644 --- a/modules/shops/_default/server.lua +++ b/modules/shops/_default/server.lua @@ -2,20 +2,37 @@ Shops = Shops or {} local registeredShops = {} +---commentThis can open a shop for the client +---@param src number +---@param shopTitle string +---@return boolean Shops.OpenShop = function(src, shopTitle) if not shopTitle and not registeredShops[shopTitle] then return false end TriggerClientEvent('community_bridge:openShop', src, 'shop', shopTitle, registeredShops[shopTitle]) + return true end +---This will create a shop to use on the client side, shops must be registered server side and exsist in the shop inventory table to allow any purchases passed. +---@param shopTitle string +---@param shopInventory table +---@param shopCoords table +---@param shopGroups table +---@return boolean Shops.CreateShop = function(shopTitle, shopInventory, shopCoords, shopGroups) - if not shopTitle and not shopInventory and not shopCoords then return end + if not shopTitle and not shopInventory and not shopCoords then return false end if registeredShops[shopTitle] then return true end registeredShops[shopTitle] = {name = shopTitle, inventory = shopInventory, shopCoords = shopCoords, groups = shopGroups} return true end +---This is an internal event to complete a shop transaction, it will verify pass items and amounts are registered to the created shop. +---@param src number +---@param shopName string +---@param item string +---@param amount number +---@param paymentType string +---@return nil Shops.CompleteCheckout = function(src, shopName, item, amount, paymentType) - if not src and not shopName and not item and not amount and not paymentType then return end local ilocale = Language.Locale local shopData = registeredShops[shopName] diff --git a/unit_tests/locale_test.lua b/unit_tests/locale_test.lua new file mode 100644 index 0000000..3b55377 --- /dev/null +++ b/unit_tests/locale_test.lua @@ -0,0 +1,19 @@ +-- if outside this resource, use local whatever = Require("modules/locales/shared.lua") +-- whatever.Locales("some-index-in-language-.json-file") +-- Files must be stored in "locales" folder, within the resource. +-- Instead of using Require you can also import it via the manifest. +-- The Lang variable is available globally, which tells you what the server is using. +-- print("Language: ", Lang) +-- print("Locale: ", Language.Locale("locale-unit-test")) + +-- Example outside community bridge resource: + +-- local Language = Require('modules/locales/shared.lua') +-- print("Language: ", Lang) +-- print("Locale: ", Language.Locale("locale-unit-test")) +RegisterCommand("lang", function(source, args, raw) + print(Language.Locale("UNITTEST.UNITTEST.UNITTESTA")) + print(Language.Locale("UNITTEST.UNITTESTA", "Devil", "GERRRRRRR!")) + + print( "Oh also this works", Language.Locale("place_object_scroll_down")) +end, false) \ No newline at end of file