Options

The UI Assistant’s option settings and components allow you to quickly create options that enable your users to control different aspects of your project, such as UI scale, font size, language, etc.

Components

Option Syncer

The Option Syncer creates a link between an Option Entry and a required Selectable, allowing the Selectable to adjust its value to the Option Entry on enable, and control the Option Entry’s value when the user interacts with the Selectable.

Properties

OptionEntry

The Option Entry updated via the Option Syncer.

LabelText

The Text Mesh Pro UGUI that will display the Option Entry's name.

ValueText

The Text Mesh Pro UGUI that will display the Option Entry's current value.

CustomSelectable

Set this to true if the Selectable used with this Option Syncer is not a Slider, Toggle, Dropdown, or Option Cycler.

Events

OnSync

Unity Events to be invoked when the Option Entry's value changes.

Public Methods

SyncSelectable

Sets the value of the Dropdown, Option Cycler, Slider, or Toggle without invoking On Value Changed events.

OnLanguageChanged

Updates options with the Option Entry's Localization Sets when the active Language changes.

Opton Cycler

The Option Cycler has a list of options, just like a dropdown, but keeps its silhouette constant by allowing users to cycle through its options via “next” and “previous” buttons.

Properties

Clamp

When set to true, the Option Cycler will stop at both ends.

Axis

The orientation of the buttons responsible for changing options.

CaptionText

Text Mesh Pro UGUI that will display the selected option's text.

CaptionImage

Image that will display the selected option's image.

PreviousArea

The area to be clicked to set the previous option.

NextArea

The area to be clicked to set the next option.

Options

The set of options the Option Cycler will display.

Events

OnValueChanged

Unity Events to be invoked when the Option Cycler's Value changes.

Public Methods

AddOption

Adds a single new option to the end of the list.

AddOptions

Adds a list of option to the end of the list.

ClearOptions

Removes all options from the list.

NextOption

Sets the next option. Unless Clamp is set to true, the first option will be set instead of going out of range.

PreviousOption

Sets the previous option. Unless Clamp is set to true, the last option will be set instead of going out of range.

SetValueWithoutNotify

Sets a specific option by index without invoking OnValueChanged events.

Get Functions

Value

The index of the currently selected option.

Optons Builder

The Options Builder allows you to effortlessly create an options interface for your project, simply by listing Option Entries under any number of categories.

Properties

OpenOnStart

When set to true, the main submenu will be visible by default.

SubmenuTemplate

Layout that will serve as the parent of a submenu's elements.

HeaderText

The Text Mesh Pro UGUI within the submenu template that will display the submenu's name.

Spacer

Object within the submenu template that will be instantiated after the last Option Syncer.

ButtonTemplate

The button that will be instantiated for functions and submenu access.

ButtonLabelText

The Text Mesh Pro UGUI within the button template that will display the button's label.

SubmenusAnimate

Check this box if the template uses the UI Animator component.

AnimationProfile

Animation Profile used by all submenus.

Submenus

Submenus that can be reached via the main submenu.

Localized

When set to true, submenus' names will require Localization Sets instead of strings.

MainHeader

Text to be displayed as the main submenu's header.

BackLabel

Text to be displayed on the button that returns to, or closes the main submenu.

DefaultsLabel

Text to be displayed on the button that reverts to Option Entries' default values.

Submenu Properties

Name

Text to be displayed on the submenu's button in the main submenu, as well as in its header.

OptionEntries

Option Entries listed in the submenu.

HasDefaultsButton

Check this box to add a button to set Option Entries' default values.

Events

OnOpen

Unity Events to be invoked when Open() is called.

OnClose

Unity Events to be invoked when Close() is called.

Public Methods

Open

Shows the main submenu.

Close

Hides all submenus.

Opton Modifier

The Option Modifier is a simple utility component that allows you to change a selected Option Entry’s value without the use of a Selectable and Option Syncer combination.

Properties

OptionEntry

The Option Entry whose value will be modified.

Public Methods

SetFloatValue

Sets the Option Entry's float value.

SetBoolValue

Sets the Option Entry's bool value.

SetIntValue

Sets the Option Entry's int value.

Settings

The Option Settings window can be opened via the “Tools/UI Assistant” menu, or, by clicking on the “Open Option Settings” button at the bottom of related components.

Properties

OptionEntries

A list of Option Entries added to the Option Settings asset. This is handled by the Option Settings editor; please do not add or remove any Option Entries yourself.

Localized

When set to true, Option Syncers' label texts will be set based on Option Entries' localized names.

Get Functions

EntryNames

Returns an array of Option Entry names listed in the Option Settings.

Option Entries

Option Entries contain data used by Option Syncers and Selectables. Create an Option Entry for every unique aspect of your project that you’d like users to be able to adjust to their taste.

Each Option Entry can store your custom float or bool value, or list of options (and the index of the selected option). Option Entries can also handle the UI Assistant’s most relevant settings: active Color Profile, active Scale Profile, Scale Interpolation, Font Size Interpolation, and active Language.

Click on the “Edit” button (gear icon) next to an Option Entry to open its editor, or, click on the “New Option Entry” button to create a new one – this will automatically open the editor.

Checking “Localize Options” in the Option Settings window will cause Option Syncers to set labels based on Localized Name instead of the Option Entry’s Name, as well as options (in the case of List-type Option Entries) based on Localized Options instead of Options.

Properties

Name

The name of the asset.

LocalizedName

Localization Set that contains the name of the asset in all Languages.

Type

The type of the Option Entry. Determines which Selectables can control its value.

Prefab

Selectable associated with this Option Entry, used to set this Option Entry's value.

DefaultFloatValue

Value referenced when RestoreDefaults() is called.

DefaultBoolValue

Value referenced when RestoreDefaults() is called.

DefaultIntValue

Value referenced when RestoreDefaults() is called.

ValueFormat

The format in which the Option Entry's value is displayed.

Clamp

Determines whether the Option Entry has limits.

ClampMin

The minimum value of the clamped Option Entry.

ClampMax

The maximum value of the clamped Option Entry.

Options

A list of strings representing the Option Entry's possible values.

LocalizedOptions

A list of Localization Sets representing the Option Entry's possible values.

Public Methods

Validate

Clamps all values.

NotifyOptionSyncers

If there are multiple Option Syncers working with the same Option Entry, they will be updated when the source Option Syncer's value changes.

RestoreDefaults

Sets all values to their defaults.

Interfaces

IOptionListener

The Option Listener interface can be used to notify components about changes made to Option Entries.

Public Methods

OnOptionFloatValueChanged

Notifies the Listener about changes made to the Option Entry's float value.

OnOptionBoolValueChanged

Notifies the Listener about changes made to the Option Entry's bool value.

OnOptionIntValueChanged

Notifies the Listener about changes made to the Option Entry's int value.

Google Sites

Report abuse