DB.CollectMemoryUsage (Civ5 API)

From Civilization Modding Wiki
Revision as of 18:32, 19 September 2012 by DonQuich (talk | contribs) (Bot update)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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


Function.png This function is a member of DB.

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


Tells the engine to gather SQL memory usage This method tells the engine to gather extended memory information by walking the heap associated with SQL. This method is used in conjunction with GetMemoryUsage and will allow it to return more detailed information. Each time this method is called, it updates the information snapshot returned by GetMemoryUsage. It is not recommended to execute this method on a per-frame basis as it can be quite slow.


Usage

void DB.CollectMemoryUsage()



Examples

--Gather SQL memory stats
DB.CollectMemoryUsage();
local info = DB.GetMemoryUsage();


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.