UIAdviser Class

The (ideally) helpful advisor who pops up from the bottom dialog during a game.

Declared on: line 23 of Lua/dialogs/adviser.lua.
Inheritance: UIAdviser » Window

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)
addMessageToHistory(speech)
addPanel(sprite_index, x, y, w, h, apply_ui_scale, draw_flags) (inherited from Window)
addQueuedMessagesToHistory()
addWindow(window) (inherited from Window)
afterLoad(old, new) (overrides Window:afterLoad)
beginDrag(x, y) (inherited from Window)
bringToTop() (inherited from Window)
checkForDuplicates(speech)
close() (inherited from Window)
deleteAllMessagesFromHistory()
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)
hide()
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)
idle()
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)
messageIndexInHistory(message)
mustPause() (inherited from Window)
onChangeLanguage() (inherited from Window)
onChangeResolution() (inherited from Window)
onCursorWorldPositionChange(x, y) (inherited from Window)
onMouseDown(button, x, y) (overrides Window:onMouseDown)
onMouseMove(x, y, dx, dy) (inherited from Window)
onMouseUp(button, x, y) (inherited from Window)
onMouseWheel(x, y) (inherited from Window)
onTick() (overrides Window:onTick)
onWorldTick() (inherited from Window)
removeAllPanels() (inherited from Window)
removeKeyHandler(keys) (inherited from Window)
removeMessageFromHistory(index)
removeWindow(window) (inherited from Window)
say(speech, talk_until_next_announce, override_current)
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)
show()
startButtonBlinking(button_index) (inherited from Window)
stopButtonBlinking() (inherited from Window)
talk()

Member Index

active_button (*)
active_scrollbar (*)
apply_ui_scale (*)
balloon_width
black_font
blink_counter (*)
blinking_button (*)
btn_repeat_delay (*)
buttons (*)
buttons_down (*)
closed (*)
cursor_x (*)
cursor_y (*)
default_button_sound (*)
draggable (*)
dragging (*)
enabled
esc_closes
frame
height
hotkeyboxes (*)
key_handlers (*)
message_history
message_history_limit
modal_class
number_frames
panel_sprites
panels (*)
parent (*)
phase
queued_messages
scrollbars (*)
speech
stay_up
textboxes (*)
th
tick_rate
tick_timer
timer
tooltip_regions (*)
ui
up_again
visible (*)
width
windows (*)
x
x_original (*)
y
y_original (*)

(*) only used in superclass methods

function UIAdviser:UIAdviser(ui)

Parameters:

Name	Type	Description
ui	?	?

Declared on: line 29 of Lua/dialogs/adviser.lua.

function UIAdviser:addMessageToHistory(speech)

Adds a message to the adviser's message history.

If the history exceeds a certain limit, the oldest messages are removed.

Parameters:

Name	Type	Description
speech	?	?

Declared on: line 73 of Lua/dialogs/adviser.lua.

function UIAdviser:addQueuedMessagesToHistory()

Adds all queued messages to the adviser's message history.

Declared on: line 92 of Lua/dialogs/adviser.lua.

function UIAdviser:afterLoad(old, new)

Parameters:

Name	Type	Description
old	?	?
new	?	?

Overrides: Window:afterLoad.
Declared on: line 336 of Lua/dialogs/adviser.lua.

function UIAdviser:checkForDuplicates(speech)

Function checks if the adviser has been asked to say something already queued

Parameters:

Name	Type	Description
speech	string	Text to check

Declared on: line 183 of Lua/dialogs/adviser.lua.

function UIAdviser:deleteAllMessagesFromHistory()

Deletes all messages from the adviser's message history.

Declared on: line 105 of Lua/dialogs/adviser.lua.

function UIAdviser:draw(canvas, x, y)

Parameters:

Name	Type	Description
canvas	?	?
x	?	?
y	?	?

Overrides: Window:draw.
Declared on: line 235 of Lua/dialogs/adviser.lua.

function UIAdviser:hide()

Hides the adviser by running the appropriate animation.

Declared on: line 174 of Lua/dialogs/adviser.lua.

function UIAdviser:idle()

Makes the adviser idle for a while before disappearing. This means that the text bubble is removed.

Declared on: line 162 of Lua/dialogs/adviser.lua.

function UIAdviser:messageIndexInHistory(message)

Parameters:

Name	Type	Description
message	?	?

Declared on: line 64 of Lua/dialogs/adviser.lua.

function UIAdviser:onMouseDown(button, x, y)

Parameters:

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

Overrides: Window:onMouseDown.
Declared on: line 258 of Lua/dialogs/adviser.lua.

function UIAdviser:onTick()

Overrides: Window:onTick.
Declared on: line 290 of Lua/dialogs/adviser.lua.

function UIAdviser:removeMessageFromHistory(index)

Removes a message from the adviser's message history.

Parameters:

Name	Type	Description
index	?	?

Declared on: line 100 of Lua/dialogs/adviser.lua.

function UIAdviser:say(speech, talk_until_next_announce, override_current)

Makes the adviser say something

Parameters:

Name	Type	Description
speech	?	The table containing the text he should say and the priority.
talk_until_next_announce	?	Whether he should stay up until the next say() call is made. Useful for the tutorial.
override_current	?	Cancels previous messages (if any) immediately and shows this new one instead.

Declared on: line 194 of Lua/dialogs/adviser.lua.

function UIAdviser:show()

Shows the adviser by running the "popup" animation. Then moves on to the next phase automatically.

Declared on: line 110 of Lua/dialogs/adviser.lua.

function UIAdviser:talk()

Displays the text bubble along with the next message from the queue.

Declared on: line 119 of Lua/dialogs/adviser.lua.