Steam.IsOverlayEnabled (Civ5 API)

From Civilization Modding Wiki
Jump to navigationJump to search

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


Function.png This function is a member of Steam.

This is a static method, invoke it with a dot.


Determines if the Steam overlay is currently being displayed


Usage

bool Steam.IsOverlayEnabled()


Returned Value

Returns true if the overlay is enabled, false if not.


Examples

local overlayEnabled = Steam.IsOverlayEnabled();
if(not overlayEnabled) then
-- show popups
else
-- wait
end


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.