https://github.com/UnityCommunity/UnitySingleton
The best way to implement singleton pattern in Unity.
https://github.com/UnityCommunity/UnitySingleton
csharp csharp-code csharp-library csharp-script design-pattern design-patterns singleton singleton-pattern singleton-standard singletonpattern unity unity-scripts unity-tutorial unity3d
Last synced: 27 days ago
JSON representation
The best way to implement singleton pattern in Unity.
- Host: GitHub
- URL: https://github.com/UnityCommunity/UnitySingleton
- Owner: UnityCommunity
- License: mit
- Created: 2017-09-16T07:23:38.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T15:19:24.000Z (7 months ago)
- Last Synced: 2024-10-29T17:12:00.771Z (7 months ago)
- Topics: csharp, csharp-code, csharp-library, csharp-script, design-pattern, design-patterns, singleton, singleton-pattern, singleton-standard, singletonpattern, unity, unity-scripts, unity-tutorial, unity3d
- Language: C#
- Homepage: https://en.wikipedia.org/wiki/Singleton_pattern
- Size: 74.2 KB
- Stars: 457
- Watchers: 17
- Forks: 61
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
| [Getting Started](#getting-started) | [Features](#features) | [License](#license) | [Resources](#resources) | [Download](#download) |
|-------------------------------------|-----------------------|---------------------|-------------------------|-----------------------|
# Unity Singleton
The best way to implement singleton pattern in Unity. By using this pattern you will be able to define Global variables and classes and use their methods and properties in Global. This pattern is a must-have for most of the games that made using Unity engine.
:book: [Learn More about Singleton pattern](https://en.wikipedia.org/wiki/Singleton_pattern)
## Features
- Works in both Development and Production
- Instantiates Singleton objects if they aren't available by Lazy Load
- You can configure fields in the inspector for singleton objects in the preload scene
## Getting Started
This package can be added to your project via [Git UPM](https://docs.unity3d.com/6000.0/Documentation/Manual/upm-ui-giturl.html).
To add this package, copy:
```shell
https://github.com/UnityCommunity/UnitySingleton.git
```
and add it as a git package in the Unity Package Manager by clicking on the "+" icon on the top left of the Package Manager Window, and selecting "Install package from git URL".
Once you have the package installed, you may
- Create your own Singleton classes by extending the Generic [:sparkles: Singleton :sparkles:](Runtime/Scripts/Singleton.cs) class. (:rocket: Check out the example [GameManager](Samples/Scripts/GameManager.cs) in the example [_Preload scene](Samples/Scenes/_Preload.unity).)
- Attach your singleton classes to a GameManager game object in a _Preload scene of your own.
- Edit the variables inside the inspector
- Run the game and enjoy!
## Usage
Add `using UnityCommunity.UnitySingleton;` for using the classes.
- Use `Singleton` for plain C# classes.
- Use `MonoSingleton` if you want a Scene-based singleton which is not persistent across scenes.
- Use `PersistentMonoSingleton` if you want a Global and persistent singleton across scenes.
## Contribute
Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute to this project.
## Download
Run the following command in terminal or command prompt to clone the repository:
```bash
git clone https://github.com/UnityCommunity/UnitySingleton.git
```
Or [:fire: Download the master branch as zip](https://github.com/UnityCommunity/UnitySingleton/archive/master.zip).
## Resources
- [:book: Wikipedia](https://en.wikipedia.org/wiki/Singleton_pattern)
- [:book: On the _Preload Scene](https://stackoverflow.com/questions/35890932/unity-game-manager-script-works-only-one-time/35891919#35891919)
- [:arrow_forward: Deep dive into the Singleton Pattern](https://www.youtube.com/watch?v=mpM0C6quQjs)
## License
MIT @ [Unity Community](https://github.com/UnityCommunity)
Made with :heart: by [Unity Community](https://github.com/UnityCommunity)