This function creates a new web browser element.

Tip

You can also enable CEF development tools using toggleBrowserDevTools.

Note

For local files as url please read Local Scheme Handler.

OOP Syntax Help! I don't understand this!

• Constructor: browser (...)

Syntax

​element|false createBrowser ( ​int width, ​int height, ​bool isLocal, [ ​bool transparent = false ] )

Required arguments

• width: The browser's native width. This should be greater than or equal to 1.
• height: The browser's native height. This should be greater than or equal to 1.
• isLocal: Sets whether the browser can only show local content or content from the internet (see examples for more information).

Optional arguments

Note: when using optional arguments, you might need to supply all arguments before the one you wish to use.

• transparent (default: false): true if you want the browser transparent, false for opaque.

Returns

Returns a texture of the browser if it was created successfully, false otherwise. Returns also false, if the user disabled remote pages and isLocal was set to false.

• element|false: new browser

Code Examples

Example 1 Example 2 (OOP) Example 3

client

This example shows you how to create a fullscreen web browser (showing a local html file) without input-handling.

-- In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

-- Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = createBrowser(screenWidth, screenHeight, true, false)

-- This is the function to render the browser.
function webBrowserRender()
    -- Render the browser on the full size of the screen.
    dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255, 255, 255, 255), true)
end

-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser, function()
    -- After the browser has been initialized, we can load our file.
    loadBrowserURL(webBrowser, "http://mta/local/html/site.html")
    -- Now we can start to render the browser.
    addEventHandler("onClientRender", root, webBrowserRender)
end)

client

OOP Required

This example shows you how to create a fullscreen web browser (showing a local html file) without input-handling.

-- In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = GuiElement.getScreenSize()

-- Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = Browser(screenWidth, screenHeight, true, false)

-- This is the function to render the browser.
function webBrowserRender()
    -- Render the browser on the full size of the screen.
    dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255, 255, 255, 255), true)
end

-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser, function()
    -- After the browser has been initialized, we can load our file.
    webBrowser.url = "http://mta/local/html/site.html"
    -- Now we can start to render the browser.
    addEventHandler("onClientRender", root, webBrowserRender)
end)

client

This example shows you how to create a fullscreen web browser (showing youtube.com) without input-handling. Remember, that youtube.com is on the global whitelist. If you want to load a domain/page that is not on the global whitelist, you have to request it with requestBrowserDomains.

-- In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

-- Let's create a new browser in remote mode.
local webBrowser = createBrowser(screenWidth, screenHeight, false, false)

-- Function to render the browser.
function webBrowserRender()
    -- Render the browser on the full size of the screen.
    dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255, 255, 255, 255), true)
end

-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser, function()
    -- After the browser has been initialized, we can load www.youtube.com
    loadBrowserURL(webBrowser, "http://www.youtube.com")
    -- Now we can start to render the browser.
    addEventHandler("onClientRender", root, webBrowserRender)
end)

See Also

Browser Functions

• canBrowserNavigateBack
• canBrowserNavigateForward
• createBrowser
• executeBrowserJavascript
• focusBrowser
• getBrowserProperty
• getBrowserSettings
• getBrowserSource
• getBrowserTitle
• getBrowserURL
• injectBrowserMouseDown
• injectBrowserMouseMove
• injectBrowserMouseUp
• injectBrowserMouseWheel
• isBrowserDomainBlocked
• isBrowserFocused
• isBrowserGPUEnabled
• isBrowserLoading
• isBrowserRenderingPaused
• loadBrowserURL
• navigateBrowserBack
• navigateBrowserForward
• reloadBrowserPage
• requestBrowserDomains
• resizeBrowser
• setBrowserAjaxHandler
• setBrowserProperty
• setBrowserRenderingPaused
• setBrowserVolume
• toggleBrowserDevTools

Browser Events

• onClientBrowserCreated
• onClientBrowserCursorChange
• onClientBrowserDocumentReady
• onClientBrowserInputFocusChanged
• onClientBrowserLoadingFailed
• onClientBrowserLoadingStart
• onClientBrowserNavigate
• onClientBrowserPopup
• onClientBrowserResourceBlocked
• onClientBrowserTooltip
• onClientBrowserWhitelistChange

Browser Elements

• browser

Reference

• Scripting Functions