Class DaggerfallUI

Implements Daggerfall's user interface with internal UI system.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
DaggerfallUI
Namespace: DaggerfallWorkshop.Game
Assembly: Assembly-CSharp.dll
Syntax
[RequireComponent(typeof(FadeBehaviour))]
[RequireComponent(typeof(DaggerfallAudioSource))]
public class DaggerfallUI : MonoBehaviour

Fields

| Improve this Doc View Source

DaggerfallAlternateHighlightTextColor

Declaration
public static Color DaggerfallAlternateHighlightTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallAlternateShadowColor1

Declaration
public static Color DaggerfallAlternateShadowColor1
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallAnswerTextColor

Declaration
public static Color DaggerfallAnswerTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallBrighterSelectedTextColor

Declaration
public static Color DaggerfallBrighterSelectedTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultHouseAutomapColor

Declaration
public static Color DaggerfallDefaultHouseAutomapColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultInputTextColor

Declaration
public static Color DaggerfallDefaultInputTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultMicMapBorderQoLColor

Declaration
public static Color DaggerfallDefaultMicMapBorderQoLColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultMicMapInnerQoLColor

Declaration
public static Color DaggerfallDefaultMicMapInnerQoLColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultSelectedTextColor

Declaration
public static Color DaggerfallDefaultSelectedTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultShadowColor

Declaration
public static Color DaggerfallDefaultShadowColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultShadowPos

Declaration
public static Vector2 DaggerfallDefaultShadowPos
Field Value
Type Description
Vector2
| Improve this Doc View Source

DaggerfallDefaultShopAutomapColor

Declaration
public static Color DaggerfallDefaultShopAutomapColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultTavernAutomapColor

Declaration
public static Color DaggerfallDefaultTavernAutomapColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultTempleAutomapColor

Declaration
public static Color DaggerfallDefaultTempleAutomapColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultTextColor

Declaration
public static Color DaggerfallDefaultTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDefaultTextCursorColor

Declaration
public static Color DaggerfallDefaultTextCursorColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallDisabledTextColor

Declaration
public static Color DaggerfallDisabledTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallForcedEnchantmentTextColor

Declaration
public static Color DaggerfallForcedEnchantmentTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallHighlightDisabledTextColor

Declaration
public static Color DaggerfallHighlightDisabledTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallHighlightTextColor

Declaration
public static Color DaggerfallHighlightTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallInfoPanelTextColor

Declaration
public static Color DaggerfallInfoPanelTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallPrisonDaysUntilFreedomColor

Declaration
public static Color DaggerfallPrisonDaysUntilFreedomColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallPrisonDaysUntilFreedomShadowColor

Declaration
public static Color DaggerfallPrisonDaysUntilFreedomShadowColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallQuestionTextColor

Declaration
public static Color DaggerfallQuestionTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallUnityDefaultCheckboxToggleColor

Declaration
public static Color DaggerfallUnityDefaultCheckboxToggleColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallUnityDefaultToolTipBackgroundColor

Declaration
public static Color DaggerfallUnityDefaultToolTipBackgroundColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallUnityDefaultToolTipTextColor

Declaration
public static Color DaggerfallUnityDefaultToolTipTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallUnityNotImplementedColor

Declaration
public static Color DaggerfallUnityNotImplementedColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallUnityStatDrainedTextColor

Declaration
public static Color DaggerfallUnityStatDrainedTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

DaggerfallUnityStatIncreasedTextColor

Declaration
public static Color DaggerfallUnityStatIncreasedTextColor
Field Value
Type Description
Color
| Improve this Doc View Source

enableHUD

Declaration
public bool enableHUD
Field Value
Type Description
Boolean
| Improve this Doc View Source

enableVideos

Declaration
public bool enableVideos
Field Value
Type Description
Boolean
| Improve this Doc View Source

globalFilterMode

Declaration
public FilterMode globalFilterMode
Field Value
Type Description
FilterMode
| Improve this Doc View Source

startupMessage

Declaration
public string startupMessage
Field Value
Type Description
String

Properties

| Improve this Doc View Source

AudioSource

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

AutomapWindow

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

BookReaderWindow

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

ControlsWindow

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

CustomMousePosition

Declaration
public Vector2? CustomMousePosition { get; set; }
Property Value
Type Description
Nullable<Vector2>
| Improve this Doc View Source

CustomRenderTarget

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

CustomScreenRect

Gets or sets custom screen rect. This will be used instead of actual screen area when determining controls root size.

Declaration
public Rect? CustomScreenRect { get; set; }
Property Value
Type Description
Nullable<Rect>
| Improve this Doc View Source

DaggerfallAudioSource

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

DaggerfallHUD

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

DaggerfallSongPlayer

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

DefaultFont

Declaration
public static DaggerfallFont DefaultFont { get; }
Property Value
Type Description
DaggerfallFont
| Improve this Doc View Source

DfCourtWindow

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

DfItemMakerWindow

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

DfPotionMakerWindow

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

DfSpellMakerWindow

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

DfTravelMapWindow

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

ExteriorAutomapWindow

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

FadeBehaviour

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

Font1

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

Font2

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

Font3

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

Font4

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

Font5

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

FontsFolder

Declaration
public string FontsFolder { get; }
Property Value
Type Description
String
| Improve this Doc View Source

GameEffectsConfigWindow

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

GlobalFilterMode

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

HasInstance

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

HotkeySequenceProcessed

Declaration
public HotkeySequence.HotkeySequenceProcessStatus HotkeySequenceProcessed { get; }
Property Value
Type Description
HotkeySequence.HotkeySequenceProcessStatus
| Improve this Doc View Source

Instance

Declaration
public static DaggerfallUI Instance { get; }
Property Value
Type Description
DaggerfallUI
| Improve this Doc View Source

InventoryWindow

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

JoystickControlsWindow

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

KeyEvent

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

LargeFont

Declaration
public static DaggerfallFont LargeFont { get; }
Property Value
Type Description
DaggerfallFont
| Improve this Doc View Source

LastCharacterTyped

Declaration
public char LastCharacterTyped { get; }
Property Value
Type Description
Char
| Improve this Doc View Source

LastKeyCode

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

LastKeyModifiers

Declaration
public HotkeySequence.KeyModifiers LastKeyModifiers { get; }
Property Value
Type Description
HotkeySequence.KeyModifiers
| Improve this Doc View Source

MouseControlsWindow

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

PaperDollRenderer

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

PixelFontMaterial

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

SDFFontMaterial

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

ShowVersionText

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

SmallFont

Declaration
public static DaggerfallFont SmallFont { get; }
Property Value
Type Description
DaggerfallFont
| Improve this Doc View Source

SpellIconCollection

Gets spell icon collection for UI systems.

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

TalkWindow

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

TitleFont

Declaration
public static DaggerfallFont TitleFont { get; }
Property Value
Type Description
DaggerfallFont
| Improve this Doc View Source

UIBlendMaterial

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

UIBlitMaterial

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

UIManager

Declaration
public static IUserInterfaceManager UIManager { get; }
Property Value
Type Description
IUserInterfaceManager
| Improve this Doc View Source

UserInterfaceManager

Declaration
public UserInterfaceManager UserInterfaceManager { get; }
Property Value
Type Description
UserInterfaceManager

Methods

| Improve this Doc View Source

AddButton(Rect, Panel)

Declaration
public static Button AddButton(Rect rect, Panel panel = null)
Parameters
Type Name Description
Rect rect
Panel panel
Returns
Type Description
Button
| Improve this Doc View Source

AddButton(Vector2, Vector2, Panel)

Declaration
public static Button AddButton(Vector2 position, Vector2 size, Panel panel = null)
Parameters
Type Name Description
Vector2 position
Vector2 size
Panel panel
Returns
Type Description
Button
| Improve this Doc View Source

AddButton(Vector2, Vector2, String, Panel)

Declaration
public static Button AddButton(Vector2 position, Vector2 size, string clickMessage, Panel panel = null)
Parameters
Type Name Description
Vector2 position
Vector2 size
String clickMessage
Panel panel
Returns
Type Description
Button
| Improve this Doc View Source

AddButton(Vector2, Vector2, String, String, Panel)

Declaration
public static Button AddButton(Vector2 position, Vector2 size, string clickMessage, string doubleClickMessage, Panel panel = null)
Parameters
Type Name Description
Vector2 position
Vector2 size
String clickMessage
String doubleClickMessage
Panel panel
Returns
Type Description
Button
| Improve this Doc View Source

AddCheckbox(Vector2, Boolean, Panel)

Declaration
public static Checkbox AddCheckbox(Vector2 position, bool isChecked, Panel panel = null)
Parameters
Type Name Description
Vector2 position
Boolean isChecked
Panel panel
Returns
Type Description
Checkbox
| Improve this Doc View Source

AddColorPicker(Vector2, Color32, IUserInterfaceManager, DaggerfallBaseWindow, Panel)

Declaration
public static Button AddColorPicker(Vector2 position, Color32 color, IUserInterfaceManager uiManager, DaggerfallBaseWindow previous = null, Panel panel = null)
Parameters
Type Name Description
Vector2 position
Color32 color
IUserInterfaceManager uiManager
DaggerfallBaseWindow previous
Panel panel
Returns
Type Description
Button
| Improve this Doc View Source

AddDefaultShadowedTextLabel(Vector2, Panel, Int32)

Declaration
public static TextLabel AddDefaultShadowedTextLabel(Vector2 position, Panel panel = null, int glyphSpacing = 1)
Parameters
Type Name Description
Vector2 position
Panel panel
Int32 glyphSpacing
Returns
Type Description
TextLabel
| Improve this Doc View Source

AddHUDText(TextFile.Token[], Single)

Declaration
public static void AddHUDText(TextFile.Token[] tokens, float delay)
Parameters
Type Name Description
TextFile.Token[] tokens
Single delay
| Improve this Doc View Source

AddHUDText(String)

Declaration
public static void AddHUDText(string message)
Parameters
Type Name Description
String message
| Improve this Doc View Source

AddHUDText(String, Single)

Declaration
public static void AddHUDText(string message, float delay)
Parameters
Type Name Description
String message
Single delay
| Improve this Doc View Source

AddOutline(Rect, Color, Panel)

Declaration
public static Outline AddOutline(Rect rect, Color color, Panel panel = null)
Parameters
Type Name Description
Rect rect
Color color
Panel panel
Returns
Type Description
Outline
| Improve this Doc View Source

AddPanel(Panel, AutoSizeModes)

Declaration
public static Panel AddPanel(Panel panel = null, AutoSizeModes scaling = AutoSizeModes.ResizeToFill)
Parameters
Type Name Description
Panel panel
AutoSizeModes scaling
Returns
Type Description
Panel
| Improve this Doc View Source

AddPanel(Rect, Panel)

Declaration
public static Panel AddPanel(Rect rect, Panel panel = null)
Parameters
Type Name Description
Rect rect
Panel panel
Returns
Type Description
Panel
| Improve this Doc View Source

AddSlider(Vector2, Action<HorizontalSlider>, Single, Panel)

Declaration
public static HorizontalSlider AddSlider(Vector2 position, Action<HorizontalSlider> setIndicator, float textScale = 1F, Panel panel = null)
Parameters
Type Name Description
Vector2 position
Action<HorizontalSlider> setIndicator
Single textScale
Panel panel
Returns
Type Description
HorizontalSlider
| Improve this Doc View Source

AddSlider(Vector2, Single, Action<HorizontalSlider>, Single, Panel)

Declaration
public static HorizontalSlider AddSlider(Vector2 position, float length, Action<HorizontalSlider> setIndicator, float textScale = 1F, Panel panel = null)
Parameters
Type Name Description
Vector2 position
Single length
Action<HorizontalSlider> setIndicator
Single textScale
Panel panel
Returns
Type Description
HorizontalSlider
| Improve this Doc View Source

AddTextBox(Rect, String, Panel, Int32, DaggerfallFont, Int32)

Declaration
public static TextBox AddTextBox(Rect rect, string defaultText, Panel panel = null, int maxCharacters = -1, DaggerfallFont font = null, int glyphSpacing = 1)
Parameters
Type Name Description
Rect rect
String defaultText
Panel panel
Int32 maxCharacters
DaggerfallFont font
Int32 glyphSpacing
Returns
Type Description
TextBox
| Improve this Doc View Source

AddTextBoxWithFocus(Rect, String, Panel, Int32, DaggerfallFont)

Declaration
public static TextBox AddTextBoxWithFocus(Rect rect, string defaultText, Panel panel = null, int maxCharacters = -1, DaggerfallFont font = null)
Parameters
Type Name Description
Rect rect
String defaultText
Panel panel
Int32 maxCharacters
DaggerfallFont font
Returns
Type Description
TextBox
| Improve this Doc View Source

AddTextButton(Rect, String, Panel)

Declaration
public static Button AddTextButton(Rect rect, string text, Panel panel = null)
Parameters
Type Name Description
Rect rect
String text
Panel panel
Returns
Type Description
Button
| Improve this Doc View Source

AddTextLabel(DaggerfallFont, Vector2, String, Panel, Int32)

Declaration
public static TextLabel AddTextLabel(DaggerfallFont font, Vector2 position, string text, Panel panel = null, int glyphSpacing = 1)
Parameters
Type Name Description
DaggerfallFont font
Vector2 position
String text
Panel panel
Int32 glyphSpacing
Returns
Type Description
TextLabel
| Improve this Doc View Source

CalculateScaledTextureRects(Rect, ScaleMode, Single, ref Rect, ref Rect)

Declaration
public static bool CalculateScaledTextureRects(Rect position, ScaleMode scaleMode, float imageAspect, ref Rect outScreenRect, ref Rect outSourceRect)
Parameters
Type Name Description
Rect position
ScaleMode scaleMode
Single imageAspect
Rect outScreenRect
Rect outSourceRect
Returns
Type Description
Boolean
| Improve this Doc View Source

CreateHealthStatusBox(IUserInterfaceWindow)

Declaration
public DaggerfallMessageBox CreateHealthStatusBox(IUserInterfaceWindow previous = null)
Parameters
Type Name Description
IUserInterfaceWindow previous
Returns
Type Description
DaggerfallMessageBox
| Improve this Doc View Source

CreateSolidTexture(Color, Int32)

Declaration
public static Texture2D CreateSolidTexture(Color color, int dim)
Parameters
Type Name Description
Color color
Int32 dim
Returns
Type Description
Texture2D
| Improve this Doc View Source

DrawTexture(Rect, Texture, ScaleMode, Boolean)

Custom DrawTexture for DagUI.

Declaration
public static void DrawTexture(Rect position, Texture image, ScaleMode scaleMode = ScaleMode.StretchToFill, bool alphaBlend = true)
Parameters
Type Name Description
Rect position

Rectangle on screen to draw the texture within.
Texture image

Texture to display.
ScaleMode scaleMode

How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within.
Boolean alphaBlend

Whether to enable alpha blending when drawing the image (enabled by default).
| Improve this Doc View Source

DrawTexture(Rect, Texture, ScaleMode, Boolean, Color)

Custom DrawTexture for DagUI.

Declaration
public static void DrawTexture(Rect position, Texture image, ScaleMode scaleMode, bool alphaBlend, Color color)
Parameters
Type Name Description
Rect position

Rectangle on screen to draw the texture within.
Texture image

Texture to display.
ScaleMode scaleMode

How to scale the image when the aspect ratio of it doesn't fit the aspect ratio to be drawn within.
Boolean alphaBlend

Whether to enable alpha blending when drawing the image (enabled by default).
Color color

A tint color to apply on the texture.
| Improve this Doc View Source

DrawTextureWithTexCoords(Rect, Texture, Rect, Boolean)

Custom DrawTextureWithTexCoords for DagUI.

Declaration
public static void DrawTextureWithTexCoords(Rect position, Texture image, Rect texCoords, bool alphaBlend = true)
Parameters
Type Name Description
Rect position

Rectangle on screen to draw the texture within.
Texture image

Texture to display.
Rect texCoords

Rectangle of source texture to draw.
Boolean alphaBlend

Whether to enable alpha blending when drawing the image (enabled by default).
| Improve this Doc View Source

DrawTextureWithTexCoords(Rect, Texture, Rect, Boolean, Color)

Custom DrawTextureWithTexCoords for DagUI.

Declaration
public static void DrawTextureWithTexCoords(Rect position, Texture image, Rect texCoords, bool alphaBlend, Color color)
Parameters
Type Name Description
Rect position

Rectangle on screen to draw the texture within.
Texture image

Texture to display.
Rect texCoords

Rectangle of source texture to draw.
Boolean alphaBlend

Whether to enable alpha blending when drawing the image (enabled by default).
Color color

A tint color to apply on the texture.
| Improve this Doc View Source

FindDaggerfallUI(out DaggerfallUI)

Declaration
public static bool FindDaggerfallUI(out DaggerfallUI dfUnityOut)
Parameters
Type Name Description
DaggerfallUI dfUnityOut
Returns
Type Description
Boolean
| Improve this Doc View Source

GetAudioClip(SoundClips)

Declaration
public AudioClip GetAudioClip(SoundClips clip)
Parameters
Type Name Description
SoundClips clip
Returns
Type Description
AudioClip
| Improve this Doc View Source

GetDistinctResolutions()

Gets all resolutions without duplicates; when the same resolution support different refresh rates, the highest one is chosen.

Declaration
public static Resolution[] GetDistinctResolutions()
Returns
Type Description
Resolution[]

All supported distinct resolutions.
| Improve this Doc View Source

GetFont(DaggerfallFont.FontName)

Gets a DaggerfallFont.

Declaration
public DaggerfallFont GetFont(DaggerfallFont.FontName fontName)
Parameters
Type Name Description
DaggerfallFont.FontName fontName
Returns
Type Description
DaggerfallFont

DaggerfallFont
| Improve this Doc View Source

GetImgBitmap(String)

Declaration
public static DFBitmap GetImgBitmap(string name)
Parameters
Type Name Description
String name
Returns
Type Description
DFBitmap
| Improve this Doc View Source

GetPauseOptionsDropdownItems()

Returns shallow copied list of registered dropdown items in alphabetical order

Declaration
public IEnumerable<Tuple<string, Action>> GetPauseOptionsDropdownItems()
Returns
Type Description
IEnumerable<Tuple<String, Action>>
| Improve this Doc View Source

GetTextureFromCifRci(String, Int32, out DFPosition, Int32, TextureFormat)

Declaration
public static Texture2D GetTextureFromCifRci(string name, int record, out DFPosition offset, int frame = 0, TextureFormat format = TextureFormat.ARGB32)
Parameters
Type Name Description
String name
Int32 record
DFPosition offset
Int32 frame
TextureFormat format
Returns
Type Description
Texture2D
| Improve this Doc View Source

GetTextureFromCifRci(String, Int32, Int32, TextureFormat)

Declaration
public static Texture2D GetTextureFromCifRci(string name, int record, int frame = 0, TextureFormat format = TextureFormat.ARGB32)
Parameters
Type Name Description
String name
Int32 record
Int32 frame
TextureFormat format
Returns
Type Description
Texture2D
| Improve this Doc View Source

GetTextureFromImg(ImgFile, TextureFormat, Boolean)

Declaration
public static Texture2D GetTextureFromImg(ImgFile img, TextureFormat format = TextureFormat.ARGB32, bool readOnly = true)
Parameters
Type Name Description
ImgFile img
TextureFormat format
Boolean readOnly
Returns
Type Description
Texture2D
| Improve this Doc View Source

GetTextureFromImg(String, out DFPosition, TextureFormat, Boolean)

Declaration
public static Texture2D GetTextureFromImg(string name, out DFPosition offset, TextureFormat format = TextureFormat.ARGB32, bool readOnly = true)
Parameters
Type Name Description
String name
DFPosition offset
TextureFormat format
Boolean readOnly
Returns
Type Description
Texture2D
| Improve this Doc View Source

GetTextureFromImg(String, Rect, TextureFormat, Boolean)

Loads IMG file to texture using a subrect of source image. Origin of source image (0,0) is bottom-left corner.

Declaration
public static Texture2D GetTextureFromImg(string name, Rect subRect, TextureFormat format = TextureFormat.ARGB32, bool readOnly = true)
Parameters
Type Name Description
String name
Rect subRect
TextureFormat format
Boolean readOnly
Returns
Type Description
Texture2D
| Improve this Doc View Source

GetTextureFromImg(String, TextureFormat, Boolean)

Declaration
public static Texture2D GetTextureFromImg(string name, TextureFormat format = TextureFormat.ARGB32, bool readOnly = true)
Parameters
Type Name Description
String name
TextureFormat format
Boolean readOnly
Returns
Type Description
Texture2D
| Improve this Doc View Source

GetTextureFromResources(String)

Get a texture from resources with modding support.

Declaration
public static Texture2D GetTextureFromResources(string name)
Parameters
Type Name Description
String name
Returns
Type Description
Texture2D
| Improve this Doc View Source

GetTextureFromResources(String, out Vector2)

Get a texture from resources with modding support. Size is read from xml or set as texture size.

Declaration
public static Texture2D GetTextureFromResources(string name, out Vector2 size)
Parameters
Type Name Description
String name
Vector2 size
Returns
Type Description
Texture2D
| Improve this Doc View Source

GetTextureFromSaveImage(SaveImage, TextureFormat)

Declaration
public static Texture2D GetTextureFromSaveImage(SaveImage image, TextureFormat format = TextureFormat.ARGB32)
Parameters
Type Name Description
SaveImage image
TextureFormat format
Returns
Type Description
Texture2D
| Improve this Doc View Source

MessageBox(TextFile.Token[], IMacroContextProvider)

Declaration
public static DaggerfallMessageBox MessageBox(TextFile.Token[] tokens, IMacroContextProvider mcp = null)
Parameters
Type Name Description
TextFile.Token[] tokens
IMacroContextProvider mcp
Returns
Type Description
DaggerfallMessageBox
| Improve this Doc View Source

MessageBox(Int32, IMacroContextProvider)

Declaration
public static DaggerfallMessageBox MessageBox(int id, IMacroContextProvider mcp = null)
Parameters
Type Name Description
Int32 id
IMacroContextProvider mcp
Returns
Type Description
DaggerfallMessageBox
| Improve this Doc View Source

MessageBox(String, Boolean, IMacroContextProvider)

Declaration
public static DaggerfallMessageBox MessageBox(string message, bool wrapText = false, IMacroContextProvider mcp = null)
Parameters
Type Name Description
String message
Boolean wrapText
IMacroContextProvider mcp
Returns
Type Description
DaggerfallMessageBox
| Improve this Doc View Source

MessageBox(String[], IMacroContextProvider)

Declaration
public static DaggerfallMessageBox MessageBox(string[] message, IMacroContextProvider mcp = null)
Parameters
Type Name Description
String[] message
IMacroContextProvider mcp
Returns
Type Description
DaggerfallMessageBox
| Improve this Doc View Source

ModulateColor(Color)

Modulates a Color for Graphics.DrawTexture where neutral is 0.5, 0.5, 0.5, 0.5

Declaration
public static Color ModulateColor(Color input)
Parameters
Type Name Description
Color input

Input Color.
Returns
Type Description
Color

Output Color modulates for Graphics.DrawTexture.
| Improve this Doc View Source

OnKeyPress(KeyCode, Boolean)

Declaration
public void OnKeyPress(KeyCode key, bool down)
Parameters
Type Name Description
KeyCode key
Boolean down
| Improve this Doc View Source

PlayOneShot(SoundClips)

Declaration
public void PlayOneShot(SoundClips clip)
Parameters
Type Name Description
SoundClips clip
| Improve this Doc View Source

PlayOneShot(AudioClip)

Declaration
public void PlayOneShot(AudioClip clip)
Parameters
Type Name Description
AudioClip clip
| Improve this Doc View Source

PopToHUD()

Pops all windows down to HUD (if present).

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

PopupMessage(String)

Declaration
public void PopupMessage(string text)
Parameters
Type Name Description
String text
| Improve this Doc View Source

PostMessage(String)

Declaration
public static void PostMessage(string message)
Parameters
Type Name Description
String message
| Improve this Doc View Source

ProcessHotKeySequences()

Declaration
public HotkeySequence.HotkeySequenceProcessStatus ProcessHotKeySequences()
Returns
Type Description
HotkeySequence.HotkeySequenceProcessStatus
| Improve this Doc View Source

RaiseOnInstantiatePersistentWindowInstances()

Declaration
protected virtual void RaiseOnInstantiatePersistentWindowInstances()
| Improve this Doc View Source

RefreshLargeHUDHeadTexture()

Declaration
public static void RefreshLargeHUDHeadTexture()
| Improve this Doc View Source

RegisterPauseOptionToDropdown(String, Action)

Registers a title and click event to add to the pause window dropdown menu

Declaration
public void RegisterPauseOptionToDropdown(string text, Action action)
Parameters
Type Name Description
String text

The text of the dropdown button.
Action action

The action executed for clicking on the button.
| Improve this Doc View Source

ReinstantiatePersistentWindowInstances()

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

SetDaggerfallPopupStyle(DaggerfallUI.PopupStyle, Panel)

Declaration
public void SetDaggerfallPopupStyle(DaggerfallUI.PopupStyle style, Panel panel)
Parameters
Type Name Description
DaggerfallUI.PopupStyle style
Panel panel
| Improve this Doc View Source

SetFocus(BaseScreenComponent)

Declaration
public static void SetFocus(BaseScreenComponent control)
Parameters
Type Name Description
BaseScreenComponent control
| Improve this Doc View Source

SetFont(DaggerfallFont.FontName, DaggerfallFont)

Sets internal fonts used by game. Useful for standalone font mods. Locale mods can still override this by registering a new font for current locale.

Declaration
public void SetFont(DaggerfallFont.FontName fontName, DaggerfallFont font)
Parameters
Type Name Description
DaggerfallFont.FontName fontName

Name of font to set.
DaggerfallFont font

Font object.
| Improve this Doc View Source

SetMidScreenText(String, Single)

Declaration
public static void SetMidScreenText(string message, float delay = 1.5F)
Parameters
Type Name Description
String message
Single delay

Events

| Improve this Doc View Source

OnInstantiatePersistentWindowInstances

Declaration
public event DaggerfallUI.OnInstantiatePersistentWindowInstancesHandler OnInstantiatePersistentWindowInstances
Event Type
Type Description
DaggerfallUI.OnInstantiatePersistentWindowInstancesHandler

Extension Methods