UIFax Class
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 UIFullscreen:afterLoad)
- appendNumber(number)
- beginDrag(x, y) (inherited from Window)
- bringToTop() (inherited from Window)
- cancel()
- choice(choice_number)
- close() (overrides Window:close)
- correct()
- draw(canvas, x, y) (overrides UIFullscreen:draw)
- getRealXY() (inherited from Window)
- getSavedWindowPositionName() (inherited from UIFullscreen)
- getStaffPosition(dx, dy) (inherited from UIFullscreen)
- 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 UIFullscreen)
- 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)
- onChangeLanguage() (inherited from Window)
- onChangeResolution() (inherited from UIFullscreen)
- onCursorWorldPositionChange(x, y) (inherited from Window)
- onMouseDown(button, x, y) (inherited from UIFullscreen)
- 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)
- 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)
- updateChoices()
- validate()
Member Index
- active_button (*)
- active_scrollbar (*)
- apply_ui_scale (*)
- background
- blink_counter (*)
- blinking_button (*)
- border_sprites (*)
- btn_repeat_delay (*)
- buttons (*)
- buttons_down (*)
- category (*)
- choice_buttons
- closed (*)
- code
- cursor_x (*)
- cursor_y (*)
- default_button_sound (*)
- draggable (*)
- dragging (*)
- esc_closes (*)
- fax_font
- height (*)
- hotkeyboxes (*)
- icon
- key_handlers (*)
- message
- modal_class (*)
- owner
- panel_sprites
- panels (*)
- parent (*)
- scrollbars (*)
- selected_staff (*)
- staff_members (*)
- textboxes (*)
- tooltip_regions (*)
- ui
- visible (*)
- width (*)
- windows (*)
- x
- x_original (*)
- y
- y_original (*)
function UIFax:UIFax(ui, icon)
Parameters:
| Name | Type | Description |
|---|---|---|
| ui | ? | ? |
| icon | ? | ? |
Declared on: line 30 of Lua/dialogs/fullscreen/fax.lua.
function UIFax:afterLoad(old, new)
Parameters:
| Name | Type | Description |
|---|---|---|
| old | ? | ? |
| new | ? | ? |
Overrides: UIFullscreen:afterLoad.
Declared on: line 299 of Lua/dialogs/fullscreen/fax.lua.
function UIFax:appendNumber(number)
Parameters:
| Name | Type | Description |
|---|---|---|
| number | ? | ? |
Declared on: line 289 of Lua/dialogs/fullscreen/fax.lua.
function UIFax:choice(choice_number)
A choice was made for the fax.
Parameters:
| Name | Type | Description |
|---|---|---|
| choice_number | integer | Number of the choice |
Declared on: line 133 of Lua/dialogs/fullscreen/fax.lua.
function UIFax:close()
Overrides: Window:close.
Declared on: line 293 of Lua/dialogs/fullscreen/fax.lua.
function UIFax:draw(canvas, x, y)
Parameters:
| Name | Type | Description |
|---|---|---|
| canvas | ? | ? |
| x | ? | ? |
| y | ? | ? |
Overrides: UIFullscreen:draw.
Declared on: line 106 of Lua/dialogs/fullscreen/fax.lua.
function UIFax:mustPause()
Faxes pause the game
Overrides: Window:mustPause.
Declared on: line 92 of Lua/dialogs/fullscreen/fax.lua.