UIConfirmDialog Class
Dialog for "Are you sure you want to quit?" and similar yes/no questions.
Declared on: line 21 of Lua/dialogs/confirm_dialog.lua.
Inheritance: UIConfirmDialog ยป Window
Full description:
This dialog is also used for errors and requires some special handling
Inheritance: UIConfirmDialog ยป Window
Full description:
This dialog is also used for errors and requires some special handling
Method Index
- addBevelPanel(x, y, w, h, colour, highlight_colour, shadow_colour, disabled_colour, lowered_colour, apply_ui_scale) (inherited from Window)
- addColourPanel(x, y, w, h, r, g, b, apply_ui_scale) (inherited from Window)
- addKeyHandler(key, handler, ...) (inherited from Window)
- addPanel(sprite_index, x, y, w, h, apply_ui_scale, draw_flags) (inherited from Window)
- addWindow(window) (inherited from Window)
- afterLoad(old, new) (overrides Window:afterLoad)
- beginDrag(x, y) (inherited from Window)
- bringToTop() (inherited from Window)
- cancel()
- close(confirmed) (overrides Window:close)
- draw(canvas, x, y) (overrides Window:draw)
- getRealXY() (inherited from Window)
- 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)
- hitTestPanel(x, y, panel) (inherited from Window)
- hoverTest(active_hover, mouse_x, mouse_y, min_x, max_x, min_y, max_y) (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)
- makeHotkeyBoxOnPanel(panel, confirm_callback, abort_callback) (inherited from Window)
- 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, apply_ui_scale) (inherited from Window)
- mustPause() (overrides Window:mustPause)
- ok()
- onChangeLanguage() (inherited from Window)
- onChangeResolution() (inherited from Window)
- onCursorWorldPositionChange(x, y) (inherited from Window)
- onMouseDown(button, x, y) (inherited from Window)
- onMouseMove(x, y, dx, dy) (inherited from Window)
- onMouseUp(button, x, y) (inherited from Window)
- onMouseWheel(x, y) (inherited from Window)
- onTick() (inherited from Window)
- onWorldTick() (inherited from Window)
- registerKeyHandlers()
- removeAllPanels() (inherited from Window)
- removeKeyHandler(keys) (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)
- setSize(width, height, apply_ui_scale) (inherited from Window)
- startButtonBlinking(button_index) (inherited from Window)
- stopButtonBlinking() (inherited from Window)
Member Index
- active_button (*)
- active_scrollbar (*)
- apply_ui_scale (*)
- blink_counter (*)
- blinking_button (*)
- btn_repeat_delay (*)
- buttons (*)
- buttons_down (*)
- callback_cancel
- callback_ok
- closed (*)
- cursor_x (*)
- cursor_y (*)
- default_button_sound (*)
- draggable (*)
- dragging (*)
- esc_closes
- height
- hotkeyboxes (*)
- key_handlers (*)
- modal_class
- must_pause
- on_top
- panel_sprites
- panels (*)
- parent (*)
- scrollbars (*)
- text
- textboxes (*)
- tooltip_regions (*)
- ui
- visible (*)
- white_font
- width
- windows (*)
- x
- x_original (*)
- y
- y_original (*)
function UIConfirmDialog:UIConfirmDialog(ui, must_pause, text, callback_ok, callback_cancel)
Initialise the Confirmation Dialog
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | ? | The UI |
| must_pause | boolean | set whether this dialog should pause the game |
| text | string | message to show |
| callback_ok | function | what to do on yes/ok |
| callback_cancel | function | what to do on no/cancel/close |
Declared on: line 35 of Lua/dialogs/confirm_dialog.lua.
function UIConfirmDialog:afterLoad(old, new)
Parameters:
| Name | Type | Description |
|---|---|---|
| old | ? | ? |
| new | ? | ? |
Overrides: Window:afterLoad.
Declared on: line 127 of Lua/dialogs/confirm_dialog.lua.
function UIConfirmDialog:close(confirmed)
Closes the confirm dialog
Parameters:
| Name | Type | Description |
|---|---|---|
| confirmed | boolean or or or nil | whether to call the confirm callback (true) or cancel callback (false/nil) |
Overrides: Window:close.
Declared on: line 103 of Lua/dialogs/confirm_dialog.lua.
function UIConfirmDialog:draw(canvas, x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
| canvas | ? | ? |
| x | ? | ? |
| y | ? | ? |
Overrides: Window:draw.
Declared on: line 119 of Lua/dialogs/confirm_dialog.lua.
function UIConfirmDialog:mustPause()
Confirm dialogs are used for errors, if it is an error then pause the game
Overrides: Window:mustPause.
Declared on: line 85 of Lua/dialogs/confirm_dialog.lua.