changelog.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

[Unreleased]

• None

[3.0.0-beta09] - 2023-12-05

Removed

• ExtendToString and ExtendToStringGrid extension methods from Utility class are removed (they now exist in the primitives library instead)

[3.0.0-beta08] - 2023-07-12

Added

• AdvancedEffect and AdvancedEffectTrigger have been added, and have a Trigger function that takes a parameter of the type you specify, which allows the effect to be triggered with additional context information.
  • This is equivalent to the old method of passing parameters which entailed creating a subclass of EffectArgs.
  • These classes accept a parameter of an arbitrary type, rather than forcing you to subclass EffectArgs to pass parameters.

Changed

• All classes related to the effects system have been moved to the GoRogue.Effects namespace.
• Effect and EffectTrigger no longer accept type parameters
  • Versions called AdvancedEffect and AdvancedEffectTrigger have been added which do accept type parameters
• Cancellation of a trigger from an effect is now handled via an out bool parameter given to Trigger and OnTrigger
  • Set this boolean value to true to cancel the trigger

Removed

• EffectArgs has been removed.
  • Parameters to AdvancedEffect and AdvancedEffectTrigger can now be of an arbitrary type.

[3.0.0-beta07] - 2023-07-11

Added

• The Factories namespace now contains LambdaFactoryBlueprint and LambdaAdvancedFactoryBlueprint which allow the user to create a blueprint by specifying a function to create the object as a constructor parameter, rather than having to create a class that implements IFactoryBlueprint/IAdvancedFactoryBlueprint.
• Factories now have an AddRange function which allows you to add many blueprints at once.

Changed

• Factories.Factory and Factories.AdvancedFactory now take a type parameter which specifies the type of object used as the key for blueprints (rather than forcing string). This allows factories to use other keys for blueprints, like enum values.
• Factory blueprint's Id property has been renamed to ID.
• ComponentCollection can now take a parent object for it's added components of any type, rather than just IObjectWithComponents.

[3.0.0-beta06] - 2023-05-22

Changed

• IParentAwareComponent and ParentAwareComponentBase now record the parent as type object
• ParentAwareComponentBase<T> no longer has type restrictions on type T; it can now accept any type as the parent.
  • This makes integration into other component systems more feasible since IObjectWithComponents is no longer required

[3.0.0-beta05] - 2023-05-17

Added

• Added custom list enumerators fitting the primitive library's custom enumerable pattern for casting objects to a given type
  • Most uses are internal, however they may be useful for exposing lists of objects in performance-critical situations.

Changed

• Upgraded primitives library to rc2, which enables some spatial map optimizations.
• ComponentCollection now uses custom iterators for component retrieval functions which are notably faster than the old implementations.
• Miscellaneous optimizations to dictionary accesses in ComponentCollection
• GameFramework.Map now uses custom iterators for GetEntitiesAt and GetObjectsAt functions which are notably faster than the old implementations.
• GameFramework.Map implements GridViewBase<MapObjectsAtEnumerator>, rather than GridViewBase<IEnumerable<IGameObject>>.
  • This should be functionally identical, since the MapObjectsAtEnumerator also implements IEnumerable.

[3.0.0-beta04] - 2023-03-24

Fixed

• Fixed bug where Map would not correctly enforce collision detection if the layersBlockingTransparency parameter was set to only the terrain layer.

Changed

• Map now, by default, keeps a cached BitArrayView to support WalkabilityView and TransparencyView, rather than calculating those values on the fly
  • This is much faster for operations which use these grid views (pathing ~9x faster in some test cases, FOV ~4x), although uses slightly more memory and makes adding/removing/moving objects around on the map slightly slower.
  • If needed, you can disable this behavior and get the old calculate-on-the-fly behavior instead by passing false to the cacheGridViews parameter of the Map constructor.

[3.0.0-beta03] - 2023-03-20

Added

• Primitives library now contains IPositionable interface (implemented by IGameObject) and contains auto-syncing spatial maps that don't require manual sync

Changed

• Spatial map movement-related functions now tolerate a source location the same as a destination location
• IGameObject now requires you to implement IPositionable
  • Requires implementation of Position field (already was existing), as well as PositionChanged event (replaces Moved) and PositionChanging
• Game objects now have a PositionChanging field which is fired before the value is actually changed
• ToEnumerable() functions on custom iterators (Rectangle.Positions() or IGridView.Positions(), for example) are now obsolete
• IGameObject.Entities is now synced to item's positions before the item's PositionChanged event fires (via PositionChanging)

Removed

• The following code has been removed because it now exists in the primitives library GoRogue depends on:
  • Spatial maps
  • LayerMasker
  • IHasID
  • IHasLayer

Fixed

• LayeredSpatialMap.TryMoveAll (in primitives library) now handles cases where items on some layers won't move properly by returning false
• LayeredSpatialMap.GetLayersInMask (in primitives library) now returns the correct layers

[3.0.0-beta02] - 2023-02-01

Changed

• GoRogue.Lines class renamed to GoRogue.LineHelpers
• Line-drawing algorithms from Lines class moved to TheSadRogue.Primitives (under Lines class)
  • Where you previously called Lines.Get, you should call line-specific functions (GetBresenhamLine(), GetDDALine(), or GetOrthogonalLine() where possible)
  • If you need an IEnumerable type specifically or need a generic function you can pass an algorithm to, call Lines.GetLine(); but this will not perform as well as the algorithm-specific functions which use custom iterators!
• PolygonArea now defaults to Bresenham lines, since they are ordered and generally faster
• PolygonArea now allows Orthogonal lines since they are also ordered

Fixed

• Bresenham lines (now in the primitives library) now break x/y ties the traditional way

Removed

• Lines.Get method and all associated line drawing algorithms have been removed
  • Refactored and moved to TheSadRogue.Primitives
• BresenhamOrdered no longer exists (Bresenham is ordered now instead)

[3.0.0-beta01] - 2022-10-07

Added

• RNG extension functions for generating random positions from Rectangles have been added
• MessageBus now has a RegisterAllSubscribers method which automatically registers all variations of ISubscriber the parameter is subscribed to in one call.
  • This is now a safer default than the old RegisterSubscribers function, but it uses reflection so may be slower.
  • TryRegisterAllSubscribers is also included.
• MessageBus now has a UnregisterAllSubscribers method which automatically unregisters all variations of ISubscriber the parameter is subscribed to in one call.
  • This is now a safer default than the old UnregisterSubscribers function, but it uses reflection so may be slower.
  • TryUnregisterAllSubscribers is also included.
• Added ISenseMap interface which captures the interface of a sense map
• Added SenseMapBase which implements boilerplate for ISenseMap and provides an easy way to create a custom implementation of that interface
• Added ISenseSource interface which captures the interface of a sense source
• Added SenseSourceBase which implements boilerplate for ISenseSource and provides an easy way to create a custom implementation of that interface
• Added the ability to implement custom sense source spreading algorithms
• Added the ability to customize aggregation of values and parallelization in the provided concrete sense map implementation

Changed

• Updated minimum version of TheSadRogue.Primitives to v1.4.1
  • See this package's changelog for change list, which include performance increases
• Redesigned sense maps (see added features)
  • Basis of sense map system is now the two interfaces ISenseMap and ISenseSource
  • Custom sense source spread algorithms can be implemented by implementing ISenseSource
  • Sense maps now operate on arbitrary ISenseSource instances, rather than some concrete implementation
  • Sense maps no longer implement IEnumerable or IGridView; instead, they provide a ResultView which exposes the results.
• Optimized Map
  • TransparencyView and WalkabilityView now retrieve values faster

Fixed

• Fixed bug where changing the Span of a sense source might not update the IsAngleRestricted value correctly

[3.0.0-alpha14] - 2022-07-07

Added

• GameFramework.Map now contains CanAddEntityAt and TryAddEntityAt functions which allow you to specify a new position to check instead of using the entity's current one.

Changed

• The double version of the recursive shadowcasting FOV algorithm is now much, much faster (about on par with the boolean version in typical cases)
• FOV.RecursiveShadowcastingFOV now uses the double-based variation of the algorithm, since it now makes a more reasonable default

Fixed

• The CanAddEntity function in GameFramework.Map now properly accounts for situations where the entity is being added to a layer which does not support multiple items at a given position

[3.0.0-alpha13] - 2022-06-26

Added

• FOV.BooleanBasedFOVBase which defines a ResultView as a BitArray, and DoubleResultView as a grid view that performs appropriate calculations based on that.
• FOV.DoubleBasedFOVBase which defines ResultView and BooleanResultView exactly as FOVBase did previously
• FOV.IFOV now defines a property which is a list of all the parameters for all the Calculate/CalculateAppend calls that have happened since the last reset
  • This enables users to track what the source/radius was for each FOV calculation that makes up the current state
• DisjointSet now optionally accepts a custom hashing algorithm to use for the items.

Changed

• FOV.RecursiveShadowcastingFOV now inherits from BooleanBasedFOVBased, and the base algorithm sets booleans rather than doubles
  • This makes Calculate and BooleanResultView much faster, particularly so as the map size increases
  • Memory usage is also reduced significantly
  • Accessing values from DoubleResultView is typically a bit slower, but for many use cases the speed increase of Calculate will offset it
  • DoubleResultView does not perform as well as the previous implementation when there are multiple FOV calculations being appended together via CalculateAppend; in cases where this becomes problematic, usage of RecursiveShadowcastingDoubleBasedFOV is recommended
• The FOV.IFOV interface's Recalculated event argument now contains a FOVCalculateParameters struct which contains all of the values that used to be on the arguments class directly
  • FOVRecalculatedEventArgs.Origin => FOVRecalculatedEventArgs.CalculateParameters.Origin, etc

Fixed

• DisjointSet<T> correctly initializes when given an input array (fixes #266)

Removed

• FOV.FOVBase no longer defines a ResultView; this field is now defined as appropriate by its subclasses

[3.0.0-alpha12] - 2022-04-16

Added

• GameFramework.Map now has TryAddEntity, CanAddEntity, and TryRemoveEntity which match the equivalent functions from spatial maps
  • Allows users to check if an add will succeed/has succeeded without involving exceptions

Changed

• IDGenerator now exposes its state via read-only properties
• IDGenerator now supports DataContract serialization (including JSON)
• IDGenerator constructor now supports specifying the boolean parameter used to record the "last ID assigned state" (useful mostly for serialization)

Fixed

• ShaiRandom will now function properly when debugging via SourceLink (bumped version to 0.0.1-beta03 which has appropriate symbols uploaded)

[3.0.0-alpha11] - 2022-03-26

Added

• Spatial maps now have a MoveValid overload which takes a list to fill instead of returning one as a result
• Spatial maps now have TryMoveAll and TryRemove functions which return false instead of throwing exceptions when the operations fail
  • More performant in cases where failure is expected
• Miscellaneous functions added which can increase performance compared to the alternative for their use case
• Pooling for List<T> structures (similar to System.Buffers.ArrayPool but for lists) is now provided in the GoRogue.Pooling namespace
  • An interface is provided which encompasses the core functionality; as well as a basic implementation of that interface, and a "dummy" implementation that can be used to disable pooling entirely (it simply allocations/GCs as you would do without the pool).
• MultiSpatialMap, LayeredSpatialMap, and GameFramework.Map now have optional constructor parameters which allow you to specify what list pool is used for the creation of internal lists.
• Added convenience functions to LayerMasker that allow you to more easily add a mask to another mask.

Changed

• Optimized SenseSource algorithm and structure
  • ~30% faster
  • Notably less memory usage and allocations performed
• Optimized SpatialMap (most functions)
  • Degree of speedup varies based on circumstance
• Optimized existing MultiSpatialMap functions
  • ~2x faster move operations in some cases
  • Minor add/remove performance increases
  • ~20-30% faster TryAdd
  • Significant reduction in number of allocations performed during most move operations
• Optimized LayeredSpatialMap functions
  • Since LayeredSpatialMap uses MultiSpatialMap, all of those performance benefits translate here as well. IN ADDITION to those benefits, the following also apply.
  • MoveAll an additional 2x faster
  • MoveValid an additional 40% faster
• Optimized LayerMasker
  • The Layers function now returns a custom enumerable instead of IEnumerable<int>, which significantly cuts down performance overhead
• MultiSpatialMap, LayeredSpatialMap, and GameFramework.Map now implement "list pooling" by default, which reduce the amount of reallocations that take place during add, remove, and move operations.
  • List pooling can be disabled or customized via a constructor parameter.
• Renamed LayerMasker.DEFAULT to LayerMasker.Default in order to match typical C# and GoRogue naming conventions.
• If a move operation fails, spatial maps now do not guarantee that state will be restored to what it was before any objects were moved.
  • This allows notable performance increase, and exceptions thrown by functions such as MoveAll generally should not be recovered from; the TryMoveAll, CanMove, and/or MoveValid functions should be used instead.

[3.0.0-alpha10] - 2022-02-13

Added

• Spatial map implementations now have TryMove, TryAdd, and TryRemove functions which return false instead of throwing exception when an operation fails
  • Assuming current implementations, this is 5-10% faster than the old method of first checking with the appropriate Can method then doing the appropriate operation
  • Note that Add, Remove, and Move have been optimized as well so this will likely produce a greater speed increase than 5-10% in existing code
• Spatial map implementations now have a TryGetPositionOf function which returns false instead of throwing exception when item given doesn't exist
• Spatial map implementations now have a GetPositionOfOrNull function which returns null instead of throwing exception when item given doesn't exist
  • Note that, unlike the original GetPositionOf implementation, it returns null, not default(T) or Point.None
• MessageBus now has TryRegisterSubscriber and TryUnregisterSubscriber functions which return false instead of throw an exception on failure (fixes #248).
• SadRogue.Primitives.GridViews namespace now has a class BitArrayView, which is a grid view of boolean values implemented via a C# BitArray
  • Recommend using this instead of bool[] or ArrayView<bool> (and sometimes instead of HashSet<Point>) to represent a set of locations within a grid

Changed

• The GetPositionOf function on spatial map implementations now throws exception if the position doesn't exist
  • Note other methods have been added that return null or false
• Move, Add, and Remove function of spatial map implementations have been optimized
  • Gains vary but can be as much as 15-20% per operation, for some implementations and circumstances
• Updated primitives library to 1.3.0
• GoRogue algorithms now use the primitives library's cache for directions of neighbors, instead of creating their own
• Various performance improvements to goal maps/flee maps
  • WeightedGoalMap up to 50-80% faster for value indexer and GetDirectionOfMinValue operations
    • Other goal maps will see more limited performance increase in GetDirectionOfMinValue calls
  • 45-55% speed increase in calls to Update() for goal maps and flee maps on open maps
  • Goal maps, and flee maps should now also use less memory (or at least produce less allocations)
• GoalMap instances now explicitly reject base grid views that change width/height (although doing so would not function appropriately in most cases previously anyway)
• Optimized memory usage for AStar
  • Saves about 8.5 kb over a 100x100 map, and produces less allocation during ShortestPath()
• RegenerateMapException message now contains more details about intended fix (fixes #253)
• GoRogue now uses ShaiRandom instead of Troschuetz.Random instead of its RNG library
  • Many changes, some breaking; check the v2 to v3 porting guide for details
  • In summary: new RNG algorithms, performance improvements, more access to generating different types of numbers, more access to generator state, more serialization control
  • KnownSeriesRandom has moved to ShaiRandom.Generators; a host of bugs were fixed in this class in the process
  • MinRandom and MaxRandom have been moved to ShaiRandom.Generators, and now support floating-point numbers
  • RandomItem, RandomPosition, and RandomIndex methods for classes are now extension of IEnhancedGenerator, instead of extensions of the container class
  • GoRogue's RandomItem and RandomIndex functions for built-in C# types are now part of ShaiRandom

Fixed

• The GetDirectionOfMinValue function for goal maps now supports maps with open edges (thanks DavidFridge)
• The WeightedGoalMap calculation is now additive, as the supplemental article indicates it should be (thanks DavidFridge)
• API documentation now properly cross-references types in primitives library
• Map constructor taking custom terrain grid view now properly initializes existing terrain on that grid view (fixes #254)
  • NOTE: Caveats about this constructor's usage have now been properly documented in API documentation
• If moving the position of an entity on the map throws an exception, the map state will now recover properly

[3.0.0-alpha09] - 2021-12-19

Added

• Spatial map implementations now allow you to specify a custom point hashing algorithm to use
• Added similar hashing algorithm parameter to GameFramework.Map

Fixed

• FleeMaps now properly support goal maps where the base map has open edges (fixes #211)

Changed

• Applied performance optimizations to A* algorithm
  • ~20% improvements to speed when generating paths on open maps
  • Performance gain varies on other test cases but should generally be measurable
• Applied performance optimizations to GoalMap and FleeMap algorithms
  • ~50% improvement on a full-update operation, using a wide-open (obstacle free) base map
  • Performance gain varies on other test cases but should generally be measurable
• Defaulted to a usually faster hashing algorithm (one based on the Map's width) in Map's SpatialMaps

[3.0.0-alpha08] - 2021-10-17

Added

• Added the IGameObject.WalkabilityChanging event that is fired directly before the walkability of the object is changed.
• Added the IGameObject.TransparencyChanging event that is fired directly before the transparency of the object is changed.
• Added IGameObject.SafelySetProperty overload that can deal with "changing" (pre) events as well as "changed" (post) events.

Fixed

• Fixed bug in GameFramework.Map that prevented setting of the walkability of map objects.

[3.0.0-alpha07] - 2021-10-13

Added

• GameObject now has constructors that omit the parameter for starting position

Changed

• MessageBus now has improved performance
• MessageBus also now supports subscribers being registered while a Send is in progress
  • No subscribers added will be called by the in-progress Send call, however any subsequent Send calls (including nested ones) will see the new subscribers
• ParentAwareComponentBase now specifies old parent in Removed event.

[3.0.0-alpha06] - 2021-10-02

Added

• Added a constructor to Region that takes a PolygonArea as a parameter and avoided copies.
• Added an event that will automatically fire when the Area property of a Region is changed.

Changed

• Comparison of PolygonArea now compares exclusively based off of defined corner equivalency.

Removed

• All functions and constructors in Region that forwarded to corresponding functions in PolygonArea.
  • Such functions and constructors are now only available by accessing Area property

Fixed

• Parallelogram static creation method for PolygonArea now functions correctly for differing values of width/height (ensures correct 45 degree angles)

[3.0.0-alpha05] - 2021-09-30

Added

• FOV now has CalculateAppend functions which calculate FOV from a given source, but add that FOV into the existing one, as opposed to replacing it
• FOV now also has a Reset function and a VisibilityReset event that may be useful in synchronizing visibility with FOV state
• PolygonArea class that implements the IReadOnlyArea interface by taking in a list of corners defining a polygon, and tracking the outer boundary points of the polygon, as well as the inner points
  • Also offers transformation operations
• Region class (not the same class as was previously named Region) that associates a polygon with components and provides a convenient interface for transformations
• MultiArea now offers a Clear() function to remove all sub-areas
• MapAreaFinder now has a function that lets you get a single area based on a starting point (eg. boundary fill algorithm), rather than all areas in the map view

Changed

• IFOV interface (and all implementations) now takes angles on a scale where 0 points up, and angles proceed clockwise
  • This matches better with bearing-finding functions in primitives library and correctly uses the common compass clockwise rotation scale
• SenseSource now takes angles on a scale where 0 points up, and angles proceed clockwise (thus matching FOV)
• Region has been rewritten and is replaced with PolygonArea
  • PolygonArea supports arbitrary numbers of corners and now implements IReadOnlyArea
  • Contains the static creation methods for rectangles and parallelograms previously on Region, as well as new ones for regular polygons and regular stars
  • The class called Region associates a PolygonArea with a set of components and provides convenient accesses to the area's functions/interfaces
    • This functions as a substitute for the sub-regions functionality previously on Region
• Significant performance optimizations applied to MultiArea and MapAreaFinder
• Updated minimum needed primitives library version to 1.1.1

Fixed

• FOVBase.OnCalculate function (all overloads) is now protected, as was intended originally
• Summary documentation for FOVBase is now complete
• FOV.RecursiveShadowcastingFOV now handles negative angle values properly
• SenseMapping.SenseSource now handles negative Angle values properly

[3.0.0-alpha04] - 2021-06-27

Added

• Created GoRogue.FOV namespace to hold everything related to FOV
• IFOV interface now exists in the GoRogue.FOV namespace which defines the public interface for a method of calculating FOV
• FOVBase abstract class has been added to the GoRogue.FOV namespace to simplify creating implementations of the IFOV interface

Changed

• Attaching IParentAwareComponent instances to two objects at once now produces a more helpful exception message
• FOV renamed to RecursiveShadowcastingFOV and moved to the GoRogue.FOV namespace
• FOV classes no longer implement IGridView<double>; instead, access their DoubleResultView field for equivalent behavior
• FOV's BooleanFOV property renamed to BooleanResultView
• The GameFramework.Map.PlayerFOV has changed types; it is now of type IFOV in order to support custom implementations of FOV calculations.

Fixed

• ParentAwareComponentBase.Added is no longer fired when the component is detached from an object

[3.0.0-alpha03] - 2021-06-13

Added

• Map now has parent-aware component support via an optional interface (similar to what GameObjects support)
• Added generic parent-aware component structure (objects that are aware of what they are attached to) that can support arbitrary parent types instead of just GameObject instances.
• Added events to IGameObject that must be fired when an object is added to/removed from a map (helper method provided)

Changed

• ComponentCollection now handles parent-aware components intrinsically (meaning IGameObject implementations don't need to worry about it anymore)
• IGameObject implementations should now call SafelySetCurrentMap in their OnMapChanged implementation (as demonstrated in GoRogue's GameObject implementation) to safely fire all events
• ITaggableComponentCollection has been effectively renamed to IComponentCollection

Fixed

• ParentAwareComponentBase.IncompatibleWith component restriction now has proper nullability on parameter types to be compatible with the ParentAwareComponentBase.Added event

Removed

• Removed GameFramework.IGameObjectComponent interface (replaced with IParentAwareComponent and/or ParentAwareComponentBase<T>
• Removed GameFramework.ComponentBase and GameFramework.ComponentBase<T> classes (replaced with ParentAwareComponentBase and ParentAwareComponentBase<T>)
• Removed IBasicComponentCollection interface (contents merged into IComponentCollection)

[3.0.0-alpha02] - 2021-04-04

Added

• MultiArea class that implements IReadOnlyArea in terms of a list of "sub-areas"
• Clear() and Count functionality to component collections
• Specific functions RandomItem and RandomIndex for Area (since Area no longer exposes a list)
• Added RegenerateMapException which can be thrown by GenerationStep instances to indicate the map must be discarded and re-generated
• Added ConfigAndGenerateSafe/ConfigAndGetStageEnumeratorSafe functions that provide behavior in addition to the typical AddStep/Generate type sequence that can handle cases where the map must be re-generated.
• DisjointSet now has events that fire when areas are joined
• DisjointSet<T> class which automatically assigns IDs to objects

Changed

• Updated to v1.0 of the primitives library
• Modified Area to implement new primitives library IReadOnlyArea interface
  • List of positions no longer exposed
  • Area has indexers that take indices and return points directly
• Modified map generation interface to support critical exceptions that require map re-generation
  • You must now call ConfigAndGenerateSafe to get equivalent behavior to gen.AddSteps(...).Generate() that will automatically handle these exceptions
• Modified ClosestMapAreaConnection step to minimize chances of issues that cause connections to cut through other areas
  • Uses more accurate description of areas in connection point selection
  • Uses the same ConnectionPointSelector used to determine points to connect for determining the distance between two areas; thus allowing more control over how distance is calculated.

Fixed

• Incorrect nullable annotation for Map.GoRogueComponents (#219)
• DungeonMazeGeneration returning rooms with unrecorded doors (#217)