Class DaggerfallMessageBox

Implements a Daggerfal popup message box dialog with variable buttons. Designed to take Daggerfall multiline text resource records.

Inheritance
Object
UserInterfaceWindow
DaggerfallBaseWindow
DaggerfallPopupWindow
DaggerfallMessageBox
CreateCharGenderSelect
DaggerfallGuildServiceCureDisease
Inherited Members
Namespace: DaggerfallWorkshop.Game.UserInterfaceWindows
Assembly: Assembly-CSharp.dll
Syntax
public class DaggerfallMessageBox : DaggerfallPopupWindow, IUserInterfaceWindow

Constructors

| Improve this Doc View Source

DaggerfallMessageBox(IUserInterfaceManager, IUserInterfaceWindow, Boolean, Int32)

Declaration
public DaggerfallMessageBox(IUserInterfaceManager uiManager, IUserInterfaceWindow previous = null, bool wrapText = false, int posY = -1)
Parameters
Type Name Description
IUserInterfaceManager uiManager
IUserInterfaceWindow previous
Boolean wrapText
Int32 posY
| Improve this Doc View Source

DaggerfallMessageBox(IUserInterfaceManager, DaggerfallMessageBox.CommonMessageBoxButtons, TextFile.Token[], IUserInterfaceWindow, IMacroContextProvider)

Declaration
public DaggerfallMessageBox(IUserInterfaceManager uiManager, DaggerfallMessageBox.CommonMessageBoxButtons buttons, TextFile.Token[] tokens, IUserInterfaceWindow previous = null, IMacroContextProvider mcp = null)
Parameters
Type Name Description
IUserInterfaceManager uiManager
DaggerfallMessageBox.CommonMessageBoxButtons buttons
TextFile.Token[] tokens
IUserInterfaceWindow previous
IMacroContextProvider mcp
| Improve this Doc View Source

DaggerfallMessageBox(IUserInterfaceManager, DaggerfallMessageBox.CommonMessageBoxButtons, Int32, IUserInterfaceWindow, IMacroContextProvider)

Declaration
public DaggerfallMessageBox(IUserInterfaceManager uiManager, DaggerfallMessageBox.CommonMessageBoxButtons buttons, int textId, IUserInterfaceWindow previous = null, IMacroContextProvider mcp = null)
Parameters
Type Name Description
IUserInterfaceManager uiManager
DaggerfallMessageBox.CommonMessageBoxButtons buttons
Int32 textId
IUserInterfaceWindow previous
IMacroContextProvider mcp
| Improve this Doc View Source

DaggerfallMessageBox(IUserInterfaceManager, DaggerfallMessageBox.CommonMessageBoxButtons, String, IUserInterfaceWindow)

Declaration
public DaggerfallMessageBox(IUserInterfaceManager uiManager, DaggerfallMessageBox.CommonMessageBoxButtons buttons, string text, IUserInterfaceWindow previous = null)
Parameters
Type Name Description
IUserInterfaceManager uiManager
DaggerfallMessageBox.CommonMessageBoxButtons buttons
String text
IUserInterfaceWindow previous

Properties

| Improve this Doc View Source

ButtonSpacing

Declaration
public int ButtonSpacing { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

ButtonTextDistance

Declaration
public int ButtonTextDistance { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

ClickAnywhereToClose

Declaration
public bool ClickAnywhereToClose { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

ExtraProceedBinding

Declaration
public KeyCode ExtraProceedBinding { get; set; }
Property Value
Type Description
KeyCode
| Improve this Doc View Source

ImagePanel

Declaration
public Panel ImagePanel { get; }
Property Value
Type Description
Panel
| Improve this Doc View Source

SelectedButton

Declaration
public DaggerfallMessageBox.MessageBoxButtons SelectedButton { get; }
Property Value
Type Description
DaggerfallMessageBox.MessageBoxButtons
| Improve this Doc View Source

TextScale

Change the scale of text inside message box. Must set custom TextScale immediately after creating messagebox and before setting text/tokens.

Declaration
public float TextScale { get; set; }
Property Value
Type Description
Single

Methods

| Improve this Doc View Source

AddButton(DaggerfallMessageBox.MessageBoxButtons, Boolean)

Declaration
public Button AddButton(DaggerfallMessageBox.MessageBoxButtons messageBoxButton, bool defaultButton = false)
Parameters
Type Name Description
DaggerfallMessageBox.MessageBoxButtons messageBoxButton
Boolean defaultButton
Returns
Type Description
Button
| Improve this Doc View Source

AddNextMessageBox(DaggerfallMessageBox)

Adds another nested message box to be displayed next when click detected.

Declaration
public void AddNextMessageBox(DaggerfallMessageBox nextMessageBox)
Parameters
Type Name Description
DaggerfallMessageBox nextMessageBox

Next message box.
| Improve this Doc View Source

EnableVerticalScrolling(Int32)

Enables vertical scrolling of message panel. Width is determined by widest text line as with non-scrolling message box. Must call this before setting text.

Declaration
public void EnableVerticalScrolling(int height)
Parameters
Type Name Description
Int32 height

Capped height of visible area of message panel. Anything past this size will become scrollable.
| Improve this Doc View Source

GetDefaultButton()

Gets default button (if any).

Declaration
public Button GetDefaultButton()
Returns
Type Description
Button

Default Button reference, or null if no default button defined.
| Improve this Doc View Source

OnPop()

Declaration
public override void OnPop()
Overrides
| Improve this Doc View Source

OnPush()

Declaration
public override void OnPush()
Overrides
| Improve this Doc View Source

SetHighlightColor(Color)

Must be set before text otherwise layout has already occurred.

Declaration
public void SetHighlightColor(Color highlightColor)
Parameters
Type Name Description
Color highlightColor
| Improve this Doc View Source

SetText(String, IMacroContextProvider)

Declaration
public void SetText(string text, IMacroContextProvider mcp = null)
Parameters
Type Name Description
String text
IMacroContextProvider mcp
| Improve this Doc View Source

SetText(String[], IMacroContextProvider)

Declaration
public void SetText(string[] rows, IMacroContextProvider mcp = null)
Parameters
Type Name Description
String[] rows
IMacroContextProvider mcp
| Improve this Doc View Source

SetTextTokens(TextFile.Token[], IMacroContextProvider, Boolean)

Declaration
public void SetTextTokens(TextFile.Token[] tokens, IMacroContextProvider mcp = null, bool expandMacros = true)
Parameters
Type Name Description
TextFile.Token[] tokens
IMacroContextProvider mcp
Boolean expandMacros
| Improve this Doc View Source

SetTextTokens(Int32, IMacroContextProvider)

Declaration
public void SetTextTokens(int id, IMacroContextProvider mcp = null)
Parameters
Type Name Description
Int32 id
IMacroContextProvider mcp
| Improve this Doc View Source

Setup()

Declaration
protected override void Setup()
Overrides
| Improve this Doc View Source

Show()

Declaration
public void Show()
| Improve this Doc View Source

Update()

Declaration
public override void Update()
Overrides

Events

| Improve this Doc View Source

OnButtonClick

Declaration
public event DaggerfallMessageBox.OnButtonClickHandler OnButtonClick
Event Type
Type Description
DaggerfallMessageBox.OnButtonClickHandler

Implements