Steam.ActivateGameOverlayToWebPage (Civ5 API)

This page is a part of the Lua and UI Reference (Civ5).

This function is a member of Steam. This is a static method, invoke it with a dot.

Opens the built-in web browser of the overlay and navigates to the specified URL

Usage

void Steam.ActivateGameOverlayToWebPage(string url)

Parameters

url:	The url to navigate to. Restrictions Must be a fully qualified URL (in other words, include http://) Only supports "http" or "file" protocols file protocol will only navigate to a file located in <My Documents>/My Games/Sid Meier's Civilization 5/

Examples

-- Navigate to the Civ 5 wiki
Steam.ActivateGameOverlayToWebPage("http://wiki.2kgames.com/civ5");

Source code samples

Redundant occurences have been removed.

MainMenu.lua

UI/FrontEnd/MainMenu.lua

0215	Steam.ActivateGameOverlayToWebPage(v.customurl);

ModsBrowser.lua

UI/FrontEnd/Modding/ModsBrowser.lua

0039	Steam.ActivateGameOverlayToWebPage("http://steamcommunity.com/workshop/browse?appid=8930");

OtherMenu.lua

UI/FrontEnd/OtherMenu.lua

0031	Steam.ActivateGameOverlayToWebPage("http://store.steampowered.com/news/?appids=8930");

The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.