Skip to content

Commit

Permalink
Release 0.42.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sschmid committed Apr 28, 2017
1 parent a52dbe6 commit a03e42e
Show file tree
Hide file tree
Showing 270 changed files with 2,969 additions and 900 deletions.
Binary file modified Build/deploy/Entitas-CSharp.zip
Binary file not shown.
Binary file not shown.
Binary file modified Build/deploy/Entitas-CodeGenerator.zip
Binary file not shown.
Binary file modified Build/deploy/Entitas-Unity.zip
Binary file not shown.
Binary file modified Build/deploy/Entitas.docset.tgz
Binary file not shown.
2 changes: 1 addition & 1 deletion Entitas/Entitas/version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.41.2
0.42.0
33 changes: 30 additions & 3 deletions EntitasUpgradeGuide.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
Entitas Upgrade Guide
=====================

Entitas provides an easy way to make upgrading to new versions a breeze.
Entitas provides automated migration tools to help upgrading to new versions.
Either use the command line tool `MigrationAssistant.exe` or the Migration menu
item in Unity. After that generate again.
item in Unity.

In some cases manual steps have to be applied BEFORE installing a new version.
This document contains checklists for every release with breaking changes.


Expand Down Expand Up @@ -35,6 +34,34 @@ $ mono MigrationAssistant.exe 0.26.0 /Path/To/Project/RequestedFolder

---

Entitas 0.42.0 upgrade guide
============================

#### Breaking changes
- Removed Entitas.Blueprints.Unity.*
- Changed ReactiveSystem.GetTrigger method signature
- Marked obsolete: `context.DestroyEntity(entity)`. Use `entity.Destroy()` instead
- Marked obsolete: `context.CreateCollector(matcher, event)`, use new `context.CreateCollector(triggerOnEvent)` when you need `.Removed` or `.AddedOrRemoved` (e.g. `GameMatcher.View.Removed()`)

#### After you installed
- Removed Entitas.Blueprints.Unity.*
- Remove all Entitas.Blueprints.Unity.* related code
- Remove BinaryBlueprints from your project. Consider using extension methods as described here instead https://github.com/sschmid/Entitas-CSharp/issues/390
- Remove from Entitas.properties:
- Entitas.Blueprints.CodeGeneration.Plugins
- Entitas.Blueprints.CodeGeneration.Plugins.BlueprintDataProvider
- Entitas.Blueprints.CodeGeneration.Plugins.BlueprintsGenerator

- Changed ReactiveSystem.GetTrigger() method signature
- find and replace `protected override Collector` -> `protected override ICollector`

- Generate

- Marked obsolete: `context.DestroyEntity(entity)`. Use `entity.Destroy()` instead
- Marked obsolete: `context.CreateCollector(matcher, event)`, use new `context.CreateCollector(triggerOnEvent)` when you need `.Removed` or `.AddedOrRemoved` (see [Test Example]())

---

Entitas 0.41.0 upgrade guide
============================

Expand Down
35 changes: 35 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# 0.42.0

See and discuss changes in [Milestone 0.42.0](https://github.com/sschmid/Entitas-CSharp/milestone/15)

#### Breaking changes
Please follow the [Entitas upgrade guide](https://github.com/sschmid/Entitas-CSharp/blob/master/EntitasUpgradeGuide.md)

- Removed Entitas.Blueprints.Unity.*
- Changed ReactiveSystem.GetTrigger method signature
- Marked obsolete: `context.DestroyEntity(entity)`. Use `entity.Destroy()` instead
- Marked obsolete: `context.CreateCollector(matcher, event)`, use new `context.CreateCollector(triggerOnEvent)` when you need `.Removed` or `.AddedOrRemoved` (see [Test Example]())

## Top new features:
- Use MultiReactiveSystem to process entities from different contexts in one system (see [Test Example](https://github.com/sschmid/Entitas-CSharp/blob/develop/Tests/Unity/VisualDebugging/Assets/Examples/VisualDebugging/Systems/SomeMultiReactiveSystem.cs))
- Use `entity.Destroy()` instead of `context.DestroyEntity(entity)`
- Unit Testing in external console works on Windows now

#### General
- Moved Entitas menu item under the Tools tab
- Removed Entitas.Blueprints.Unity.* from zips
- Creating new zip for code generator default plugins
- UX improvements

#### Entitas
- Added MultiReactiveSystem to support reactive systems observing different contexts #303
- Added TriggerOnEvent
- Renamed `entity.Destroy()` to `entity.InternalDestroy()` to reduce confusion
- Added `entity.Destroy()` instead of `context.DestroyEntity(entity)` #254

#### CodeGenerator
- Added ComponentEntityInterfaceGenerator #303
- Updated ContextObserverGenerator to avoid `System.Security.SecurityException` on Windows #375
- .ToSafeDirectory() supports empty string and “.” to specify current directory


# 0.41.2

After installing please check your Entitas.properties. Due to the addition of `IConfigurable` for code generator plugins some keys in Entitas.properties changed. `entitas.exe doctor`, `entitas.exe status` and `entitas.exe fix` can help you fixing any issues. A new default Entitas.properties file will be created if none is found. The default Entitas.properties should work with Unity without modification. For reference take a look at [Match-One - Entitas.properties](https://github.com/sschmid/Match-One/blob/master/Entitas.properties)
Expand Down
2 changes: 1 addition & 1 deletion Scripts/docs_resources/docset.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "Entitas"
PROJECT_NUMBER = 0.41.2
PROJECT_NUMBER = 0.42.0
PROJECT_BRIEF = "Entitas is a super fast Entity Component System (ECS) Framework specifically made for C# and Unity"
PROJECT_LOGO = "Scripts/docs_resources/docs-logo.png"
OUTPUT_DIRECTORY = "Build/docs"
Expand Down
2 changes: 1 addition & 1 deletion Scripts/docs_resources/html.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "Entitas"
PROJECT_NUMBER = 0.41.2
PROJECT_NUMBER = 0.42.0
PROJECT_BRIEF = "Entitas is a super fast Entity Component System (ECS) Framework specifically made for C# and Unity"
PROJECT_LOGO = "Scripts/docs_resources/docs-logo.png"
OUTPUT_DIRECTORY = "Build/docs"
Expand Down
4 changes: 2 additions & 2 deletions docs/_abstract_entity_index_8cs_source.html

Large diffs are not rendered by default.

Loading

0 comments on commit a03e42e

Please sign in to comment.