Hint Management

Most games that have controller support communicate which button corresponds to which action via labeled icons that appear somewhere on the screen. The UI Assistant’s Hint Manager allows you to set up, and display such context-based Hint Snippets with minimal effort.

Components

Hint Manager

The Hint Manager is a singleton component designed to manage hints across your project, with the help of Hint Contexts. It must be attached to a prefab to ensure proper behavior, and at least one instance must be placed in a scene, preferably the first scene that appears when launching your project.

Properties

Visuals

The first child under the Hint Manager that contains all other objects.

Template

The layout that will be instantiated to contain a single Hint Context's entries.

HintSnippet

The Hint Snippet that will be instantiated to display a single Hint Context entry.

OptionEntry

An optional Boolean type Option Entry that can enable users to hide hints via settings.

TransitionTime

The time it takes for a Hint Context's entries to appear and disappear.

Events

OnShow

Unity Events to be invoked when the number of Hint Contexts becomes 1.

OnSwap

Unity Events to be invoked when Hint Contexts replace each other.

OnHide

Unity Events to be invoked when the number of Hint Contexts becomes 0.

Public Methods

ShowHints

Adds a Hint Context to the stack, and displays Hint Snippets accordingly.

RemoveHints

Removes a Hint Context from the stack.

Hint Context

Hint Contexts allow you to set up a list of hint entries for any context within your project. Each Hint Context will forward its entries to the Hint Manager to be displayed as Hint Snippets. Entries include labels, and optionally, one or several button icons.

Note that this setup does not require you to work with Hint Snippets, as that is handled automatically by the Hint Manager during runtime.

Properties

ShowOnEnable

When set to true, Hint Manager will be notified when the Hint Context is enabled.

Localized

When set to true, entries' labels will require Localization Sets instead of strings.

Entries (HintEntry)

One or multiple hint entries to be displayed as Hint Snippets.

HintEntry Properties

Label

Text to be displayed by the Hint Manager.

ButtonCombinatiton

Check this box if the prompted function requires multiple buttons to be pressed.

ButtonSprites

Icons used to refer to specific keyboard or controller buttons.

Public Methods

Show

Notifies the Hint Manager to show this Hint Context's entries.

Hide

Notifies the Hint Manager that this Hint Context's entries should no longer be shown.

For Hint Contexts to work, your scene must have a Hint Manager. Otherwise, you will receive a "Hint Context failed to display hints; please add a Hint Manager to your scene." warning. The Samples/Prefabs folder contains a „HintManager” prefab, ready to be used.

Hint Snippet

A Hint Snippet’s task is to display a hint entry’s parameters, defined in the Hint Context. The Samples/Prefabs folder contains a “HintSnippet” prefab, referenced by the “HintManager” mentioned above, ready to be used.

Properties

ButtonTemplate

Image that will be instantiated to display the Hint Context entry's button sprites.

AndSeparator

Graphic that will appear between icons if the Hint Context entry prompts a button combination.

OrSeparator

Graphic that will appear between icons when the Hint Context entry lists multiple buttons.

LabelText

The Text Mesh Pro UGUI that will display the Hint Context entry's label.

Public Methods

SetSnippet

Sets the Hint Snippet’s parameters based on a Hint Context entry. This is handled by the Hint Manager.

Google Sites

Report abuse