EasyInput

EasyInput

class in UnityEngine.UI.iMenu

Description

The method used is similar to Input.

Static Public Functions

GetKey Returns true while the user holds down the key.

GetKeyDown Returns true during the frame the user starts pressing down the key.

GetKeyUp Returns true during the frame the user releases the key.

GetAxis Returns the value of the axis.

GetAxisRaw Returns the value of the axis with no smoothing filtering applied.

GetQuadrant Returns the value of the quadrant.

GetQuadrantRaw Returns the value of the quadrant with no smoothing filtering applied.





Scripting

FadeAnimation

FadeAnimation

class in UnityEngine.UI.iMenu / Inherits from:IFade

Description

This component will allow you under the situation of using the Navigator components to use the AnimationClip to achieve the menu dynamic, and then place this component on the GameObject of the menu.

Variables

clipFadeIn The animation clip when the menu fade in.

clipFadeOut The animation clip when the menu fade out.

Inherited members

Public Functions

FadeIn Execute the page fade in.

FadeOut Execute the page fade out.

Scripting

IFade

IFade

class in UnityEngine.UI.iMenu

Description

Processing the dynamics of the menu.

Public Functions

FadeIn Execute the page fade in.

FadeOut Execute the page fade out.





Scripting

Navigator

Navigator

class in UnityEngine.UI.iMenu / Inherits from:INavigator

Description

This component will allow you to easily handle menu switching with a small amount of code or even without any code.

Variables

playAutomatically Does it play automatically for openinnig the first page?

pageDatas Pages of the All you want to navigate.

Public Functions

AddPageData Add a page to the navigator.

HavePageInNavigator Whether the page is already in the navigator.

RemovePageData Remove a page data from the navigator.

OpenFirstPage Open and execute the first page.

CloseActivityPages Close all active pages.

AddOnExchangeListener Add listener of the page exchange event.

AddOnExchangeFinishedListener Add listener of the page finishes exchange event.

RemoveOnExchangeListener Remove the "OnExchange" listeners.

RemoveOnExchangeFinishedListener Remove the "OnExchangeFinished" listeners.

RemoveAllOnExchangeListener Remove all "OnExchange" listeners.

RemoveAllOnExchangeFinishedListener Remove all "OnExchangeFinished" listeners.

ResetToFirstOption Reset the option index to the first enabled cell position.





Scripting

INavigator

INavigator

class in UnityEngine.UI.iMenu

Description

Abstract class for navigator.





Scripting

SubCell

SubCell

class in UnityEngine.UI.iMenu / Inherits from:IClick

Description

Sub-cells attached to the main cell.

Inherited members

Variables

clickParameter Used to distinguish which sub-cell to click on.

Scripting

IClick

IClick

class in UnityEngine.UI.iMenu

Description

Classes of the click.

Variables

clickParameter Used to distinguish which sub-cell to click on.

Scripting

Keyboard

Keyboard

class in UnityEngine.UI.iMenu / Inherits from:IControllerEntity

Description

Through the keyboard operation to switch the components of the options.

Variables

reverseKeys With "pressMode" reverse the keys.

allChangeGroup All key groups used to switch the direction of the options.

pressMode Defines the menu for it is executed when the button is pressed or when the key is released.

Inherited members

Variables

curve A curve that describes the change in speed.

listenKeys All the keys to be listened.

speedMode Switch the speed mode of options.

switchSpeed The speed of switching the options.

target The target element to control.




Scripting

IControllerEntity

IControllerEntity

class in UnityEngine.UI.iMenu / Inherits from:IController

Description

The abstract Class of the neat menu.

Variables

curve A curve that describes the change in speed.

listenKeys All the keys to be listened.

speedMode Switch the speed mode of options.

Inherited members

Variables

target The target element to control.

switchSpeed The speed of switching the options.

Scripting

More Video

Navigator example:



How to create a map menu:



Dynamically create all the buttons in the menu:



iMenu Tutorial

Scripting API

iMenu - Scripting API

Navigator

Navigator

Menu

CustomMenu

RectMenu

RingMenu

Fade

FadeAnimation

Cell

Cell

SubCell

Focus

FocusSprite

FocusCursor

FocusColor

FocusAlpha

FocusGradientScale

FocusGradientAlpha

FocusPosition

FocusRotation

FocusScale

Controller

GamePad

Keyboard

DragRing

Cursor

CursorTranslate





iMenu Tutorial

iMenu - Intelligent Menu for uGUI Tutorial

iMenu Tutorial

Welcome to the iMenu tutorial.
You will feel the convenience of creating a menu.

Video

More..

API

Scripting API

Auxiliary

EasyInput

FocusGradientScale

FocusGradientScale

class in UnityEngine.UI.iMenu / Inherits from:IFocusTweenGradient

Description

Let the players know the gradient scaling components of the current focus button.

Variables

delta The amount of the scaling of a decrement (or power down) by one unit per distance to the focus button.

focus The scale when the button is focused.

target To change scale of the Transform.

Inherited members

Variables

curve Focus on the lerp curve.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

gradientType Type of Gradient.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.

Scripting

FocusPosition

FocusPosition

class in UnityEngine.UI.iMenu / Inherits from:IFocusTweenTransform

Description

Let the players know the position of the current focus button to change the component.

Variables

focusOffset The position offset when the target position is in the focus state.

target To change the target transform of the position offset.

Inherited members

Variables

curve Focus on the lerp curve.

defocusAfterFocusing Defocused immediately after focusing.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

refocus Whether to re-focus the effect. When the button is already in focus, whether to re-focus effect while clicking.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.

Scripting

CursorTranslate

CursorTranslate

class in UnityEngine.UI.iMenu / Inherits from:ICursor

Description

Let the players know the cursor components of the current focus button.

Variables

ignoreTimeScale Whether to ignore the time scale.

speed The speed of the cursor movement.

Inherited members

Public Functions

Hide Hide the cursor.

Show Show the cursors.

FocusScale

FocusScale

class in UnityEngine.UI.iMenu / Inherits from:IFocusTweenTransform

Description

Let the players know the scale of the current focus button to change the component.

Variables

focus The scale when the target is focused.

normal The scale when the target is in the normal state.

target To change the target transform of the scale.

Inherited members

Variables

curve Focus on the lerp curve.

defocusAfterFocusing Defocused immediately after focusing.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

refocus Whether to re-focus the effect. When the button is already in focus, whether to re-focus effect while clicking.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.

Scripting

FocusRotation

FocusRotation

class in UnityEngine.UI.iMenu / Inherits from:IFocusTweenTransform

Description

Let the players know the rotation of the current focus button changes the component.

Variables

focus Rotation when the target is in focus.

normal Rotation of the target in the normal state.

target To change the target transform of the rotation.

Inherited members

Variables

curve Focus on the lerp curve.

defocusAfterFocusing Defocused immediately after focusing.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

refocus Whether to re-focus the effect. When the button is already in focus, whether to re-focus effect while clicking.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.

Scripting

FocusGradientAlpha

FocusGradientAlpha

class in UnityEngine.UI.iMenu / Inherits from:IFocusTweenGradient

Description

Let the players know the gradient alpha components of the current focus button.

Variables

delta The amount of the alpha of a decrement (or power down) by one unit per distance to the focus button.

focus The alpha when the button is focused.

includeChildren Whether it contains all sub-objects.

target To change alpha of the MaskableGraphic.

Inherited members

Variables

curve Focus on the lerp curve.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

gradientType Type of Gradient.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.




Scripting

FocusAlpha

FocusAlpha

class in UnityEngine.UI.iMenu / Inherits from:IFocusTweenEach

Description

Let the players know the alpha of the current focus button to change the component.

Variables

normal The alpha of the target in the normal state.

disable The alpha of the target when it is not enable.

disableFocus The alpha of the target when it is not enable and its in the focus state.

focus The alpha of the target in the focus state.

includeChildren Whether it contains all sub-objects.

normal The alpha of the target in the normal state.

target To change alpha of the MaskableGraphic.

Inherited members

Variables

curve Focus on the lerp curve.

defocusAfterFocusing Defocused immediately after focusing.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

refocus Whether to re-focus the effect. When the button is already in focus, whether to re-focus effect while clicking.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.

Scripting

FocusColor

FocusColor

class in UnityEngine.UI.iMenu / Inherits from:IFocusTweenEach

Description

Let the players know the color of the current focus button to change the component.

Variables

normal The color of the target in the normal state.

disable The color of the target when it is not enable.

disableFocus The color of the target when it is not enable and its in the focus state.

focus The color of the target in the focus state.

includeChildren Whether it contains all sub-objects.

normal The color of the target in the normal state.

target To change color of the MaskableGraphic.

Inherited members

Variables

curve Focus on the lerp curve.

defocusAfterFocusing Defocused immediately after focusing.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

refocus Whether to re-focus the effect. When the button is already in focus, whether to re-focus effect while clicking.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.




Scripting

FocusCursor

FocusCursor

class in UnityEngine.UI.iMenu / Inherits from:IFocus

Description

Let the player know the specified cursor element of the current focus button.

Variables

focusTransform Used to describe the position, rotation, and scale of the cursor when its focused.

cursor The cursor is driven when focusing.

Inherited members

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.




Scripting

FocusSprite

FocusSprite

class in UnityEngine.UI.iMenu / Inherits from:IFocus

Description

Let the players know the picture of the current focus button to change the component.

Variables

disable The sprite is displayed when the target is not enabled.

disableFocus The sprite is displayed when the target is not enabled and the focus is on.

focus The sprite is displayed when the target is in focus state.

normal The sprite is displayed when the target is in the normal state.

target To change the sprite's target image.

Inherited members

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.




Scripting

IFocusTweenTransform

IFocusTweenTransform

class in UnityEngine.UI.iMenu / Inherits from:IFocusTween

Description

Variables

defocusAfterFocusing Defocused immediately after focusing.

refocus Whether to re-focus the effect. When the button is already in focus, whether to re-focus effect while clicking.

Inherited members

Variables

curve Focus on the lerp curve.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.

Scripting

IFocusTweenGradient

IFocusTweenGradient

class in UnityEngine.UI.iMenu / Inherits from:IFocusTween

Description

The abstract class is graded according to the distance from the focus button.

Variables

gradientType Type of Gradient.

Inherited members

Variables

curve Focus on the lerp curve.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.




Scripting

IFocusTweenEach

IFocusTweenEach

class in UnityEngine.UI.iMenu / Inherits from:IFocusTween

Description

An abstract class that fades according to various focus states.

Variables

defocusAfterFocusing Defocused immediately after focusing.

refocus Whether to re-focus the effect. When the button is already in focus, whether to re-focus effect while clicking.

Inherited members

Variables

curve Focus on the lerp curve.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.

Scripting

IFocusTween

IFocusTween

class in UnityEngine.UI.iMenu / Inherits from:IFocus

Description

You must have seen the typical menu mode in most games.

When you want to make a rectangular arrangement such as a list of props, this will be your best choice.

Variables

curve Focus on the lerp curve.

durationFocus Focus time in seconds.

durationDefocus Defocus time in seconds.

ignoreTimeScale Whether to ignore the time zoom.

onBegin Start focusing and defocusing events.

onFinished Focus and defocus end event.

Inherited members

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.




Scripting

IFocus

IFocus

class in UnityEngine.UI.iMenu

Description

The abstract class used to display the focus state of the button.

Public Functions

QuickSetStatus Set the focus state. Ignore the tween process.

Recover Revert to the state before focusing.

SetStatus Set the focus state.




Scripting

Cell

Cell

class in UnityEngine.UI.iMenu / Inherits from:ICell

Description

The easiest button style. It comes with a text.

Variables

text Text UI of the cell.

Inherited members

Variables

downOptionIndex When this button goes down, it will jump to which index button. It's only useful in customMenu type.

leftOptionIndex When this button goes left, it will jump to which index button. It's only useful in customMenu type.

rightOptionIndex When this button goes right, it will jump to which index button. It's only useful in customMenu type.

upOptionIndex When this button goes up, it will jump to which index button. It's only useful in customMenu type.

Inherited members

Variables

clickParameter Used to distinguish which sub-cell to click on.The main cell is fixed to 0.



Scripting

ICell

ICell

class in UnityEngine.UI.iMenu / Inherits from:IClick

Description

The most basic button unit.

If you want to customize the special button appearance, then add a C # script to inherit it!

Variables

downOptionIndex When this button goes down, it will jump to which index button. It's only useful in customMenu type.

leftOptionIndex When this button goes left, it will jump to which index button. It's only useful in customMenu type.

rightOptionIndex When this button goes right, it will jump to which index button. It's only useful in customMenu type.

upOptionIndex When this button goes up, it will jump to which index button. It's only useful in customMenu type.

Inherited members

Variables

clickParameter Used to distinguish which sub-cell to click on.The main cell is fixed to 0.

Scripting