# ecslite-threads-unity

**Repository Path**: CrazyKt/ecslite-threads-unity

## Basic Information

- **Project Name**: ecslite-threads-unity
- **Description**: Unity Jobs support for LeoEcsLite C# Entity Component System framework
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-11
- **Last Updated**: 2021-12-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Unity Jobs support for LeoEcsLite C# Entity Component System framework
Unity jobs support for [LeoECS Lite](https://github.com/Leopotam/ecslite).

> Tested on unity 2020.3 (dependent on it) and contains assembly definition for compiling to separate assembly file for performance reason.

> **Important!** Don't forget to use `DEBUG` builds for development and `RELEASE` builds in production: all internal error checks / exception throwing works only in `DEBUG` builds and eleminated for performance reasons in `RELEASE`.

# Table of content
* [Socials](#socials)
* [Installation](#installation)
    * [As unity module](#as-unity-module)
    * [As source](#as-source)
* [Example](#example)
    * [Component](#component)
    * [JobSystem](#jobsystem)
    * [Job](#job)
* [License](#license)

# Socials
[![discord](https://img.shields.io/discord/404358247621853185.svg?label=enter%20to%20discord%20server&style=for-the-badge&logo=discord)](https://discord.gg/5GZVde6)

# Installation

## As unity module
This repository can be installed as unity module directly from git url. In this way new line should be added to `Packages/manifest.json`:
```
"com.leopotam.ecslite.threads.unity": "https://github.com/Leopotam/ecslite-threads-unity.git",
```
By default last released version will be used. If you need trunk / developing version then `develop` name of branch should be added after hash:
```
"com.leopotam.ecslite.threads.unity": "https://github.com/Leopotam/ecslite-threads-unity.git#develop",
```

## As source
If you can't / don't want to use unity modules, code can be downloaded as sources archive of required release from [Releases page](`https://github.com/Leopotam/ecslite-threads-unity/releases`).

# Example

## Component
```csharp
struct C1 {
    public int Id;
}
```
## JobSystem
```csharp
class TestJobSystem : EcsUnityJobSystem<TestJob, C1> {
    protected override int GetChunkSize (EcsSystems systems) {
        // How many entities will be processed in one chunk.
        // This method will be called each frame.
        return 1000;
    }

    protected override EcsWorld GetWorld (EcsSystems systems) {
        // World for component pools and filter.
        return systems.GetWorld ();
    }
    
    protected override EcsFilter GetFilter (EcsWorld world) {
        // Filter for processing.
        return world.Filter<C1> ().End ();
    }
    
    // Optional additional initialization of job structure.
    protected override void SetData (EcsSystems systems, ref TestJob job) {
        job.DeltaTime = Time.deltaTime;
    }
}
```
> **Important!** EcsUnityJobSystem supports up to 4 component pools.
 
## Job
```csharp
struct TestJob : IEcsUnityJob<C1> {
    public float DeltaTime;
    NativeArray<int> _entities;
    [NativeDisableParallelForRestriction]
    NativeArray<C1> _pool1;
    [NativeDisableParallelForRestriction]
    NativeArray<int> _indices1;

    public void Init (NativeArray<int> entities, NativeArray<C1> pool1, NativeArray<int> indices1) {
        // entities array.
        _entities = entities;
        // dense array of components.
        _pool1 = pool1;
        // sparse indices array of components.
        _indices1 = indices1;
    }

    public void Execute (int index) {
        // We should get entity id from entities collection. 
        var entity = _entities[index];
        // To get access for C1 data.
        var pool1Idx = _indices1[entity];
        var c1 = _pool1[pool1Idx];
        // We can change it.
        c1.Id = (c1.Id + 1) % 10000;
        // And save it back.
        _pool1[pool1Idx] = c1;
    }
}
```

> **Important!** Don't forget to add `NativeDisableParallelForRestriction` attribute to pool/indices arrays.


# License
The software is released under the terms of the [MIT license](./LICENSE.md).

No personal support or any guarantees.