LoadBrowserURL: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:


===Required arguments===
===Required arguments===
*'''webBrowser:''' The [[browser]] element which will load the URL
*'''webBrowser:''' The [[Element/Browser|browser]] element which will load the URL
*'''url:''' The url you want to load. It can either contain a remote website ("http://" prefix) or a website stored within a local resource ("gui.html" for example).
*'''url:''' The url you want to load. It can either contain a remote website ("http://" prefix) or a website stored within a local resource ("http://local/gui.html" for example).


===Returns===
===Returns===
Line 18: Line 18:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
-- In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()
local screenWidth, screenHeight = guiGetScreenSize()


--Let's create a new browser in local mode. We will not be able to load an external URL.
-- 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)
local webBrowser = createBrowser(screenWidth, screenHeight, false, false)
--This is the function to render the browser.
-- This is the function to render the browser.
function webBrowserRender()
function webBrowserRender()
--Render the browser on the full size of the screen.
-- 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)
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end
end


--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- 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.
-- After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser,  
addEventHandler("onClientBrowserCreated", webBrowser,  
function()
function()
--After the browser has been initialized, we can load our file.
-- After the browser has been initialized, we can load our website.
loadBrowserURL(webBrowser, "html/site.html")
loadBrowserURL(webBrowser, "https://www.youtube.com/")
--Now we can start to render the browser.
 
-- Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
addEventHandler("onClientRender", root, webBrowserRender)
end
end

Revision as of 10:01, 18 August 2015

This function loads the specified URL.

Syntax

bool loadBrowserURL ( browser webBrowser, string url )

OOP Syntax Help! I don't understand this!

Method: browser:loadURL(...)
Counterpart: loadBrowserURL


Required arguments

  • webBrowser: The browser element which will load the URL
  • url: The url you want to load. It can either contain a remote website ("http://" prefix) or a website stored within a local resource ("http://local/gui.html" for example).

Returns

Returns true if the URL was successfully loaded.

Example

-- 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, false, 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 website.
		loadBrowserURL(webBrowser, "https://www.youtube.com/")

		-- Now we can start to render the browser.
		addEventHandler("onClientRender", root, webBrowserRender)
	end
)

See also