API:LCDUnsetButtonHandler

UI Lua API · LCD functions
Version: WAR 1.4.8

Removes the button handler of an LCD page.

LCDUnsetButtonHandler(pageName)

Arguments

pageName

string – Name of the page.

Returns

Nothing.

Details

• After the call, the page has no button handler and LCDSetButtonHandler can set a new one.
• An argument error is reported with the name LCDUnregisterEventHandler, not LCDUnsetButtonHandler: the client checks the argument under that function's name.
• The stock UI never calls this function.

Errors

• Error in function call 'LCDUnsetButtonHandler': Page '%s' does not exist.

Example

A minimal example built from the signature:

LCDUnsetButtonHandler( "MyPage" )
LCDSetButtonHandler( "MyPage", "MyAddon.OnLCDButton" )

See also

• LCDSetButtonHandler