guiCreateBrowser

Client-side

Server-side

Shared

This function creates a new CEGUI web browser element.

Note

Minimum size of the browser is 1x1.
If the user disabled remote pages and isLocal was set to false, the function will return false.

OOP Syntax Help! I don't understand this!

Constructor: GuiBrowser (...)

Syntax

gui-browser|false guiCreateBrowser ( float x, float y, float width, float height, bool isLocal, bool isTransparent, [ bool isRelative = false, gui-element parent = nil ] )

Required arguments

x: A float of the 2D X position of the browser on a player's screen. This is affected by the relative argument.
y: A float of the 2D Y position of the browser on a player's screen. This is affected by the relative argument.
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 over here for more information).
isTransparent: true if you want the browser to support transparency, false otherwise.

Optional arguments

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

isRelative (default: false): This is whether sizes and positioning are relative. If this is true, then all x, y, width, height floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and coordinates are based on client's resolution, accessible using guiGetScreenSize.
parent (default: nil): This is the parent that the browser is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

Returns

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

gui-browser|false: browser element

Code Examples

client

This examples simply creates a web browser and loads an URL.

local browserGUI = guiCreateBrowser(100, 100, 300, 50, true, true, false)
local browser = guiGetBrowser(browserGUI)

addEventHandler("onClientBrowserCreated", browser, function()
    loadBrowserURL(browser, "http://mta/local/html/index.html")
end)

guiCreateBrowser

OOP Syntax Help! I don't understand this!

Syntax

Required arguments

Optional arguments

Returns

Code Examples

See Also

GUI Functions

GUI Elements

Reference