DgsCreateBrowser

From Multi Theft Auto: Wiki
Jump to: navigation, search

This function creates a browser handled and rendered by dgs.

All of the functions of browser are available.

Syntax

element dgsCreateBrowser ( float x, float y, float width, float height, bool relative, [element parent = nil, bool isLocal = false, bool transparent = false, float browserWidth = width, float browserHeight = height, int color = 0xFFFFFFFF ] )

Required Arguments

  • x: A float of the 2D x position of the DGS browser on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the DGS browser on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the DGS browser. This is affected by the relative argument.
  • height: A float of the height of the DGS browser. This is affected by the relative argument.
  • relative: 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 relative to the parent.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • parent: This is the parent that the gui label 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.
  • isLocal: Sets whether the browser can only show local content or content from the internet. (see createBrowser)
  • transparent: true if you want the browser transparent, false for opaque. (see createBrowser)
  • browserWidth: The browser's native width. (see createBrowser)
  • browserHeight: The browser's native height. (see createBrowser)
  • color: An int of the color of the browser.

Returns

Returns a browser if it was successfully created, false otherwise.

Example

DGS = exports.dgs

local webBrowser = DGS:dgsCreateBrowser(200,200,400,400,false)

--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")
end)

See Also

Multi Language Supports

Animation

3D Interface

3D Text

Arrow List

Browser

  • dgsCreateBrowser

Button

Check Box

Combo Box

Edit

Ellipse Detect Area

Detect Area

Grid List

Image

Memo

Label

Progress Bar

Radio Button

Scroll Bar

Scroll Pane

Switch Button

Tab Panel

Window

Plugin

Media Browser

Rounded Rectangle