Mirror of Svelto.ECS because we're a fan of it
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

CHANGELOG.md 7.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. # Svelto.ECS Changelog
  2. All notable changes to this project will be documented in this file. Changes are listed in random order of importance.
  3. ## [3.4.5] - 04-2023
  4. * improved code after internal data refactoring and fixed some bugs
  5. * Added static DynamicEntityDescriptor method to create a new DynamicEntityDescriptor without passing an array of components
  6. * factory method to build entities without entity descriptor is now internal
  7. ## [3.4.4] - 04-2023
  8. * refactored internal datastructures
  9. * added IReactOnDisposeEx interface
  10. * added code to warmup all the entity descriptors at startup to avoid first time allocations when an entitydescriptor is used for the very first time
  11. * added the option to iterate transient filters per component like it already happens with persistent filters. Transient filters are tracked optionally.
  12. * fixed huge bug in the filter enumerator, truly surprised this never showed up
  13. ## [3.4.2] - 03-2023
  14. * removed static caches used in performance critical paths as they were causing unexpected performance issues (the fetching of static data is slower than i imagined)
  15. * add Native prefix in front of the native memory utilities method names
  16. * largely improved the console logger system
  17. * minor improvements to the platform profiler structs
  18. * improvements to the ThreadSafeObjectPool class (some refactoring too)
  19. * added several datastructures previously belonging to Svelto.ECS
  20. * all the FastClear methods are gone. The standard clear method now is aware of the type used and will clear it in the fastest way possible
  21. * MemClear is added in case memory needs to be cleared explicitly
  22. * added new SveltoStream, Unmanaged and Managed stream classes, their use case will be documented one day
  23. * renamed the Svelto.Common.DataStructures namespace to Svelto.DataStructures
  24. * added FixedTypedArray* methods. Fixed size arrays embedded in structs are now possible
  25. * FasterList extension to convert to Span and ByteSpan
  26. * Fix reported bugs
  27. * Minor Svelto Dictionary improvements
  28. * Added ValueContainer, a simple int, Tvalue dictionary based on sparse set. It has very specific use cases at the moment. Mainly to be used for the new ECS OOP Abstraction resoruce manager
  29. * Added IReactOnSubmissionStarted interface
  30. ### SveltoOnDOTS changes
  31. * update to DOTS 1.0 (but still compatible with 0.51, although slower)
  32. * Deprecated the use of EntityCommandBuffer since was very slow
  33. * added faster batched DOTS operations, new DOTS creation patterns introduced (old one still compatible as long as EntityCommandBuffer was not used)
  34. * ISveltoOnDOTSSubmission interface exists only to allow the user to submit entities On DOTS explicitly, use this instead of
  35. * SveltoOnDOTSHandleCreationEngine is no more, you want to use ISveltoOnDOTSStructuralEngine and its DOTSOperations instead wherever EntityManager was used before
  36. * ISveltoOnDOTSStructuralEngine is no more, you want to use ISveltoOnDOTSStructuralEngine and its DOTSOperations instead
  37. * in all the case above, if you were relying on Update you probably want to use OnPostSubmission instead
  38. * DOTSOperations new AddJobToComplete method will allow to register jobs from inside ISveltoOnDOTSStructuralEngines that will be completed at the end of the submission
  39. ## [3.3.2] - 04-06-2022
  40. * Internal refactoring to support future features. Currently it may translate to a small performance boost
  41. * IEntityComponent and IEntityViewComponent now implements _IInternalEntityComponent. This shouldn't affect existing code
  42. * Improve thread-safety of entity building
  43. * Fixed serious bug that affected the integrity of the EntityIDs values during RemoveEX callbacks
  44. * The point above may result in a performance boost in the Filters updates during submission
  45. * Code is again 2019 compatible (this may have been broken for a while)
  46. * Fix a crash wit the EntityCollection deconstruction while trying to deconstruct an empty collection
  47. * Breaking: EntityFilterCollection GetGroupFilter will throw an exception if the filter doesn't exist. Use GetOrCreateGroupFilter in case.
  48. * Breaking: LocatorMap has been renamed to EntityReferenceMap
  49. * Breaking: GetEntityLocatorMap has been renamed to GetEntityReferenceMap
  50. ## [3.3.1] - 26-04-2022
  51. * Fixed serious bug that would affect the new IReactOnRemoveEx callbacks
  52. ## [3.3.0] - 11-04-2022
  53. * INeedEGID and INeedEntityReference interfaces are not deprecated, but still available for backwards compatibility through the define SLOW_SVELTO_SUBMISSION
  54. * There are some minor breaking changes, you may need to rename a bunch of methods calls
  55. * Drastically improved Submission phase performance
  56. * All the IReactOn interfaces are now replaced by much faster IReacOn\*Ex interfaces. Use those instead.
  57. * QueryEntities methods now optionally return also an array of Entity IDs that you can reference like a component (this supersedes INeedEGID)
  58. * Completely reworked and way more powerful filter API. The old one has been renamed to Legacy and left for backward compatibility
  59. * NativeEGIDMultiMapper doesn't need to be created every submission anymore. It can be created permanently and disposed when not used anymore (some caveats with it)
  60. * Improved Serialization system
  61. * Improved SveltoOnDots system
  62. * Tons of other improvements and bug fixes
  63. ## [3.2.5]
  64. * refactor and improved NativeBag and UnsafeBlob. This fix a previously known crash with Unity IL2CPP
  65. ## [3.2.0]
  66. * Improved checks on Svelto rules for the declaration of components and view components. This set of rules is not final yet (ideally one day they should be moved to static analyzers)
  67. * Introduce the concept of Entity Reference. It's a very light weight identifier to keep track of entities EGID that can change dynamically (EGIDs change when groups are swapped), Entity References never change. The underlying code will be optimised even further in future.
  68. * Introduced the concept of Disabled Group. Once a group is marked as disabled, queries will always ignore it.
  69. * Merged DispatchOnSet and DispatchOnChange and renamed to ReactiveValue. This class will be superseded by better patterns in future.
  70. * Added FindGroups with 4 components
  71. * Improved QueryGroups interface
  72. * Improved DynamicEntityDescriptor interface
  73. * Improved ExtendibleEntityDescriptor interface
  74. * Improved Native memory support
  75. * Improved Svelto and Unity DOTS integration
  76. * Improved and fixed Serialization code
  77. * Ensure that the creation of static groups is deterministic (GroupHashMap)
  78. ## [3.1.3]
  79. * bumped dependency of Svelto.Common due to an important fix there.
  80. ## [3.1.2]
  81. * improved async entity submission code (still experimental)
  82. * improved native entity operations debug info
  83. ## [3.1.1]
  84. * SubmissionEngine didn't need the EntityManager property, so it has been removed
  85. ## [3.1.0]
  86. * rearrange folders structures for clarity
  87. * added DoubleEntitiesEnumerator, as seen in MiniExample 4, to allow a double iteration of the same group skipping
  88. already checked tuples
  89. * reengineered the behaviour of WaitForSubmissionEnumerator
  90. * removed redudant SimpleEntitySubmissionSchedulerInterface interface
  91. * renamed BuildGroup in to ExclusiveBuildGroup
  92. * renamed EntityComponentInitializer to EntityInitializer
  93. * Entity Submission now can optionally be time sliced (based on number of entities to submit per slice)
  94. * working on the Unity extension Submission Engine, still WIP
  95. * added the possibility to hold a reference in a EntityViewComponent. This reference cannot be accesses as an object,
  96. but can be converted to the original object in OOP abstract layers
  97. * renamed NativeEntityComponentInitializer to NativeEntityInitializer