DgsCreateBrowser: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This function creates a browser handled by dgs.
This function creates a browser handled and rendered by dgs.


All of the functions of browser are available.
All of the functions of browser are available.
 
{{Note|
*You have to use '''http://mta/resourceName/html/index.html''' instead of '''http://mta/local/html/index.html''', because the '''local''' is relative to the resource that creates the browser. DGS browser is created in DGS, this means '''local''' will be direct to '''DGS'''.}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
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 ] )
element dgsCreateBrowser ( float x, float y, float width, float height, bool relative [, element parent = nil, bool isLocal = false, bool isTransparent = false, float resolutionX = width, float resolutionY = height, int color = 0xFFFFFFFF ] )
</syntaxhighlight>  
</syntaxhighlight>


===Required Arguments===  
===Required Arguments===  
*'''x:''' A float of the 2D x position of the DGS label on a player's screen.  This is affected by the ''relative'' argument.
*'''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 label 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 GUI label. 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 GUI label. 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.
*'''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.


Line 21: Line 22:
*'''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.
*'''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]])
*'''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]])
*'''isTransparent:''' true if you want the browser isTransparent, false for opaque. (see [[createBrowser]])
*'''browserWidth:''' The browser's native width. (see [[createBrowser]])
*'''resolutionX:''' The browser's native width. (see [[createBrowser]])
*'''browserHeight:''' The browser's native height. (see [[createBrowser]])
*'''resolutionY:''' The browser's native height. (see [[createBrowser]])
*'''color:''' An int of the color of the browser.
*'''color:''' An int of the color of the browser.


Line 30: Line 31:


==Example==  
==Example==  
Remote Browser
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
Line 40: Line 42:
--After the browser has been initialized, we can load www.youtube.com
--After the browser has been initialized, we can load www.youtube.com
loadBrowserURL(webBrowser, "http://www.youtube.com")
loadBrowserURL(webBrowser, "http://www.youtube.com")
end)
</syntaxhighlight>
Local Browser
<syntaxhighlight lang="lua">
DGS = exports.dgs
local webBrowser = DGS:dgsCreateBrowser(200,200,400,400,false,nil,true)
--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 a local website
loadBrowserURL(webBrowser, "http://mta/"..getResourceName(resource).."/index.html" ) --Note: you need to specify the resource name in the url.
end)
end)
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 15:30, 1 July 2021

This function creates a browser handled and rendered by dgs.

All of the functions of browser are available.

[[{{{image}}}|link=|]] Note:

Syntax

element dgsCreateBrowser ( float x, float y, float width, float height, bool relative [, element parent = nil, bool isLocal = false, bool isTransparent = false, float resolutionX = width, float resolutionY = 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)
  • isTransparent: true if you want the browser isTransparent, false for opaque. (see createBrowser)
  • resolutionX: The browser's native width. (see createBrowser)
  • resolutionY: 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

Remote Browser 

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)

Local Browser 

DGS = exports.dgs

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

--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 a local website
	loadBrowserURL(webBrowser, "http://mta/"..getResourceName(resource).."/index.html" ) --Note: you need to specify the resource name in the url.
end)

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsCreateBrowser?oldid=71425"