DUI

DUI (Dynamic UI) allows you to render a web page as a texture on any in-game surface — screens, billboards, laptops, phones, etc.

CreateDui

Creates a new DUI instance.

local dui = KOJA.Client.CreateDui(opts)

Field	Type	Default	Description
url	string	—	URL to load inside the DUI
width	number	1280	Texture width in pixels
height	number	720	Texture height in pixels

Returns DuiInstance

DuiInstance

Properties

Property	Type	Description
id	string	Unique identifier
url	string	Current URL
handle	long	Native DUI handle
txd	string	Texture dictionary name
txn	string	Texture name

Methods

setUrl

Navigate the DUI to a new URL.

dui:setUrl(newUrl)

sendMessage

Send a JSON-serialisable message into the DUI's JavaScript.

dui:sendMessage(message)

The web page receives it as a message event. In your JS/TS:

window.addEventListener('message', (event) => {
    console.log(event.data)
})

getHandle / getTextureDict / getTextureName

dui:getHandle()       -- long
dui:getTextureDict()  -- string (txd name)
dui:getTextureName()  -- string (txn name)

replaceTexture

Replace an existing game texture with this DUI's texture.

dui:replaceTexture(originalTxd, originalTxn)

removeReplaceTexture

Restore the original texture.

dui:removeReplaceTexture(originalTxd, originalTxn)

destroy

Destroy the DUI and free resources.

dui:destroy()

Examples

Replace a game texture (e.g. a TV screen)

local dui = KOJA.Client.CreateDui({
    url    = 'https://www.youtube.com/embed/dQw4w9WgXcQ',
    width  = 1280,
    height = 720,
})

-- Replace the TV screen texture
dui:replaceTexture('prop_tv_flat_01', 'prop_tv_flat_01_emissive')

-- When done:
dui:removeReplaceTexture('prop_tv_flat_01', 'prop_tv_flat_01_emissive')
dui:destroy()

Draw DUI on a custom surface using scaleform

local dui = KOJA.Client.CreateDui({ url = 'nui://my-resource/screen.html' })

CreateThread(function()
    while true do
        Wait(0)
        DrawSprite(dui:getTextureDict(), dui:getTextureName(), 0.5, 0.5, 1.0, 1.0, 0.0, 255, 255, 255, 255)
    end
end)

Send live data to the DUI

local dui = KOJA.Client.CreateDui({ url = 'nui://my-resource/hud.html' })

CreateThread(function()
    while true do
        Wait(1000)
        dui:sendMessage({
            action = 'updateSpeed',
            speed  = GetEntitySpeed(GetPlayerPed(-1)) * 3.6,
        })
    end
end)