Browser::active: Difference between revisions

From RAGE Multiplayer Wiki
(Created page with "'''Function''': Gets or sets if the browser is active ==Parameters== * '''Toggle''': {{RageType|Boolean}} ==Syntax== {{ClientsideCode| <pre> browser.active; </pre> }} ==Exa...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
'''Function''': Gets or sets if the browser is active
{{ClientsideJsFunction}}
{{JSContainer|


==Parameters==
'''Change or get browser active state. Active state is true by default when creating a browser, setting a browser's active property to false will hide it, and true will show it.'''
* '''Toggle''': {{RageType|Boolean}}
 
===Params===
* '''enable''': {{RageType|boolean}}
 
===Return value===
*''' {{RageType|boolean}} '''


==Syntax==
==Syntax==
{{ClientsideCode|
<syntaxhighlight lang="javascript">
<pre>
browser.active; //getter
browser.active;
browser.active = value; //setter
</pre>
</syntaxhighlight>
}}


==Example==
==Example==
Setter:
<syntaxhighlight lang="javascript">
{{ClientsideCode|
const mybrowser = mp.browsers.new('http://package/page/index.html');
<pre>
mp.events.add('client::browser:changeState', (state) => {
let browser = mp.browsers.new("package://index.html");
    mybrowser.active = state;
browser.active = false";
    mp.console.logInfo(`You have ${state ? "enabled" : "disabled"} browser id ${mybrowser.id}`)
</pre>
})
</syntaxhighlight>
}}
}}
Getter:
==See also==
{{ClientsideCode|
<pre>
let active = browser.active;
</pre>
}}
See [[Package Protocol]] for more info on the <code>package://</code> url.
 
==See Also==
{{Browser_definition_c}}
{{Browser_definition_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:TODO: Example]]

Latest revision as of 17:28, 2 July 2024

Client-Side
Function

 JavaScript



JavaScript Syntax


Change or get browser active state. Active state is true by default when creating a browser, setting a browser's active property to false will hide it, and true will show it.

Params

  • enable: boolean

Return value

  • boolean

Syntax

browser.active; //getter
browser.active = value; //setter

Example

const mybrowser = mp.browsers.new('http://package/page/index.html');
mp.events.add('client::browser:changeState', (state) => {
    mybrowser.active = state;
    mp.console.logInfo(`You have ${state ? "enabled" : "disabled"} browser id ${mybrowser.id}`)
})


See also