Documentation
Browser

Browser

All Lua functions and events in the Browser category, on the server and the client.

Client functions 45

canBrowserNavigateBackChecks whether the browser history has a previous page.
canBrowserNavigateForwardChecks whether the browser history has a next page.
createBrowserCreates a browser: an HTML page rendered into a texture. Draw it with dxDrawImage and load the address only in the onClientBrowserCreated event.
evaluateBrowserJavascriptRuns JavaScript on a local page and returns its result to Lua. If the code returns a Promise, the function waits for it.
executeBrowserJavascriptRuns JavaScript on the page. Works on local browsers only.
focusBrowserGives the keyboard to a browser. Typing goes to the page when one of its text fields is active and the cursor is shown. nil removes focus from all browsers.
getBrowserFrameRateReturns how many times per second the page is redrawn.
getBrowserPixelAlphaReturns the opacity of a page pixel. Useful for letting clicks on transparent parts of a HUD go through to the game.
getBrowserPropertyReturns a browser property. "mobile" (phone view) is supported.
getBrowsersReturns every browser created by scripts.
getBrowserSettingsReturns the browser settings chosen by the player (ESC, Settings, Browser).
getBrowserSizeReturns the browser size in pixels.
getBrowserSourceFetches the HTML of the current page and passes it to a function.
getBrowserTitleReturns the page title (from <title>).
getBrowserURLReturns the page's current address.
getBrowserVolumeReturns one browser's volume or, with no argument, the volume of all browsers.
getBrowserZoomReturns the page zoom (1 is 100%).
injectBrowserCharacterTypes text into the page's active field, character by character (keypress / input events), including accented letters and other UTF-8 characters.
injectBrowserKeySends a key press or release to the page (e.g. Enter, Backspace, arrows), as if the player pressed it on the keyboard. The page gets normal keydown / keyup events. Use injectBrowserCharacter to type text.
injectBrowserMouseDownPresses a mouse button on the page at the position of the last injectBrowserMouseMove. Two presses at the same spot within 0.5 s reach the page as a double click, three as a triple click (paragraph selection), like in Windows.
injectBrowserMouseMoveMoves the mouse cursor on the page.
injectBrowserMouseUpReleases a mouse button on the page.
injectBrowserMouseWheelScrolls the page with the mouse wheel. Negative values scroll down and right.
isBrowserDomainBlockedChecks whether a domain (or address) is unavailable to web browsers: because of the blacklist, missing player consent or disabled remote pages.
isBrowserFocusedChecks whether the browser has keyboard focus.
isBrowserGPUEnabledChecks whether pages are drawn by the graphics card.
isBrowserLoadingChecks whether the page is still loading.
isBrowserLocalChecks whether the browser is local (resource files) rather than remote (internet).
isBrowserRenderingPausedChecks whether page rendering is paused.
isBrowserSupportedChecks whether the game can create browsers.
loadBrowserURLLoads an address in the browser. A local browser opens resource files, a remote one opens pages from allowed domains.
navigateBrowserBackGoes to the previous page in the history.
navigateBrowserForwardGoes to the next page in the history.
reloadBrowserPageReloads the current page.
requestBrowserDomainsAsks the player for permission to open pages from the given domains. A domain must be on the server's list (browser_domains in server-config.json); others are rejected without asking. Consent is remembered.
resizeBrowserChanges the browser size.
setBrowserAjaxHandlerAnswers page requests to a path from Lua, e.g. fetch("http://trilogy/local/api"). The function returns the response body and optionally a MIME type. With no function the handler is removed.
setBrowserFrameRateSets how many times per second the page redraws (1-240, default 60). Fewer frames mean less CPU work, for example for a HUD that rarely changes; more frames give smoother animations on monitors above 60 Hz.
setBrowserFunctionExposes a Lua function to a local page. In JavaScript you call it with await trilogy.call("name", ...) and get its result.
setBrowserPropertySets a browser property. "mobile" is supported: "1" turns on the phone view.
setBrowserRenderingPausedPauses or resumes page rendering. A paused page does not load the CPU while it is hidden.
setBrowserVolumeSets the volume of one browser or, when you pass just a number, of all browsers.
setBrowserZoomSets the page zoom (0.25-5, 1 is 100%).
toggleBrowserDevToolsOpens or closes the page's developer tools. Requires setDevelopmentMode(true, true) and "browser_devtools": true in server-config.json.
triggerBrowserEventSends an event from Lua to a local page. In JavaScript you receive it with trilogy.on("name", fn), without building code in a string.

Client functions 45

Client events 27