CorsixTH Lua Documentation

Button Class

A region of a `Panel` which causes some action when clicked.

Declared on: line 384 of Lua/window.lua.

Method Index

Member Index

function Button:enable(enable)

Parameters:

NameTypeDescription
enable ? ?

Declared on: line 413 of Lua/window.lua.

function Button:setDisabledSprite(index)

Parameters:

NameTypeDescription
index ? ?

Declared on: line 408 of Lua/window.lua.

function Button:setDynamicTooltip(callback, x, y)

Parameters:

NameTypeDescription
callback ? ?
x ? ?
y ? ?

Declared on: line 483 of Lua/window.lua.

function Button:setSound(name)

Parameters:

NameTypeDescription
name ? ?

Declared on: line 462 of Lua/window.lua.

function Button:setToggleState(state)

Parameters:

NameTypeDescription
state ? ?

Declared on: line 448 of Lua/window.lua.

function Button:setTooltip(tooltip, x, y)

Specify a tooltip to be displayed when hovering this button. x and y are optional position of bottom left of the tooltip. If not specified, will default to top center of button.

Parameters:

NameTypeDescription
tooltip ? ?
x ? ?
y ? ?

Declared on: line 471 of Lua/window.lua.

Page generated on Thu Jun 24, 2010 at 02:46:54 by LDocGen.