https://github.com/gilzoide/unity-back-button-stack
Easily manage a stack of objects that respond to the ESC button / Android Back button in Unity, so that only the top object handles the event.
https://github.com/gilzoide/unity-back-button-stack
back-button backbutton manager stack unity unity3d upm upm-package
Last synced: 5 months ago
JSON representation
Easily manage a stack of objects that respond to the ESC button / Android Back button in Unity, so that only the top object handles the event.
- Host: GitHub
- URL: https://github.com/gilzoide/unity-back-button-stack
- Owner: gilzoide
- License: unlicense
- Created: 2023-10-28T02:55:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T21:19:53.000Z (6 months ago)
- Last Synced: 2025-01-31T03:54:41.381Z (5 months ago)
- Topics: back-button, backbutton, manager, stack, unity, unity3d, upm, upm-package
- Language: C#
- Homepage:
- Size: 23.4 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Back Button Stack
[](https://openupm.com/packages/com.gilzoide.back-button-stack/)
Easily manage a stack of objects that respond to the ESC button / Android Back button in Unity, so that only the top object handles the event.
Check out the [Popup Stack](Samples~/PopupStack) sample scene for some usage example.
## Features
- Only the last object in the stack will be called when the ESC/Back button is pressed.
- Inherit [ABackButtonHandler](Runtime/ABackButtonHandler.cs) to have scripts that handle the ESC/Back button be inserted/removed from the singleton stack automatically in their `OnEnable` / `OnDisable` methods.
- Supports pure C# classes as well, just implement the [IBackButtonHandler](Runtime/IBackButtonHandler.cs) interface and call `AddToBackButtonStack` and `RemoveFromBackButtonStack` to add / remove it from the singleton stack.
- Custom inspector for debugging which objects are currently in the stack, just select the `BackButtonStack` object in the `DontDestroyOnLoad` scene while in Play Mode.
## How to install
Either:
- Use the [openupm registry](https://openupm.com/) and install this package using the [openupm-cli](https://github.com/openupm/openupm-cli):
```
openupm add com.gilzoide.back-button-stack
```
- Install using the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui-giturl.html) with the following URL:
```
https://github.com/gilzoide/unity-back-button-stack.git#1.0.0
```
- Clone this repository or download a snapshot of it directly inside your project's `Assets` or `Packages` folder.