Skip to content

UIReady.md

Latest commit

 

History

History
47 lines (30 loc) · 3.58 KB

UIReady.md

File metadata and controls

47 lines (30 loc) · 3.58 KB
Raw

Компонент UIReady

Что это: Компонент также содержит логику для асинхронной загрузки сцен с отображением прогресса.

Как использовать: см. разделы ниже.

Статус: deprecated.

Замена: SceneFlowController.

Для нового кода используйте SceneFlowController (модуль Level, Neoxider/Level/SceneFlowController). UIReady остаётся рабочим, но помечен как устаревший и скрыт из меню добавления компонентов. Миграция: замените компонент на SceneFlowController; поля ALS (gameObjectLoad, textProgress, loadEndText) настройте в секции Progress UI; методы LoadScene / Restart / Quit / Pause / ProceedScene совпадают по смыслу.

1. Введение

UIReady — это многоцелевой компонент для управления базовыми UI-взаимодействиями и сценами. Он предоставляет готовые публичные методы, которые можно легко назначить на кнопки в инспекторе Unity для выполнения таких действий, как перезапуск уровня, загрузка другой сцены или выход из игры.

Компонент также содержит логику для асинхронной загрузки сцен с отображением прогресса.

2. Описание класса

UIReady

  • Пространство имен: Neo.UI
  • Путь к файлу: Assets/Neoxider/Scripts/UI/UIReady.cs

Описание Предоставляет набор готовых методов для управления сценами и приложением, предназначенных для использования с UI-кнопками.

Ключевые особенности

  • Управление сценами: Простые методы для перезапуска, загрузки по ID и асинхронной загрузки.
  • Асинхронная загрузка: Встроенная логика для отображения прогресса загрузки сцены на UI-элементах (TextMeshProUGUI, Animator).
  • Управление приложением: Метод для выхода из игры.
  • Пауза: Простой метод для установки Time.timeScale в 0 или 1.

Публичные методы

  • Quit(): Завершает работу приложения. Возвращает void.
  • Restart(): Перезагружает текущую активную сцену. Возвращает void.
  • Pause(bool activ): Ставит или снимает паузу, изменяя Time.timeScale. Возвращает void.
  • LoadScene(int idScene): Загружает сцену по ее buildIndex. Возвращает void.
  • LoadSceneAsync(int idScene): Запускает асинхронную загрузку сцены по ее buildIndex. Возвращает void.
  • ProceedScene(): Позволяет асинхронно загруженной сцене активироваться (используется после LoadSceneAsync). Возвращает void.