UIMenuBar Class

The ingame menu bar which sits (nominally hidden) at the top of the screen.

Declared on: line 25 of Lua/dialogs/menu.lua.
Inheritance: UIMenuBar » Window

Method Index

addBevelPanel(x, y, w, h, colour, highlight_colour, shadow_colour, disabled_colour) (inherited from Window)
addColourPanel(x, y, w, h, r, g, b) (inherited from Window)
addKeyHandler(key, handler, ...) (inherited from Window)
addMenu(title, menu)
addPanel(sprite_index, x, y, w, h) (inherited from Window)
addWindow(window) (inherited from Window)
afterLoad(old, new) (inherited from Window)
appear()
beginDrag(x, y) (inherited from Window)
bringToTop() (inherited from Window)
calculateMenuSize(menu)
close() (inherited from Window)
disappear()
draw(canvas) (overrides Window:draw)
drawMenu(menu, canvas)
getSavedWindowPositionName() (inherited from Window)
getTooltipAt(x, y) (inherited from Window)
getTooltipForElement(elem, x, y) (inherited from Window)
getWindow(window_class) (inherited from Window)
getWindows(window_class) (inherited from Window)
hitTest(x, y) (inherited from Window)
hitTestBar(x, y)
hitTestPanel(x, y, panel) (inherited from Window)
makeButtonOnPanel(panel, x, y, w, h, sprite, on_click, on_click_self, on_rightclick) (inherited from Window)
makeDynamicTooltip(callback, x, y, r, b, tooltip_x, tooltip_y) (inherited from Window)
makeMenu(app)
makeScrollbarOnPanel(panel, slider_colour, callback, min_value, max_value, page_size, value) (inherited from Window)
makeTextboxOnPanel(panel, confirm_callback, abort_callback) (inherited from Window)
makeTooltip(text, x, y, r, b, tooltip_x, tooltip_y) (inherited from Window)
onChangeLanguage() (overrides Window:onChangeLanguage)
onChangeResolution() (overrides Window:onChangeResolution)
onCursorWorldPositionChange(x, y) (inherited from Window)
onMouseDown(button, x, y) (overrides Window:onMouseDown)
onMouseMove(x, y) (overrides Window:onMouseMove)
onMouseUp(button, x, y) (overrides Window:onMouseUp)
onTick() (overrides Window:onTick)
onWorldTick() (inherited from Window)
removeAllPanels() (inherited from Window)
removeWindow(window) (inherited from Window)
sendToBottom(window) (inherited from Window)
sendToTop(window) (inherited from Window)
setDefaultPosition(x, y) (inherited from Window)
setPosition(x, y) (inherited from Window)
startButtonBlinking(button_index) (inherited from Window)
stopButtonBlinking() (inherited from Window)

Member Index

active_button (*)
active_menu
active_scrollbar (*)
blink_counter (*)
blinking_button (*)
blue_font
btn_repeat_delay (*)
buttons (*)
buttons_down (*)
closed (*)
default_button_sound (*)
disappear_counter
draggable (*)
dragging (*)
height
key_handlers (*)
menu_disappear_counter
menus
on_top
open_menus
panel_sprites
panels (*)
parent (*)
scrollbars (*)
textboxes (*)
tooltip_regions (*)
ui
visible
white_font
width
windows (*)
x
x_original (*)
y
y_original (*)

(*) only used in superclass methods

function UIMenuBar:UIMenuBar(ui)

Parameters:

Name	Type	Description
ui	?	?

Declared on: line 28 of Lua/dialogs/menu.lua.

function UIMenuBar:addMenu(title, menu)

Parameters:

Name	Type	Description
title	?	?
menu	?	?

Declared on: line 123 of Lua/dialogs/menu.lua.

function UIMenuBar:appear()

Declared on: line 314 of Lua/dialogs/menu.lua.

function UIMenuBar:calculateMenuSize(menu)

Parameters:

Name	Type	Description
menu	?	?

Declared on: line 416 of Lua/dialogs/menu.lua.

function UIMenuBar:disappear()

Declared on: line 323 of Lua/dialogs/menu.lua.

function UIMenuBar:draw(canvas)

Parameters:

Name	Type	Description
canvas	?	?

Overrides: Window:draw.
Declared on: line 139 of Lua/dialogs/menu.lua.

function UIMenuBar:drawMenu(menu, canvas)

Parameters:

Name	Type	Description
menu	?	?
canvas	?	?

Declared on: line 179 of Lua/dialogs/menu.lua.

function UIMenuBar:hitTestBar(x, y)

Parameters:

Name	Type	Description
x	?	?
y	?	?

Declared on: line 215 of Lua/dialogs/menu.lua.

function UIMenuBar:makeMenu(app)

Parameters:

Name	Type	Description
app	?	?

Declared on: line 515 of Lua/dialogs/menu.lua.

function UIMenuBar:onChangeLanguage()

Overrides: Window:onChangeLanguage.
Declared on: line 100 of Lua/dialogs/menu.lua.

function UIMenuBar:onChangeResolution()

Overrides: Window:onChangeResolution.
Declared on: line 96 of Lua/dialogs/menu.lua.

function UIMenuBar:onMouseDown(button, x, y)

Parameters:

Name	Type	Description
button	?	?
x	?	?
y	?	?

Overrides: Window:onMouseDown.
Declared on: line 329 of Lua/dialogs/menu.lua.

function UIMenuBar:onMouseMove(x, y)

Parameters:

Name	Type	Description
x	?	?
y	?	?

Overrides: Window:onMouseMove.
Declared on: line 231 of Lua/dialogs/menu.lua.

function UIMenuBar:onMouseUp(button, x, y)

Parameters:

Name	Type	Description
button	?	?
x	?	?
y	?	?

Overrides: Window:onMouseUp.
Declared on: line 358 of Lua/dialogs/menu.lua.

function UIMenuBar:onTick()

Overrides: Window:onTick.
Declared on: line 54 of Lua/dialogs/menu.lua.