ISteamHTMLSurface

Note

This documentation is auto-generated. Methods marked with 🤖 are automatically generated bindings. Methods marked with ✍️ are manually implemented and methods marked with ✋ are currently not implemented.

List of Functions

HTMLSurface.AddHeader()
HTMLSurface.AllowStartRequest()
HTMLSurface.CopyToClipboard()
HTMLSurface.CreateBrowser()
HTMLSurface.ExecuteJavascript()
HTMLSurface.Find()
HTMLSurface.GetLinkAtPosition()
HTMLSurface.GoBack()
HTMLSurface.GoForward()
HTMLSurface.Init()
HTMLSurface.JSDialogResponse()
HTMLSurface.KeyChar()
HTMLSurface.KeyDown()
HTMLSurface.KeyUp()
HTMLSurface.LoadURL()
HTMLSurface.MouseDoubleClick()
HTMLSurface.MouseDown()
HTMLSurface.MouseMove()
HTMLSurface.MouseUp()
HTMLSurface.MouseWheel()
HTMLSurface.OpenDeveloperTools()
HTMLSurface.PasteFromClipboard()
HTMLSurface.Reload()
HTMLSurface.RemoveBrowser()
HTMLSurface.SetBackgroundMode()
HTMLSurface.SetCookie()
HTMLSurface.SetDPIScalingFactor()
HTMLSurface.SetHorizontalScroll()
HTMLSurface.SetKeyFocus()
HTMLSurface.SetPageScaleFactor()
HTMLSurface.SetSize()
HTMLSurface.SetVerticalScroll()
HTMLSurface.Shutdown()
HTMLSurface.StopFind()
HTMLSurface.StopLoad()
HTMLSurface.ViewSource()

Function Reference

HTMLSurface.AddHeader(unBrowserHandle, pchKey, pchValue)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
pchKey (str?) –
pchValue (str?) –

SteamWorks:

AddHeader

HTMLSurface.AllowStartRequest(unBrowserHandle, bAllowed)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
bAllowed (bool) –

SteamWorks:

AllowStartRequest

HTMLSurface.CopyToClipboard(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: CopyToClipboard

HTMLSurface.CreateBrowser(pchUserAgent, pchUserCSS, callback)

🤖 Auto-generated binding

Parameters:

pchUserAgent (str?) –
pchUserCSS (str?) –
callback (function) – CallResult callback receiving struct HTML_BrowserReady_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

CreateBrowser

Example:

Steam.HTMLSurface.CreateBrowser(nil, nil, function(data, err)
    if not err then
        local hBrowser = data.unBrowserHandle
        Steam.HTMLSurface.SetSize(hBrowser, 1280, 720)
        Steam.HTMLSurface.LoadURL(hBrowser, 'https://store.steampowered.com', nil)
    end
end)

HTMLSurface.ExecuteJavascript(unBrowserHandle, pchScript)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
pchScript (str?) –

SteamWorks:

ExecuteJavascript

Example:

Steam.HTMLSurface.ExecuteJavascript(hBrowser, 'document.title = "Hello from Lua";')

HTMLSurface.Find(unBrowserHandle, pchSearchStr, bCurrentlyInFind, bReverse)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
pchSearchStr (str?) –
bCurrentlyInFind (bool) –
bReverse (bool) –

SteamWorks:

Find

Example:

Steam.HTMLSurface.Find(hBrowser, 'search term', false, false)

HTMLSurface.GetLinkAtPosition(unBrowserHandle, x, y)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
x (int) –
y (int) –

SteamWorks:

GetLinkAtPosition

HTMLSurface.GoBack(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: GoBack

Example:

Steam.HTMLSurface.GoBack(hBrowser)

HTMLSurface.GoForward(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: GoForward

Example:

Steam.HTMLSurface.GoForward(hBrowser)

HTMLSurface.Init()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: Init

Example:

Steam.HTMLSurface.Init()

HTMLSurface.JSDialogResponse(unBrowserHandle, bResult)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
bResult (bool) –

SteamWorks:

JSDialogResponse

HTMLSurface.KeyChar(unBrowserHandle, cUnicodeChar, eHTMLKeyModifiers)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
cUnicodeChar (int) –
eHTMLKeyModifiers (int - ISteamHTMLSurface::EHTMLKeyModifiers) –

SteamWorks:

KeyChar

Example:

Steam.HTMLSurface.KeyChar(hBrowser, string.byte(char), 0)

HTMLSurface.KeyDown(unBrowserHandle, nNativeKeyCode, eHTMLKeyModifiers, bIsSystemKey)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
nNativeKeyCode (int) –
eHTMLKeyModifiers (int - ISteamHTMLSurface::EHTMLKeyModifiers) –
bIsSystemKey (bool) –

SteamWorks:

KeyDown

Example:

Steam.HTMLSurface.KeyDown(hBrowser, nativeKeyCode, 0, false)

HTMLSurface.KeyUp(unBrowserHandle, nNativeKeyCode, eHTMLKeyModifiers)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
nNativeKeyCode (int) –
eHTMLKeyModifiers (int - ISteamHTMLSurface::EHTMLKeyModifiers) –

SteamWorks:

KeyUp

Example:

Steam.HTMLSurface.KeyUp(hBrowser, nativeKeyCode, 0)

HTMLSurface.LoadURL(unBrowserHandle, pchURL, pchPostData)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
pchURL (str?) –
pchPostData (str?) –

SteamWorks:

LoadURL

Notes:

See HTMLSurface.CreateBrowser()’s example.

HTMLSurface.MouseDoubleClick(unBrowserHandle, eMouseButton)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
eMouseButton (int - ISteamHTMLSurface::EHTMLMouseButton) –

SteamWorks:

MouseDoubleClick

HTMLSurface.MouseDown(unBrowserHandle, eMouseButton)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
eMouseButton (int - ISteamHTMLSurface::EHTMLMouseButton) –

SteamWorks:

MouseDown

Example:

Steam.HTMLSurface.MouseDown(hBrowser, Steam.eHTMLMouseButton_Left)

HTMLSurface.MouseMove(unBrowserHandle, x, y)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
x (int) –
y (int) –

SteamWorks:

MouseMove

Example:

-- Pass mouse events to the HTML surface
Steam.HTMLSurface.MouseMove(hBrowser, mouseX, mouseY)

HTMLSurface.MouseUp(unBrowserHandle, eMouseButton)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
eMouseButton (int - ISteamHTMLSurface::EHTMLMouseButton) –

SteamWorks:

MouseUp

Example:

Steam.HTMLSurface.MouseUp(hBrowser, Steam.eHTMLMouseButton_Left)

HTMLSurface.MouseWheel(unBrowserHandle, nDelta)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
nDelta (int) –

SteamWorks:

MouseWheel

Example:

Steam.HTMLSurface.MouseWheel(hBrowser, -120)  -- scroll down

HTMLSurface.OpenDeveloperTools(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: OpenDeveloperTools

HTMLSurface.PasteFromClipboard(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: PasteFromClipboard

HTMLSurface.Reload(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: Reload

Example:

Steam.HTMLSurface.Reload(hBrowser)

HTMLSurface.RemoveBrowser(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: RemoveBrowser

Example:

Steam.HTMLSurface.RemoveBrowser(hBrowser)

HTMLSurface.SetBackgroundMode(unBrowserHandle, bBackgroundMode)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
bBackgroundMode (bool) –

SteamWorks:

SetBackgroundMode

HTMLSurface.SetCookie(pchHostname, pchKey, pchValue, pchPath, nExpires, bSecure, bHTTPOnly)

🤖 Auto-generated binding

Parameters:

pchHostname (str?) –
pchKey (str?) –
pchValue (str?) –
pchPath (str?) –
nExpires (int - RTime32) –
bSecure (bool) –
bHTTPOnly (bool) –

SteamWorks:

SetCookie

HTMLSurface.SetDPIScalingFactor(unBrowserHandle, flDPIScaling)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
flDPIScaling (float) –

SteamWorks:

SetDPIScalingFactor

HTMLSurface.SetHorizontalScroll(unBrowserHandle, nAbsolutePixelScroll)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
nAbsolutePixelScroll (int) –

SteamWorks:

SetHorizontalScroll

Example:

Steam.HTMLSurface.SetHorizontalScroll(hBrowser, 0)

HTMLSurface.SetKeyFocus(unBrowserHandle, bHasKeyFocus)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
bHasKeyFocus (bool) –

SteamWorks:

SetKeyFocus

HTMLSurface.SetPageScaleFactor(unBrowserHandle, flZoom, nPointX, nPointY)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
flZoom (float) –
nPointX (int) –
nPointY (int) –

SteamWorks:

SetPageScaleFactor

HTMLSurface.SetSize(unBrowserHandle, unWidth, unHeight)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
unWidth (int) –
unHeight (int) –

SteamWorks:

SetSize

Notes:

See HTMLSurface.CreateBrowser()’s example.

HTMLSurface.SetVerticalScroll(unBrowserHandle, nAbsolutePixelScroll)

🤖 Auto-generated binding

Parameters:

unBrowserHandle (int - HHTMLBrowser) –
nAbsolutePixelScroll (int) –

SteamWorks:

SetVerticalScroll

Example:

Steam.HTMLSurface.SetVerticalScroll(hBrowser, scrollPos)

HTMLSurface.Shutdown()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: Shutdown

Example:

Steam.HTMLSurface.Shutdown()

HTMLSurface.StopFind(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: StopFind

Example:

Steam.HTMLSurface.StopFind(hBrowser)

HTMLSurface.StopLoad(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: StopLoad

Example:

Steam.HTMLSurface.StopLoad(hBrowser)

HTMLSurface.ViewSource(unBrowserHandle)

🤖 Auto-generated binding

Parameters:: unBrowserHandle (int - HHTMLBrowser) –
SteamWorks:: ViewSource

Unimplemented Methods

HTMLSurface.FileLoadDialogResponse()

✋ Not implemented - unsupported type: const char **

SteamWorks:: FileLoadDialogResponse

Callbacks

HTMLSurface.OnHTML_BrowserReady()

Callback for HTML_BrowserReady_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)

HTMLSurface.OnHTML_NeedsPaint()

Callback for HTML_NeedsPaint_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pBGRA (string)
data.unWide (int)
data.unTall (int)
data.unUpdateX (int)
data.unUpdateY (int)
data.unUpdateWide (int)
data.unUpdateTall (int)
data.unScrollX (int)
data.unScrollY (int)
data.flPageScale (float)
data.unPageSerial (int)

Example:

function Steam.HTMLSurface.OnHTML_NeedsPaint(data)
    -- data.pBGRA contains raw BGRA pixel data
    -- data.unWide, data.unTall = dimensions
    updateBrowserTexture(data.pBGRA, data.unWide, data.unTall)
end

HTMLSurface.OnHTML_StartRequest()

Callback for HTML_StartRequest_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchURL (string)
data.pchTarget (string)
data.pchPostData (string)
data.bIsRedirect (bool)

Example:

function Steam.HTMLSurface.OnHTML_StartRequest(data)
    print('Navigating to:', data.pchURL)
    -- Call AllowStartRequest to allow or block navigation
    Steam.HTMLSurface.AllowStartRequest(data.unBrowserHandle, true)
end

HTMLSurface.OnHTML_CloseBrowser()

Callback for HTML_CloseBrowser_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)

HTMLSurface.OnHTML_URLChanged()

Callback for HTML_URLChanged_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchURL (string)
data.pchPostData (string)
data.bIsRedirect (bool)
data.pchPageTitle (string)
data.bNewNavigation (bool)

Example:

function Steam.HTMLSurface.OnHTML_URLChanged(data)
    print('URL changed to:', data.pchURL)
    updateAddressBar(data.pchURL)
end

HTMLSurface.OnHTML_FinishedRequest()

Callback for HTML_FinishedRequest_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchURL (string)
data.pchPageTitle (string)

Example:

function Steam.HTMLSurface.OnHTML_FinishedRequest(data)
    print('Page loaded:', data.pchURL)
    hideLoadingSpinner()
end

HTMLSurface.OnHTML_OpenLinkInNewTab()

Callback for HTML_OpenLinkInNewTab_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchURL (string)

HTMLSurface.OnHTML_ChangedTitle()

Callback for HTML_ChangedTitle_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchTitle (string)

Example:

function Steam.HTMLSurface.OnHTML_ChangedTitle(data)
    windowTitle = data.pchTitle
end

HTMLSurface.OnHTML_SearchResults()

Callback for HTML_SearchResults_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.unResults (int)
data.unCurrentMatch (int)

HTMLSurface.OnHTML_CanGoBackAndForward()

Callback for HTML_CanGoBackAndForward_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.bCanGoBack (bool)
data.bCanGoForward (bool)

HTMLSurface.OnHTML_HorizontalScroll()

Callback for HTML_HorizontalScroll_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.unScrollMax (int)
data.unScrollCurrent (int)
data.flPageScale (float)
data.bVisible (bool)
data.unPageSize (int)

HTMLSurface.OnHTML_VerticalScroll()

Callback for HTML_VerticalScroll_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.unScrollMax (int)
data.unScrollCurrent (int)
data.flPageScale (float)
data.bVisible (bool)
data.unPageSize (int)

HTMLSurface.OnHTML_LinkAtPosition()

Callback for HTML_LinkAtPosition_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.x (int)
data.y (int)
data.pchURL (string)
data.bInput (bool)
data.bLiveLink (bool)

HTMLSurface.OnHTML_JSAlert()

Callback for HTML_JSAlert_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchMessage (string)

Example:

function Steam.HTMLSurface.OnHTML_JSAlert(data)
    showAlertDialog(data.pchMessage)
    Steam.HTMLSurface.JSDialogResponse(data.unBrowserHandle, true)
end

HTMLSurface.OnHTML_JSConfirm()

Callback for HTML_JSConfirm_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchMessage (string)

HTMLSurface.OnHTML_FileOpenDialog()

Callback for HTML_FileOpenDialog_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchTitle (string)
data.pchInitialFile (string)

HTMLSurface.OnHTML_NewWindow()

Callback for HTML_NewWindow_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchURL (string)
data.unX (int)
data.unY (int)
data.unWide (int)
data.unTall (int)
data.unNewWindow_BrowserHandle_IGNORE (int - HHTMLBrowser)

HTMLSurface.OnHTML_SetCursor()

Callback for HTML_SetCursor_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.eMouseCursor (int)

HTMLSurface.OnHTML_StatusText()

Callback for HTML_StatusText_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchMsg (string)

HTMLSurface.OnHTML_ShowToolTip()

Callback for HTML_ShowToolTip_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchMsg (string)

HTMLSurface.OnHTML_UpdateToolTip()

Callback for HTML_UpdateToolTip_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.pchMsg (string)

HTMLSurface.OnHTML_HideToolTip()

Callback for HTML_HideToolTip_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)

HTMLSurface.OnHTML_BrowserRestarted()

Callback for HTML_BrowserRestarted_t

callback(data) receives:

data.unBrowserHandle (int - HHTMLBrowser)
data.unOldBrowserHandle (int - HHTMLBrowser)

ISteamHTMLSurface

List of Functions

List of Callbacks

Function Reference

Unimplemented Methods

Callbacks