• Useful UI codes.
• Unity minimum version: 2018.3
• Current version: 4.2.0
• License: MIT

For some games it's preferred to trigger a button On Click event only after a delayed period of time.

You can do this by using the DelayedButton component and setting the Delay property.

Create a new class implementing AbstractMenu component, like so:

using UnityEngine;
using ActionCode.UI;

namespace YourGameNamespace.UI
{
    [DisallowMultipleComponent]
    public sealed class PauseMenu : AbstractMenu
    {
        [Header("Buttons")]
        [SerializeField] private DelayedButton resumeButton;
        [SerializeField] private DelayedButton restartButton;
        [SerializeField] private DelayedButton soundsButton;
        [SerializeField] private DelayedButton exitButton;

        protected override void BindButtonsEvents()
        {
            resumeButton.onClick.AddListener(Resume);
            restartButton.onClick.AddListener(OpenRestartPopup);
            soundsButton.onClick.AddListener(OpenSoundOptions);
            exitButton.onClick.AddListener(OpenExitPopup);
        }

        protected override void UnBindButtonsEvents()
        {
            resumeButton.onClick.RemoveListener(Resume);
            restartButton.onClick.RemoveListener(OpenRestartPopup);
            soundsButton.onClick.RemoveListener(OpenSoundOptions);
            exitButton.onClick.RemoveListener(OpenExitPopup);
        }

        private void Resume() => print("Resume");
        private void Restart() => print("Restart");
        private void Sounds()=> print("Sounds");
        private void Exit() => print("Exit");
    }
}

Note that all buttons OnClick events should be binded (and unbinded) via code. This is important for good code practice.

Also, it's important that you use the DelayedButton instead the default one.

This Scriptable Object is important to reuse the data present on it into other menus.

Create a new Menu Data asset by using the Create menu, ActionCode > UI > Menu Data.

Add SelectableAudioMenu component in the GameObject parenting your buttons and assign a Menu Data asset to it. Inside this asset, don't forget to choose a Selection AudioClip to play every time a button is selected.

This GameObject doesn't need to have an AbstractMenu implementation on it but it's necessary that your children buttons have an implementation of ISelectable interface, like DelayedButton does.

If you want to add this behavior to other UI component, like a Slider or Text, add the SelectableTrigger component to it, which is other implementation of ISelectable interface.

It's possible to play an AudioSource every time the Slider value changes by using AudibleSlider. This is useful to demonstrate an increasing/decreasing of audio volume when setting an AudioMixer volume property using the Slider.

Add SubmitableAudioMenu component in the GameObject parenting your buttons and assign a Menu Data asset to it. Inside this asset, don't forget to choose a Submition AudioClip to play every time a button is submitted.

This GameObject doesn't need to have an AbstractMenu implementation on it but it's necessary that your children buttons have an implementation of ISubmitable interface, like DelayedButton does.

Normally, a Selectable GameObject (like buttons) is just highlighted when a Pointer hovers it. For some games it's preferred to select the button instead. You can do it by using HighlightableMenu component.

Add HighlightableMenu component in the GameObject parenting your buttons.

This GameObject doesn't need to have an AbstractMenu implementation on it but it's necessary that your children buttons have an implementation of IHighlightable interface, like DelayedButton does.

If you want to add this behavior to other UI component, like a Slider or Text, add the HighlightableTrigger component to it, which is other implementation of IHighlightable interface.

In most games the first button from a Menu is already selected when it started.

To create this behavior, add FirstGameObjectSelector component in the GameObject parenting the Selectable component. This GameObject may have an AbstractMenu implementation on it or even a Popup component.

To use all components above in a single traditional menu, right click on your menu component (the one implementing AbstractMenu) and select Create a Traditional Menu:

HighlightableMenu, SelectableAudioMenu, SubmitableAudioMenu and FirstGameObjectSelector components will attached to its GameObject.

Note: for a even more traditional menu experience, don't forget to disable the Deselect On Background Click field inside the Input System UI Input Module component handling your UI.

Follow the instructions inside here and the package ActionCode-UI will be available for you to install using the Package Manager windows.

You will need a Git client installed on your computer with the Path variable already set.

• Use the Package Manager "Add package from git URL..." feature and paste this URL: https://github.com/HyagoOliveira/UI.git

• You can also manually modify you Packages/manifest.json file and add this line inside dependencies attribute:

"com.actioncode.ui":"https://github.com/HyagoOliveira/UI.git"

Hyago Oliveira

GitHub - BitBucket - LinkedIn - [email protected]