From 3c20728860b5a9eefb549724695caccc704a5f20 Mon Sep 17 00:00:00 2001 From: Zuntie Date: Sun, 9 Nov 2025 02:44:10 +0100 Subject: [PATCH 1/3] feat(esx_lib): initial DUI addition --- [core]/esx_lib/imports/dui/client.lua | 118 ++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 [core]/esx_lib/imports/dui/client.lua diff --git a/[core]/esx_lib/imports/dui/client.lua b/[core]/esx_lib/imports/dui/client.lua new file mode 100644 index 00000000..613a55d3 --- /dev/null +++ b/[core]/esx_lib/imports/dui/client.lua @@ -0,0 +1,118 @@ +--[[ + https://github.com/overextended/ox_lib + + This file is licensed under LGPL-3.0 or higher + + Copyright © 2025 Linden +]] + +---@class DuiProperties +---@field url string +---@field width number +---@field height number +---@field debug? boolean + +---@class Dui +---@field private private { id: string, debug: boolean } +---@field url string +---@field duiObject number +---@field duiHandle string +---@field runtimeTxd number +---@field txdObject number +---@field dictName string +---@field txtName string +xLib.dui = xLib.class() + +---@type table +local duis = {} + +local currentId = 0 + +---@param data DuiProperties +function xLib.dui:constructor(data) + local time = GetGameTimer() + local id = ("%s_%s_%s"):format(cache.resource, time, currentId) + currentId = currentId + 1 + local dictName = ('ox_lib_dui_dict_%s'):format(id) + local txtName = ('ox_lib_dui_txt_%s'):format(id) + local duiObject = CreateDui(data.url, data.width, data.height) + local duiHandle = GetDuiHandle(duiObject) + local runtimeTxd = CreateRuntimeTxd(dictName) + local txdObject = CreateRuntimeTextureFromDuiHandle(runtimeTxd, txtName, duiHandle) + self.private.id = id + self.private.debug = data.debug or false + self.url = data.url + self.duiObject = duiObject + self.duiHandle = duiHandle + self.runtimeTxd = runtimeTxd + self.txdObject = txdObject + self.dictName = dictName + self.txtName = txtName + duis[id] = self + + if self.private.debug then + print(('Dui %s created'):format(id)) + end +end + +function xLib.dui:remove() + SetDuiUrl(self.duiObject, 'about:blank') + DestroyDui(self.duiObject) + duis[self.private.id] = nil + + if self.private.debug then + print(('Dui %s removed'):format(self.private.id)) + end +end + +---@param url string +function xLib.dui:setUrl(url) + self.url = url + SetDuiUrl(self.duiObject, url) + + if self.private.debug then + print(('Dui %s url set to %s'):format(self.private.id, url)) + end +end + +---@param message table +function xLib.dui:sendMessage(message) + SendDuiMessage(self.duiObject, json.encode(message)) + + if self.private.debug then + print(('Dui %s message sent with data :'):format(self.private.id), json.encode(message, { indent = true })) + end +end + +---@param x number +---@param y number +function xLib.dui:sendMouseMove(x, y) + SendDuiMouseMove(self.duiObject, x, y) +end + +---@param button 'left' | 'middle' | 'right' +function xLib.dui:sendMouseDown(button) + SendDuiMouseDown(self.duiObject, button) +end + +---@param button 'left' | 'middle' | 'right' +function xLib.dui:sendMouseUp(button) + SendDuiMouseUp(self.duiObject, button) +end + +---@param deltaX number +---@param deltaY number +function xLib.dui:sendMouseWheel(deltaX, deltaY) + SendDuiMouseWheel(self.duiObject, deltaY, deltaX) +end + + +AddEventHandler('onResourceStop', function(resourceName) + if cache.resource ~= resourceName then return end + + for _, dui in pairs(duis) do + dui:remove() + end +end) + +return xLib.dui From edcfa009fb11266fbd9b1128323ed538b1826725 Mon Sep 17 00:00:00 2001 From: Zuntie Date: Sun, 9 Nov 2025 02:49:24 +0100 Subject: [PATCH 2/3] feat(esx_lib): DUI development guidelines compliant --- [core]/esx_lib/imports/dui/client.lua | 44 +++++++++++++-------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/[core]/esx_lib/imports/dui/client.lua b/[core]/esx_lib/imports/dui/client.lua index 613a55d3..4b8ffae1 100644 --- a/[core]/esx_lib/imports/dui/client.lua +++ b/[core]/esx_lib/imports/dui/client.lua @@ -13,7 +13,8 @@ ---@field debug? boolean ---@class Dui ----@field private private { id: string, debug: boolean } +---@field private_id string +---@field private_debug boolean ---@field url string ---@field duiObject number ---@field duiHandle string @@ -24,7 +25,7 @@ xLib.dui = xLib.class() ---@type table -local duis = {} +local Duis = {} local currentId = 0 @@ -33,14 +34,14 @@ function xLib.dui:constructor(data) local time = GetGameTimer() local id = ("%s_%s_%s"):format(cache.resource, time, currentId) currentId = currentId + 1 - local dictName = ('ox_lib_dui_dict_%s'):format(id) - local txtName = ('ox_lib_dui_txt_%s'):format(id) + local dictName = ("ox_lib_dui_dict_%s"):format(id) + local txtName = ("ox_lib_dui_txt_%s"):format(id) local duiObject = CreateDui(data.url, data.width, data.height) local duiHandle = GetDuiHandle(duiObject) local runtimeTxd = CreateRuntimeTxd(dictName) local txdObject = CreateRuntimeTextureFromDuiHandle(runtimeTxd, txtName, duiHandle) - self.private.id = id - self.private.debug = data.debug or false + self.private_id = id + self.private_debug = data.debug or false self.url = data.url self.duiObject = duiObject self.duiHandle = duiHandle @@ -48,20 +49,20 @@ function xLib.dui:constructor(data) self.txdObject = txdObject self.dictName = dictName self.txtName = txtName - duis[id] = self + Duis[id] = self - if self.private.debug then - print(('Dui %s created'):format(id)) + if self.private_debug then + print(("Dui %s created"):format(id)) end end function xLib.dui:remove() - SetDuiUrl(self.duiObject, 'about:blank') + SetDuiUrl(self.duiObject, "about:blank") DestroyDui(self.duiObject) - duis[self.private.id] = nil + Duis[self.private_id] = nil - if self.private.debug then - print(('Dui %s removed'):format(self.private.id)) + if self.private_debug then + print(("Dui %s removed"):format(self.private_id)) end end @@ -70,8 +71,8 @@ function xLib.dui:setUrl(url) self.url = url SetDuiUrl(self.duiObject, url) - if self.private.debug then - print(('Dui %s url set to %s'):format(self.private.id, url)) + if self.private_debug then + print(("Dui %s url set to %s"):format(self.private_id, url)) end end @@ -79,8 +80,8 @@ end function xLib.dui:sendMessage(message) SendDuiMessage(self.duiObject, json.encode(message)) - if self.private.debug then - print(('Dui %s message sent with data :'):format(self.private.id), json.encode(message, { indent = true })) + if self.private_debug then + print(("Dui %s message sent with data :"):format(self.private_id), json.encode(message, { indent = true })) end end @@ -90,12 +91,12 @@ function xLib.dui:sendMouseMove(x, y) SendDuiMouseMove(self.duiObject, x, y) end ----@param button 'left' | 'middle' | 'right' +---@param button "left" | "middle" | "right" function xLib.dui:sendMouseDown(button) SendDuiMouseDown(self.duiObject, button) end ----@param button 'left' | 'middle' | 'right' +---@param button "left" | "middle" | "right" function xLib.dui:sendMouseUp(button) SendDuiMouseUp(self.duiObject, button) end @@ -106,11 +107,10 @@ function xLib.dui:sendMouseWheel(deltaX, deltaY) SendDuiMouseWheel(self.duiObject, deltaY, deltaX) end - -AddEventHandler('onResourceStop', function(resourceName) +AddEventHandler("onResourceStop", function(resourceName) if cache.resource ~= resourceName then return end - for _, dui in pairs(duis) do + for _, dui in pairs(Duis) do dui:remove() end end) From 1a27c365b677ea1d19ced371505d240e37bd0143 Mon Sep 17 00:00:00 2001 From: Zuntie Date: Sun, 9 Nov 2025 17:44:52 +0100 Subject: [PATCH 3/3] fix(esx_lib): changed runtime texture names; tiny performance optimizaion. Working, Finished. --- [core]/esx_lib/imports/dui/client.lua | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/[core]/esx_lib/imports/dui/client.lua b/[core]/esx_lib/imports/dui/client.lua index 4b8ffae1..3fd9eb61 100644 --- a/[core]/esx_lib/imports/dui/client.lua +++ b/[core]/esx_lib/imports/dui/client.lua @@ -24,6 +24,8 @@ ---@field txtName string xLib.dui = xLib.class() +local resource = GetCurrentResourceName() + ---@type table local Duis = {} @@ -32,10 +34,10 @@ local currentId = 0 ---@param data DuiProperties function xLib.dui:constructor(data) local time = GetGameTimer() - local id = ("%s_%s_%s"):format(cache.resource, time, currentId) + local id = ("%s_%s_%s"):format(resource, time, currentId) currentId = currentId + 1 - local dictName = ("ox_lib_dui_dict_%s"):format(id) - local txtName = ("ox_lib_dui_txt_%s"):format(id) + local dictName = ("%s_dui_dict_%s"):format(resource, id) + local txtName = ("%s_lib_dui_txt_%s"):format(resource, id) local duiObject = CreateDui(data.url, data.width, data.height) local duiHandle = GetDuiHandle(duiObject) local runtimeTxd = CreateRuntimeTxd(dictName) @@ -108,11 +110,11 @@ function xLib.dui:sendMouseWheel(deltaX, deltaY) end AddEventHandler("onResourceStop", function(resourceName) - if cache.resource ~= resourceName then return end + if resource ~= resourceName then return end - for _, dui in pairs(Duis) do - dui:remove() - end + for id in next, Duis do + Duis[id]:remove() + end end) -return xLib.dui +return xLib.dui \ No newline at end of file