-
-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
41 changed files
with
404 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
documentation/api/DefaultEcs-Components-T--this-DefaultEcs-Entity-.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[Components<T>](./DefaultEcs-Components-T-.md 'DefaultEcs.Components<T>') | ||
## Components<T>.this[DefaultEcs.Entity] Property | ||
Gets the component of type [T](./DefaultEcs-Components-T-.md#DefaultEcs-Components-T--T 'DefaultEcs.Components<T>.T') on the provided [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
```C# | ||
public ref T this[DefaultEcs.Entity entity] { get; } | ||
``` | ||
#### Parameters | ||
<a name='DefaultEcs-Components-T--this-DefaultEcs-Entity--entity'></a> | ||
`entity` [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') | ||
The [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') for which to get the component of type [T](./DefaultEcs-Components-T-.md#DefaultEcs-Components-T--T 'DefaultEcs.Components<T>.T'). | ||
|
||
#### Returns | ||
[T](./DefaultEcs-Components-T-.md#DefaultEcs-Components-T--T 'DefaultEcs.Components<T>.T') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs') | ||
## Components<T> Struct | ||
Provides a fast access to the components of type [T](#DefaultEcs-Components-T--T 'DefaultEcs.Components<T>.T'). | ||
```C# | ||
public readonly ref struct Components<T> | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-Components-T--T'></a> | ||
`T` | ||
The type of the component. | ||
|
||
### Properties | ||
- [this[DefaultEcs.Entity]](./DefaultEcs-Components-T--this-DefaultEcs-Entity-.md 'DefaultEcs.Components<T>.this[DefaultEcs.Entity]') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') | ||
## EntitySet.Dispose() Method | ||
Releases current [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') of its subscriptions, stopping it to get modifications on the [World](./DefaultEcs-World.md 'DefaultEcs.World')'s [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
Releases current [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') of its subscriptions, stopping it to get modifications on the [World](./DefaultEcs-EntitySet-World.md 'DefaultEcs.EntitySet.World')'s [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
```C# | ||
public void Dispose(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') | ||
## EntitySet.World Property | ||
Gets the [World](./DefaultEcs-World.md 'DefaultEcs.World') instance from which current [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') originate. | ||
```C# | ||
public DefaultEcs.World World { get; } | ||
``` | ||
#### Returns | ||
[World](./DefaultEcs-World.md 'DefaultEcs.World') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 changes: 23 additions & 0 deletions
23
...-AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner_int).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') | ||
## AComponentSystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner, int) Constructor | ||
Initialise a new instance of the [AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') class with the given [World](./DefaultEcs-World.md 'DefaultEcs.World') and [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner'). | ||
```C# | ||
protected AComponentSystem(DefaultEcs.World world, DefaultEcs.Threading.IParallelRunner runner, int minComponentCountByRunnerIndex); | ||
``` | ||
#### Parameters | ||
<a name='DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner_int)-world'></a> | ||
`world` [World](./DefaultEcs-World.md 'DefaultEcs.World') | ||
The [World](./DefaultEcs-World.md 'DefaultEcs.World') on which to process the update. | ||
|
||
<a name='DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner_int)-runner'></a> | ||
`runner` [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') | ||
The [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') used to process the update in parallel if not null. | ||
|
||
<a name='DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner_int)-minComponentCountByRunnerIndex'></a> | ||
`minComponentCountByRunnerIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') | ||
The minimum number of component per runner index to use the given [runner](#DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner_int)-runner 'DefaultEcs.System.AComponentSystem<TState,TComponent>.AComponentSystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner, int).runner'). | ||
|
||
#### Exceptions | ||
[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') | ||
[world](#DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner_int)-world 'DefaultEcs.System.AComponentSystem<TState,TComponent>.AComponentSystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner, int).world') is null. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
...-System-AEntityBufferedSystem-T--AEntityBufferedSystem(DefaultEcs-EntitySet).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') | ||
## AEntityBufferedSystem(DefaultEcs.EntitySet) Constructor | ||
Initialise a new instance of the [AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') class with the given [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'). | ||
```C# | ||
protected AEntityBufferedSystem(DefaultEcs.EntitySet set); | ||
``` | ||
#### Parameters | ||
<a name='DefaultEcs-System-AEntityBufferedSystem-T--AEntityBufferedSystem(DefaultEcs-EntitySet)-set'></a> | ||
`set` [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') | ||
The [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') on which to process the update. | ||
|
||
#### Exceptions | ||
[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') | ||
[set](#DefaultEcs-System-AEntityBufferedSystem-T--AEntityBufferedSystem(DefaultEcs-EntitySet)-set 'DefaultEcs.System.AEntityBufferedSystem<T>.AEntityBufferedSystem(DefaultEcs.EntitySet).set') is null. |
16 changes: 16 additions & 0 deletions
16
...tEcs-System-AEntityBufferedSystem-T--AEntityBufferedSystem(DefaultEcs-World).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') | ||
## AEntityBufferedSystem(DefaultEcs.World) Constructor | ||
Initialise a new instance of the [AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') class with the given [World](./DefaultEcs-World.md 'DefaultEcs.World'). | ||
To create the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'), [WithAttribute](./DefaultEcs-System-WithAttribute.md 'DefaultEcs.System.WithAttribute') and [WithoutAttribute](./DefaultEcs-System-WithoutAttribute.md 'DefaultEcs.System.WithoutAttribute') attributes will be used. | ||
```C# | ||
protected AEntityBufferedSystem(DefaultEcs.World world); | ||
``` | ||
#### Parameters | ||
<a name='DefaultEcs-System-AEntityBufferedSystem-T--AEntityBufferedSystem(DefaultEcs-World)-world'></a> | ||
`world` [World](./DefaultEcs-World.md 'DefaultEcs.World') | ||
The [World](./DefaultEcs-World.md 'DefaultEcs.World') from which to get the [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') instances to process the update. | ||
|
||
#### Exceptions | ||
[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') | ||
[world](#DefaultEcs-System-AEntityBufferedSystem-T--AEntityBufferedSystem(DefaultEcs-World)-world 'DefaultEcs.System.AEntityBufferedSystem<T>.AEntityBufferedSystem(DefaultEcs.World).world') is null. |
7 changes: 7 additions & 0 deletions
7
documentation/api/DefaultEcs-System-AEntityBufferedSystem-T--Dispose().md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') | ||
## AEntityBufferedSystem<T>.Dispose() Method | ||
Disposes of the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') instance. | ||
```C# | ||
public virtual void Dispose(); | ||
``` |
9 changes: 9 additions & 0 deletions
9
documentation/api/DefaultEcs-System-AEntityBufferedSystem-T--EntityAdded.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') | ||
## AEntityBufferedSystem<T>.EntityAdded Event | ||
Event called when an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') is added to the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'). | ||
```C# | ||
public event EntityAdded; | ||
``` | ||
#### Event type | ||
[DefaultEcs.ActionIn<](./DefaultEcs-ActionIn-T-(T).md 'DefaultEcs.ActionIn<T>(T)')[Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity')[>](./DefaultEcs-ActionIn-T-(T).md 'DefaultEcs.ActionIn<T>(T)') |
9 changes: 9 additions & 0 deletions
9
documentation/api/DefaultEcs-System-AEntityBufferedSystem-T--EntityRemoved.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') | ||
## AEntityBufferedSystem<T>.EntityRemoved Event | ||
Event called when an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') is removed from the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'). | ||
```C# | ||
public event EntityRemoved; | ||
``` | ||
#### Event type | ||
[DefaultEcs.ActionIn<](./DefaultEcs-ActionIn-T-(T).md 'DefaultEcs.ActionIn<T>(T)')[Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity')[>](./DefaultEcs-ActionIn-T-(T).md 'DefaultEcs.ActionIn<T>(T)') |
9 changes: 9 additions & 0 deletions
9
documentation/api/DefaultEcs-System-AEntityBufferedSystem-T--IsEnabled.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') | ||
## AEntityBufferedSystem<T>.IsEnabled Property | ||
Gets or sets whether the current [AEntityBufferedSystem<T>](./DefaultEcs-System-AEntityBufferedSystem-T-.md 'DefaultEcs.System.AEntityBufferedSystem<T>') instance should update or not. | ||
```C# | ||
public bool IsEnabled { get; set; } | ||
``` | ||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
Oops, something went wrong.