QUI_Menu

Responsible for managing all of the UI elements in a menu.

QUI_Element

The base for most UI elements in the Quantum UI system. It contains all the basic fields and methods used by each element.

public bool startActive If the element should start as active. Keep in mind only one tab window can be active, if this is a tab window.
private string startActiveAnimation The animation name from the animation preset on the element animator to play at the start if active.
private string startInactiveAnimation The animation name from the animation preset on the element animator to play at the start if inactive.
public bool active Whether or not the element is active.
public QUI_ElementAnimator animator The animator to use, if there is one.
public QUI_ElementAudio audio The audio to use, if there is one.
public UnityEvent onActive Invoked when the element is activated.
public UnityEvent onInactive Invoked when the element is deactivated.

Changes the active state of the element.

bool value Whether or not the element should be active.
// Keep in mind that QUI_Window is based on QUI_Element.
reference.SetActive(true);

Plays an audio clip with the given name from the element audio preset.

string name The name of the audio clip in the QUI_ElementAudio's audio preset to play.
// Keep in mind that QUI_Window is based on QUI_Element.
reference.PlayAudio('On Click');

QUI_Window

A basic UI element responsible for holding other UI elements. Based off of QUI_Element, and does not modify it.

QUI_TabGroup

A basic UI element responsible for holding QUI_TabWindows. Based off of QUI_Element, but adds to it.

public List<QUI_TabWindow> windows All of the windows in the tab group.
public QUI_TabWindow currentWindow The currently shown window in the tab group.
public QUI_TabAlign tabAlign How the tabs should align.
public float sideOffset How far the tabs should be from the side of the tab window when aligning to the left or right.
private bool aligned Whether the tabs have been aligned at the start yet.

Sets the active tab window of the group.

QUI_TabWindow window The window to change to.
tabGroupReference.SetWindow(tabWindowReference);

Aligns the tabs to the given alignment.

QUI_TabAlign align How the tabs should be aligned.
reference.AlignTabs(QUI_TabAlign.Center);

QUI_TabWindow

A basic UI element responsible for holding other UI elements in a tab group. Only used by QUI_TabGroup. Based off of QUI_Element, but overrides SetActive.

public QUI_Tab tab The tab used to open the window.

Changes the active state of the window and tab.

bool value Whether or not the window should be active.
reference.SetActive(true);

QUI_Tab

Used for changing which tab window is shown in a tab group. Only used by QUI_Window. Based off of QUI_Element, but overrides SetActive.

Changes the active state of the tab.

bool value Whether or not the tab should be active.
reference.SetActive(true);

QUI_ElementAnimator

Used to handle animation of a UI element.

public Animator animator The animator component to use.
public QUI_ElementAnimationPreset animationPreset The animation preset to use when animating this element.

Plays an animation from the preset, by the given name. There are overloads, but only used internally, and not needed for general use.

string name The name from the animation preset to play.
reference.PlayAnimation('Jump');

QUI_ElementAnimation

Used for the animation of a UI element.

public string name The name of the animation.
public QUI_ElementAnimationType type The type of the animation.
public string parameterName The name of the animator parameter to use.
public string parameterValue The value to set the animator parameter to.

Plays the animation from the start.

Animator animator The animator used to play the animation.
elementAnimation.Play(animatorReference);

QUI_ElementAnimationPreset

Gives a set of animations for a UI element.

public string name The name of preset.
public List<QUI_ElementAnimation> animations The list of animations to be used by the preset.

QUI_ElementAudio

Used to make UI sounds on an element.

public AudioSource audioSource The AudioSource to play sounds from.
public QUI_ElementAudioPreset audioPreset The audio preset to get sounds from.

Plays an audio clip from the audio preset.

string name The name of the audio in the preset to play.
reference.Play('On Click');

QUI_ElementAudioClip

Stores info about an audio clip to be played an element audio source.

public string name The name of the audio clip.
public AudioClip clip The audio clip file that the QUI_ElementAudioClip represents.
public float volume The volume to play the clip at.

QUI_ElementAudioPreset

Gives a set of audio clips for a UI element.

public string name The name of the audio preset.
public List<QUI_ElementAudioClip> clips The list of audio clips.

QUI_SceneTransition

Handles smooth transition effects between scenes, along with loading screen effects.

public QUI_ElementAnimator animator The animator used in running the scene transition.
public QUI_Bar loadingBar The loading bar to update, if there is one.
public RectTransform loadingUI The UI element to show when loading, if there is one.
public QUI_LoadType loadType How to load the scene.
public string loadingSceneName The name of the loading scene, if the type is LoadingScene.
public string enterSceneAnimation The name of the transition animation to play when entering a scene.
public string exitSceneAnimation The name of the transition animation to play when exiting a scene.

Starts to load the necessary scene, used at the end of scene transition animations.

reference.StartLoad();

Starts loading a scene, with behaviour based on the loading type.

string sceneName The name of the scene to load.
reference.LoadScene('Main Menu');

QUI_SwitchToggle

Handles the change of sprites for a toggle UI element on click.

public Toggle toggle The toggle element to use.
public Image toggleGraphic The toggle graphic to set.
public Sprite onSprite The sprite when the toggle is on.
public Sprite offSprite The sprite when the toggle is off.
public Image toggleBackgroundGraphic The toggle background graphic to set.
public Sprite onBackgroundSprite The sprite background when the toggle is on.
public Sprite offBackgroundSprite The sprite background when the toggle is off.

Updates the graphic shown on the switch. Used in the toggle's onclick event.

reference.SetToggleGraphic();

QUI_OptionList

Offers multiple strings to choose from using buttons.

Sets the chosen option to the one given.

int index The index of the option in the list.
reference.SetOption(0);

Increments/decrements the current option by the given amount.

int direction The direction to change the option index by, either -1 or 1.
reference.ChangeOption(1);

QUI_Bar

Represents any type of UI bar, such as a health or progress bar.

public RectTransform barTransform The bar used as a background and mask.
public RectTransform fillTransform The fill image transform.
public Image fill The fill image.
public QUI_BarFillType fillType How the bar fills up.
public float fillAmount Used as the fill amount of the bar, including at the start.

Sets the fill amount of the bar.

float amount How much to fill up the bar.
reference.SetFill(0.75f);