UIFolder Class
Customise window used in the main menu and ingame.
Declared on: line 21 of Lua/dialogs/resizables/folder_settings.lua.
Inheritance: UIFolder » UIResizable » Window
Inheritance: UIFolder » UIResizable » Window
Method Index
- _getOptionYPos()
- 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) (inherited from UIResizable)
- beginDrag(x, y) (inherited from Window)
- beginResize(x, y, mode) (inherited from UIResizable)
- bringToTop() (inherited from Window)
- buttonBack()
- buttonBrowseForAudio_music()
- buttonBrowseForFont()
- buttonBrowseForSavegames()
- buttonBrowseForScreenshots()
- buttonBrowseForTHInstall()
- close() (overrides Window:close)
- 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)
- resetMusicDir()
- resetSavegameDir()
- resetScreenshotDir()
- sendToBottom(window) (inherited from Window)
- sendToTop(window) (inherited from Window)
- setColour(colour) (inherited from UIResizable)
- setDefaultPosition(x, y) (inherited from Window)
- setPosition(x, y) (inherited from Window)
- setSize(width, height) (inherited from UIResizable)
- startButtonBlinking(button_index) (inherited from Window)
- stopButtonBlinking() (inherited from Window)
Member Index
- _current_option_index
- active_button (*)
- active_scrollbar (*)
- app
- apply_ui_scale (*)
- background_panel (*)
- blink_counter (*)
- blinking_button (*)
- border_pos (*)
- border_sprites (*)
- btn_repeat_delay (*)
- built_in_font
- buttons (*)
- buttons_down (*)
- closed (*)
- colour (*)
- cursor_x (*)
- cursor_y (*)
- default_button_sound
- draggable (*)
- dragging (*)
- esc_closes
- fonts_panel
- height (*)
- hotkeyboxes (*)
- key_handlers (*)
- min_height (*)
- min_width (*)
- modal_class
- mode
- music_panel
- on_top
- panel_sprites (*)
- panels (*)
- parent (*)
- resizable
- saves_panel
- screenshots_panel
- scrollbars (*)
- textboxes (*)
- tooltip_regions (*)
- ui
- visible (*)
- width (*)
- windows (*)
- x (*)
- x_original (*)
- y (*)
- y_original (*)
function UIFolder:UIFolder(ui, mode)
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | ? | ? |
| mode | ? | ? |
Declared on: line 50 of Lua/dialogs/resizables/folder_settings.lua.
function UIFolder:_getOptionYPos()
- Calculates the Y position for the dialog box in the option menu
and increments along the current position for the next element
@return The Y position to place the element at
Declared on: line 35 of Lua/dialogs/resizables/folder_settings.lua.
function UIFolder:buttonBrowseForAudio_music()
Declared on: line 243 of Lua/dialogs/resizables/folder_settings.lua.
function UIFolder:buttonBrowseForFont()
Declared on: line 197 of Lua/dialogs/resizables/folder_settings.lua.
function UIFolder:buttonBrowseForSavegames()
Declared on: line 202 of Lua/dialogs/resizables/folder_settings.lua.
function UIFolder:buttonBrowseForScreenshots()
Declared on: line 228 of Lua/dialogs/resizables/folder_settings.lua.
function UIFolder:buttonBrowseForTHInstall()
Declared on: line 217 of Lua/dialogs/resizables/folder_settings.lua.
function UIFolder:close()
Overrides: Window:close.
Declared on: line 261 of Lua/dialogs/resizables/folder_settings.lua.
function UIFolder:resetMusicDir()
Declared on: line 186 of Lua/dialogs/resizables/folder_settings.lua.