Difference between revisions of "StartDefaultBrowser"
From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: | Line 1: | ||
− | + | ==startDefaultBrowser== | |
− | |||
− | |||
− | |||
− | |||
+ | <div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div> | ||
− | + | <div class="command-doc">Open an url in user's default browser or in the steam overlay (if active).</div> | |
− | + | Lua Syntax: | |
− | + | <pre class="command-syntax">startDefaultBrowser(Url)</pre> | |
+ | ===Arguments=== | ||
+ | ====Url==== | ||
+ | :'''"string"''' - The url which should be opened | ||
+ | ===Flags=== | ||
+ | ===Return Values=== | ||
+ | ;status | ||
+ | :True if browser was successfully launched, false otherwise. | ||
+ | ===Examples=== | ||
+ | Example 1: launch default browser & open included link, if browser is already running then open link in a new tab | ||
<syntaxhighlight> | <syntaxhighlight> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
startDefaultBrowser("http://visionaire-studio.net") | startDefaultBrowser("http://visionaire-studio.net") | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Revision as of 17:12, 22 November 2013
startDefaultBrowser
Available since: v3.0
Open an url in user's default browser or in the steam overlay (if active).
Lua Syntax:
startDefaultBrowser(Url)
Arguments
Url
- "string" - The url which should be opened
Flags
Return Values
- status
- True if browser was successfully launched, false otherwise.
Examples
Example 1: launch default browser & open included link, if browser is already running then open link in a new tab
startDefaultBrowser("http://visionaire-studio.net")