-
-
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
177 changed files
with
1,867 additions
and
735 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 was deleted.
Oops, something went wrong.
12 changes: 12 additions & 0 deletions
12
documentation/api/DefaultEcs-AoTHelper-RegisterComponent-T-().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,12 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[AoTHelper](./DefaultEcs-AoTHelper.md 'DefaultEcs.AoTHelper') | ||
## AoTHelper.RegisterComponent<T>() Method | ||
Registers the type [T](#DefaultEcs-AoTHelper-RegisterComponent-T-()-T 'DefaultEcs.AoTHelper.RegisterComponent<T>().T') so it can freely be used in [ComponentAttribute](./DefaultEcs-System-ComponentAttribute.md 'DefaultEcs.System.ComponentAttribute'). | ||
```csharp | ||
public static void RegisterComponent<T>(); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-AoTHelper-RegisterComponent-T-()-T'></a> | ||
`T` | ||
The type of component. | ||
|
12 changes: 12 additions & 0 deletions
12
documentation/api/DefaultEcs-AoTHelper-RegisterMessage-T-().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,12 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[AoTHelper](./DefaultEcs-AoTHelper.md 'DefaultEcs.AoTHelper') | ||
## AoTHelper.RegisterMessage<T>() Method | ||
Registers the type [T](#DefaultEcs-AoTHelper-RegisterMessage-T-()-T 'DefaultEcs.AoTHelper.RegisterMessage<T>().T') so [SubscribeAttribute](./DefaultEcs-SubscribeAttribute.md 'DefaultEcs.SubscribeAttribute') can freely be used on method like the delegate [MessageHandler<T>(T)](./DefaultEcs-MessageHandler-T-(T).md 'DefaultEcs.MessageHandler<T>(T)') to automatically subscribe when using [IPublisherExtension](./DefaultEcs-IPublisherExtension.md 'DefaultEcs.IPublisherExtension') on a [World](./DefaultEcs-World.md 'DefaultEcs.World') instance. | ||
```csharp | ||
public static void RegisterMessage<T>(); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-AoTHelper-RegisterMessage-T-()-T'></a> | ||
`T` | ||
The type of message. | ||
|
12 changes: 12 additions & 0 deletions
12
documentation/api/DefaultEcs-AoTHelper-RegisterUnmanagedComponent-T-().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,12 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[AoTHelper](./DefaultEcs-AoTHelper.md 'DefaultEcs.AoTHelper') | ||
## AoTHelper.RegisterUnmanagedComponent<T>() Method | ||
Registers the unmanaged type [T](#DefaultEcs-AoTHelper-RegisterUnmanagedComponent-T-()-T 'DefaultEcs.AoTHelper.RegisterUnmanagedComponent<T>().T') so it can freely be used in [ComponentAttribute](./DefaultEcs-System-ComponentAttribute.md 'DefaultEcs.System.ComponentAttribute') and by [Set<T>(T)](./DefaultEcs-Command-EntityRecord-Set-T-(T).md 'DefaultEcs.Command.EntityRecord.Set<T>(T)'). | ||
```csharp | ||
public static void RegisterUnmanagedComponent<T>(); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-AoTHelper-RegisterUnmanagedComponent-T-()-T'></a> | ||
`T` | ||
The type of component. | ||
|
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,12 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs') | ||
## AoTHelper Class | ||
Provides a set of methods to help the generation of generic code for AoT compilation. | ||
```csharp | ||
public static class AoTHelper | ||
``` | ||
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [AoTHelper](./DefaultEcs-AoTHelper.md 'DefaultEcs.AoTHelper') | ||
### Methods | ||
- [RegisterComponent<T>()](./DefaultEcs-AoTHelper-RegisterComponent-T-().md 'DefaultEcs.AoTHelper.RegisterComponent<T>()') | ||
- [RegisterMessage<T>()](./DefaultEcs-AoTHelper-RegisterMessage-T-().md 'DefaultEcs.AoTHelper.RegisterMessage<T>()') | ||
- [RegisterUnmanagedComponent<T>()](./DefaultEcs-AoTHelper-RegisterUnmanagedComponent-T-().md 'DefaultEcs.AoTHelper.RegisterUnmanagedComponent<T>()') |
16 changes: 16 additions & 0 deletions
16
documentation/api/DefaultEcs-Command-EntityRecord-NotifyChanged-T-().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.Command](./DefaultEcs-Command.md 'DefaultEcs.Command').[EntityRecord](./DefaultEcs-Command-EntityRecord.md 'DefaultEcs.Command.EntityRecord') | ||
## EntityRecord.NotifyChanged<T>() Method | ||
Notifies the value of the component of type [T](#DefaultEcs-Command-EntityRecord-NotifyChanged-T-()-T 'DefaultEcs.Command.EntityRecord.NotifyChanged<T>().T') has changed on the corresponding [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
This command takes 9 bytes. | ||
```csharp | ||
public void NotifyChanged<T>(); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-Command-EntityRecord-NotifyChanged-T-()-T'></a> | ||
`T` | ||
The type of the component. | ||
|
||
#### Exceptions | ||
[System.InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/System.InvalidOperationException 'System.InvalidOperationException') | ||
Command buffer is full. |
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
21 changes: 21 additions & 0 deletions
21
documentation/api/DefaultEcs-ComponentAddedHandler-T-(DefaultEcs-Entity_T).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,21 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs') | ||
## ComponentAddedHandler<T>(DefaultEcs.Entity, T) Delegate | ||
Represents the method that will called when a component of type [T](#DefaultEcs-ComponentAddedHandler-T-(DefaultEcs-Entity_T)-T 'DefaultEcs.ComponentAddedHandler<T>(DefaultEcs.Entity, T).T') is added on an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
```csharp | ||
public delegate void ComponentAddedHandler<T>(in DefaultEcs.Entity entity, in T value); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-ComponentAddedHandler-T-(DefaultEcs-Entity_T)-T'></a> | ||
`T` | ||
The type of the component added. | ||
|
||
#### Parameters | ||
<a name='DefaultEcs-ComponentAddedHandler-T-(DefaultEcs-Entity_T)-entity'></a> | ||
`entity` [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') | ||
The [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') on which the component was added. | ||
|
||
<a name='DefaultEcs-ComponentAddedHandler-T-(DefaultEcs-Entity_T)-value'></a> | ||
`value` [T](#DefaultEcs-ComponentAddedHandler-T-(DefaultEcs-Entity_T)-T 'DefaultEcs.ComponentAddedHandler<T>(DefaultEcs.Entity, T).T') | ||
The value of the component. | ||
|
25 changes: 25 additions & 0 deletions
25
documentation/api/DefaultEcs-ComponentChangedHandler-T-(DefaultEcs-Entity_T_T).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,25 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs') | ||
## ComponentChangedHandler<T>(DefaultEcs.Entity, T, T) Delegate | ||
Represents the method that will called when a component of type [T](#DefaultEcs-ComponentChangedHandler-T-(DefaultEcs-Entity_T_T)-T 'DefaultEcs.ComponentChangedHandler<T>(DefaultEcs.Entity, T, T).T') is removed from an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
```csharp | ||
public delegate void ComponentChangedHandler<T>(in DefaultEcs.Entity entity, in T oldValue, in T newValue); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-ComponentChangedHandler-T-(DefaultEcs-Entity_T_T)-T'></a> | ||
`T` | ||
The type of the component removed. | ||
|
||
#### Parameters | ||
<a name='DefaultEcs-ComponentChangedHandler-T-(DefaultEcs-Entity_T_T)-entity'></a> | ||
`entity` [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') | ||
The [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') on which the component was removed. | ||
|
||
<a name='DefaultEcs-ComponentChangedHandler-T-(DefaultEcs-Entity_T_T)-oldValue'></a> | ||
`oldValue` [T](#DefaultEcs-ComponentChangedHandler-T-(DefaultEcs-Entity_T_T)-T 'DefaultEcs.ComponentChangedHandler<T>(DefaultEcs.Entity, T, T).T') | ||
The previous value of the component. | ||
|
||
<a name='DefaultEcs-ComponentChangedHandler-T-(DefaultEcs-Entity_T_T)-newValue'></a> | ||
`newValue` [T](#DefaultEcs-ComponentChangedHandler-T-(DefaultEcs-Entity_T_T)-T 'DefaultEcs.ComponentChangedHandler<T>(DefaultEcs.Entity, T, T).T') | ||
The new value of the component. | ||
|
21 changes: 21 additions & 0 deletions
21
documentation/api/DefaultEcs-ComponentDisabledHandler-T-(DefaultEcs-Entity_T).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,21 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs') | ||
## ComponentDisabledHandler<T>(DefaultEcs.Entity, T) Delegate | ||
Represents the method that will called when a component of type [T](#DefaultEcs-ComponentDisabledHandler-T-(DefaultEcs-Entity_T)-T 'DefaultEcs.ComponentDisabledHandler<T>(DefaultEcs.Entity, T).T') is disabled on an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
```csharp | ||
public delegate void ComponentDisabledHandler<T>(in DefaultEcs.Entity entity, in T value); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-ComponentDisabledHandler-T-(DefaultEcs-Entity_T)-T'></a> | ||
`T` | ||
The type of the component disabled. | ||
|
||
#### Parameters | ||
<a name='DefaultEcs-ComponentDisabledHandler-T-(DefaultEcs-Entity_T)-entity'></a> | ||
`entity` [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') | ||
The [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') on which the component was disabled. | ||
|
||
<a name='DefaultEcs-ComponentDisabledHandler-T-(DefaultEcs-Entity_T)-value'></a> | ||
`value` [T](#DefaultEcs-ComponentDisabledHandler-T-(DefaultEcs-Entity_T)-T 'DefaultEcs.ComponentDisabledHandler<T>(DefaultEcs.Entity, T).T') | ||
The value of the component. | ||
|
21 changes: 21 additions & 0 deletions
21
documentation/api/DefaultEcs-ComponentEnabledHandler-T-(DefaultEcs-Entity_T).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,21 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs') | ||
## ComponentEnabledHandler<T>(DefaultEcs.Entity, T) Delegate | ||
Represents the method that will called when a component of type [T](#DefaultEcs-ComponentEnabledHandler-T-(DefaultEcs-Entity_T)-T 'DefaultEcs.ComponentEnabledHandler<T>(DefaultEcs.Entity, T).T') is enabled on an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
```csharp | ||
public delegate void ComponentEnabledHandler<T>(in DefaultEcs.Entity entity, in T value); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-ComponentEnabledHandler-T-(DefaultEcs-Entity_T)-T'></a> | ||
`T` | ||
The type of the component enabled. | ||
|
||
#### Parameters | ||
<a name='DefaultEcs-ComponentEnabledHandler-T-(DefaultEcs-Entity_T)-entity'></a> | ||
`entity` [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') | ||
The [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') on which the component was enabled. | ||
|
||
<a name='DefaultEcs-ComponentEnabledHandler-T-(DefaultEcs-Entity_T)-value'></a> | ||
`value` [T](#DefaultEcs-ComponentEnabledHandler-T-(DefaultEcs-Entity_T)-T 'DefaultEcs.ComponentEnabledHandler<T>(DefaultEcs.Entity, T).T') | ||
The value of the component. | ||
|
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,20 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs') | ||
## ComponentPredicate<T>(T) Delegate | ||
Represents the method that defines a set of criteria and determines whether the specified component meets those criteria. | ||
```csharp | ||
public delegate bool ComponentPredicate<T>(in T value); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-ComponentPredicate-T-(T)-T'></a> | ||
`T` | ||
The type of the component to compare. | ||
|
||
#### Parameters | ||
<a name='DefaultEcs-ComponentPredicate-T-(T)-value'></a> | ||
`value` [T](#DefaultEcs-ComponentPredicate-T-(T)-T 'DefaultEcs.ComponentPredicate<T>(T).T') | ||
The component value. | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') | ||
true if the component meets the criteria; otherwise, false. |
21 changes: 21 additions & 0 deletions
21
documentation/api/DefaultEcs-ComponentRemovedHandler-T-(DefaultEcs-Entity_T).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,21 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs') | ||
## ComponentRemovedHandler<T>(DefaultEcs.Entity, T) Delegate | ||
Represents the method that will called when a component of type [T](#DefaultEcs-ComponentRemovedHandler-T-(DefaultEcs-Entity_T)-T 'DefaultEcs.ComponentRemovedHandler<T>(DefaultEcs.Entity, T).T') is removed from an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
```csharp | ||
public delegate void ComponentRemovedHandler<T>(in DefaultEcs.Entity entity, in T value); | ||
``` | ||
#### Type parameters | ||
<a name='DefaultEcs-ComponentRemovedHandler-T-(DefaultEcs-Entity_T)-T'></a> | ||
`T` | ||
The type of the component removed. | ||
|
||
#### Parameters | ||
<a name='DefaultEcs-ComponentRemovedHandler-T-(DefaultEcs-Entity_T)-entity'></a> | ||
`entity` [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') | ||
The [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') on which the component was removed. | ||
|
||
<a name='DefaultEcs-ComponentRemovedHandler-T-(DefaultEcs-Entity_T)-value'></a> | ||
`value` [T](#DefaultEcs-ComponentRemovedHandler-T-(DefaultEcs-Entity_T)-T 'DefaultEcs.ComponentRemovedHandler<T>(DefaultEcs.Entity, T).T') | ||
The value of the component. | ||
|
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').[EntitiesMap<TKey>](./DefaultEcs-EntitiesMap-TKey-.md 'DefaultEcs.EntitiesMap<TKey>') | ||
## EntitiesMap<TKey>.Complete() Method | ||
Clears current instance of its entities if it was created with some reactive filter ([WhenAdded<T>()](./DefaultEcs-EntityRuleBuilder-WhenAdded-T-().md 'DefaultEcs.EntityRuleBuilder.WhenAdded<T>()'), [WhenChanged<T>()](./DefaultEcs-EntityRuleBuilder-WhenChanged-T-().md 'DefaultEcs.EntityRuleBuilder.WhenChanged<T>()') or [WhenRemoved<T>()](./DefaultEcs-EntityRuleBuilder-WhenRemoved-T-().md 'DefaultEcs.EntityRuleBuilder.WhenRemoved<T>()')). | ||
Does nothing if it was created from a static filter. | ||
This method need to be called after current instance content has been processed in a update cycle. | ||
```csharp | ||
public void Complete(); | ||
``` |
15 changes: 15 additions & 0 deletions
15
...mentation/api/DefaultEcs-EntitiesMap-TKey--ContainsEntity(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,15 @@ | ||
#### [DefaultEcs](./index.md 'index') | ||
### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitiesMap<TKey>](./DefaultEcs-EntitiesMap-TKey-.md 'DefaultEcs.EntitiesMap<TKey>') | ||
## EntitiesMap<TKey>.ContainsEntity(DefaultEcs.Entity) Method | ||
Determines whether the [EntitiesMap<TKey>](./DefaultEcs-EntitiesMap-TKey-.md 'DefaultEcs.EntitiesMap<TKey>') contains a specific [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). | ||
```csharp | ||
public bool ContainsEntity(DefaultEcs.Entity entity); | ||
``` | ||
#### Parameters | ||
<a name='DefaultEcs-EntitiesMap-TKey--ContainsEntity(DefaultEcs-Entity)-entity'></a> | ||
`entity` [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') | ||
The [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') to locate in the [EntitiesMap<TKey>](./DefaultEcs-EntitiesMap-TKey-.md 'DefaultEcs.EntitiesMap<TKey>'). | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') | ||
true if the [EntitiesMap<TKey>](./DefaultEcs-EntitiesMap-TKey-.md 'DefaultEcs.EntitiesMap<TKey>') contains the specified [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'); otherwise, false. |
Oops, something went wrong.