SetBrowserProperty: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Added example)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs Example}}
{{New feature/item|3.0150|1.5||
{{New feature/item|3.0150|1.5||
This function sets a given property of a specified browser.
This function sets a given property of a specified browser.
Line 22: Line 21:


==Example==
==Example==
TODO
This example will add a command handler for 'mobile' that will toggle mobile browsing for all browsers.
<syntaxhighlight lang="lua">
addCommandHandler("mobile",
    function ()
        for i, browser in pairs(getElementsByType("webbrowser")) do
            setBrowserProperty(browser, "mobile", getBrowserProperty(browser, "mobile") == "1" and "0" or "1")
        end
    end)
</syntaxhighlight>


==See also==
==See also==
{{CEF_functions}}
{{CEF_functions}}

Revision as of 22:44, 15 July 2017

This function sets a given property of a specified browser.

Syntax

bool setBrowserProperty ( browser theBrowser, string key, string value )

OOP Syntax Help! I don't understand this!

Method: browser:setProperty(...)
Counterpart: getBrowserProperty


Required arguments

  • theBrowser: The browser element you want to set a property of
  • key: The browser property key. It can be:
    • mobile: Surfing the web as mobile
  • value: A value indicating whether to enable ("1") the property or not ("0")

Returns

Returns true if the property was successfully set, false otherwise.

Example

This example will add a command handler for 'mobile' that will toggle mobile browsing for all browsers.

addCommandHandler("mobile",
    function ()
        for i, browser in pairs(getElementsByType("webbrowser")) do
            setBrowserProperty(browser, "mobile", getBrowserProperty(browser, "mobile") == "1" and "0" or "1")
        end
    end)

See also