API:LCDDestroyPage

UI Lua API · LCD functions
Version: WAR 1.4.8

Removes a page created with LCDCreatePage.

LCDDestroyPage(pageName)

Arguments

pageName

string – Name of the page.

Returns

Nothing.

Details

• The page is destroyed and its name becomes free again.
• If the page is the one being shown, the client clears the shown page first, so no page is shown afterwards.
• If no page has this name, the client logs LCD Keyboard: A page '%s' does not exist.
• The stock UI never calls this function.

Errors

None besides the generic Invalid Parameters message when the argument is not a string. A missing page is only logged (see Details).

Example

A minimal example built from the signature:

LCDCreatePage( "MyPage" )
-- ...
LCDDestroyPage( "MyPage" )

See also

• LCDCreatePage
• LCDShowPage