Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Haruma-K/UnityScreenNavigator
Library for screen transitions, transition animations, transition history stacking, and screen lifecycle management in Unity's uGUI.
https://github.com/Haruma-K/UnityScreenNavigator
navigation ugui unity
Last synced: about 13 hours ago
JSON representation
Library for screen transitions, transition animations, transition history stacking, and screen lifecycle management in Unity's uGUI.
- Host: GitHub
- URL: https://github.com/Haruma-K/UnityScreenNavigator
- Owner: Haruma-K
- License: mit
- Created: 2021-08-30T13:01:14.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T06:39:55.000Z (3 months ago)
- Last Synced: 2024-11-06T13:11:56.495Z (5 days ago)
- Topics: navigation, ugui, unity
- Language: C#
- Homepage:
- Size: 11.6 MB
- Stars: 945
- Watchers: 13
- Forks: 77
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Unity Screen Navigator
[](LICENSE.md)
[日本語ドキュメント(Japanese Documents Available)](README_JA.md)
Library for screen transitions, transition animations, transition history stacking, and screen lifecycle management in Unity's uGUI.
## Table of Contents
Details
- [Overview](#overview)
- [Features](#features)
- [Demo](#demo)
- [Setup](#setup)
- [Requirement](#requirement)
- [Install](#install)
- [Basic Screen Transition](#basic-screen-transition)
- [Concept of screens and transitions](#concept-of-screens-and-transitions)
- [Create page and transition](#create-page-and-transition)
- [Create modal and transition](#create-modal-and-transition)
- [Create sheet and transition](#create-sheet-and-transition)
- [How to wait for the transition](#how-to-wait-for-the-transition)
- [Getting containers with static methods](#getting-containers-with-static-methods)
- [Screen Transition Animation](#screen-transition-animation)
- [Setting common transition animations](#setting-common-transition-animations)
- [Setting transition animation for each screen](#setting-transition-animation-for-each-screen)
- [Change transition animation according to partner screen](#change-transition-animation-according-to-partner-screen)
- [Screen transition animation and drawing order](#screen-transition-animation-and-drawing-order)
- [Create simple transition animations easily](#create-simple-transition-animations-easily)
- [Implement interactive animation with partner screen](#implement-interactive-animation-with-partner-screen)
- [Create animation with Timeline](#create-animation-with-timeline)
- [Lifecycle Events](#lifecycle-events)
- [Lifecycle events of the page](#lifecycle-events-of-the-page)
- [Lifecycle events of the modal](#lifecycle-events-of-the-modal)
- [Lifecycle events of the sheet](#lifecycle-events-of-the-sheet)
- [Use async methods instead of coroutines](#use-async-methods-instead-of-coroutines)
- [Loading Screen Resources](#loading-screen-resources)
- [Change the loading method of screen resources](#change-the-loading-method-of-screen-resources)
- [Use Addressable Asset System for the loading](#use-addressable-asset-system-for-the-loading)
- [Load synchronously](#load-synchronously)
- [Preloading](#preloading)
- [Other Features](#other-features)
- [Pop multiple screens at once](#pop-multiple-screens-at-once)
- [Don't stack pages in history](#dont-stack-pages-in-history)
- [Change the backdrop of modals](#change-the-backdrop-of-modals)
- [Close the active modal when the backdrop is clicked](#close-the-active-modal-when-the-backdrop-is-clicked)
- [Enable interaction during transitions](#enable-interaction-during-transitions)
- [Disable masking for container](#disable-masking-for-container)
- [Get information about playing animation information](#get-information-about-playing-animation-information)
- [Use loaded Prefab instances when loading screens](#use-loaded-prefab-instances-when-loading-screens)
- [FAQ](#faq)
- [How to make each Screen with Scene instead of Prefab](#how-to-make-each-screen-with-scene-instead-of-prefab)
- [How to separate view and logic](#how-to-separate-view-and-logic)
- [How to pass data to each screen](#how-to-pass-data-to-each-screen)
- [How to reuse popped pages or modals](#how-to-reuse-popped-pages-or-modals)
- [License](#license)
## Overview
#### Features
* You can create pages, modals, tabs and their transitions easily and flexibly.
* Manage screen lifecycle and memory from load to destroy.
* Separated workflow with animators for complex screen transition animations.
* Well-separated library with no extra functions (ex. GUI library, state machine).
* And standard features such as history stacking and click prevention during transitions.
#### Demo
You can play the demo scene with the following steps.
1. Clone this repository.
2. Open and play the following scene.
* https://github.com/Haruma-K/UnityScreenNavigator/blob/master/Assets/Demo/Core/DemoEntryPoint.unity
Please note that some of the images used in this demo are from the following free contents.
For more information, including copyright, please refer to the following website.
* [JewelSaviorFREE](http://www.jewel-s.jp/)
## Setup
#### Requirement
* Unity 2021.3 or higher
* uGUI (UIElements not supported)
#### Install
1. Open the Package Manager from Window > Package Manager
2. "+" button > Add package from git URL
3. Enter the following to install
* https://github.com/Haruma-K/UnityScreenNavigator.git?path=/Assets/UnityScreenNavigator
Or, open Packages/manifest.json and add the following to the dependencies block.
```json
{
"dependencies": {
"com.harumak.unityscreennavigator": "https://github.com/Haruma-K/UnityScreenNavigator.git?path=/Assets/UnityScreenNavigator"
}
}
```
If you want to set the target version, specify it like follow.
* https://github.com/Haruma-K/UnityScreenNavigator.git?path=/Assets/UnityScreenNavigator#1.0.0
## Basic Screen Transition
#### Concept of screens and transitions
Unity Screen Navigator classifies screens into three types: "Page", "Modal" and "Sheet".
"Page" is a screen that transitions in sequence.
For example, when you transition from the Page A to Page B, Page A will be stacked in the history.
And when you return from Page B, Page A will be redisplayed with its states intact.
"Modal" is a screen that is stacked in a window.
When it is displayed, all interactions except for the foreground modal will be blocked.
And "Sheet" is used for tab-like GUI.
History is not managed, and only one active screen is displayed.
These screens can be nested.
And, the area of each screen can be freely specified (not necessarily the entire window).
#### Create page and transition
To create the page transition, first attach the "Page Container" component to an GameObject under the Canvas.
The pages will be displayed to fit it, so adjust the size.
Next, attach the `Page` component to the root GameObject of the page view.
Place this GameObject under the Resources folder with an arbitrary name.
And call `PageContainer.Push()` with the Resources path to display the page.
The following is an example of pushing the page placed in `Assets/Resources/ExamplePage.prefab`.
```cs
PageContainer pageContainer;
// Push the page named "ExamplePage".
var handle = pageContainer.Push("ExamplePage", true);
// Wait for the transition to finish.
yield return handle;
//await handle.Task; // You can also use await.
//handle.OnTerminate += () => { }; // You can also use callback.
```
Also, use `PageContainer.Pop()` to discard the active page and display the previous page.
```cs
PageContainer pageContainer;
// Pop the active page.
var handle = pageContainer.Pop(true);
// Wait for the transition to finish.
yield return handle;
```
If you want to skip a certain page when call `Pop()`, you can [disable stacking to history](#Dont-stack-pages-in-history) by using the optional argument.
#### Create modal and transition
To create the modal transition, first attach the "Modal Container" component to an GameObject under the Canvas.
In general, modals are designed to cover the entire window with their backdrop and block clicks.
Therefore, the size of the RectTransform of the GameObject should basically be set to match the window size.
Next, attach the `Modal` component to the root GameObject of the modal view.
This root GameObject will be adjusted to fit the size of the `Modal Container`.
So if you want to create the modal with margins, create a child GameObject with a smaller size and create the content inside it.
Place this GameObject under the Resources folder with an arbitrary name.
And call `ModalContainer.Push()` with the Resources path to display the page.
The following is an example of pushing the modal placed in `Assets/Resources/ExampleModal.prefab`.
```cs
ModalContainer modalContainer;
// Push the modal named "ExampleModal".
var handle = modalContainer.Push("ExampleModal", true);
// Wait for the transition to finish.
yield return handle;
//await handle.Task; // You can also use await.
//handle.OnTerminate += () => { }; // You can also use callback.
```
Also, use `ModalContainer.Pop()` to discard the active modal and display the previous modal.
```cs
ModalContainer modalContainer;
// Pop the active modal.
var handle = modalContainer.Pop(true);
// Wait for the transition to finish.
yield return handle;
```
Note that [you can change the modal backdrop](#Change-the-backdrop-of-modals) as you like.
#### Create sheet and transition
To create the sheet transition, first attach the "Sheet Container" component to an GameObject under the Canvas.
The sheets will be displayed to fit it, so adjust the size.
Next, attach the `Sheet` component to the root GameObject of the sheet view.
Place this GameObject under the Resources folder with an arbitrary name.
Call `SheetContainer.Register()` with the Resources path to create the sheet.
After it is created, you can change the active sheet by calling `SheetContainer.Show()`.
At this time, if there is already an active sheet, it will be deactivated.
The following is an example of displaying the sheet placed in `Assets/Resources/ExampleSheet.prefab`.
```cs
SheetContainer sheetContainer;
// Instantiate the sheet named "ExampleSheet"
var registerHandle = sheetContainer.Register("ExampleSheet");
yield return registerHandle;
// Show the sheet named "ExampleSheet"
var showHandle = sheetContainer.Show("ExampleSheet", false);
yield return showHandle;
```
Note that when multiple sheets with same resource keys are instantiated by the `Register()` method, the identity of the sheet instance cannot guaranteed by the resource key.
In such case, use the sheet ID instead of the resource key, as shown below.
```cs
SheetContainer sheetContainer;
// Instantiate the sheet named "ExampleSheet" and get the sheet id.
var sheetId = 0;
var registerHandle = sheetContainer.Register("ExampleSheet", x =>
{
sheetId = x.sheetId;
});
yield return registerHandle;
// Show the sheet with sheetId.
var showHandle = sheetContainer.Show(sheetId, false);
yield return showHandle;
```
Also, to hide the active sheet instead of switching it, use the `Hide()` method.
```cs
SheetContainer sheetContainer;
// Hide the active sheet.
var handle = sheetContainer.Hide(true);
// Wait for the transition to finish.
yield return handle;
```
#### How to wait for the transition
Each method for transition returns `AsyncProcessHandle` as the return value.
Using this object, you can wait for the transition process to finish.
You can use coroutines, asynchronous methods, and callbacks to do this.
To wait in a coroutine, use `yield return` as shown below.
```cs
yield return pageContainer.Push("ExamplePage", true);
```
To wait in an asynchronous method, use await for `AsyncProcessHandle.Task` as follows.
```cs
await pageContainer.Push("ExamplePage", true).Task;
```
And use `AsyncProcessHandle.OnTerminate` if you want to use a callback.
```cs
pageContainer.Push("ExamplePage", true).OnTerminate += () => { };
```
#### Getting containers with static methods
Each container (`PageContainer`/`ModalContainer`/`SheetContainer`) has static methods to get the instance.
Using the `Container.Of()` as follows, you can get the container that is attached to the nearest parent from the given Transform or RectTransform.
```cs
var pageContainer = PageContainer.Of(transform);
var modalContainer = ModalContainer.Of(transform);
var sheetContainer = SheetContainer.Of(transform);
```
Also, you can set the `Name` property in the container's Inspector to get the container by its name.
In this case, use the `Container.Find()` method as follows.
```cs
var pageContainer = PageContainer.Find("SomePageContainer");
var modalContainer = ModalContainer.Find("SomeModalContainer");
var sheetContainer = SheetContainer.Find("SomeSheetContainer");
```
## Screen Transition Animation
#### Setting common transition animations
In default, a standard transition animation is set for each screen type.
You can create a class derived from `TransitionAnimationObject` to create custom transition animation.
This class has a property and methods to define the animation behavior.
```cs
// Duration (sec).
public abstract float Duration { get; }
// Initialize.
public abstract void Setup();
// Define the state at this time.
public abstract void SetTime(float time);
```
Please refer to [SimpleTransitionAnimationObject](https://github.com/Haruma-K/UnityScreenNavigator/blob/master/Assets/UnityScreenNavigator/Runtime/Core/Shared/SimpleTransitionAnimationObject.cs) for the practical implementation.
Then, instantiate this Scriptable Object, and assign it to `UnityScreenNavigatorSettings`.
You can create `UnityScreenNavigatorSettings` from `Assets > Create > Screen Navigator Settings`.
#### Setting transition animation for each screen
You can also set up different animation for each screen.
Each Page, Modal, and Sheet component has the `Animation Container` property.
You can set the transition animation to it.
You can change the transition animation of this screen by setting the `Asset Type` to `Scriptable Object` and assigning the `TransitionAnimationObject` described in the previous section to `Animation Object`.
Also, you can use the MonoBehaviour instead of the ScriptableObject.
In this case, first create a class that extends `TransitionAnimationBehaviour` .
Please refer to [SimpleTransitionAnimationBehaviour](https://github.com/Haruma-K/UnityScreenNavigator/blob/master/Assets/UnityScreenNavigator/Runtime/Core/Shared/SimpleTransitionAnimationBehaviour.cs) for the practical implementation.
Then, attach this component and set the `Asset Type` to `Mono Behaviour` and assign the reference to `Animation Behaviour`.
#### Change transition animation according to partner screen
For example, when screen A enters and screen B exits, screen B is called the "Partner Screen" of screen A.
If you enter the name of the partner screen in the property shown below, the transition animation will be applied only when this name matches the partner screen name.
In default, the prefab name is used as the screen name.
If you want to name it explicitly, uncheck `Use Prefab Name As Identifier` and enter a name in the `Identifier` property.
In addition, regular expressions can be used for the `Partner Page Identifier Regex`.
And if multiple animations are set, they will be evaluated in order from top.
#### Screen transition animation and drawing order
In the transition animation of a screen with a partner screen, the drawing order can be important.
For example, an animation where the screen covers the partner screen.
If you want to control the drawing order, use the `Rendering Order` property.
During screen transitions, the screen is drawn in the order of decreasing this value.
Note that modals do not have a `Rendering Order` property, since the newest one is always displayed in front.
#### Create simple transition animations easily
You can use `SimpleTransitionAnimationObject` as a simple transition animation implementation.
This can be created from `Assets > Create > Screen Navigator > Simple Transition Animation`.
Then, a ScriptableObject as shown below will be generated, and you can set up the animation from the Inspector.
You can also use `SimpleTransitionAnimationBehaviour` as a MonoBehaviour implementation of this.
This is used by attaching it directly to a GameObject.
Description of each property is as follows.
|Property Name|Description|
|-|-|
|Delay|Delay time before the animation starts (seconds).|
|Duration|Animation duration (seconds).|
|Ease Type|Type of the easing functions.|
|Before Alignment|Relative position from the container before transition.|
|Before Scale|Scale before transition.|
|Before Alpha|Transparency before transition.|
|After Alignment|Relative position from the container after transition.|
|After Scale|Scale after transition.|
|After Alpha|Transparency after transition.|
#### Implement interactive animation with partner screen
You can also create animations that refer to the state of the partner screen.
In the following example, the image of the previous modal is enlarged while seamlessly transitioning to the next modal.
To implement this, first create a class that derived from `TransitionAnimationObject` or `TransitionAnimationBehaviour`.
Then, refer to the `PartnerRectTransform` property to get the partner screen.
If the partner screen does not exist, `PartnerRectTransform` will be null.
Please refer to [CharacterImageModalTransitionAnimation](https://github.com/Haruma-K/UnityScreenNavigator/blob/master/Assets/Demo/Scripts/CharacterImageModalTransitionAnimation.cs) in demo for the practical implementation.
#### Create animation with Timeline
You can use Timeline to create transition animation.
It is recommended to use Timeline for complex transition animation.
To implement this, first attach the `Timeline Transition Animation Behaviour` to a GameObject.
And assign `Playable Director` and `Timeline Asset` to properties.
`Play On Awake` property of `Playable Director` need to be unchecked.
Finally, assign this `Timeline Transition Animation Behaviour` to the `Animation Container`.
In addition, I recommend [UnityUIPlayables](https://github.com/Haruma-K/UnityUIPlayables) to create uGUI animations with Timeline.
## Lifecycle Events
#### Lifecycle events of the page
By overriding following methods in the class derived from the `Page` class,
you can write the processes associated with the lifecycle of the page.
```cs
using System.Collections;
using UnityScreenNavigator.Runtime.Core.Page;
public class SomePage : Page
{
// Called just after this page is loaded.
public override IEnumerator Initialize() { yield break; }
// Called just before this page is released.
public override IEnumerator Cleanup() { yield break; }
// Called just before this page is displayed by the Push transition.
public override IEnumerator WillPushEnter() { yield break; }
// Called just after this page is displayed by the Push transition.
public override void DidPushEnter() { }
// Called just before this page is hidden by the Push transition.
public override IEnumerator WillPushExit() { yield break; }
// Called just after this page is hidden by the Push transition.
public override void DidPushExit() { }
// Called just before this page is displayed by the Pop transition.
public override IEnumerator WillPopEnter() { yield break; }
// Called just after this page is displayed by the Pop transition.
public override void DidPopEnter() { }
// Called just before this page is hidden by the Pop transition.
public override IEnumerator WillPopExit() { yield break; }
// Called just after this page is hidden by the Pop transition.
public override void DidPopExit() { }
}
```
You can also register lifecycle events externally by `Page.AddLifecycleEvents()` as below.
```cs
// IPageLifecycleEvent is the interface that has lifecycle events described above.
// You can specify the execution priority with the second argument.
// Less than 0: executed before Page lifecycle event.
// Greater than 0: executed after Page lifecycle event.
IPageLifecycleEvent lifecycleEventImpl;
Page page;
page.AddLifecycleEvent(lifecycleEventImpl, -1);
// It is also possible to register only some lifecycle events as follows.
IEnumerator OnWillPushEnter()
{
// Some code.
yield break;
}
page.AddLifecycleEvent(onWillPushEnter: OnWillPushEnter);
```
And you can also hook transition events from the container by passing object that implements `IPageContainerCallbackReceiver` to `PageContainer.AddCallbackReceiver()`.
```cs
public interface IPageContainerCallbackReceiver
{
// Called just before the Push transition is executed.
void BeforePush(Page enterPage, Page exitPage);
// Called just after the Push transition is executed.
void AfterPush(Page enterPage, Page exitPage);
// Called just before the Pop transition is executed.
void BeforePop(Page enterPage, Page exitPage);
// Called just after the Pop transition is executed.
void AfterPop(Page enterPage, Page exitPage);
}
```
Note that if you implement `IPageContainerCallbackReceiver` to `MonoBehaviour` and attach it to GameObject of the container,
it will be registered to `PageContainer` without calling `PageContainer.AddCallbackReceiver()`.
#### Lifecycle events of the modal
By overriding following methods in the class derived from the `Modal` class,
you can write the processes associated with the lifecycle of the modal.
```cs
using System.Collections;
using UnityScreenNavigator.Runtime.Core.Modal;
public class SomeModal : Modal
{
// Called just after this modal is loaded.
public override IEnumerator Initialize() { yield break; }
// Called just before this modal is released.
public override IEnumerator Cleanup() { yield break; }
// Called just before this model is displayed by the Push transition.
public override IEnumerator WillPushEnter() { yield break; }
// Called just after this modal is displayed by the Push transition.
public override void DidPushEnter() { }
// Called just before this modal is hidden by the Push transition.
public override IEnumerator WillPushExit() { yield break; }
// Called just after this modal is hidden by the Push transition.
public override void DidPushExit() { }
// Called just before this modal is displayed by the Pop transition.
public override IEnumerator WillPopEnter() { yield break; }
// Called just after this modal is displayed by the Pop transition.
public override void DidPopEnter() { }
// Called just before this modal is hidden by the Pop transition.
public override IEnumerator WillPopExit() { yield break; }
// Called just after this modal is hidden by the Pop transition.
public override void DidPopExit() { }
}
```
You can also register lifecycle events externally by `Modal.AddLifecycleEvents()` as below.
```cs
// IModalLifecycleEvent is the interface that has lifecycle events described above.
// You can specify the execution priority with the second argument.
// Less than 0: executed before Modal lifecycle event.
// Greater than 0: executed after Modal lifecycle event.
IModalLifecycleEvent lifecycleEventImpl;
Modal modal;
Modal.AddLifecycleEvent(lifecycleEventImpl, -1);
// It is also possible to register only some lifecycle events as follows.
IEnumerator OnWillPushEnter()
{
// Some code.
yield break;
}
modal.AddLifecycleEvent(onWillPushEnter: OnWillPushEnter);
```
And you can also hook transition events from the container by passing object that implements `IModalContainerCallbackReceiver` to `ModalContainer.AddCallbackReceiver()`.
```cs
public interface IModalContainerCallbackReceiver
{
// Called just before the Push transition is executed.
void BeforePush(Modal enterModal, Modal exitModal);
// Called just after the Push transition is executed.
void AfterPush(Modal enterModal, Modal exitModal);
// Called just before the Pop transition is executed.
void BeforePop(Modal enterModal, Modal exitModal);
// Called just after the Pop transition is executed.
void AfterPop(Modal enterModal, Modal exitModal);
}
```
Note that if you implement `IModalContainerCallbackReceiver` to `MonoBehaviour` and attach it to GameObject of the container,
it will be registered to `ModalContainer` without calling `ModalContainer.AddCallbackReceiver()`.
#### Lifecycle events of the sheet
By overriding following methods in the class derived from the `Sheet` class,
you can write the processes associated with the lifecycle of the sheet.
```cs
using System.Collections;
using UnityScreenNavigator.Runtime.Core.Sheet;
public class SomeSheet : Sheet
{
// Called just after this sheet is loaded.
public override IEnumerator Initialize() { yield break; }
// Called just before this sheet is released.
public override IEnumerator Cleanup() { yield break; }
// Called just before this sheet is displayed.
public override IEnumerator WillEnter() { yield break; }
// Called just after this sheet is displayed.
public override void DidEnter() { }
// Called just before this sheet is hidden.
public override IEnumerator WillExit() { yield break; }
// Called just after this sheet is hidden.
public override void DidExit() { }
}
```
You can also register lifecycle events externally by `Sheet.AddLifecycleEvents()` as below.
```cs
// ISheetLifecycleEvent is the interface that has lifecycle events described above.
// You can specify the execution priority with the second argument.
// Less than 0: executed before Sheet lifecycle event.
// Greater than 0: executed after Sheet lifecycle event.
ISheetLifecycleEvent lifecycleEventImpl;
Sheet sheet;
Sheet.AddLifecycleEvent(lifecycleEventImpl, -1);
// It is also possible to register only some lifecycle events as follows.
IEnumerator OnWillEnter()
{
// Some code.
yield break;
}
sheet.AddLifecycleEvent(onWillEnter: OnWillEnter);
```
And you can also hook transition events from the container by passing object that implements `ISheetContainerCallbackReceiver` to `SheetContainer.AddCallbackReceiver()`.
```cs
public interface ISheetContainerCallbackReceiver
{
// Called just before the Show transition is executed.
void BeforeShow(Sheet enterSheet, Sheet exitSheet);
// Called just after the Show transition is executed.
void AfterShow(Sheet enterSheet, Sheet exitSheet);
// Called just before the Hide transition is executed.
void BeforeHide(Sheet exitSheet);
// Called just after the Hide transition is executed.
void AfterHide(Sheet exitSheet);
}
```
Note that if you implement `ISheetContainerCallbackReceiver` to `MonoBehaviour` and attach it to GameObject of the container,
it will be registered to `SheetContainer` without calling `SheetContainer.AddCallbackReceiver()`.
#### Use async methods instead of coroutines
You can also use asynchronous methods instead of coroutines to define lifecycle events, as shown below.
```cs
using System.Threading.Tasks;
using UnityScreenNavigator.Runtime.Core.Page;
public class SomePage : Page
{
// Using asynchronous methods to define lifecycle events
public override async Task Initialize()
{
await Task.Delay(100);
}
}
```
To use asynchronous methods, add `Scripting Define Symbols` in the following steps.
* Player Settings > Other Settings
* Add `USN_USE_ASYNC_METHODS` to `Scripting Define Symbols`.
Note that `Scripting Define Symbols` needs to be set for all platforms.
## Loading Screen Resources
#### Change the loading method of screen resources
As mentioned above, by default, the resources of each screen are placed in the Resources folder as Prefab.
If you want to change the loading method, first create the Scriptable Object derived from `AssetLoaderObject`.
`AssetLoaderObject` is an implementation of `IAssetLoader`, and has the following methods.
```cs
// Load the resource indicated by the key.
public abstract AssetLoadHandle Load(string key) where T : Object;
// Asynchronously load the resource indicated by the key.
public abstract AssetLoadHandle
// Release the resource indicated by the handle.
public abstract void Release(AssetLoadHandle handle);
```
Please refer to [ResourcesAssetLoader](https://github.com/Haruma-K/UnityScreenNavigator/blob/master/Assets/UnityScreenNavigator/Runtime/Foundation/AssetLoader/ResourcesAssetLoader.cs) for the practical implementation.
After create it, assign it's instance to `AssetLoader` property of `UnityScreenNavigatorSettings`.
You can create `UnityScreenNavigatorSettings` from `Assets > Create > Screen Navigator Settings`.
You can also set the `IAssetLoader`for each container by setting the `AssetLoader` property of each `Container`.
#### Use Addressable Asset System for the loading
An implementation of `IAssetLoader` for the Addressable Asset System is provided by default.
If you want to load each screen with an address, follow the steps below to set it up.
1. Select `Assets > Create > Resource Loader > Addressable Asset Loader`
2. Assign the ScriptableObject created in step 1 to the `AssetLoader` property of `UnityScreenNavigatorSettings`.
#### Load synchronously
You can pass false as the `loadAsync` argument of each container's transition method to load the screen synchronously.
For example, `PageContainer.Push()` should be written as follows.
```cs
PageContainer container;
// Load synchronously.
var handle = container.Push("FooPage", true, loadAsync: false);
// Wait for the end of the transition animation.
yield return handle;
```
In addition, you can initialize it in same frame as the transition method call by using `onLoad` callback together.
```cs
PageContainer container;
// Load synchronously and receive the callback after loading.
var handle = container.Push("FooPage", true, loadAsync: false, onLoad: x =>
{
// Initialize page. (Called in the same frame as Push)
x.page.Setup();
});
// Wait for the end of the transition animation.
yield return handle;
```
Note that if you use `AddressableAssetLoader` and load synchronously, Addressables 1.17.4 or higher is required.
In addition, there are performance cautions due to [Addressable's specifications](https://docs.unity3d.com/Packages/[email protected]/manual/SynchronousAddressables.html).
#### Preloading
The pages and the modals are loaded only after a screen transition is requested.
When loading a large resource, it may take a long time to load and prevent smooth transitions.
In such a case, it is useful to preload resources in advance.
The following is an example of preloading with `PageContainer`.
```cs
const string pageName = "FooPage";
PageContainer container;
// Preload FooPage.
var preloadHandle = container.Preload(pageName);
// Wait for the end of the preloading.
yield return preloadHandle;
// Transition smoothly because FooPage has been preloaded.
container.Push(pageName, true);
// Release the preloaded FooPage.
container.ReleasePreloaded(pageName);
```
Please refer to [HomePage in demo](https://github.com/Haruma-K/UnityScreenNavigator/blob/master/Assets/Demo/Scripts/HomePage.cs) for the practical implementation.
When the `Home` page is initialized, the `Shop` page is also loaded and destroyed at the same time.
## Other Features
#### Pop multiple screens at once
In `PageContainer` and `Modal Container`, you can pop multiple screens at once.
To do this, specify the number of screens to be popped in the second argument of `PageContainer.Pop()` or `ModalContainer.Pop()`.
```cs
PageContainer pageContainer;
pageContainer.Pop(true, 2);
ModalContainer modalContainer;
modalContainer.Pop(true, 2);
```
You can also specify the destination `PageID` or `ModalID`.
`PageID` and `ModalID` can be obtained using the `onLoad` callback of `Push()` as shown below.
```cs
PageContainer pageContainer;
pageContainer.Push("fooPage", true, onLoad: x =>
{
var pageId = x.pageId;
});
ModalContainer modalContainer;
modalContainer.Push("fooModal", true, onLoad: x =>
{
var modalId = x.modalId;
});
```
In addition, you can specify any ID by specifying the `pageId` or `modalId` argument of `Push()`.
```cs
PageContainer pageContainer;
pageContainer.Push("fooPage", true, pageId: "MyPageID");
ModalContainer modalContainer;
modalContainer.Push("fooModal", true, modalId: "MyModalID");
```
In addition, for the pages or modals that are skipped when popping multiple screens, the lifecycle events before and after transition will not be called, only the event before destroying will be called.
In `PageContainer`, the transition animation of the skipping pages will not be played.
In `ModalContainer`, the transition animation when the skipped modals are closed will be played simultaneously.
#### Don't stack pages in history
There are some pages that you want to skip on transition back, such as loading screen.
In such a case, you can prevent the page from being stacked in the history by setting the optional argument `stack` to `false` in the `PageContainer.Push()`.
The instance of this page will be disposed when transitioning to the next page, and thus skipped when backing.
```cs
PageContainer container;
// Transition to FooPage without stacking it in the history.
yield return container.Push("FooPage", true, stack: false);
// Transition to BarPage, and FooPage is disposed.
yield return container.Push("BarPage", true);
// When Pop, it does not back to FooPage, but to the page before it.
yield return container.Pop(true);
```
Please refer to [TopPage in demo](https://github.com/Haruma-K/UnityScreenNavigator/blob/master/Assets/Demo/Scripts/TopPage.cs) for the practical implementation.
Transition to the loading page without stacking.
#### Change the backdrop of modals
In default, a black semi-transparent screen is set as the modal backdrop.
You can change this in the settings.
To do this, first attach the `Modal Backdrop` component to the modal backdrop view, and make it a prefab.
Next, assign this prefab as the modal backdrop.
To change the modal backdrop of the whole application, assign it to `Modal Backdrop Prefab` in `UnityScreenNavigatorSettings`.
You can create `UnityScreenNavigatorSettings` from `Assets > Create > Screen Navigator Settings`.
You can also set the backdrop for each `Modal Container` by assigning the prefab to the `Override Backdrop Prefab` of the `Modal Container`.
#### Close the active modal when the backdrop is clicked
In default, the backdrop is not clickable.
If you want to close the active modal when the backdrop is clicked, first change the backdrop by the steps above.
Then, check the **Close Modal When Clicked** option of the **Modal Backdrop** component.
#### Enable interaction during transitions
From the start of transition to the end, interactions of all containers such as clicking on the screen are disabled.
You can change the settings by changing `Enable Interaction In Transition` and `Control Interactions Of All Containers` property of `UnityScreenNavigatorSettings`.
In default, `Enable Interaction In Transition` is `false` and `Control Interactions Of All Containers` is `true`.
To enable interaction during transitions, set `Enable Interaction In Transition` to `true`.
And if you want to disable interaction only for the container that is currently transitioning, keep `Enable Interaction In Transition` to `false` and set `Control Interactions Of All Containers` to `false`.
You can create `UnityScreenNavigatorSettings` from `Assets > Create > Screen Navigator Settings`.
However, it is not possible to transition to other screen while transitioning in one container.
So you need to control the transition timing appropriately if you enable interaction.
#### Disable masking for container
By default, the part of the screen under the container that is outside the container is masked.
If you want to show the screen outside the container, uncheck the `Rect Mask 2D` component attached to the container's GameObject.
#### Get information about playing animation information
You can get the information about the transition animation currently playing from the following properties of the `Page`, `Modal`, `Sheet` classes.
| Property Name | Description |
|-|-|
| IsTransitioning | Whether in transition or not. |
| TransitionAnimationType | Type of the transition animation. If not in transition, return null. |
| TransitionAnimationProgress | Progress of the transition animation. |
| TransitionAnimationProgressChanged | Event when the progress of the transition animation changes. |
#### Use loaded Prefab instances when loading screens
The `PreloadedAssetLoaderObject` allows you to load preloaded prefab instances directly, instead of using Resources or Addressables when loading the screen.
You can use it by entering the key and prefab in the Scriptable Object created from Assets > Create > Resource Loader > Preloaded Asset Loader as shown below.
I also provide `PreloadedAssetLoader` implementation for runtime.
## FAQ
#### How to make each Screen with Scene instead of Prefab
You can load the Screen placed in the Scene by implementing `AssetLoader`.
Implement `IAssetLoader` to load the Scene file that contains the requested screen and return the GameObject of the screen.
See [Change the loading method of screen resources](#change-the-loading-method-of-screen-resources) for details.
#### How to separate view and logic
I wrote the blog post below to demonstrate the concept and implementation.
https://light11.hatenadiary.com/entry/2022/01/11/193925
(Sorry but Japanese only)
#### How to pass data to each screen
First, as an example, data is passed to the screen when loading is completed in the demo scene, as shown below.
https://github.com/Haruma-K/UnityScreenNavigator/blob/8a115b1b25ac1d9fcf4b1ab6d5f2c1cd1d915ee5/Assets/Demo/Scripts/CharacterModal.cs#L91
However, there are many other possible ways to pass data.
For example, there may be a case where you want to use a DI Container to set data.
Therefore, it is the policy of this library not to implement and enforce a specific way.
#### How to reuse popped pages or modals
Popped pages and modals are immediately destroyed and cannot be reused.
The essence of the desire for reuse can be categorized into the following two types.
1. not wanting to load screen resources each time
2. want to preserve the state of the screen
Of these, the load time issue can be resolved by [Preloading](#preloading).
As for state preserving, from the standpoint of maintainability, state and view should be decoupled so that they can be reconstructed.
In addition, in general, from usability standpoint, it is "Tab" transition that should retain state.
In this library as well, the state is always preserved in transitions using "Sheet" to implement tabs.
See [Create sheet and transition](#create-sheet-and-transition) for details.
And if reusable, users will need to manage the lifecycle by themselves.
In other words, when it is no longer needed, users must call the Cleanup method to destroy instance and clean up the memory.
## License
This software is released under the MIT License.
You are free to use it within the scope of the license.
However, the following copyright and license notices are required for use.
* https://github.com/Haruma-K/UnityScreenNavigator/blob/master/LICENSE.md