Animation

The UI Assistant’s animation settings and components allow you to hide and show parts of your UI, and display texts character by character.

Components

UI Animator

The UI Animator allows you to hide and show your UI elements. The component derives from the Visibility State Handler abstract class, and requires a Rect Transform, a Canvas Group, and an Animation Profile to function.

Note that Animation Profiles can be set up to just make your UI elements less prominent – you don’t have to hide your Game Objects completely.

Properties

AnimationProfile

Determines the Game Object's position, rotation, scale, and alpha in its hidden state.

StartHidden

If set to true, the Game Object will appear in its hidden state by default.

IsDynamic

Check this box if the Game Object's Rect Transform and/or Canvas Group is manipulated by scripts other than this.

Events

OnShow

Unity Events to be invoked at the end of the Show animation.

OnHide

Unity Events to be invoked at the end of the Hide animation.

Public Methods

HideInstantly

Applies the hidden state without animation.

Show

Animates into the visible state.

Hide

Animates into the hidden state.

Toggle

Animates between the visible and hidden states, based on current state.

Custom UI Animator

The Custom UI Animator has a purpose similar to the UI Animator's, however, it works with an Animator, allowing you to create more complex animations and state transitions.

The Animator Controller used by this component requires a simple, but specific setup. Please use the "Auto Generate Animation" button, or refer to the example in the Animations subfolder under Samples.

Properties

StartHidden

If set to true, the Game Object will appear in its hidden state by default.

IsDynamic

Check this box if the Game Object's Rect Transform and/or Canvas Group is manipulated by scripts other than this.

ParameterName

Name of the Animator Controller's parameter used to switch between hidden and visible states.

Events

OnShow

Unity Events to be invoked at the end of the Show animation.

OnHide

Unity Events to be invoked at the end of the Hide animation.

Public Methods

HideInstantly

Applies the hidden state without animation.

Show

Animates into the visible state.

Hide

Animates into the hidden state.

Toggle

Animates between the visible and hidden states, based on current state.

Selectable Scaler

The Selectable Scaler allows objects to dynamically adjust their local scale in response to changes in a Colored Selectable's state. These scaling animations can be used to complement color transitions for additional visual feedback.

Properties

Selectable

The Colored Selectable whose state will be matched.

NormalScale

The local scale of the Transform in the Normal state.

HighlightedScale

The local scale of the Transform in the Highlighted state.

PressedScale

The local scale of the Transform in the Pressed state.

SelectedScale

The local scale of the Transform in the Selected state.

DisabledScale

The local scale of the Transform in the Disabled state.

TransitionTime

The time it takes to transition from one state to the next.

TransitionCurve

Animation curve used to ease between states.

Public Methods

DoStateTransition

Prompts the Selectable Scaler to update its Transform's local scale.

Text Revealer

The Text Revealer allows you to display your text with a typewriter effect – character by character. Speeds, pause times, and pause conditions (characters) can be set in the Animation Settings.

Properties

StartHidden

If set to true, the Text Mesh Pro UGUI will not display any text on Start.

Events

OnRevealStart

Unity Events to be invoked when the Text Revealer animation starts.

OnRevealEnd

Unity Events to be invoked when the Text Revealer animation ends.

Public Methods

RevealText

Starts the reveal animation of the Text Mesh Pro UGUI's text, or a string of your choice.

SkipToEnd

Stops the text's reveal animation and immediately skips to the end.

OnLanguageChanged

Stops revealing and displays the Text Mesh Pro UGUI's entire text on the next frame.

Settings

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

Properties

AnimationProfiles

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

ProfileNames

Returns an array of Animation Profile names listed in the Animation Settings.

Animation Profiles

Animation Profiles contain data used by UI Animators to determine their Rect Transforms’ and Canvas Groups’ values in the hidden state. You can create multiple Animation Profiles to achieve different effects with your UI Animators.

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

Properties

Name

The name of the asset.

TransitionTime

The time it takes to transition between the hidden and visible states.

TransitionCurve

Animation curve used to ease between the states.

PositionOffset

Values used to move the Game Object into its hidden state. Positive values move the Game Object away from its parent, while negative values move it toward it.

AngleOffset

Value used to rotate the Game Object into its hidden state, based on its anchored position. A positive value will rotate the Game Object clockwise if it’s anchored to the right, or, counterclockwise if it’s anchored to the left.

Scale

Values used to multiply the X and Y values of the Game Object’s scale when transitioning into the hidden state.

Alpha

The Canvas Group’s alpha value in the Game Object’s hidden state.

Text Revealer

Unlike UI Animators that allow you to select one of multiple Animation Profiles, all Text Revealers will work with the same values set in the Animation Settings window.

Properties

TimePerCharacter

The number of seconds the Text Revealer waits between revealing two adjacent characters.

SkipSpaces

If set to true, the Text Revealer will skip spaces during its animation.

PauseCharacters

Characters (without spaces) that cause the Text Revealer to pause.

RegularPauseTime

The number of seconds the Text Revealer waits after detecting a pause character.

EllipsisCharacters

Characters (without spaces) that cause the Text Revealer to pause when the character repeats.

EllipsisPauseTime

The number of seconds the Text Revealer waits after detecting an ellipsis character in a sequence. Overrides regular pause time in those cases.

Get Functions

IsRevealing

Returns true if the text is currently animating.

RevealProgress

Returns a value between 0 and 1 based on current and target animation times.

Google Sites

Report abuse