QMMenu

Do Not Modify This

The list of windows in the menu.

Do Not Modify This

The list of tab groups in the menu.

The background of the menu. Not required.

The loading progress bar of the menu. Not required, unless a loading screen is used.

Quits the application.


reference.Quit();

int pBuildIndex - The build index of the scene.

Loads a scene while showing a loading screen.


reference.LoadScene(0);

string pSceneName - The name of the scene.

Loads a scene while showing a loading screen.


reference.LoadScene("Example Scene");

Not For Use

Finds all the windows in the menu.


reference.GetWindows();

Not For Use

Finds all the tab groups in the menu.


reference.GetTabGroups();

bool pShown - Whether or not it should be shown.

Shows/hides the menu background.


reference.ToggleBackground(true);

bool pOpen - Whether or not they are open.

Changes the open state of all windows and tab groups.


reference.ChangeAllOpenState(true);

bool pOpen - Whether or not they are open.

Changes the open state of all windows.


reference.ChangeWindowOpenState(true);

bool pOpen - Whether or not they are open.

Changes the open state of all tab groups.


reference.ChangeTabGroupOpenState(true);

bool pOpen - Whether or not they are open.

Not for use.

Changes the open state of all windows and tab groups.


reference.InspectorChangeAllOpenState(true);

bool pOpen - Whether or not they are open.

Not for use.

Changes the open state of all windows.


reference.InspectorChangeWindowOpenState(true);

bool pOpen - Whether or not they are open.

Not for use.

Changes the open state of all tab groups.


reference.InspectorChangeTabGroupOpenState(true);

bool pOpen - Whether or not they are open.

Not recommended for use.

Changes the open state of all windows and tab groups, skipping animation.


reference.OverrideAllOpenState(true);

bool pOpen - Whether or not they are open.

Not recommended for use.

Changes the open state of all windows, skipping animation.


reference.OverrideWindowOpenState(true);

bool pOpen - Whether or not they are open.

Not recommended for use.

Changes the open state of all tab groups, skipping animation.


reference.OverrideTabGroupOpenState(true);

QMWindow

The reference to the content GameObject of the window, which is the parent of all other UI elements in the window.

The reference to the Animator component for the window. This is not needed if the windows just show/hide.

The type of animation for the window. Either by GameObject active state, an animator boolean parameter, an animator trigger parameter, an animator integer parameter, or an animator float parameter.

Only needed if animationType is not ActiveState.

The name of the state when the window animator is open. This is needed for instantly switching to that state when the scene is loaded if the window is open by default.

Only needed if animationType is not ActiveState.

The name of the state when the window animator is open. This is needed for instantly switching to that state when the scene is loaded if the window is open by default.

Only needed if animationType is not ActiveState and not AnimatorTrigger.

The name of the animator parameter for setting the boolean, integer, or float upon open state change.

Only needed if animationType is AnimatorTrigger.

The name of the trigger animator parameter to set upon opening the window.

Only needed if animationType is AnimatorTrigger.

The name of the trigger animator parameter to set upon closing the window.

Only needed if animationType is AnimatorInt.

The value of the integer parameter to set upon opening the window.

Only needed if animationType is AnimatorInt.

The value of the integer parameter to set upon closing the window.

Only needed if animationType is AnimatorFloat.

The value of the float parameter to set upon opening the window.

Only needed if animationType is AnimatorFloat.

The value of the float parameter to set upon opening the window.

Do not change this manually unless the custom inspector doesn't save this for some reason. It is best to use reference.ChangeOpenState(pOpen).

Whether or not the window is open.

bool pOpen - Whether or not the window is open.

Changes the window's open state.


reference.ChangeOpenState(true);

bool pOpen - Whether or not the window is open.

Not recommended for use.

Changes the window's open state, skipping the animation.


reference.OverrideOpenState(true);

bool pOpen - Whether or not the window is open.

Not for use.

Changes the window's open state.


reference.InspectorChangeOpenState(true);

QMTabGroup

Do Not Modify This

The list of windows in the tab group.

Do Not Modify This

The list of tabs in the tab group.

Do not change this manually. It is best to use reference.ChangeTab(pTab).

The currently open tab window in the tab group.

The way to align the tabs. Either Left, Center, or Right. Changing this in the inspector or clicking the "Align Tabs" button will align them this way. They will not automatically align on scene load, meaning that developers can assign special positioning.

How much to offset the tabs from the top of the tab group when aligning the tabs.

How much to offset the tabs from the sides of the tab group when aligning the tabs to the left or right.

The reference to the content GameObject of the window, which is the parent of all tab windows in the group.

The reference to the Animator component for the tab group. This is not needed if the tab groups just show/hide.

The type of animation for the tab group. Either by GameObject active state, an animator boolean parameter, an animator trigger parameter, an animator integer parameter, or an animator float parameter.

Only needed if animationType is not ActiveState.

The name of the state when the tab group animator is open. This is needed for instantly switching to that state when the scene is loaded if the tab group is open by default.

Only needed if animationType is not ActiveState.

The name of the state when the tab group animator is closed. This is needed for instantly switching to that state when the scene is loaded if the tab group is closed by default.

Only needed if animationType is not ActiveState and not AnimatorTrigger.

The name of the animator parameter for setting the boolean, integer, or float upon open state change.

Only needed if animationType is AnimatorTrigger.

The name of the trigger animator parameter to set upon opening the tab group.

Only needed if animationType is AnimatorTrigger.

The name of the trigger animator parameter to set upon closing the tab group.

Only needed if animationType is AnimatorInt.

The value of the integer parameter to set upon opening the tab group.

Only needed if animationType is AnimatorInt.

The value of the integer parameter to set upon closing the tab group.

Only needed if animationType is AnimatorFloat.

The value of the float parameter to set upon opening the tab group.

Only needed if animationType is AnimatorFloat.

The value of the float parameter to set upon closing the tab group.

Do not change this manually unless the custom inspector doesn't save this for some reason. It is best to use reference.ChangeOpenState(pOpen).

Whether or not the tab group is open.

QMTabWindow pTab - The tab to switch to.

Changes the current tab.


reference.ChangeTab(pTab);

QMTabWindow pTab - The tab to switch to.

Not recommended for use.

Changes the current tab.


reference.OverrideTab(pTab);

QMTabWindow pTab - The tab to switch to.

Not for use.

Changes the current tab.


reference.InspectorChangeTab(pTab);

bool pOpen - Whether or not the tab group is open.

Changes the tab group's open state.


reference.ChangeOpenState(true);

bool pOpen - Whether or not the tab group is open.

Not recommended for use.

Changes the tab group's open state, skipping the animation.


reference.OverrideOpenState(true);

bool pOpen - Whether or not the tab group is open.

Not for use.

Changes the tab group's open state.


reference.InspectorChangeOpenState(true);

Aligns the tabs with the currently selected setting.


reference.AlignTabs();

QMTabWindow

Do Not Modify This

The reference to the QMTab of the tab window.

The reference to the content GameObject of the window, which is the parent of all tab windows in the group.

Do not change this manually unless the custom inspector doesn't save this for some reason. It is best to use reference.ChangeOpenState(pOpen).

Whether or not the tab window is open.

bool pOpen - Whether or not the tab window is open.

Not recommened for use, instead use ChangeTab(pTab) on the QMTabGroup.

Changes the tab window's open state.


reference.ChangeOpenState(true);

bool pOpen - Whether or not the tab window is open.

Not recommended for use.

Changes the tab window's open state, skipping the animation.


reference.OverrideOpenState(true);

bool pOpen - Whether or not the tab window is open.

Not for use.

Changes the tab window's open state.


reference.InspectorChangeOpenState(true);

QMTab

The reference to the Image component for the tab.

The reference to the Animator component for the tab. This is not needed if the tabs just show/hide.

The type of animation for the tab. Either by Sprite change, Color change, an animator boolean parameter, an animator trigger parameter, an animator integer parameter, or an animator float parameter.

Only needed if animationType is Sprite.

The Sprite when the tab is open.

Only needed if animationType is Sprite.

The Sprite when the tab is closed.

Only needed if animationType is Color.

The Color when the tab is open.

Only needed if animationType is Color.

The Color when the tab is closed.

Only needed if animationType is not Sprite and not Color.

The name of the state when the tab animator is open. This is needed for instantly switching to that state when the scene is loaded if the tab is open by default.

Only needed if animationType is not Sprite and not Color.

The name of the state when the tab animator is closed. This is needed for instantly switching to that state when the scene is loaded if the tab is closed by default.

Only needed if animationType is not Sprite, Color, or AnimatorTrigger.

The name of the animator parameter for setting the boolean, integer, or float upon open state change.

Only needed if animationType is AnimatorTrigger.

The name of the trigger animator parameter to set upon opening the tab.

Only needed if animationType is AnimatorTrigger.

The name of the trigger animator parameter to set upon closing the tab.

Only needed if animationType is AnimatorInt.

The value of the integer parameter to set upon opening the tab.

Only needed if animationType is AnimatorInt.

The value of the integer parameter to set upon closing the tab.

Only needed if animationType is AnimatorFloat.

The value of the float parameter to set upon opening the tab.

Only needed if animationType is AnimatorFloat.

The value of the float parameter to set upon closing the tab.

Do not change this manually unless the custom inspector doesn't save this for some reason. It is best to use reference.ChangeOpenState(pTab) on the QMTabGroup.

Whether or not the tab is open.

bool pOpen - Whether or not the tab is open.

Not recommened for use, instead use ChangeTab(pTab) on the QMTabGroup.

Changes the tab's open state.


reference.ChangeOpenState(true);

bool pOpen - Whether or not the tab is open.

Not recommended for use.

Changes the tab's open state, skipping the animation.


reference.OverrideOpenState(true);

bool pOpen - Whether or not the tab is open.

Not for use.

Changes the tab's open state.


reference.InspectorChangeOpenState(true);

QMBar

The reference to the bar's transform.

The reference to the bar fill's transform.

The reference to the bar fill's image.

How the bar fills up.

float pPercent - The percent represented as a number between 0 and 1.

Changes the percentage filled.


reference.ChangeFill(0.5f);

QMOptionList

The list of options.

The reference to the TextMeshProUGUI Component to show the current option.

The index of the current option.

The event triggered when the current option is changed.

Returns the currently selected option.


reference.GetOption();

string pOption - The option text.

Gets the index of an option by text.


reference.GetOptionIndex("example option");

int pAmount - The amount to change by.

Changes the currently selected option by a certain amount.


reference.ChangeOption(1);

int pOption - The new selected option.

Sets the currently selected option to a certain option.


reference.ChangeOption(0);

int param1 - The text of the new selected option.

Sets the currently selected option to a certain option.


reference.ChangeOption("example option");

QMAudio

The reference to the AudioSource Component to play sounds through.

The reference to the AudioClip of the sound to play.

Plays the default audio.


reference.PlayAudio();

AudioClip pClip - The clip to play.

Plays the given audio.


reference.PlayAudio(pClip);

QMSaveDropdown

The name of the setting to save.

The reference to the UI Component to save the value of.

Saves the value of the reference under the given setting name.


reference.Save();

QMSaveInput

The name of the setting to save.

The reference to the UI Component to save the value of.

Saves the value of the reference under the given setting name.


reference.Save();

QMSaveOptionList

The name of the setting to save.

The reference to the UI Component to save the value of.

Saves the value of the reference under the given setting name.


reference.Save();

QMSaveSlider

The name of the setting to save.

The reference to the UI Component to save the value of.

Saves the value of the reference under the given setting name./p>


reference.Save();

QMSaveToggle

The name of the setting to save.

The reference to the UI Component to save the value of.

Saves the value of the reference under the given setting name.


reference.Save();