UISaveGame Class
Save Game Window
Inheritance: UISaveGame » UIFileBrowser » UIResizable » Window
Method Index
- abortName()
- 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() (overrides UIResizable:afterLoad)
- beginDrag(x, y) (inherited from Window)
- beginResize(x, y, mode) (inherited from UIResizable)
- bringToTop() (inherited from Window)
- buttonBack() (inherited from UIFileBrowser)
- checkChoice(node) (inherited from UIFileBrowser)
- choiceMade(name) (overrides UIFileBrowser:choiceMade)
- close() (inherited from Window)
- confirmName() (overrides UIFileBrowser:confirmName)
- doSave(filename)
- draw(canvas, x, y) (inherited from UIResizable)
- 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 UIResizable)
- hitTestCorners(x, y) (inherited from UIResizable)
- 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() (inherited from Window)
- onChangeLanguage() (inherited from Window)
- onChangeResolution() (inherited from Window)
- onCursorWorldPositionChange(x, y) (inherited from Window)
- onMouseDown(button, x, y) (inherited from UIResizable)
- 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)
- overrideMinSize(min_width, min_height) (inherited from UIResizable)
- removeAllPanels() (inherited from Window)
- removeKeyHandler(keys) (inherited from Window)
- removeWindow(window) (inherited from Window)
- sendToBottom(window) (inherited from Window)
- sendToTop(window) (inherited from Window)
- setColour(colour) (inherited from UIResizable)
- setDefaultPosition(x, y) (inherited from Window)
- setInputValue(label) (overrides UIFileBrowser:setInputValue)
- setPosition(x, y) (inherited from Window)
- setSize(width, height) (inherited from UIResizable)
- startButtonBlinking(button_index) (inherited from Window)
- stopButtonBlinking() (inherited from Window)
- trySave(filename)
Member Index
- active_button (*)
- active_scrollbar (*)
- apply_ui_scale (*)
- background_panel (*)
- blink_counter (*)
- blinking_button (*)
- border_pos (*)
- border_sprites (*)
- btn_repeat_delay (*)
- buttons (*)
- buttons_down (*)
- closed (*)
- col_bg (*)
- col_scrollbar (*)
- colour (*)
- control
- cursor_x (*)
- cursor_y (*)
- default_button_sound (*)
- draggable (*)
- dragging (*)
- esc_closes (*)
- height (*)
- hotkeyboxes (*)
- key_handlers (*)
- min_height (*)
- min_width (*)
- modal_class (*)
- mode (*)
- new_savegame_textbox
- on_top (*)
- panel_sprites (*)
- panels (*)
- parent (*)
- resizable (*)
- scrollbars (*)
- textboxes (*)
- tooltip_regions (*)
- ui
- visible (*)
- width
- windows (*)
- x (*)
- x_original (*)
- y (*)
- y_original (*)
function UISaveGame:UISaveGame(ui)
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | ? | ? |
Declared on: line 45 of Lua/dialogs/resizables/file_browsers/save_game.lua.
function UISaveGame:abortName()
Function called when textbox is aborted (e.g. by pressing escape)
Declared on: line 61 of Lua/dialogs/resizables/file_browsers/save_game.lua.
function UISaveGame:afterLoad()
Overrides: UIResizable:afterLoad.
Declared on: line 115 of Lua/dialogs/resizables/file_browsers/save_game.lua.
function UISaveGame:choiceMade(name)
Function called by clicking button of existing save #num
Parameters:
| Name | Type | Description |
|---|---|---|
| name | ? | ? |
Overrides: UIFileBrowser:choiceMade.
Declared on: line 86 of Lua/dialogs/resizables/file_browsers/save_game.lua.
function UISaveGame:confirmName()
Function called when textbox is confirmed (e.g. by pressing enter)
Overrides: UIFileBrowser:confirmName.
Declared on: line 74 of Lua/dialogs/resizables/file_browsers/save_game.lua.
function UISaveGame:doSave(filename)
Actually do save the game with given filename.
Parameters:
| Name | Type | Description |
|---|---|---|
| filename | ? | ? |
Declared on: line 100 of Lua/dialogs/resizables/file_browsers/save_game.lua.
function UISaveGame:setInputValue(label)
Updates the textbox to selected file
Parameters:
| Name | Type | Description |
|---|---|---|
| label | string | Selected file name |
Overrides: UIFileBrowser:setInputValue.
Declared on: line 67 of Lua/dialogs/resizables/file_browsers/save_game.lua.
function UISaveGame:trySave(filename)
Try to save the game with given filename; if already exists, create confirmation window first.
Parameters:
| Name | Type | Description |
|---|---|---|
| filename | ? | ? |
Declared on: line 91 of Lua/dialogs/resizables/file_browsers/save_game.lua.