UniFlux - Flexible Event Driven and Flux for Unity

<span class="badge-npmversion"><a href="https://npmjs.org/package/com.xavierarpa.uniflux" title="View this project on NPM"><img src="https://img.shields.io/npm/v/com.xavierarpa.uniflux.svg" alt="NPM version" /></a></span>

⚠️ Please read Documentation

🛠 Try UniFlux Toolkit

Contact Me

Installation

• You can Download at Unity Asset Store

• You can use the .unityPackage in releases

• You can use the *.tzg in releases and add in PackageManager

• You can add in PackageManager (How to install package from git URL)

https://github.com/xavierarpa/UniFlux.git

• You can install via openupm CLI

openupm add com.xavierarpa.uniflux

• You can install via npm

npm i com.xavierarpa.uniflux

Performance

| Name | Iterations | GC | Time | |-----------|--------------:|------:|-----:| | UniFlux (Dispatch<string>) | 10.000 | 0B | 1ms | | UniFlux (ADD Store<string>) | 10.000 | 1.2MB | ~3ms | | UniFlux (REMOVE Store<string>) | 10.000 | 1.2MB | ~3ms |

Note: Storing (ADD and REMOVE) by design is planned to do it once so there's no problem in performance.

Tip: MethodFlux in Interfaces

You can use [MethodFlux] directly in an interface so that implementations are automatically detected. Example:

public interface IService<T>
{
    T Service 
    { 
        [MethodFlux(0)] get; // attribute lives on the interface
    }
}

internal class AudioModule : MonoFlux, IAudioService
{
    IAudioService IService<IAudioService>.Service => this;
    // ↑ Automatically subscribed — UniFlux reads the attribute from the interface
}

Personal recommendation from Xavier!

Star History

License

MIT

<pre> MIT License Copyright (c) 2023 Xavier Thomas Peter Arpa Lopez Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </pre>