Table of Contents

Namespace UILib

Classes

Audio

A class for interacting with UILib's audio.

Note: If you intend to play multiple arbitrary sounds at once, you should not use this class.

It's intended for most simple use cases, and has an AudioSource per Play* method, but it can't handle playing multiple sounds at once through the same Play* method.

Canvas

A Canvas which each Overlay gets attached to.

Every overlay has its own canvas to handle sorting them on top of each other.

Colors

A class for helping with generating colors using a variety of color representations.

Overlay

A primitive UIObject which stays in a fixed position on the screen.

ResizeButton

A button which is added to the bottom right of Windows to allow resizing them.

Resources

A class holding resources used by UILib. These resources are loaded from an AssetBundle.

Shortcut

A class which represents a shortcut. This holds important information about a shortcut such as the event listener and underlying keybinds.

Also has a useful field canRun which indicates whether a shortcut can run. This takes into consideration a variety of cases including:

  • UILib's InputOverlay waiting for an input
  • An input field being selected (to avoid triggering while typing/deselecting)
  • The player is editing keybinds in the InGameMenu
Theme

Provides a way of modifying how UIs are themed.

TitleBar

The title bar which is placed at the top of all Windows.

UIComponent

The base class which components that can be placed on the UI inherit from.

UIObject

The base class which most objects inherit from.

You'd rarely want to use this class directly though. Most of the time you'd want to use UIComponent or something like an Overlay or Window.

Provides most of the necessary functionality.

UIRoot

The root of UILib. This initializes audio, notifications, the color picker, the input overlay, and handles window management.

You should use onInit to know when you can start using UILib. onInit invokes listeners once UILib has finished setting everything up internally.

Window

A Window object. Like an Overlay but more dynamic.

This object is one of the fundamental building blocks of UILib.

It supports being moved, resized, maximised, closed.

It also has a specially configured ScrollView built in.

Enums

Overlay.SortingMode

The sorting modes which can be applied to Overlays.