Skip to content

Repository files navigation

ActionUpdaterService for Unity

Overview

IActionUpdaterService is a flexible and easy-to-use service for Unity, designed to manage and dispatch update-related actions (FixedUpdate, Update, LateUpdate) outside of MonoBehaviour. It allows for a more modular approach to handling updates, especially useful in projects using dependency injection frameworks like Zenject.

Features

  • Separate update methods (FixedUpdate, Update, LateUpdate) outside MonoBehaviour.
  • Easy subscription and unsubscription of actions.
  • Pause functionality to control the execution of update actions.
  • Automatic cleanup to prevent memory leaks.

Getting Started

Installation

  1. Import the IActionUpdaterService package into your Unity project.
  2. Add ActionUpdaterService and ActionUpdateDispatcher scripts to your project.

Zenject Binding

Bind the IActionUpdaterService in your Zenject installer like this:

publicsealedclassServicesInstaller:MonoInstaller{publicoverridevoidInstallBindings(){Container.Bind<IActionUpdaterService>().To<ActionUpdaterService>().AsSingle();}}

Don't forget to add to the ProjectContext:

DocsMaterials/img.pngDocsMaterials/img_1.png

Dispatcher

Add the ActionUpdateDispatcher class to the ProjectContext prefab, Bootstrupper or any other object that will be the only one in the game.

img_2.png

Usage

Inject IActionUpdaterService into your classes and subscribe to the desired update methods:

publicsealedclassYourClass{privateIActionUpdaterServiceactionUpdater;[Inject]privatevoidConstructor(IActionUpdaterServiceactionUpdater)=>this.actionUpdater=actionUpdater;publicvoidSomeMethod(){actionUpdater.Subscribe(MyUpdateMethod,UpdateType.Update);}privatevoidMyUpdateMethod(){// Your update logic here}}

Remember to unsubscribe from the service to prevent memory leaks:

publicvoidOnDestroy(){actionUpdater.Unsubscribe(MyUpdateMethod,UpdateType.Update);}

Pausing Updates

You can pause and resume the execution of update methods:

actionUpdater.SetPause(true);// Pauses updatesactionUpdater.SetPause(false);// Resumes updates

Example

DocsMaterials/img_4.pngDocsMaterials/img_3.png

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

Developed by RimuruDev.

About

IActionUpdaterService is a flexible and easy-to-use service for Unity, designed to manage and dispatch update-related actions (FixedUpdate, Update, LateUpdate) outside of MonoBehaviour. It allows for a more modular approach to handling updates, especially useful in projects using dependency injection frameworks like Zenject.

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages