DreamGUI
Reference

Class reference

Every public DreamGUI class's properties, functions and events, printed from reflection, with its UMG comparison.

One page per class: its properties (type, category, whether the details panel shows it, how a Blueprint reads and writes it), the functions it offers, its events, and at the end how its names compare with the UMG class it corresponds to. The pages are printed from reflection by the plugin's DreamGUIReferenceDocs commandlet, so they cannot fall behind the headers:

UnrealEditor-Cmd.exe <project>.uproject -run=DreamGUIReferenceDocs

Why the names follow UMG's, and which members differ on purpose: UMG parity.

Controls

UDreamBorderA border whose hierarchy is code, not an asset: a face, a padding, and a hole to put things in.
UDreamButtonA button whose hierarchy is code, not an asset.
UDreamDialogA dialog whose hierarchy is code, not an asset: a dimmer, a centred panel, a title, a content
UDreamDropdownA dropdown whose hierarchy is code, not an asset.
UDreamEditableTextA text field with no box: UMG's EditableText, where Native.TextInput is its EditableTextBox.
UDreamExpandableAreaA header that toggles, and the content it hides.
UDreamInputKeySelectorA button whose label is a bound key, and which listens for the next one when clicked.
UDreamListViewA list whose hierarchy is code, not an asset: rows built from a source, in a scrolling viewport.
UDreamListViewBaseEverything a list and a tree have in common, which is nearly all of it.
UDreamMenuAnchorA place a menu opens from, and the thing that puts it away again.
UDreamMultiLineEditableTextThe same field over several lines: UMG's MultiLineEditableText.
UDreamNativeWidgetHostA hole in a DreamGUI hierarchy that a UMG widget fills.
UDreamProgressBarA progress bar whose hierarchy is code, not an asset.
UDreamRadioButtonA radio button whose hierarchy is code, not an asset.
UDreamRichTextBlockA rich text block whose hierarchy is code, not an asset: one paragraph that reads markup.
UDreamRingMenuA ring menu whose hierarchy is code, not an asset: wedges around a hub, picked by direction.
UDreamScrollBarA scroll bar whose hierarchy is code, not an asset.
UDreamScrollBoxA scroll box whose hierarchy is code, not an asset.
UDreamSliderA slider whose hierarchy is code, not an asset.
UDreamSpinBoxA spin box whose hierarchy is code, not an asset.
UDreamTabViewA tab view whose hierarchy is code, not an asset: a strip of tabs over a switcher of pages.
UDreamTextInputA text field whose hierarchy is code, not an asset.
UDreamThrobberA throbber whose hierarchy is code, not an asset: N pieces that pulse, saying only "something is
UDreamTileViewA tile view whose hierarchy is code, not an asset: a list whose rows are laid out across as well
UDreamToggleA toggle whose hierarchy is code, not an asset.
UDreamTreeViewA tree whose hierarchy is code, not an asset: a list whose rows carry an indent and a twisty.
UDreamUIControlA control whose hierarchy is code, not an asset.

Panels and slots

UDreamLayoutContainerBorderUMG's UBorder: one child, padded, aligned by the BORDER rather than by the child's slot.
UDreamLayoutContainerCanvasPanelUMG Canvas Panel
UDreamLayoutContainerGridPanelUMG Grid Panel
UDreamLayoutContainerHorizontalBoxUMG Horizontal Box
UDreamLayoutContainerMenuAnchorUMG's UMenuAnchor, layout side.
UDreamLayoutContainerOverlayUMG Overlay
UDreamLayoutContainerSafeZoneUMG Safe Zone
UDreamLayoutContainerScaleBoxUMG Scale Box
UDreamLayoutContainerScrollBoxUMG Scroll Box
UDreamLayoutContainerSizeBoxUMG Size Box
UDreamLayoutContainerStackBoxUMG Stack Box
UDreamLayoutContainerUniformGridPanelUMG Uniform Grid Panel
UDreamLayoutContainerVerticalBoxUMG Vertical Box
UDreamLayoutContainerWidgetSwitcherUMG Widget Switcher
UDreamLayoutContainerWrapBoxUMG Wrap Box
UDreamPanelLayoutBaseDream Panel Layout Base
UDreamPanelSlotUMG-style per-child layout data owned by the child widget.

Widgets

UDreamUserWidgetA widget hierarchy that is a CLASS rather than an asset instance -- the counterpart to UMG's
UDreamWidgetBase class for almost all UI related things.

Function libraries

UDreamLyricsLibraryDream Lyrics Library
UDreamTextPaintLibraryTweens that move a text's paints (FDreamTextPaint) without repainting it: each drives one of UDreamText's paint
UDreamUIAnimationLibraryThe Blueprint-side helpers for FDreamUIAnimationHandle, which a struct cannot carry itself.
UDreamUIBPLibraryDream UIBPLibrary
UDreamUICaptureLibraryPictures of what DreamGUI draws, written out as PNG files -- a render target, a canvas that renders into one, or a
UDreamUIInputModeLibraryInput mode and cursor control, addressed by DreamGUI's user index rather than by a raw controller.
UDreamUILayoutLibraryThe viewport, the mouse and the screen -- this framework's UWidgetLayoutLibrary.
UDreamUIWidgetGeometryLibraryCoordinate conversions between a widget's own space, the viewport and the screen -- this
UDreamUIWidgetLibraryFinding widgets, driving a drag, and building an image brush from Blueprint -- the parts of

Styles

FDreamBorderStyleA border: a brush, a padding and one child.
FDreamButtonStyleA button: one face, three pointer states, a label.
FDreamDialogStyleA dialog: a dimmer over the screen, a panel on it, a title, content and buttons.
FDreamDropdownStyleA dropdown: a button-shaped face, and the list it opens.
FDreamExpandableAreaStyleAn expandable area: a header that toggles, and the content it hides.
FDreamInputKeySelectorStyleA key binder: a button whose label is the bound key, and which listens when pressed.
FDreamListStyleA list: rows built from a source, in a scrolling viewport.
FDreamMenuAnchorStyleA menu anchor: the popup's look, and how it is placed against whatever opened it.
FDreamProgressBarStyleA progress bar: a track and the filled part of it.
FDreamRadioButtonStyleA radio button: the toggle's anatomy -- a box, a mark inside it, a label beside it -- with the
FDreamRichTextStyleA rich text block: one paragraph that reads markup.
FDreamRingMenuStyleA ring menu: wedges around a hub, and the geometry that decides where they sit.
FDreamScrollBarStyleA scroll box: a clipped viewport, the content that slides inside it, and the bars beside it.
FDreamScrollBoxStyleDream Scroll Box Style
FDreamSliderStyleA slider: a track, the filled part of it, and the handle riding it.
FDreamSpinBoxStyleA spin box: a numeric field between a decrement face and an increment face.
FDreamTabViewStyleA tab view: a strip of tabs over a switcher of pages.
FDreamTextInputStyleA text field: the box, the text in it, and the placeholder shown while there is none.
FDreamTextStyleHow the built-in shader draws a text's glyphs beyond the plain face: outline, underlay (drop
FDreamThrobberStyleA throbber: N identical pieces, animating, saying only "something is happening".
FDreamTileViewStyleA tile view: a list whose rows are a grid of tiles.
FDreamToggleStyleWhat a toggle looks like, separated from what it is.
FDreamTreeViewStyleA tree: a list whose rows carry an indent and a twisty.
FDreamUIFaceBrushAn optional skin for a control part's procedural-rect face.
FDreamUIImageBrushDream UIImage Brush
FDreamUIStateFacesOne face drawn five ways -- Slate's FButtonStyle shape, which is the thing a control style here
FDreamUIWidgetGeometryA widget's measured rect, and the handle every coordinate conversion below is asked through --

On this page