diff --git a/GoRogue/GoRogue.csproj b/GoRogue/GoRogue.csproj index e8c633ee..b01a497f 100644 --- a/GoRogue/GoRogue.csproj +++ b/GoRogue/GoRogue.csproj @@ -3,13 +3,13 @@ netstandard2.0 GoRogue - 1.8.0 + 1.8.1 Christopher Ridley Roguelike/2D game utility library. LICENSE https://github.com/Chris3606/GoRogue false - See https://github.com/Chris3606/GoRogue/releases/tag/v1.8.0 for release notes. + Bugfixes. See https://github.com/Chris3606/GoRogue/releases/tag/v1.8.1 for release notes. Copyright © 2019 Christopher Ridley. All rights reserved. roguelike roguelikes rogue library 2d game games diff --git a/docs/annotated.html b/docs/annotated.html index 948b6b85..526d9c70 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -153,29 +153,28 @@  CEffectArgsDefault argument for any effect. Any class that is used as the template argument for an effect must either be this or a class that inherits from this.  CEffectTriggerRepresents an "event" that can trigger one or more Effects of the appropriate type. Typically instnaces of this class can simply be created, however a subclass may be required for custom add/remove actions and ordering.  CFOVClass responsible for caculating basic FOV (see SenseMap for more advanced lighting). Effectively a simplified, slightly faster interface compared to SenseMap, that supports only a single source and only shadowcasting. This is more conducive to the typical use case for FOV. It can calculate the FOV with a finite or infinite max radius, and can use a variety of radius types, as specified in Radius class (all the same ones that SenseMap supports). It also supports both 360 degree FOV and a "field of view" (cone) FOV. One may access this class like a 2D array of doubles (FOV values), wherein the values will range from 0.0 to 1.0, where 1.0 means the corresponding map grid coordinate is at maximum visibility, and 0.0 means the cooresponding coordinate is outside of FOV entirely (not visible). Values fall off linearly with respect to radius as distance from the center increases. - CIDComparerClass intended for comparing/hashing objects that implement IHasID. Type T must be a reference type. - CIDGeneratorClass designed as a helper for situations where you need to generate and assign a unique integer to each instance of a class, eg. for a class implementing IHasID (see that interface documentation for usage example). One may initialize it with a starting unsigned integer, or 0 if none is specified. Then, every time one wants to use an integer, one should call UseID(), and use the one it returns. It is not thread-safe on its own – if it needs to be, one might consider using a lock around any UseID calls. - CIHasIDInterface for a class that has an ID, typically used for hashing purposes. The ID should be unique or close to unique over all instances of the class (for efficiency). Typical implementation could be simply random-genning the ID, or for completely unique IDs can involve using an IDGenerator, potentially as follows: - CIHasLayerInterface to be implemented by objects that will be used in LayeredSpatialMap/Map classes. - CIReadOnlyDisjointSetBasic read-only representation of a Disjoint set data structure. Assumes it is holding integers between 0 and size - 1. - CIReadOnlyFOVRead-only interface of the FOV class. - CIReadOnlyLayeredSpatialMapRead-only interface for LayeredSpatialMap – useful for exposing LayeredSpatialMap instances as read-only properties. - CIReadOnlyRadiusAreaProviderRead-only interface of a RadiusAreaProvider. - CIReadOnlySpatialMapSee ISpatialMap documentation. Similar in principle to the C# standard IReadOnlyList/IReadOnlyCollection interface. Simply exposes only those functions of the ISpatialMap interface that do not allow direct modification of the data (eg. adding/moving/removing items). This can allow for direct exposure of an ISpatialMap as a property of type IReadOnlySpatialMap, without allowing such an exposure to break data encapsulation principles of something like a game map. - CISpatialMapGeneral interface for a data structure that records objects on a map. - CISpatialTupleInterface specifying return type for item-location pairs in a spatial map implementation. - CItemEventArgsEvent args for spatial map events pertaining to an item (item added, item removed, etc.) - CItemMovedEventArgsEvent args for SpatialMap's ItemMoved event. - CLayeredSpatialMapISpatialMap implementation that can be used to efficiently represent "layers" of objects, with each layer represented as a SpatialMap. It uses layer masking (bit-masking per layer) to allow functions to operate on specific layers. Items must implement IHasID and IHasLayer, be a reference type, and their Layer value MUST NOT change while they are in the data structure. - CLayerMaskerAllows convenient interpretation and creation of layer masks (bit-masks) mask layers represented by integers [0-NumberOfLayers - 1]. - CLinesProvides implementations of various (line-drawing) algorithms for generating points closest to a line between two points on a grid. - CMathHelpersStatic class consisting of mathematical "helper" functions and constants – things like angle unit conversions, and other helpful functions. - CMultiSpatialMapSee SpatialMap documentation – similar in principle. However, this implementation allows multiple items to exist at one point in the SpatialMap, in exchange for the loss of the convenience functions like GetItem vs GetItems, as well as potential performance differences (although unless the number of objects at any given location is large, the performance is asymptotically the same). - CRadiusClass representing different radius types. Similar in architecture to Coord in architecture – it cannot be instantiated. Instead it simply has pre-allocated static variables for each type of radius, that should be used whenever a variable of type Radius is required. - CRadiusAreaProviderClass capable of getting all unique positions inside of a given radius and (optional) bounds. - CRectangleRepresents a rectangle in terms of grid squares. Provides numerous functions pertaining to area. - CSpatialMapDesigned as an more efficient data structure for recording objects on a map. The simple version: if you're about to use a List to store a bunch of objects in your map, consider using this or MultiSpatialMap instead! - CUtilityStatic class full of miscellaneous helper methods. + CIDGeneratorClass designed as a helper for situations where you need to generate and assign a unique integer to each instance of a class, eg. for a class implementing IHasID (see that interface documentation for usage example). One may initialize it with a starting unsigned integer, or 0 if none is specified. Then, every time one wants to use an integer, one should call UseID(), and use the one it returns. It is not thread-safe on its own – if it needs to be, one might consider using a lock around any UseID calls. + CIHasIDInterface for a class that has an ID, typically used for hashing purposes. The ID should be unique or close to unique over all instances of the class (for efficiency). Typical implementation could be simply random-genning the ID, or for completely unique IDs can involve using an IDGenerator, potentially as follows: + CIHasLayerInterface to be implemented by objects that will be used in LayeredSpatialMap/Map classes. + CIReadOnlyDisjointSetBasic read-only representation of a Disjoint set data structure. Assumes it is holding integers between 0 and size - 1. + CIReadOnlyFOVRead-only interface of the FOV class. + CIReadOnlyLayeredSpatialMapRead-only interface for LayeredSpatialMap – useful for exposing LayeredSpatialMap instances as read-only properties. + CIReadOnlyRadiusAreaProviderRead-only interface of a RadiusAreaProvider. + CIReadOnlySpatialMapSee ISpatialMap documentation. Similar in principle to the C# standard IReadOnlyList/IReadOnlyCollection interface. Simply exposes only those functions of the ISpatialMap interface that do not allow direct modification of the data (eg. adding/moving/removing items). This can allow for direct exposure of an ISpatialMap as a property of type IReadOnlySpatialMap, without allowing such an exposure to break data encapsulation principles of something like a game map. + CISpatialMapGeneral interface for a data structure that records objects on a map. + CISpatialTupleInterface specifying return type for item-location pairs in a spatial map implementation. + CItemEventArgsEvent args for spatial map events pertaining to an item (item added, item removed, etc.) + CItemMovedEventArgsEvent args for SpatialMap's ItemMoved event. + CLayeredSpatialMapISpatialMap implementation that can be used to efficiently represent "layers" of objects, with each layer represented as a SpatialMap. It uses layer masking (bit-masking per layer) to allow functions to operate on specific layers. Items must implement IHasID and IHasLayer, be a reference type, and their Layer value MUST NOT change while they are in the data structure. + CLayerMaskerAllows convenient interpretation and creation of layer masks (bit-masks) mask layers represented by integers [0-NumberOfLayers - 1]. + CLinesProvides implementations of various (line-drawing) algorithms for generating points closest to a line between two points on a grid. + CMathHelpersStatic class consisting of mathematical "helper" functions and constants – things like angle unit conversions, and other helpful functions. + CMultiSpatialMapSee SpatialMap documentation – similar in principle. However, this implementation allows multiple items to exist at one point in the SpatialMap, in exchange for the loss of the convenience functions like GetItem vs GetItems, as well as potential performance differences (although unless the number of objects at any given location is large, the performance is asymptotically the same). + CRadiusClass representing different radius types. Similar in architecture to Coord in architecture – it cannot be instantiated. Instead it simply has pre-allocated static variables for each type of radius, that should be used whenever a variable of type Radius is required. + CRadiusAreaProviderClass capable of getting all unique positions inside of a given radius and (optional) bounds. + CRectangleRepresents a rectangle in terms of grid squares. Provides numerous functions pertaining to area. + CSpatialMapDesigned as an more efficient data structure for recording objects on a map. The simple version: if you're about to use a List to store a bunch of objects in your map, consider using this or MultiSpatialMap instead! + CUtilityStatic class full of miscellaneous helper methods. diff --git a/docs/class_go_rogue_1_1_advanced_layered_spatial_map.html b/docs/class_go_rogue_1_1_advanced_layered_spatial_map.html index da9c45f7..2378dac2 100644 --- a/docs/class_go_rogue_1_1_advanced_layered_spatial_map.html +++ b/docs/class_go_rogue_1_1_advanced_layered_spatial_map.html @@ -95,21 +95,45 @@  AdvancedLayeredSpatialMap (IEqualityComparer< T > comparer, int numberOfLayers, int startingLayer=0, uint layersSupportingMultipleItems=0)  Constructor. Takes a comparator to use, number of layers to include, as well as a starting layer index (defaulting to 0) and a layer mask indicating which layers support multiple items at a single position (defaulting to no layers). More...
  -IReadOnlySpatialMap< T > GetLayer (int layer) - Gets a read-only spatial map representing the layer given. More...
-  -IEnumerable< IReadOnlySpatialMap< T > > GetLayers (uint layerMask=uint.MaxValue) - Returns read-only spatial maps that represent each layer included in the given layer mask. Defaults to all layers. More...
-  bool Add (T newItem, Coord position)  Adds the given item at the given position. Item is automatically added to correct layer. More...
  bool Add (T newItem, int x, int y)  Adds the given item at the given position, or returns false if the item cannot be added. Item is automatically added to correct layer. More...
  +IReadOnlyLayeredSpatialMap< T > AsReadOnly () + Returns a read-only reference to the data structure. Convenient for "safely" exposing the structure as a property. More...
+  void Clear ()  Clears all items from all layers. More...
  +bool Contains (T item) + Returns whether or not the data structure contains the given item. More...
+  +bool Contains (Coord position, uint layerMask=uint.MaxValue) + Returns whether or not there is an item in the data structure at the given position that is on a layer included in the given layer mask. Defaults to searching on all layers. More...
+  +bool Contains (int x, int y, uint layerMask=uint.MaxValue) + Returns whether or not there is an item in the data structure at the given position, that is on a layer included in the given layer mask. More...
+  +IEnumerator< ISpatialTuple< T > > GetEnumerator () + Used by foreach loop, so that the class will give ISpatialTuple objects when used in a foreach loop. Generally should never be called explicitly. More...
+  +IEnumerable< T > GetItems (Coord position, uint layerMask=uint.MaxValue) + Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
+  +IEnumerable< T > GetItems (int x, int y, uint layerMask=uint.MaxValue) + Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
+  +IReadOnlySpatialMap< T > GetLayer (int layer) + Gets a read-only spatial map representing the layer given. More...
+  +IEnumerable< IReadOnlySpatialMap< T > > GetLayers (uint layerMask=uint.MaxValue) + Returns read-only spatial maps that represent each layer included in the given layer mask. Defaults to all layers. More...
+  +Coord GetPosition (T item) + Gets the position associated with the item in the data structure, or null if that item is not found. More...
+  bool Move (T item, Coord target)  Moves the given item to the given position, or returns false if the item cannot be moved. More...
  @@ -131,57 +155,33 @@ IEnumerable< T > Remove (int x, int y, uint layerMask=uint.MaxValue)  Removes all items at the specified location that are on any layer included in the given layer mask from the data structure. Returns any items that were removed. Defaults to all layers. More...
  -IReadOnlyLayeredSpatialMap< T > AsReadOnly () - Returns a read-only reference to the data structure. Convenient for "safely" exposing the structure as a property. More...
-  -bool Contains (T item) - Returns whether or not the data structure contains the given item. More...
-  -bool Contains (Coord position, uint layerMask=uint.MaxValue) - Returns whether or not there is an item in the data structure at the given position that is on a layer included in the given layer mask. Defaults to searching on all layers. More...
-  -bool Contains (int x, int y, uint layerMask=uint.MaxValue) - Returns whether or not there is an item in the data structure at the given position, that is on a layer included in the given layer mask. More...
-  -IEnumerable< T > GetItems (Coord position, uint layerMask=uint.MaxValue) - Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
-  -IEnumerable< T > GetItems (int x, int y, uint layerMask=uint.MaxValue) - Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
-  -Coord GetPosition (T item) - Gets the position associated with the item in the data structure, or null if that item is not found. More...
-  -IEnumerator< ISpatialTuple< T > > GetEnumerator () - Used by foreach loop, so that the class will give ISpatialTuple objects when used in a foreach loop. Generally should never be called explicitly. More...
-  + + + - - -

Public Attributes

int Count => _layers.Sum(map => map.Count)
 Gets the number of entities on all layers. More...
 
IEnumerable< IReadOnlySpatialMap< T > > Layers => _layers
 Gets read-only spatial maps representing each layer. To access a specific layer, instead use GetLayer. More...
 
int NumberOfLayers => _layers.Length
 Gets the number of layers represented. More...
 
int Count => _layers.Sum(map => map.Count)
 Gets the number of entities on all layers. More...
 
- - - - - - + + + + + + @@ -193,18 +193,18 @@ - - - - - - + + + + + +

Properties

int StartingLayer [get]
 Starting index for layers included in theis LayeredSpatialMap. Specified at construction. More...
 
LayerMasker LayerMasker [get]
 Object that helps get layer masks as they pertain to this LayeredSpatialMap More...
 
IEnumerable< T > Items [get]
 Gets all the items on all layers. More...
 
LayerMasker LayerMasker [get]
 Object that helps get layer masks as they pertain to this LayeredSpatialMap More...
 
IEnumerable< Coord > Positions [get]
 Gets all positions that have items for each layer. No positions are duplicated if multiple layers have an item at a position. More...
 
int StartingLayer [get]
 Starting index for layers included in theis LayeredSpatialMap. Specified at construction. More...
 
- Properties inherited from GoRogue.IReadOnlySpatialMap< T >
int Count [get]
 The number of items in the data structure. More...
 Enumerable of all positions that contain items. Likely this won't be used as much, since most objects that are contained in a spatial map implementation will record their position as a member, however in case that is not the case for a particular use, or just as a convenience if you only care about the coordinates, this is provided. More...
 
- Properties inherited from GoRogue.IReadOnlyLayeredSpatialMap< T >
int StartingLayer [get]
 Starting index for layers included in this structure. More...
 
IEnumerable< IReadOnlySpatialMap< T > > Layers [get]
 Gets read-only spatial maps representing each layer. To access a specific layer, instead use GetLayer. More...
 
LayerMasker LayerMasker [get]
 Object that helps get layer masks as they pertain to this LayeredSpatialMap More...
 
IEnumerable< IReadOnlySpatialMap< T > > Layers [get]
 Gets read-only spatial maps representing each layer. To access a specific layer, instead use GetLayer. More...
 
int NumberOfLayers [get]
 Gets the number of layers represented. More...
 
int StartingLayer [get]
 Starting index for layers included in this structure. More...
 
@@ -233,7 +233,7 @@

Be mindful of the efficiency of your hashing function specified in the IEqualityComparer – it will in large part determine the performance of AdvancedLayeredSpatialMap!

Template Parameters

Events

- +
TType of items in the layers. Type T must implement IHasLayer, and its IHasLayer.Layer value MUST NOT change while the item is in the AdvancedLayeredSpatialMap.
TType of items in the layers. Type T must implement IHasLayer, and its IHasLayer.Layer value MUST NOT change while the item is in the AdvancedLayeredSpatialMap.
@@ -288,10 +288,10 @@

LayeredSpatialMap.

Parameters
- + - +
comparerEquality comparer to use for comparison and hashing of type T. Be mindful of the efficiency of this instances GetHashCode function, as it will determine the efficiency of many AdvancedLayeredSpatialMap functions.
comparerEquality comparer to use for comparison and hashing of type T. Be mindful of the efficiency of this instances GetHashCode function, as it will determine the efficiency of many AdvancedLayeredSpatialMap functions.
numberOfLayersNumber of layers to include.
startingLayerIndex to use for the first layer.
layersSupportingMultipleItemsA layer mask indicating which layers should support multiple items residing at the same location on that layer. Defaults to no layers.
layersSupportingMultipleItemsA layer mask indicating which layers should support multiple items residing at the same location on that layer. Defaults to no layers.
@@ -488,11 +488,11 @@

Parameters
- +
positionThe position to check for.
layerMaskLayer mask that indicates which layers to check. Defaults to all layers.
layerMaskLayer mask that indicates which layers to check. Defaults to all layers.
-
Returns
True if there is some item at the given position on a layer included in the given layer mask, false if not.
+
Returns
True if there is some item at the given position on a layer included in the given layer mask, false if not.

Implements GoRogue.IReadOnlyLayeredSpatialMap< T >.

@@ -535,11 +535,11 @@

xX-value of the position to check for. yY-value of the position to check for. - layerMaskLayer mask that indicates which layers to check. Defaults to all layers. + layerMaskLayer mask that indicates which layers to check. Defaults to all layers. -
Returns
True if there is some item at the given position on a layer included in the given layer mask, false if not.
+
Returns
True if there is some item at the given position on a layer included in the given layer mask, false if not.

Implements GoRogue.IReadOnlyLayeredSpatialMap< T >.

@@ -595,7 +595,7 @@

Parameters
- +
positionThe position to return the item(s) for.
layerMaskLayer mask that indicates which layers to check. Defaults to all layers.
layerMaskLayer mask that indicates which layers to check. Defaults to all layers.
@@ -642,7 +642,7 @@

xX-value of the position to return the item(s) for. yY-value of the position to return the item(s) for. - layerMaskLayer mask that indicates which layers to check. Defaults to all layers. + layerMaskLayer mask that indicates which layers to check. Defaults to all layers. @@ -700,7 +700,7 @@

Parameters
- +
layerMaskLayer mask indicating which layers to return. Defaults to all layers.
layerMaskLayer mask indicating which layers to return. Defaults to all layers.
@@ -863,7 +863,7 @@

currentPosition to move all items from. targetPosition to move all items to. - layerMaskLayer mask specifying which layers to search for items on. Defaults to all layers. + layerMaskLayer mask specifying which layers to search for items on. Defaults to all layers. @@ -922,7 +922,7 @@

currentYY-value of the position to move items from. targetXX-value of the position to move items to. targetYY-value of the position to move itesm from. - layerMaskLayer mask specifying which layers to search for items on. Defaults to all layers. + layerMaskLayer mask specifying which layers to search for items on. Defaults to all layers. @@ -989,7 +989,7 @@

Parameters
- +
positionPosition to remove items from.
layerMaskThe layer mask indicating which layers to search for items. Defaults to all layers.
layerMaskThe layer mask indicating which layers to search for items. Defaults to all layers.
@@ -1034,7 +1034,7 @@

xX-value of the position to remove items from. yY-value of the position to remove items from. - layerMaskThe layer mask indicating which layers to search for items. Defaults to all layers. + layerMaskThe layer mask indicating which layers to search for items. Defaults to all layers. diff --git a/docs/class_go_rogue_1_1_advanced_multi_spatial_map.html b/docs/class_go_rogue_1_1_advanced_multi_spatial_map.html index 1c272875..f069b359 100644 --- a/docs/class_go_rogue_1_1_advanced_multi_spatial_map.html +++ b/docs/class_go_rogue_1_1_advanced_multi_spatial_map.html @@ -236,7 +236,7 @@

MultiSpatialMap.

Parameters
- +
comparerEquality comparer to use for comparison and hashing of type T. Be mindful of the efficiency of this instances GetHashCode function, as it will determine the efficiency of many AdvancedMultiSpatialMap functions.
comparerEquality comparer to use for comparison and hashing of type T. Be mindful of the efficiency of this instances GetHashCode function, as it will determine the efficiency of many AdvancedMultiSpatialMap functions.
initialCapacityThe initial maximum number of elements the MultiSpatialMap can hold before it has to internally resize data structures. Defaults to 32.
diff --git a/docs/class_go_rogue_1_1_advanced_spatial_map.html b/docs/class_go_rogue_1_1_advanced_spatial_map.html index 8cda31a5..5d6763d9 100644 --- a/docs/class_go_rogue_1_1_advanced_spatial_map.html +++ b/docs/class_go_rogue_1_1_advanced_spatial_map.html @@ -246,7 +246,7 @@

AdvancedSpatialMap.

Parameters
- +
comparerEquality comparer to use for comparison and hashing of type T. Be mindful of the efficiency of this instances GetHashCode function, as it will determine the efficiency of many AdvancedSpatialMap functions.
comparerEquality comparer to use for comparison and hashing of type T. Be mindful of the efficiency of this instances GetHashCode function, as it will determine the efficiency of many AdvancedSpatialMap functions.
initialCapacityThe initial maximum number of elements the SpatialMap can hold before it has to internally resize data structures. Defaults to 32.
diff --git a/docs/class_go_rogue_1_1_f_o_v.html b/docs/class_go_rogue_1_1_f_o_v.html index 519e0207..d1c5f22c 100644 --- a/docs/class_go_rogue_1_1_f_o_v.html +++ b/docs/class_go_rogue_1_1_f_o_v.html @@ -152,6 +152,9 @@  Array-style indexer that takes an x and y value as the index, and retrieves the FOV value at the given location. More...
  - Properties inherited from GoRogue.IReadOnlyFOV +IMapView< bool > BooleanFOV [get] + A view of the FOV results in boolean form, where true indicates a location is in FOV, and false indicates it is not. More...
+  IEnumerable< Coord > CurrentFOV [get]  IEnumerable of only positions currently in FOV. More...
  @@ -161,9 +164,6 @@ IEnumerable< Coord > NewlyUnseen [get]  IEnumerable of positions that are NOT in FOV as of the most current Calculate call, but WERE in FOV after the previous time Calculate was called. More...
  -IMapView< bool > BooleanFOV [get] - A view of the FOV results in boolean form, where true indicates a location is in FOV, and false indicates it is not. More...
-  - Properties inherited from GoRogue.MapViews.IMapView< double > int Height [get]  The height of the map being represented. More...
diff --git a/docs/class_go_rogue_1_1_game_framework_1_1_game_object.html b/docs/class_go_rogue_1_1_game_framework_1_1_game_object.html index 1bc8cf12..2b748888 100644 --- a/docs/class_go_rogue_1_1_game_framework_1_1_game_object.html +++ b/docs/class_go_rogue_1_1_game_framework_1_1_game_object.html @@ -104,27 +104,27 @@ - - - - - - - - - - - - + + + + + + + + + + + + - - - + + + @@ -142,8 +142,7 @@

Properties

virtual Coord Position [get, set]
 The position of this object on the grid. Any time this value is changed, the Moved event is fired. More...
 
virtual bool IsWalkable [get, set]
 Whether or not the object is to be considered "walkable", eg. whether or not the square it resides on can be traversed by other, non-walkable objects on the same map. Effectively, whether or not this object collides according to the collision layer. More...
 
virtual bool IsTransparent [get, set]
 Whether or not the object is considered "transparent", eg. whether or not light passes through it for the sake of a Map's FOV. More...
 
bool IsStatic [get]
 Whether or not the object is "static". Static objects CANNOT be moved, and only static objects may be placed on a Map's layer 0. More...
 
Map< BaseSubclass > CurrentMap [get, set]
 The current Map which this object resides on. Null if the object has not been assigned an object. A GameObject is allowed to reside on only one map. More...
 
uint ID [get]
 ID of the object. Used for the sake of putting instances of this class in ISpatialMap implementations, and is NOT guaranteed to be entirely unique, though this can be modified by overriding the GenerateID function. More...
 
bool IsStatic [get]
 Whether or not the object is "static". Static objects CANNOT be moved, and only static objects may be placed on a Map's layer 0. More...
 
virtual bool IsTransparent [get, set]
 Whether or not the object is considered "transparent", eg. whether or not light passes through it for the sake of a Map's FOV. More...
 
virtual bool IsWalkable [get, set]
 Whether or not the object is to be considered "walkable", eg. whether or not the square it resides on can be traversed by other, non-walkable objects on the same map. Effectively, whether or not this object collides according to the collision layer. More...
 
int Layer [get]
 Layer of a Map that this object can reside on. More...
 
Map< BaseSubclass > CurrentMap [get, set]
 The current Map which this object resides on. Null if the object has not been assigned an object. A GameObject is allowed to reside on only one map. More...
 
virtual Coord Position [get, set]
 The position of this object on the grid. Any time this value is changed, the Moved event is fired. More...
 
- Properties inherited from GoRogue.IHasID
uint ID [get]
 ID assigned to this entity. More...

Detailed Description

Base class for any object that has a grid position and can be added to a Map. BaseSubclass must be the type that is deriving from this types, eg. class MyDerivingGameObject : GameObject<MyDerivingGameObject>

-

This class is designed to serve as a base class for your own game objects in your game. It implements basic common functionality such as walkability and transparency, and provides some infrastructure that allows it to be added to instances of Map<GameObject<BaseSubclass>>. It also implements the necessary functionality that allows GameObjects to be added to an ISpatialMap implementation.

-

It is intended that you create a class (say, MyGameObject), that derives from this one (GameObject<MyGameObject>), and use this as the base class for your game's objects. This way, a Map<MyGameObject> class will return its objects as type MyGameObject, meaning you can implement any common, game-specific functionality you need and have easy access to that information when objects are retrieved from the map.

+

This class is designed to serve as a base class for your own game objects in your game. It implements basic common functionality such as walkability and transparency, and provides some infrastructure that allows it to be added to instances of Map<GameObject<BaseSubclass>>. It also implements the necessary functionality that allows GameObjects to be added to an ISpatialMap implementation. /// It is intended that you create a class (say, MyGameObject), that derives from this one (GameObject<MyGameObject>), and use this as the base class for your game's objects. This way, a Map<MyGameObject> class will return its objects as type MyGameObject, meaning you can implement any common, game-specific functionality you need and have easy access to that information when objects are retrieved from the map.

Template Parameters
@@ -208,9 +207,9 @@

- - - + + +
BaseSubclassType of the class that is deriving from this one.
positionPosition to start the object at.
layerThe layer of of a Map the object is assigned to.
isStaticWhether or not the object can be moved (true if the object CANNOT be moved, false otherwise).
isWalkableWhether or not the object is considered "transparent", eg. whether or not light passes through it for the sake of a Map's FOV.
isTransparentWhether or not the object is considered "transparent", eg. whether or not light passes through it for the sake of a Map's FOV.
isStaticWhether or not the object can be moved (true if the object CANNOT be moved, false otherwise).
isWalkableWhether or not the object is considered "transparent", eg. whether or not light passes through it for the sake of a Map's FOV.
isTransparentWhether or not the object is considered "transparent", eg. whether or not light passes through it for the sake of a Map's FOV.
diff --git a/docs/class_go_rogue_1_1_game_framework_1_1_map.html b/docs/class_go_rogue_1_1_game_framework_1_1_map.html index 60f48dda..be7c0e1a 100644 --- a/docs/class_go_rogue_1_1_game_framework_1_1_map.html +++ b/docs/class_go_rogue_1_1_game_framework_1_1_map.html @@ -141,27 +141,27 @@ - - - + + + - - - - - - + + + + + + @@ -174,42 +174,40 @@

Public Attributes

IMapView< BaseObject > Terrain => _terrain
 Terrain of the map. Terrain at each location may be set via the SetTerrain function. More...
 
ArrayMap< bool > Explored
 Whether or not each tile is considered explored. Tiles start off unexplored, and become explored as soon as they are within a calculated FOV. This ArrayMap may also have values set to it, to easily allow for serialization or wizard-mode like functionality. More...
 
Distance DistanceMeasurement => AStar.DistanceMeasurement
 Distance measurement used for pathing and measuring distance on the map. More...
 
IReadOnlyLayeredSpatialMap< BaseObject > Entities => _entities.AsReadOnly()
 IReadOnlyLayeredSpatialMap of all entities (non-terrain objects) on the map. More...
 
LayerMasker LayerMasker => _entities.LayerMasker
 LayerMasker that should be used to create layer masks for this Map. More...
 
IReadOnlyFOV FOV => _fov.AsReadOnly()
 Current FOV results for the map. Calculate FOV via the Map's CalculateFOV functions. More...
 
Distance DistanceMeasurement => AStar.DistanceMeasurement
 Distance measurement used for pathing and measuring distance on the map. More...
 
int Height => _terrain.Height
 Height of the map, in grid spaces. More...
 
LayerMasker LayerMasker => _entities.LayerMasker
 LayerMasker that should be used to create layer masks for this Map. More...
 
IMapView< BaseObject > Terrain => _terrain
 Terrain of the map. Terrain at each location may be set via the SetTerrain function. More...
 
int Width => _terrain.Width
 Width of the map, in grid spaces. More...
 
- - - + + + + + + - - -

Properties

uint LayersBlockingWalkability [get]
 Layer mask that contains only layers that block walkability. A non-walkable BaseObject can only be added to this map if the layer it is on is contained within this layer mask. More...
 
AStar AStar [get]
 AStar pathfinder for the map. Uses WalkabilityView to determine which locations can be reached. More...
 
uint LayersBlockingTransparency [get]
 Layer mask that contains only layers that block transparency. A non-transparent BaseObject can only be added to this map if the layer it is on is contained within this layer mask. More...
 
uint LayersBlockingWalkability [get]
 Layer mask that contains only layers that block walkability. A non-walkable BaseObject can only be added to this map if the layer it is on is contained within this layer mask. More...
 
IMapView< bool > TransparencyView [get]
 IMapView representing transparency values for each tile. Each location is true if the location is transparent (there are no non-transparent objects at that location), false otherwise. More...
 
IMapView< bool > WalkabilityView [get]
 IMapView representing walkability values for each tile. Each location is true if the location is walkable (there are no non-walkable objects at that location), false otherwise. More...
 
AStar AStar [get]
 AStar pathfinder for the map. Uses WalkabilityView to determine which locations can be reached. More...
 
- - - + + +

Events

EventHandler< ItemEventArgs< BaseObject > > ObjectAdded
 Event that is fired whenever some object is added to the map. More...
 
EventHandler< ItemEventArgs< BaseObject > > ObjectRemoved
 Event that is fired whenever some object is removed from the map. More...
 
EventHandler< ItemMovedEventArgs< BaseObject > > ObjectMoved
 Event that is fired whenever some object that is part of the map is successfully moved. More...
 
EventHandler< ItemEventArgs< BaseObject > > ObjectRemoved
 Event that is fired whenever some object is removed from the map. More...
 

Detailed Description

Base class for a map that consists of one or more objects of type BaseObject. It implements basic functionality to manage these objects, as well as commonly needed functinonality like tile exploration, FOV, and pathfinding. BaseObject must be a type that derives from GameObject<BaseObject>.

-

A Map consists of BaseObjects on one or more layers. These layers are numbered, from the lowest layer of 0 upward. Each Map contains at minimum a "terrain" layer. This is considered to be layer 0. All objects added to this layer must have their IsStatic flag set to true, and must reside on layer 0.

-

A map will typically also have some other layers, for non terrain objects like the player, monsters, items, etc. The number of these layers present on the map, along with which of all the layers participate in collision detection, etc., can be specified in the constructor.

-

While this class has some flexibility, it does, unlike the rest of the library, tend to impose itself on your architecture. In cases where this is undesireable, each component of this map class exists as a separate component (layer masking, the SpatialMap(s) storing the entity layers, FOV, and pathfinding all exist as their own (more flexible) components). This class is not intended to cover every possible use case, but instead may act as an example or starting point in the case where you would like to use the components in a different way or within a different architecture.

+

A Map consists of BaseObjects on one or more layers. These layers are numbered, from the lowest layer of 0 upward. Each Map contains at minimum a "terrain" layer. This is considered to be layer 0. All objects added to this layer must have their IsStatic flag set to true, and must reside on layer 0. /// A map will typically also have some other layers, for non terrain objects like the player, monsters, items, etc. The number of these layers present on the map, along with which of all the layers participate in collision detection, etc., can be specified in the constructor. /// While this class has some flexibility, it does, unlike the rest of the library, tend to impose itself on your architecture. In cases where this is undesireable, each component of this map class exists as a separate component (layer masking, the SpatialMap(s) storing the entity layers, FOV, and pathfinding all exist as their own (more flexible) components). This class is not intended to cover every possible use case, but instead may act as an example or starting point in the case where you would like to use the components in a different way or within a different architecture.

Template Parameters
- +
BaseObjectThe class deriving from GameObject that this map will hold.
BaseObjectThe class deriving from GameObject that this map will hold.
@@ -284,10 +282,10 @@

widthWidth of the map. heightHeight of the map. numberOfEntityLayersNumber of non-terrain layers for the map. - distanceMeasurementDistance measurement to use for pathing/measuring distance on the map. - layersBlockingWalkabilityLayer mask containing those layers that should be allowed to have items that block walkability. Defaults to all layers. - layersBlockingTransparencyLayer mask containing those layers that should be allowed to have items that block FOV. Defaults to all layers. - entityLayersSupportingMultipleItemsLayer mask containing those layers that should be allowed to have multiple objects at the same location on the same layer. Defaults to no layers. + distanceMeasurementDistance measurement to use for pathing/measuring distance on the map. + layersBlockingWalkabilityLayer mask containing those layers that should be allowed to have items that block walkability. Defaults to all layers. + layersBlockingTransparencyLayer mask containing those layers that should be allowed to have items that block FOV. Defaults to all layers. + entityLayersSupportingMultipleItemsLayer mask containing those layers that should be allowed to have multiple objects at the same location on the same layer. Defaults to no layers.

@@ -347,12 +345,12 @@

Parameters
- + - - - - + + + +
terrainLayerThe ISettableMapView that represents the terrain layer for this map. It is intended that this be modified ONLY via the SetTerrain function – if it is modified outside of that, the ItemAdded/Removed events are NOT guaranteed to be called!
terrainLayerThe ISettableMapView that represents the terrain layer for this map. It is intended that this be modified ONLY via the SetTerrain function – if it is modified outside of that, the ItemAdded/Removed events are NOT guaranteed to be called!
numberOfEntityLayersNumber of non-terrain layers for the map.
distanceMeasurementDistance measurement to use for pathing/measuring distance on the map.
layersBlockingWalkabilityLayer mask containing those layers that should be allowed to have items that block walkability. Defaults to all layers.
layersBlockingTransparencyLayer mask containing those layers that should be allowed to have items that block FOV. Defaults to all layers.
entityLayersSupportingMultipleItemsLayer mask containing those layers that should be allowed to have multiple objects at the same location on the same layer. Defaults to no layers.
distanceMeasurementDistance measurement to use for pathing/measuring distance on the map.
layersBlockingWalkabilityLayer mask containing those layers that should be allowed to have items that block walkability. Defaults to all layers.
layersBlockingTransparencyLayer mask containing those layers that should be allowed to have items that block FOV. Defaults to all layers.
entityLayersSupportingMultipleItemsLayer mask containing those layers that should be allowed to have multiple objects at the same location on the same layer. Defaults to no layers.

@@ -505,7 +503,7 @@

positionThe center point of the new FOV to calculate. radiusThe radius of the FOV. Defaults to infinite. - radiusShapeThe shape of the FOV to calculate. Can be specified as either Distance or Radius types (they are implicitly convertible). + radiusShapeThe shape of the FOV to calculate. Can be specified as either Distance or Radius types (they are implicitly convertible). @@ -556,7 +554,7 @@

xX-value of the center point for the new FOV to calculate. yY-value of the center point for the new FOV to calculate. radiusThe radius of the FOV. Defaults to infinite. - radiusShapeThe shape of the FOV to calculate. Can be specified as either Distance or Radius types (they are implicitly convertible). + radiusShapeThe shape of the FOV to calculate. Can be specified as either Distance or Radius types (they are implicitly convertible). @@ -612,9 +610,9 @@

positionThe center point of the new FOV to calculate. radiusThe radius of the FOV. Defaults to infinite. - radiusShapeThe shape of the FOV to calculate. Can be specified as either Distance or Radius types (they are implicitly convertible). + radiusShapeThe shape of the FOV to calculate. Can be specified as either Distance or Radius types (they are implicitly convertible). angleThe angle in degrees the FOV cone faces. 0 degrees points right. - spanThe angle in degrees specifying the full arc of the FOV cone. span/2 degrees on either side of the given angle are included in the cone. + spanThe angle in degrees specifying the full arc of the FOV cone. span/2 degrees on either side of the given angle are included in the cone. @@ -677,9 +675,9 @@

xX-value of the center point for the new FOV to calculate. yY-value of the center point for the new FOV to calculate. radiusThe radius of the FOV. Defaults to infinite. - radiusShapeThe shape of the FOV to calculate. Can be specified as either Distance or Radius types (they are implicitly convertible). + radiusShapeThe shape of the FOV to calculate. Can be specified as either Distance or Radius types (they are implicitly convertible). angleThe angle in degrees the FOV cone faces. 0 degrees points right. - spanThe angle in degrees specifying the full arc of the FOV cone. span/2 degrees on either side of the given angle are included in the cone. + spanThe angle in degrees specifying the full arc of the FOV cone. span/2 degrees on either side of the given angle are included in the cone. @@ -716,11 +714,11 @@

Parameters
- +
positionPosition to get object for.
layerMaskLayer mask for which layers can return an object. Defaults to all layers.
layerMaskLayer mask for which layers can return an object. Defaults to all layers.
-
Returns
The first object encountered, moving from the highest existing layer in the layer mask downward.
+
Returns
The first object encountered, moving from the highest existing layer in the layer mask downward.
@@ -761,11 +759,11 @@

xX-value of the position to get object for. yY-value of the position to get object for. - layerMaskLayer mask for which layers can return an object. Defaults to all layers. + layerMaskLayer mask for which layers can return an object. Defaults to all layers. -
Returns
The first object encountered, moving from the highest existing layer in the layer mask downward.
+
Returns
The first object encountered, moving from the highest existing layer in the layer mask downward.
@@ -799,11 +797,11 @@

Parameters
- +
positionPosition to get objects for.
layerMaskLayer mask for which layers can return an object. Defaults to all layers.
layerMaskLayer mask for which layers can return an object. Defaults to all layers.
-
Returns
All objects encountered at the given position, in order from the highest existing layer in the mask downward.
+
Returns
All objects encountered at the given position, in order from the highest existing layer in the mask downward.
@@ -844,11 +842,11 @@

xX-value of the position to get objects for. yY-value of the position to get objects for. - layerMaskLayer mask for which layers can return an object. Defaults to all layers. + layerMaskLayer mask for which layers can return an object. Defaults to all layers. -
Returns
All objects encountered at the given position, in order from the highest existing layer in the mask downward.
+
Returns
All objects encountered at the given position, in order from the highest existing layer in the mask downward.
@@ -940,7 +938,7 @@

Returns
True if the entity was removed successfully, false otherwise (eg, the entity was not part of this map).
+
Returns
True if the entity was removed successfully, false otherwise (eg, the entity was not part of this map).
@@ -1102,7 +1100,7 @@

Returns
All objects at the given location, in order from highest layer to lowest layer.
+
Returns
All objects at the given location, in order from highest layer to lowest layer.
@@ -1126,7 +1124,7 @@

Returns
All objects at the given location, in order from highest layer to lowest layer.
+
Returns
All objects at the given location, in order from highest layer to lowest layer.
diff --git a/docs/class_go_rogue_1_1_i_d_comparer-members.html b/docs/class_go_rogue_1_1_i_d_comparer-members.html deleted file mode 100644 index 075df2d4..00000000 --- a/docs/class_go_rogue_1_1_i_d_comparer-members.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -GoRogue: Member List - - - - - - - - - - -
-
-
GoRogue.IDComparer< T > Member List
-
-
- -

This is the complete list of members for GoRogue.IDComparer< T >, including all inherited members.

- - - -
Equals(T x, T y)GoRogue.IDComparer< T >
GetHashCode(T obj)GoRogue.IDComparer< T >
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/class_go_rogue_1_1_i_d_comparer.html b/docs/class_go_rogue_1_1_i_d_comparer.html deleted file mode 100644 index bbb7f074..00000000 --- a/docs/class_go_rogue_1_1_i_d_comparer.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - - -GoRogue: GoRogue.IDComparer< T > Class Template Reference - - - - - - - - - -
-
- - - - - - -
-
GoRogue -
-
C# roguelike/2D game utility library.
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -List of all members
-
-
GoRogue.IDComparer< T > Class Template Reference
-
-
- -

Class intended for comparing/hashing objects that implement IHasID. Type T must be a reference type. - More...

-
-Inheritance diagram for GoRogue.IDComparer< T >:
-
-
- - - -
- - - - - - - - -

-Public Member Functions

bool Equals (T x, T y)
 Equality comparison. Performs comparison via the object's ReferenceEquals function. More...
 
int GetHashCode (T obj)
 Generates a hash based on the object's ID.GetHashCode() function. More...
 
-

Detailed Description

-

Class intended for comparing/hashing objects that implement IHasID. Type T must be a reference type.

-
Template Parameters
- - -
TType of object being compared. Type T must be a reference type that implements IHasID.
-
-
-
-
Type Constraints
- - - -
T :class 
T :IHasID 
-
-
-
-

Member Function Documentation

- -

§ Equals()

- -
-
- - - - - - - - - - - - - - - - - - -
bool GoRogue.IDComparer< T >.Equals (T x,
T y 
)
-
- -

Equality comparison. Performs comparison via the object's ReferenceEquals function.

-
Parameters
- - - -
xFirst object to compare.
ySecond object to compare.
-
-
-
Returns
True if the objects are considered equal, false otherwise.
- -
-
- -

§ GetHashCode()

- -
-
- - - - - - - - -
int GoRogue.IDComparer< T >.GetHashCode (T obj)
-
- -

Generates a hash based on the object's ID.GetHashCode() function.

-
Parameters
- - -
objObject to generate the hash for.
-
-
-
Returns
The hash of the object, based on its ID.
- -
-
-
The documentation for this class was generated from the following file:
    -
  • GoRogue/ISpatialMap.cs
    • -
-
- -
-Generated by   -doxygen - 1.8.12 -
- - diff --git a/docs/class_go_rogue_1_1_i_d_comparer.png b/docs/class_go_rogue_1_1_i_d_comparer.png deleted file mode 100644 index 126ee292..00000000 Binary files a/docs/class_go_rogue_1_1_i_d_comparer.png and /dev/null differ diff --git a/docs/class_go_rogue_1_1_layer_masker.html b/docs/class_go_rogue_1_1_layer_masker.html index 723d49f4..1e713fb0 100644 --- a/docs/class_go_rogue_1_1_layer_masker.html +++ b/docs/class_go_rogue_1_1_layer_masker.html @@ -82,30 +82,30 @@  LayerMasker (int numberOfLayers=32)  Constructor. Takes the number of layers allowed, which must be more than 0 and less than or equal to 32. More...
  -uint Mask (params int[] layers) - Gets a layer mask including exactly the given layer indices. Any layer given outside the maximum number of layers is ignored, and will not be added to the resulting mask. More...
-  -uint Mask (IEnumerable< int > layers) - Gets a layer mask including exactly the given layer indices. Any layer given outside the maximum number of layers is ignored, and will not be added to the resulting mask. More...
-  uint AddLayers (uint mask, params int[] layers)  Adds the given layers to the given layer mask, provided those layers are within the supported number of layers. Any layer outside of this range will not be added. More...
  uint AddLayers (uint mask, IEnumerable< int > layers)  Adds the given layers to the given layer mask, provided those layers are within the supported number of layers. Any layer outside of this range will not be added. More...
  -uint MaskAllBelow (int layer) - Generates and returns a layer mask including the given layer and any layer below (less than) it. Layers not in the supported number of layers will be ignored, and will not be added to the resulting layer mask. More...
-  -uint MaskAllAbove (int layer) - Generates and returns a layer mask including the given layer and any layer above (greater than) it. Layers not in the supported number of layers will be ignored, and will not be added to the resulting layer mask. More...
-  bool HasLayer (uint mask, int layer)  Returns whether or not a layer is contained within the given layer mask. Returns false if the layer given is outside the supported number of layers. More...
  IEnumerable< int > Layers (uint mask)  Returns an IEnumerable of all layers contained within the given layer mask (that fall within the supported number of layers). More...
  +uint Mask (params int[] layers) + Gets a layer mask including exactly the given layer indices. Any layer given outside the maximum number of layers is ignored, and will not be added to the resulting mask. More...
+  +uint Mask (IEnumerable< int > layers) + Gets a layer mask including exactly the given layer indices. Any layer given outside the maximum number of layers is ignored, and will not be added to the resulting mask. More...
+  +uint MaskAllAbove (int layer) + Generates and returns a layer mask including the given layer and any layer above (greater than) it. Layers not in the supported number of layers will be ignored, and will not be added to the resulting layer mask. More...
+  +uint MaskAllBelow (int layer) + Generates and returns a layer mask including the given layer and any layer below (less than) it. Layers not in the supported number of layers will be ignored, and will not be added to the resulting layer mask. More...
+  @@ -192,7 +192,7 @@

Returns
A layer mask including any original layers that were in the given mask (regardless of whether they were within the supported number of layers), as well as the new layers provided (provided they are within the supported number of layers).
+
Returns
A layer mask including any original layers that were in the given mask (regardless of whether they were within the supported number of layers), as well as the new layers provided (provided they are within the supported number of layers).
@@ -230,7 +230,7 @@

Returns
A layer mask including any original layers that were in the given mask (regardless of whether they were within the supported number of layers), as well as the new layers provided (provided they are within the supported number of layers).
+
Returns
A layer mask including any original layers that were in the given mask (regardless of whether they were within the supported number of layers), as well as the new layers provided (provided they are within the supported number of layers).
@@ -268,7 +268,7 @@

Returns
True if the given layer is present in the given layer mask, false if it is not or the layer is outside the supported number of layers for this LayerMasker.
+
Returns
True if the given layer is present in the given layer mask, false if it is not or the layer is outside the supported number of layers for this LayerMasker.
@@ -295,7 +295,7 @@

Returns
All layers contained within the given layer mask that fall within the supported number of layers for this LayerMasker.
+
Returns
All layers contained within the given layer mask that fall within the supported number of layers for this LayerMasker.
@@ -322,7 +322,7 @@

Returns
A layer mask including exactly those layers in the input that were within the supported number of layers.
+
Returns
A layer mask including exactly those layers in the input that were within the supported number of layers.
@@ -349,7 +349,7 @@

Returns
A layer mask including exactly those layers in the input that were within the supported number of layers.
+
Returns
A layer mask including exactly those layers in the input that were within the supported number of layers.
@@ -376,7 +376,7 @@

Returns
A layer mask including the specified layer and all layers above it, provided those layers fall within the supported number of layers.
+
Returns
A layer mask including the specified layer and all layers above it, provided those layers fall within the supported number of layers.
@@ -403,7 +403,7 @@

Returns
A layer mask including the specified layer and all layers below it, provided those layers fall within the supported number of layers.
+
Returns
A layer mask including the specified layer and all layers below it, provided those layers fall within the supported number of layers.
diff --git a/docs/class_go_rogue_1_1_layered_spatial_map.html b/docs/class_go_rogue_1_1_layered_spatial_map.html index 0aec477e..daeae253 100644 --- a/docs/class_go_rogue_1_1_layered_spatial_map.html +++ b/docs/class_go_rogue_1_1_layered_spatial_map.html @@ -96,21 +96,45 @@

- - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -132,56 +156,32 @@ - - - - - - - - - - - - - - - - - - - - - - - -

Public Attributes

 AdvancedLayeredSpatialMap (IEqualityComparer< T > comparer, int numberOfLayers, int startingLayer=0, uint layersSupportingMultipleItems=0)
 Constructor. Takes a comparator to use, number of layers to include, as well as a starting layer index (defaulting to 0) and a layer mask indicating which layers support multiple items at a single position (defaulting to no layers). More...
 
IReadOnlySpatialMap< T > GetLayer (int layer)
 Gets a read-only spatial map representing the layer given. More...
 
IEnumerable< IReadOnlySpatialMap< T > > GetLayers (uint layerMask=uint.MaxValue)
 Returns read-only spatial maps that represent each layer included in the given layer mask. Defaults to all layers. More...
 
bool Add (T newItem, Coord position)
 Adds the given item at the given position. Item is automatically added to correct layer. More...
 
bool Add (T newItem, int x, int y)
 Adds the given item at the given position, or returns false if the item cannot be added. Item is automatically added to correct layer. More...
 
IReadOnlyLayeredSpatialMap< T > AsReadOnly ()
 Returns a read-only reference to the data structure. Convenient for "safely" exposing the structure as a property. More...
 
void Clear ()
 Clears all items from all layers. More...
 
bool Contains (T item)
 Returns whether or not the data structure contains the given item. More...
 
bool Contains (Coord position, uint layerMask=uint.MaxValue)
 Returns whether or not there is an item in the data structure at the given position that is on a layer included in the given layer mask. Defaults to searching on all layers. More...
 
bool Contains (int x, int y, uint layerMask=uint.MaxValue)
 Returns whether or not there is an item in the data structure at the given position, that is on a layer included in the given layer mask. More...
 
IEnumerator< ISpatialTuple< T > > GetEnumerator ()
 Used by foreach loop, so that the class will give ISpatialTuple objects when used in a foreach loop. Generally should never be called explicitly. More...
 
IEnumerable< T > GetItems (Coord position, uint layerMask=uint.MaxValue)
 Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
 
IEnumerable< T > GetItems (int x, int y, uint layerMask=uint.MaxValue)
 Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
 
IReadOnlySpatialMap< T > GetLayer (int layer)
 Gets a read-only spatial map representing the layer given. More...
 
IEnumerable< IReadOnlySpatialMap< T > > GetLayers (uint layerMask=uint.MaxValue)
 Returns read-only spatial maps that represent each layer included in the given layer mask. Defaults to all layers. More...
 
Coord GetPosition (T item)
 Gets the position associated with the item in the data structure, or null if that item is not found. More...
 
bool Move (T item, Coord target)
 Moves the given item to the given position, or returns false if the item cannot be moved. More...
 
IEnumerable< T > Remove (int x, int y, uint layerMask=uint.MaxValue)
 Removes all items at the specified location that are on any layer included in the given layer mask from the data structure. Returns any items that were removed. Defaults to all layers. More...
 
IReadOnlyLayeredSpatialMap< T > AsReadOnly ()
 Returns a read-only reference to the data structure. Convenient for "safely" exposing the structure as a property. More...
 
bool Contains (T item)
 Returns whether or not the data structure contains the given item. More...
 
bool Contains (Coord position, uint layerMask=uint.MaxValue)
 Returns whether or not there is an item in the data structure at the given position that is on a layer included in the given layer mask. Defaults to searching on all layers. More...
 
bool Contains (int x, int y, uint layerMask=uint.MaxValue)
 Returns whether or not there is an item in the data structure at the given position, that is on a layer included in the given layer mask. More...
 
IEnumerable< T > GetItems (Coord position, uint layerMask=uint.MaxValue)
 Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
 
IEnumerable< T > GetItems (int x, int y, uint layerMask=uint.MaxValue)
 Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
 
Coord GetPosition (T item)
 Gets the position associated with the item in the data structure, or null if that item is not found. More...
 
IEnumerator< ISpatialTuple< T > > GetEnumerator ()
 Used by foreach loop, so that the class will give ISpatialTuple objects when used in a foreach loop. Generally should never be called explicitly. More...
 
+ + + - - - - - - - - - + + + + + + @@ -193,18 +193,18 @@ - - - - - - + + + + + + @@ -231,7 +231,7 @@

This class is desinged to wrap a bunch of ISpatialMap instances together. At creation, whether or not each layer supports multiple items at the same location is specified via a layer mask.. One spatial map represents one layer of a map (items, monsters, etc). This class provides read-only access to each layer, as well as functions to add/remove/move items, do item grabbing based on layers, etc. Will not allow the same item to be added to multiple layers.

Template Parameters

Additional Inherited Members

- Public Attributes inherited from GoRogue.AdvancedLayeredSpatialMap< T >
int Count => _layers.Sum(map => map.Count)
 Gets the number of entities on all layers. More...
 
IEnumerable< IReadOnlySpatialMap< T > > Layers => _layers
 Gets read-only spatial maps representing each layer. To access a specific layer, instead use GetLayer. More...
 
int NumberOfLayers => _layers.Length
 Gets the number of layers represented. More...
 
int Count => _layers.Sum(map => map.Count)
 Gets the number of entities on all layers. More...
 
- Properties inherited from GoRogue.AdvancedLayeredSpatialMap< T >
int StartingLayer [get]
 Starting index for layers included in theis LayeredSpatialMap. Specified at construction. More...
 
LayerMasker LayerMasker [get]
 Object that helps get layer masks as they pertain to this LayeredSpatialMap More...
 
IEnumerable< T > Items [get]
 Gets all the items on all layers. More...
 
LayerMasker LayerMasker [get]
 Object that helps get layer masks as they pertain to this LayeredSpatialMap More...
 
IEnumerable< Coord > Positions [get]
 Gets all positions that have items for each layer. No positions are duplicated if multiple layers have an item at a position. More...
 
int StartingLayer [get]
 Starting index for layers included in theis LayeredSpatialMap. Specified at construction. More...
 
- Properties inherited from GoRogue.IReadOnlySpatialMap< T >
int Count [get]
 The number of items in the data structure. More...
 Enumerable of all positions that contain items. Likely this won't be used as much, since most objects that are contained in a spatial map implementation will record their position as a member, however in case that is not the case for a particular use, or just as a convenience if you only care about the coordinates, this is provided. More...
 
- Properties inherited from GoRogue.IReadOnlyLayeredSpatialMap< T >
int StartingLayer [get]
 Starting index for layers included in this structure. More...
 
IEnumerable< IReadOnlySpatialMap< T > > Layers [get]
 Gets read-only spatial maps representing each layer. To access a specific layer, instead use GetLayer. More...
 
LayerMasker LayerMasker [get]
 Object that helps get layer masks as they pertain to this LayeredSpatialMap More...
 
IEnumerable< IReadOnlySpatialMap< T > > Layers [get]
 Gets read-only spatial maps representing each layer. To access a specific layer, instead use GetLayer. More...
 
int NumberOfLayers [get]
 Gets the number of layers represented. More...
 
int StartingLayer [get]
 Starting index for layers included in this structure. More...
 
- Events inherited from GoRogue.AdvancedLayeredSpatialMap< T >
EventHandler< ItemEventArgs< T > > ItemAdded
 Fires whenever an item is added to any layer. More...
- +
TType of items in the layers. Type T must implement IHasID and IHasLayer, must be a reference type, and its IHasLayer.Layer value MUST NOT change while the item is in the LayeredSpatialMap.
TType of items in the layers. Type T must implement IHasID and IHasLayer, must be a reference type, and its IHasLayer.Layer value MUST NOT change while the item is in the LayeredSpatialMap.
@@ -284,7 +284,7 @@

numberOfLayersNumber of layers to include. startingLayerIndex to use for the first layer. - layersSupportingMultipleItemsA layer mask indicating which layers should support multiple items residing at the same location on that layer. Defaults to no layers. + layersSupportingMultipleItemsA layer mask indicating which layers should support multiple items residing at the same location on that layer. Defaults to no layers. diff --git a/docs/class_go_rogue_1_1_map_generation_1_1_connectors_1_1_room_door_connector.html b/docs/class_go_rogue_1_1_map_generation_1_1_connectors_1_1_room_door_connector.html index 54ef1f6d..c544ba7c 100644 --- a/docs/class_go_rogue_1_1_map_generation_1_1_connectors_1_1_room_door_connector.html +++ b/docs/class_go_rogue_1_1_map_generation_1_1_connectors_1_1_room_door_connector.html @@ -157,9 +157,9 @@

roomsA collection of rooms to process. minSidesToConnectMinimum sides of the room to process. Defaults to 1. maxSidesToConnectMaximum sides of the room to process. Defaults to 4. - cancelSideConnectionSelectChanceA chance out of 100 to cancel selecting sides to process (per room). Defaults to 50. - cancelConnectionPlacementChanceA chance out of 100 to cancel placing a door on a side after one has been placed (per room). Defaults to 70. - cancelConnectionPlacementChanceIncreaseIncrease the cancelConnectionPlacementChance value by this amount each time a door is placed (per room). Defaults to 10. + cancelSideConnectionSelectChanceA chance out of 100 to cancel selecting sides to process (per room). Defaults to 50. + cancelConnectionPlacementChanceA chance out of 100 to cancel placing a door on a side after one has been placed (per room). Defaults to 70. + cancelConnectionPlacementChanceIncreaseIncrease the cancelConnectionPlacementChance value by this amount each time a door is placed (per room). Defaults to 10. @@ -245,9 +245,9 @@

roomsA collection of rooms to process. minSidesToConnectMinimum sides of the room to process. Defaults to 1. maxSidesToConnectMaximum sides of the room to process. Defaults to 4. - cancelSideConnectionSelectChanceA chance out of 100 to cancel selecting sides to process (per room). Defaults to 50. - cancelConnectionPlacementChanceA chance out of 100 to cancel placing a door on a side after one has been placed (per room). Defaults to 70. - cancelConnectionPlacementChanceIncreaseIncrease the cancelConnectionPlacementChance value by this amount each time a door is placed (per room). Defaults to 10. + cancelSideConnectionSelectChanceA chance out of 100 to cancel selecting sides to process (per room). Defaults to 50. + cancelConnectionPlacementChanceA chance out of 100 to cancel placing a door on a side after one has been placed (per room). Defaults to 70. + cancelConnectionPlacementChanceIncreaseIncrease the cancelConnectionPlacementChance value by this amount each time a door is placed (per room). Defaults to 10. diff --git a/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html b/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html index 8b532f98..0547cf90 100644 --- a/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html +++ b/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html @@ -216,7 +216,7 @@

Parameters
- + diff --git a/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator-members.html b/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator-members.html index 88a42a4a..dd38ed05 100644 --- a/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator-members.html +++ b/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator-members.html @@ -70,7 +70,8 @@

This is the complete list of members for GoRogue.MapGeneration.Generators.MazeGenerator, including all inherited members.

mapThe map to set values to.
rngThe RNG to use to place rooms and determine room size. If null is specified, the default RNG is used.
rngThe RNG to use to place rooms and determine room size. If null is specified, the default RNG is used.
maxRoomsThe maximum number of rooms to attempt to place on the map.
roomMinSizeThe minimum size in width and height of each room.
roomMaxSizeThe maximum size in width and height of each room.
- + +
Generate(ISettableMapView< bool > map, IGenerator rng=null, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)GoRogue.MapGeneration.Generators.MazeGeneratorstatic
Generate(ISettableMapView< bool > map, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)GoRogue.MapGeneration.Generators.MazeGeneratorstatic
Generate(ISettableMapView< bool > map, IGenerator rng=null, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)GoRogue.MapGeneration.Generators.MazeGeneratorstatic
diff --git a/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html b/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html index 354edf3d..6c5d022c 100644 --- a/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html +++ b/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html @@ -77,6 +77,9 @@ + + + @@ -84,8 +87,60 @@

Detailed Description

Generates a maze, and adds it to the given map.

Member Function Documentation

+ +

§ Generate() [1/2]

+ +
+
+

Static Public Member Functions

static void Generate (ISettableMapView< bool > map, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)
 Generates a maze in map using crawlers that walk the map carving tunnels. More...
 
static void Generate (ISettableMapView< bool > map, IGenerator rng=null, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)
 Generates a maze in map using crawlers that walk the map carving tunnels. More...
 
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
static void GoRogue.MapGeneration.Generators.MazeGenerator.Generate (ISettableMapView< bool > map,
int crawlerChangeDirectionImprovement = 10,
int saveDeadEndChance = 0 
)
+ 		+static
+
+ +

Generates a maze in map using crawlers that walk the map carving tunnels.

+
Parameters
+ + + + +
mapThe map to modify.
crawlerChangeDirectionImprovementOut of 100, how much to increase the chance of the crawler changing direction each step. Once it changes direction, the chance resets to 0 and increases by this amount. Defaults to 10.
saveDeadEndChanceAfter the crawler finishes, the small dead ends will be trimmed out. This value indicates the chance out of 100 that the dead end remains. Defaults to 0.
+
+
+ +
+ -

§ Generate()

+

§ Generate() [2/2]

@@ -135,8 +190,8 @@

mapThe map to modify. rngThe RNG to use. - crawlerChangeDirectionImprovementOut of 100, how much to increase the chance of the crawler changing direction each step. Once it changes direction, the chance resets to 0 and increases by this amount. Defaults to 10. - saveDeadEndChanceAfter the crawler finishes, the small dead ends will be trimmed out. This value indicates the chance out of 100 that the dead end remains. Defaults to 0. + crawlerChangeDirectionImprovementOut of 100, how much to increase the chance of the crawler changing direction each step. Once it changes direction, the chance resets to 0 and increases by this amount. Defaults to 10. + saveDeadEndChanceAfter the crawler finishes, the small dead ends will be trimmed out. This value indicates the chance out of 100 that the dead end remains. Defaults to 0.

diff --git a/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html b/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html index 0c7ab6d3..b5a17e16 100644 --- a/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html +++ b/docs/class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html @@ -170,10 +170,10 @@

maxRoomsMaximum amount of rooms to generate. roomMinSizeThe minimum size of the room. Forces an odd number. roomMaxSizeThe maximum size of the room. Forces an odd number. - roomSizeRatioXThe ratio of the room width to the height. Defaults to 1.0. - roomSizeRatioYThe ratio of the room height to the width. Defaults to 1.0. - maxCreationAttemptsThe max times to re-generate a room that cannot be placed before giving up on placing that room. Defaults to 10. - maxPlacementAttemptsThe max times to attempt to place a room in a map without intersection, before giving up and re-generating that room. Defaults to 10. + roomSizeRatioXThe ratio of the room width to the height. Defaults to 1.0. + roomSizeRatioYThe ratio of the room height to the width. Defaults to 1.0. + maxCreationAttemptsThe max times to re-generate a room that cannot be placed before giving up on placing that room. Defaults to 10. + maxPlacementAttemptsThe max times to attempt to place a room in a map without intersection, before giving up and re-generating that room. Defaults to 10. @@ -272,10 +272,10 @@

maxRoomsMaximum amount of rooms to generate. roomMinSizeThe minimum size of the room. Forces an odd number. roomMaxSizeThe maximum size of the room. Forces an odd number. - roomSizeRatioXThe ratio of the room width to the height. Defaults to 1.0. - roomSizeRatioYThe ratio of the room height to the width. Defaults to 1.0. - maxCreationAttemptsThe max times to re-generate a room that cannot be placed before giving up on placing that room. Defaults to 10. - maxPlacementAttemptsThe max times to attempt to place a room in a map without intersection, before giving up and re-generating that room. Defaults to 10. + roomSizeRatioXThe ratio of the room width to the height. Defaults to 1.0. + roomSizeRatioYThe ratio of the room height to the width. Defaults to 1.0. + maxCreationAttemptsThe max times to re-generate a room that cannot be placed before giving up on placing that room. Defaults to 10. + maxPlacementAttemptsThe max times to attempt to place a room in a map without intersection, before giving up and re-generating that room. Defaults to 10. diff --git a/docs/class_go_rogue_1_1_map_generation_1_1_quick_generators.html b/docs/class_go_rogue_1_1_map_generation_1_1_quick_generators.html index f193ceb8..d58ac331 100644 --- a/docs/class_go_rogue_1_1_map_generation_1_1_quick_generators.html +++ b/docs/class_go_rogue_1_1_map_generation_1_1_quick_generators.html @@ -76,24 +76,25 @@ - - - - - - + + + + + + + + + - + - - -

Static Public Member Functions

static IEnumerable< Rectangle > GenerateRandomRoomsMap (ISettableMapView< bool > map, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom=10)
 Generates a map by attempting to randomly place the specified number of rooms, ranging in size between the specified min size and max size, trying the specified number of times to position a room without overlap before discarding the room entirely. The given map will have a value of false set to all non-passable tiles, and true set to all passable ones. More...
 
static IEnumerable< Rectangle > GenerateRandomRoomsMap (ISettableMapView< bool > map, IGenerator rng, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom=10)
 Generates a map by attempting to randomly place the specified number of rooms, ranging in size between the specified min size and max size, trying the specified number of times to position a room without overlap before discarding the room entirely. The given map will have a value of false set to all non-passable tiles, and true set to all passable ones. More...
 
static IEnumerable< MapArea > GenerateCellularAutomataMap (ISettableMapView< bool > map, IGenerator rng=null, int fillProbability=40, int totalIterations=7, int cutoffBigAreaFill=4)
 Generates a cave-like map using the cellular automata algorithm here: http://www.roguebasin.com/index.php?title=Cellular_Automata_Method_for_Generating_Random_Cave-Like_Levels. See CellularAutomataAreaGenerator for details. This algorithm is identical, except that it connects the areas automatically afterward. More...
 
static IEnumerable<(Rectangle Room, Coord[][] Connections)> GenerateDungeonMazeMap (ISettableMapView< bool > map, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0, int minSidesToConnect=1, int maxSidesToConnect=4, int cancelSideConnectionSelectChance=50, int cancelConnectionPlacementChance=70, int cancelConnectionPlacementChanceIncrease=10)
 Generates a dungeon map based on the process outlined here: http://journal.stuffwithstuff.com/2014/12/21/rooms-and-mazes/. More...
 
static IEnumerable<(Rectangle Room, Coord[][] Connections)> GenerateDungeonMazeMap (ISettableMapView< bool > map, IGenerator rng, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0, int minSidesToConnect=1, int maxSidesToConnect=4, int cancelSideConnectionSelectChance=50, int cancelConnectionPlacementChance=70, int cancelConnectionPlacementChanceIncrease=10)
 Generates a dungeon map based on the process outlined here: http://journal.stuffwithstuff.com/2014/12/21/rooms-and-mazes/. More...
 
static IEnumerable< Rectangle > GenerateRandomRoomsMap (ISettableMapView< bool > map, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom=10)
 Generates a map by attempting to randomly place the specified number of rooms, ranging in size between the specified min size and max size, trying the specified number of times to position a room without overlap before discarding the room entirely. The given map will have a value of false set to all non-passable tiles, and true set to all passable ones. More...
 
static IEnumerable< Rectangle > GenerateRandomRoomsMap (ISettableMapView< bool > map, IGenerator rng, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom=10)
 Generates a map by attempting to randomly place the specified number of rooms, ranging in size between the specified min size and max size, trying the specified number of times to position a room without overlap before discarding the room entirely. The given map will have a value of false set to all non-passable tiles, and true set to all passable ones. More...
 
static void GenerateRectangleMap (ISettableMapView< bool > map)
 Generates a map, as a simple rectangular box, setting the map given as a "walkability map". Wall tiles (the edges of the map) will have a value of false set in the given map, whereas true will be set to all non-wall tiles. More...
 Generates a map, as a simple rectangular box, setting the map given as a "walkability +map". Wall tiles (the edges of the map) will have a value of false set in the given map, whereas true will be set to all non-wall tiles. More...
 
static IEnumerable< MapArea > GenerateCellularAutomataMap (ISettableMapView< bool > map, IGenerator rng=null, int fillProbability=40, int totalIterations=7, int cutoffBigAreaFill=4)
 Generates a cave-like map using the cellular automata algorithm here: http://www.roguebasin.com/index.php?title=Cellular_Automata_Method_for_Generating_Random_Cave-Like_Levels. See CellularAutomataAreaGenerator for details. This algorithm is identical, except that it connects the areas automatically afterward. More...
 

Detailed Description

Collection of algorithms that put map generation pieces together, in ways that allow you to quickly and easily generate a given type of map in a single function call. The implementation of these functions may also be used as the basis for implementing more customized generation processes.

@@ -292,17 +293,17 @@

maxRoomsMaximum amount of rooms to generate. roomMinSizeThe minimum size of the room. Forces an odd number. roomMaxSizeThe maximum size of the room. Forces an odd number. - roomSizeRatioXThe ratio of the room width to the height. Defaults to 1.0. - roomSizeRatioYThe ratio of the room height to the width. Defaults to 1.0. - maxCreationAttemptsThe max times to re-generate a room that cannot be placed before giving up on placing that room. Defaults to 10. - maxPlacementAttemptsThe max times to attempt to place a room in a map without intersection, before giving up and re-generating that room. Defaults to 10. - crawlerChangeDirectionImprovementOut of 100, how much to increase the chance of the crawler changing direction each step during maze generation. Once it changes direction, the chance resets to 0 and increases by this amount. Defaults to 10. - saveDeadEndChanceAfter the maze generation finishes, the small dead ends will be trimmed out. This value indicates the chance out of 100 that the dead end remains. Defaults to 0. + roomSizeRatioXThe ratio of the room width to the height. Defaults to 1.0. + roomSizeRatioYThe ratio of the room height to the width. Defaults to 1.0. + maxCreationAttemptsThe max times to re-generate a room that cannot be placed before giving up on placing that room. Defaults to 10. + maxPlacementAttemptsThe max times to attempt to place a room in a map without intersection, before giving up and re-generating that room. Defaults to 10. + crawlerChangeDirectionImprovementOut of 100, how much to increase the chance of the crawler changing direction each step during maze generation. Once it changes direction, the chance resets to 0 and increases by this amount. Defaults to 10. + saveDeadEndChanceAfter the maze generation finishes, the small dead ends will be trimmed out. This value indicates the chance out of 100 that the dead end remains. Defaults to 0. minSidesToConnectMinimum sides of the room to process. Defaults to 1. maxSidesToConnectMaximum sides of the room to process. Defaults to 4. - cancelSideConnectionSelectChanceA chance out of 100 to cancel selecting sides to process (per room) while we are connecting them. Defaults to 50. - cancelConnectionPlacementChanceA chance out of 100 to cancel placing a door on a side after one has already been placed (per room) during connection.Defaults to 70. - cancelConnectionPlacementChanceIncreaseIncrease the cancelConnectionPlacementChance value by this amount each time a door is placed (per room) during the connection process. Defaults to 10. + cancelSideConnectionSelectChanceA chance out of 100 to cancel selecting sides to process (per room) while we are connecting them. Defaults to 50. + cancelConnectionPlacementChanceA chance out of 100 to cancel placing a door on a side after one has already been placed (per room) during connection.Defaults to 70. + cancelConnectionPlacementChanceIncreaseIncrease the cancelConnectionPlacementChance value by this amount each time a door is placed (per room) during the connection process. Defaults to 10. @@ -444,17 +445,17 @@

maxRoomsMaximum amount of rooms to generate. roomMinSizeThe minimum size of the room. Forces an odd number. roomMaxSizeThe maximum size of the room. Forces an odd number. - roomSizeRatioXThe ratio of the room width to the height. Defaults to 1.0. - roomSizeRatioYThe ratio of the room height to the width. Defaults to 1.0. - maxCreationAttemptsThe max times to re-generate a room that cannot be placed before giving up on placing that room. Defaults to 10. - maxPlacementAttemptsThe max times to attempt to place a room in a map without intersection, before giving up and re-generating that room. Defaults to 10. - crawlerChangeDirectionImprovementOut of 100, how much to increase the chance of the crawler changing direction each step during maze generation. Once it changes direction, the chance resets to 0 and increases by this amount. Defaults to 10. - saveDeadEndChanceAfter the maze generation finishes, the small dead ends will be trimmed out. This value indicates the chance out of 100 that the dead end remains. Defaults to 0. + roomSizeRatioXThe ratio of the room width to the height. Defaults to 1.0. + roomSizeRatioYThe ratio of the room height to the width. Defaults to 1.0. + maxCreationAttemptsThe max times to re-generate a room that cannot be placed before giving up on placing that room. Defaults to 10. + maxPlacementAttemptsThe max times to attempt to place a room in a map without intersection, before giving up and re-generating that room. Defaults to 10. + crawlerChangeDirectionImprovementOut of 100, how much to increase the chance of the crawler changing direction each step during maze generation. Once it changes direction, the chance resets to 0 and increases by this amount. Defaults to 10. + saveDeadEndChanceAfter the maze generation finishes, the small dead ends will be trimmed out. This value indicates the chance out of 100 that the dead end remains. Defaults to 0. minSidesToConnectMinimum sides of the room to process. Defaults to 1. maxSidesToConnectMaximum sides of the room to process. Defaults to 4. - cancelSideConnectionSelectChanceA chance out of 100 to cancel selecting sides to process (per room) while we are connecting them. Defaults to 50. - cancelConnectionPlacementChanceA chance out of 100 to cancel placing a door on a side after one has already been placed (per room) during connection.Defaults to 70. - cancelConnectionPlacementChanceIncreaseIncrease the cancelConnectionPlacementChance value by this amount each time a door is placed (per room) during the connection process. Defaults to 10. + cancelSideConnectionSelectChanceA chance out of 100 to cancel selecting sides to process (per room) while we are connecting them. Defaults to 50. + cancelConnectionPlacementChanceA chance out of 100 to cancel placing a door on a side after one has already been placed (per room) during connection.Defaults to 70. + cancelConnectionPlacementChanceIncreaseIncrease the cancelConnectionPlacementChance value by this amount each time a door is placed (per room) during the connection process. Defaults to 10. @@ -591,7 +592,7 @@

Parameters
- + @@ -627,7 +628,8 @@

-

Generates a map, as a simple rectangular box, setting the map given as a "walkability map". Wall tiles (the edges of the map) will have a value of false set in the given map, whereas true will be set to all non-wall tiles.

+

Generates a map, as a simple rectangular box, setting the map given as a "walkability +map". Wall tiles (the edges of the map) will have a value of false set in the given map, whereas true will be set to all non-wall tiles.

Parameters

mapThe map to set values to.
rngThe RNG to use to place rooms and determine room size. If null is specified, the default RNG is used.
rngThe RNG to use to place rooms and determine room size. If null is specified, the default RNG is used.
maxRoomsThe maximum number of rooms to attempt to place on the map.
roomMinSizeThe minimum size in width and height of each room.
roomMaxSizeThe maximum size in width and height of each room.
diff --git a/docs/class_go_rogue_1_1_map_views_1_1_i_map_view_extensions.html b/docs/class_go_rogue_1_1_map_views_1_1_i_map_view_extensions.html index 7ae4b6f1..5a960646 100644 --- a/docs/class_go_rogue_1_1_map_views_1_1_i_map_view_extensions.html +++ b/docs/class_go_rogue_1_1_map_views_1_1_i_map_view_extensions.html @@ -76,9 +76,18 @@
mapThe map to set values to.
+ + + + + + + + + @@ -106,15 +115,6 @@ - - - - - - - - -

Static Public Member Functions

static void ApplyOverlay< T > (this ISettableMapView< T > self, IMapView< T > overlay)
 Extension method that applies values of the overlay to the current one – effectively sets all the values of the current map to be corresponding to the one you pass in. More...
 
static Rectangle Bounds< T > (this IMapView< T > mapView)
 Gets a rectangle representing the bounds of the MapView. More...
 
static string ExtendToString< T > (this IMapView< T > map, string begin="", string beginRow="", Func< T, string > elementStringifier=null, string rowSeparator="\, string elementSeparator=" ", string endRow="", string end="")
 Extension method for IMapViews allowing printing the contents. Takes characters to surround the map printout, and each row, the method used to get the string representation of each element (defaulting to the ToString function of type T), and separation characters for each element and row. More...
 
static string ExtendToString< T > (this IMapView< T > map, int fieldSize, string begin="", string beginRow="", Func< T, string > elementStringifier=null, string rowSeparator="\, string elementSeparator=" ", string endRow="", string end="")
 Extension method for IMapViews allowing printing the contents. Takes characters to surround the map, and each row, the method used to get the string representation of each element (defaulting to the ToString function of type T), and separation characters for each element and row. Takes the size of the field to give each element, characters to surround the MapView printout, and each row, the method used to get the string representation of each element (defaulting to the ToString function of type T), and separation characters for each element and row. More...
 
static IEnumerable< Coord > Positions< T > (this IMapView< T > mapView)
 Iterates through each position in the map view. Equivalent to nested for loop for (y = 0...) for (x = 0...) More...
 
static Coord RandomPosition< T > (this IMapView< T > mapView, IGenerator rng=null)
 Gets a random position within the MapView. More...
 
static string ExtendToString< T > (this IMapView< T > map, string begin="", string beginRow="", Func< T, string > elementStringifier=null, string rowSeparator="\, string elementSeparator=" ", string endRow="", string end="")
 Extension method for IMapViews allowing printing the contents. Takes characters to surround the map printout, and each row, the method used to get the string representation of each element (defaulting to the ToString function of type T), and separation characters for each element and row. More...
 
static string ExtendToString< T > (this IMapView< T > map, int fieldSize, string begin="", string beginRow="", Func< T, string > elementStringifier=null, string rowSeparator="\, string elementSeparator=" ", string endRow="", string end="")
 Extension method for IMapViews allowing printing the contents. Takes characters to surround the map, and each row, the method used to get the string representation of each element (defaulting to the ToString function of type T), and separation characters for each element and row. Takes the size of the field to give each element, characters to surround the MapView printout, and each row, the method used to get the string representation of each element (defaulting to the ToString function of type T), and separation characters for each element and row. More...
 
static void ApplyOverlay< T > (this ISettableMapView< T > self, IMapView< T > overlay)
 Extension method that applies values of the overlay to the current one – effectively sets all the values of the current map to be corresponding to the one you pass in. More...
 

Detailed Description

Extensions for the IMapView class that effectively act as methods with default implementations for them.

@@ -156,7 +156,7 @@

Parameters
- +
selfThe current ISettableMapView. Never specified manually as this is an extension method.
selfThe current ISettableMapView. Never specified manually as this is an extension method.
overlayThe data apply to the map. Must have identical dimensions to the current map.
@@ -295,7 +295,7 @@

Returns
A string representation of the map, as viewd by the given map view.
+
Returns
A string representation of the map, as viewd by the given map view.

@@ -396,7 +396,7 @@

Returns
A string representation of the map, as viewd by the given map view.
+
Returns
A string representation of the map, as viewd by the given map view.
@@ -548,7 +548,7 @@

Returns
The item at a random position in the MapView for which the selector returns true.
+
Returns
The item at a random position in the MapView for which the selector returns true.
diff --git a/docs/class_go_rogue_1_1_map_views_1_1_lambda_settable_translation_map.html b/docs/class_go_rogue_1_1_map_views_1_1_lambda_settable_translation_map.html index 7964c698..bdfab70a 100644 --- a/docs/class_go_rogue_1_1_map_views_1_1_lambda_settable_translation_map.html +++ b/docs/class_go_rogue_1_1_map_views_1_1_lambda_settable_translation_map.html @@ -397,7 +397,7 @@

Parameters
- +
positionPosition corresponding to given data value of your map.
positionPosition corresponding to given data value of your map.
valueThe data value from your map.
diff --git a/docs/class_go_rogue_1_1_multi_spatial_map.html b/docs/class_go_rogue_1_1_multi_spatial_map.html index f21ddcb9..52a6b84c 100644 --- a/docs/class_go_rogue_1_1_multi_spatial_map.html +++ b/docs/class_go_rogue_1_1_multi_spatial_map.html @@ -203,7 +203,7 @@

Although SpatialMap should generally be preferred in cases where only one item is allowed at a location in the first place, this implementation may be particularly useful for situations such as inventory items, where multiple items may be desired at one location. If one is implementing something akin to "buckets", one may also subclass this implementation and provide handlers to the various events it exposes to keep track of the object on top, etc. The two implementations could also in many cases be used in combination as necessary, since they both implement the ISpatialMap interface.

Template Parameters
- +
TThe type of items being stored. Must implement IHasID and be a reference-type.
TThe type of items being stored. Must implement IHasID and be a reference-type.
diff --git a/docs/class_go_rogue_1_1_pathing_1_1_goal_map.html b/docs/class_go_rogue_1_1_pathing_1_1_goal_map.html index 3de7d4de..f1b14002 100644 --- a/docs/class_go_rogue_1_1_pathing_1_1_goal_map.html +++ b/docs/class_go_rogue_1_1_pathing_1_1_goal_map.html @@ -91,6 +91,9 @@  GoalMap (IMapView< GoalState > baseMap, Distance distanceMeasurement)  Constructor. Takes a base map and a distance measurement to use for calculation. More...
  +Direction GetDirectionOfMinValue (Coord position) + Gets the direction of the neighbor with the minimum goal-map value from the given position. More...
+  override string ToString ()  Returns the goal-map values represented as a 2D grid-style string. More...
  @@ -106,9 +109,6 @@ bool Update ()  Re-evaluates the entire goal map. Should be called when obstacles change. If the obstacles have not changed but the goals have, call UpdatePathsOnly() for better efficiency. More...
  -Direction GetDirectionOfMinValue (Coord position) - Gets the direction of the neighbor with the minimum goal-map value from the given position. More...
-  bool UpdatePathsOnly ()  Re-evaluates the walkable portion of the goal map. Should be called anytime the goals change. More...
  @@ -221,7 +221,7 @@

Returns
The direction that has the minimum value in the goal-map, or Direction.NONE if the neighbors are all obstacles.
+
Returns
The direction that has the minimum value in the goal-map, or Direction.NONE if the neighbors are all obstacles.
diff --git a/docs/class_go_rogue_1_1_pathing_1_1_goal_map_extensions.html b/docs/class_go_rogue_1_1_pathing_1_1_goal_map_extensions.html index 9571963e..29279450 100644 --- a/docs/class_go_rogue_1_1_pathing_1_1_goal_map_extensions.html +++ b/docs/class_go_rogue_1_1_pathing_1_1_goal_map_extensions.html @@ -126,13 +126,13 @@

Parameters
- +
goalMapThe IMapView of nullable double values to operate on. Never specified manually since this is an extension method.
goalMapThe IMapView of nullable double values to operate on. Never specified manually since this is an extension method.
positionThe position to get the minimum value for.
adjacencyRuleThe adjacency rule to use to determine neighbors.
-
Returns
The direction that has the minimum value in the goal-map, or Direction.NONE if the neighbors are all obstacles.
+
Returns
The direction that has the minimum value in the goal-map, or Direction.NONE if the neighbors are all obstacles.
diff --git a/docs/class_go_rogue_1_1_sense_mapping_1_1_sense_source.html b/docs/class_go_rogue_1_1_sense_mapping_1_1_sense_source.html index 93a24941..26956ae2 100644 --- a/docs/class_go_rogue_1_1_sense_mapping_1_1_sense_source.html +++ b/docs/class_go_rogue_1_1_sense_mapping_1_1_sense_source.html @@ -92,27 +92,27 @@ + + + - - - - - - - - - + + + + + + @@ -228,7 +228,7 @@

position

- +

Properties

double Angle [get, set]
 If IsAngleRestricted is true, the angle in degrees that represents a line from the source's start to the outermost center point of the cone formed by the source's calculated values. 0 degrees points right. If IsAngleRestricted is false, this will be 0.0 degrees. More...
 
Distance DistanceCalc [get, set]
 The distance calculation used to determine what shape the radius has (or a type implicitly convertible to Distance, eg. Radius) More...
 
bool Enabled [get, set]
 Whether or not this source is enabled. If a source is disabled when its SenseMap's Calculate function is called, the source does not calculate values and is effectively assumed to be "off". More...
 
Coord Position [get, set]
 The position on a map that the source is located at. More...
 
bool IsAngleRestricted [get, set]
 Whether or not the spreading of values from this source is restricted to an angle and span. More...
 
double Angle [get, set]
 If IsAngleRestricted is true, the angle in degrees that represents a line from the source's start to the outermost center point of the cone formed by the source's calculated values. 0 degrees points right. If IsAngleRestricted is false, this will be 0.0 degrees. More...
 
double Span [get, set]
 If IsAngleRestricted is true, the angle in degrees that represents the full arc of the cone formed by the source's calculated values. If IsAngleRestricted is false, it will be 360 degrees. More...
 
Coord Position [get, set]
 The position on a map that the source is located at. More...
 
double Radius [get, set]
 The maximum radius of the source – this is the maximum distance the source values will emanate, provided the area is completely unobstructed. Changing this will trigger resizing (re-allocation) of the underlying arrays. However, data is not copied over – there is no need to since Calculate in SenseMap immediately copies values from local array to its "master" array. More...
 
double Span [get, set]
 If IsAngleRestricted is true, the angle in degrees that represents the full arc of the cone formed by the source's calculated values. If IsAngleRestricted is false, it will be 360 degrees. More...
 
SourceType Type [get, set]
 The spread mechanics to use for source values. More...
 
The position on a map that the source is located at.
radiusThe maximum radius of the source – this is the maximum distance the source values will emanate, provided the area is completely unobstructed.
distanceCalcThe distance calculation used to determine what shape the radius has (or a type implicitly convertible to Distance, eg. Radius).
angleThe angle in degrees that specifies the outermost center point of the cone formed by the source's values. 0 degrees points right.
angleThe angle in degrees that specifies the outermost center point of the cone formed by the source's values. 0 degrees points right.
spanThe angle, in degrees, that specifies the full arc contained in the cone formed by the source's values – angle/2 degrees are included on either side of the cone's center line.
diff --git a/docs/class_go_rogue_1_1_spatial_map.html b/docs/class_go_rogue_1_1_spatial_map.html index c4e2d9e7..88c316c8 100644 --- a/docs/class_go_rogue_1_1_spatial_map.html +++ b/docs/class_go_rogue_1_1_spatial_map.html @@ -210,7 +210,7 @@

Typical roguelikes will use a 2D array (or 1D array accessed as a 2D array), for terrain, and lists of objects for things like entities, items, etc. This is simple but ultimately not efficient; for example, in that implementation, determining if there is an object at a location takes an amount of time proportional to the number of objects in this list. However, the other simple option is to use an array with size equal to the size of the map (as many do for terrain) for all object lists. This is even less ideal, as in that case, the time to iterate over all objects becomes proportional to the size of the map (since one has to do that for rendering, ouch!), which is typically much larger than the number of objects in a list. This is the problem SpatialMap is designed to solve. It provides fast, near-constant-time operations for getting the object at a location, adding entities, removing entities, and will allow you to iterate through all objects in the SpatialMap in time proportional to the number of objects in it (the best possible). Effectively, it is a more efficient list for objects that have a position associated with them. This implementation can only allow one item at a given location at a time – for an implementation that allows multiple items, see MultiSpatialMap. The objects stored in a SpatialMap must implement the IHasID (see that interface's documentation for an easy implementation example). This is used internally to keep track of the objects, since uints are easily (efficiently) hashable.

Template Parameters
- +
TThe type of object that will be contained by this SpatialMap. Must implement IHasID and be a reference-type.
TThe type of object that will be contained by this SpatialMap. Must implement IHasID and be a reference-type.
diff --git a/docs/classes.html b/docs/classes.html index e1f18b85..f9229adf 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -66,55 +66,56 @@
a | b | c | d | e | f | g | h | i | k | l | m | o | p | q | r | s | t | u | v | w
- - - - + + + + + - - - - + + + - - - + + + + - - - + - - - + + + + + - - - - - + + + + + - - - + +
  a  
-		Distance (GoRogue)   IMapViewExtensions (GoRogue.MapViews)   LambdaTranslationMap (GoRogue.MapViews)   RandomConnectionPointSelector (GoRogue.MapGeneration.Connectors)   
DistributionHelpers (GoRogue.Random)   ImpossibleDieException (GoRogue.DiceNotation.Exceptions)   LayeredSpatialMap (GoRogue)   Rectangle (GoRogue)   
AddTerm (GoRogue.DiceNotation.Terms)   DivideTerm (GoRogue.DiceNotation.Terms)   InvalidChooseException (GoRogue.DiceNotation.Exceptions)   LayerMasker (GoRogue)   RoomDoorConnector (GoRogue.MapGeneration.Connectors)   
AdjacencyRule (GoRogue)   
  e  
-		InvalidMultiplicityException (GoRogue.DiceNotation.Exceptions)   Lines (GoRogue)   RoomsGenerator (GoRogue.MapGeneration.Generators)   
AdvancedLayeredSpatialMap (GoRogue)   InvalidSyntaxException (GoRogue.DiceNotation.Exceptions)   
  m  
-
  s  
+		DisjointSet (GoRogue)   IMapView (GoRogue.MapViews)   LambdaSettableMapView (GoRogue.MapViews)   RadiusAreaProvider (GoRogue)   
Distance (GoRogue)   IMapViewExtensions (GoRogue.MapViews)   LambdaSettableTranslationMap (GoRogue.MapViews)   RandomConnectionPointSelector (GoRogue.MapGeneration.Connectors)   
AddTerm (GoRogue.DiceNotation.Terms)   DistributionHelpers (GoRogue.Random)   ImpossibleDieException (GoRogue.DiceNotation.Exceptions)   LambdaTranslationMap (GoRogue.MapViews)   Rectangle (GoRogue)   
AdjacencyRule (GoRogue)   DivideTerm (GoRogue.DiceNotation.Terms)   InvalidChooseException (GoRogue.DiceNotation.Exceptions)   LayeredSpatialMap (GoRogue)   RoomDoorConnector (GoRogue.MapGeneration.Connectors)   
AdvancedLayeredSpatialMap (GoRogue)   
  e  
+		InvalidMultiplicityException (GoRogue.DiceNotation.Exceptions)   LayerMasker (GoRogue)   RoomsGenerator (GoRogue.MapGeneration.Generators)   
AdvancedMultiSpatialMap (GoRogue)   InvalidSyntaxException (GoRogue.DiceNotation.Exceptions)   Lines (GoRogue)   
  s  
AdvancedMultiSpatialMap (GoRogue)   Effect (GoRogue)   IParser (GoRogue.DiceNotation)   
AdvancedSpatialMap (GoRogue)   EffectArgs (GoRogue)   IReadOnlyDisjointSet (GoRogue)   Map (GoRogue.GameFramework)   SenseMap (GoRogue.SenseMapping)   
ArrayMap (GoRogue.MapViews)   EffectTrigger (GoRogue)   IReadOnlyFOV (GoRogue)   MapArea (GoRogue.MapGeneration)   SenseSource (GoRogue.SenseMapping)   
AStar (GoRogue.Pathing)   
  f  
-		IReadOnlyLayeredSpatialMap (GoRogue)   MapAreaFinder (GoRogue.MapGeneration)   SettableTranslationMap (GoRogue.MapViews)   
AdvancedSpatialMap (GoRogue)   Effect (GoRogue)   IParser (GoRogue.DiceNotation)   
  m  
+
ArrayMap (GoRogue.MapViews)   EffectArgs (GoRogue)   IReadOnlyDisjointSet (GoRogue)   SenseMap (GoRogue.SenseMapping)   
AStar (GoRogue.Pathing)   EffectTrigger (GoRogue)   IReadOnlyFOV (GoRogue)   Map (GoRogue.GameFramework)   SenseSource (GoRogue.SenseMapping)   
  b  
-		IReadOnlyMapArea (GoRogue.MapGeneration)   MathHelpers (GoRogue)   SettableViewport (GoRogue.MapViews)   
FleeMap (GoRogue.Pathing)   IReadOnlyRadiusAreaProvider (GoRogue)   MaxRandom (GoRogue.Random)   SingletonRandom (GoRogue.Random)   
BasicRoomsGenerator (GoRogue.MapGeneration.Generators)   FOV (GoRogue)   IReadOnlySenseMap (GoRogue.SenseMapping)   MazeGenerator (GoRogue.MapGeneration.Generators)   SpatialMap (GoRogue)   
BoundedRectangle (GoRogue)   
  g  
-		IReadOnlySpatialMap (GoRogue)   MinRandom (GoRogue.Random)   SubtractTerm (GoRogue.DiceNotation.Terms)   
  f  
+		IReadOnlyLayeredSpatialMap (GoRogue)   MapArea (GoRogue.MapGeneration)   SettableTranslationMap (GoRogue.MapViews)   
IReadOnlyMapArea (GoRogue.MapGeneration)   MapAreaFinder (GoRogue.MapGeneration)   SettableViewport (GoRogue.MapViews)   
BasicRoomsGenerator (GoRogue.MapGeneration.Generators)   FleeMap (GoRogue.Pathing)   IReadOnlyRadiusAreaProvider (GoRogue)   MathHelpers (GoRogue)   SingletonRandom (GoRogue.Random)   
BoundedRectangle (GoRogue)   FOV (GoRogue)   IReadOnlySenseMap (GoRogue.SenseMapping)   MaxRandom (GoRogue.Random)   SpatialMap (GoRogue)   
  c  
-		ISettableMapView (GoRogue.MapViews)   MultiplyTerm (GoRogue.DiceNotation.Terms)   
  t  
-
GameObject (GoRogue.GameFramework)   ISpatialMap (GoRogue)   MultiSpatialMap (GoRogue)   
CellularAutomataAreaGenerator (GoRogue.MapGeneration.Generators)   GoalMap (GoRogue.Pathing)   ISpatialTuple (GoRogue)   
  o  
-		TranslationMap (GoRogue.MapViews)   
CenterBoundsConnectionPointSelector (GoRogue.MapGeneration.Connectors)   GoalMapExtensions (GoRogue.Pathing)   ItemEventArgs (GoRogue)   
  u  
+
  g  
+		IReadOnlySpatialMap (GoRogue)   MazeGenerator (GoRogue.MapGeneration.Generators)   SubtractTerm (GoRogue.DiceNotation.Terms)   
ISettableMapView (GoRogue.MapViews)   MinRandom (GoRogue.Random)   
  t  
ClosestMapAreaConnector (GoRogue.MapGeneration.Connectors)   
  h  
-		ItemMovedEventArgs (GoRogue)   OrderedMapAreaConnector (GoRogue.MapGeneration.Connectors)   
ConstantTerm (GoRogue.DiceNotation.Terms)   ITerm (GoRogue.DiceNotation.Terms)   
  p  
-		Utility (GoRogue)   
Coord (GoRogue)   HorizontalVerticalTunnelCreator (GoRogue.MapGeneration.Connectors)   ITunnelCreator (GoRogue.MapGeneration.Connectors)   
  v  
+
CellularAutomataAreaGenerator (GoRogue.MapGeneration.Generators)   GameObject (GoRogue.GameFramework)   ISpatialMap (GoRogue)   MultiplyTerm (GoRogue.DiceNotation.Terms)   
CenterBoundsConnectionPointSelector (GoRogue.MapGeneration.Connectors)   GoalMap (GoRogue.Pathing)   ISpatialTuple (GoRogue)   MultiSpatialMap (GoRogue)   TranslationMap (GoRogue.MapViews)   
ClosestMapAreaConnector (GoRogue.MapGeneration.Connectors)   GoalMapExtensions (GoRogue.Pathing)   ItemEventArgs (GoRogue)   
  o  
+
  u  
ConstantTerm (GoRogue.DiceNotation.Terms)   
  h  
+		ItemMovedEventArgs (GoRogue)   
Coord (GoRogue)   ITerm (GoRogue.DiceNotation.Terms)   OrderedMapAreaConnector (GoRogue.MapGeneration.Connectors)   Utility (GoRogue)   
  d  
-
  i  
+		HorizontalVerticalTunnelCreator (GoRogue.MapGeneration.Connectors)   ITunnelCreator (GoRogue.MapGeneration.Connectors)   
  p  
+
  v  
+
  i  
  k  
-		Parser (GoRogue.DiceNotation)   
Path (GoRogue.Pathing)   Viewport (GoRogue.MapViews)   
Dice (GoRogue.DiceNotation)   IAreaConnectionPointSelector (GoRogue.MapGeneration.Connectors)   KeepTerm (GoRogue.DiceNotation.Terms)   
  q  
-
  w  
DiceExpression (GoRogue.DiceNotation)   IDComparer (GoRogue)   KnownSeriesGenerator (GoRogue.Random)   
DiceTerm (GoRogue.DiceNotation.Terms)   IDGenerator (GoRogue)   
  l  
-		QuickGenerators (GoRogue.MapGeneration)   WeightedGoalMap (GoRogue.Pathing)   
Direction (GoRogue)   IDiceExpression (GoRogue.DiceNotation)   
  r  
+
Dice (GoRogue.DiceNotation)   Parser (GoRogue.DiceNotation)   Viewport (GoRogue.MapViews)   
DiceExpression (GoRogue.DiceNotation)   IAreaConnectionPointSelector (GoRogue.MapGeneration.Connectors)   KeepTerm (GoRogue.DiceNotation.Terms)   Path (GoRogue.Pathing)   
  w  
+
DiceTerm (GoRogue.DiceNotation.Terms)   IDGenerator (GoRogue)   KnownSeriesGenerator (GoRogue.Random)   
  q  
+
Direction (GoRogue)   IDiceExpression (GoRogue.DiceNotation)   
  l  
+		WeightedGoalMap (GoRogue.Pathing)   
DirectLineTunnelCreator (GoRogue.MapGeneration.Connectors)   IHasID (GoRogue)   QuickGenerators (GoRogue.MapGeneration)   
DiscreteConverter (GoRogue.Random)   IHasLayer (GoRogue)   LambdaMapView (GoRogue.MapViews)   
  r  
DirectLineTunnelCreator (GoRogue.MapGeneration.Connectors)   IHasID (GoRogue)   LambdaMapView (GoRogue.MapViews)   
DiscreteConverter (GoRogue.Random)   IHasLayer (GoRogue)   LambdaSettableMapView (GoRogue.MapViews)   Radius (GoRogue)   
DisjointSet (GoRogue)   IMapView (GoRogue.MapViews)   LambdaSettableTranslationMap (GoRogue.MapViews)   RadiusAreaProvider (GoRogue)   
Radius (GoRogue)   
a | b | c | d | e | f | g | h | i | k | l | m | o | p | q | r | s | t | u | v | w
diff --git a/docs/functions_e.html b/docs/functions_e.html index 262340be..ebb6e583 100644 --- a/docs/functions_e.html +++ b/docs/functions_e.html @@ -91,7 +91,6 @@

- e -

  • Equals() : GoRogue.Coord -, GoRogue.IDComparer< T > , GoRogue.MapGeneration.MapArea , GoRogue.Rectangle
    • @@ -99,7 +98,7 @@

    - e -

      : GoRogue.Distance
    • EuclideanDistanceMagnitude() -: GoRogue.Coord +: GoRogue.Coord
    • Expand() : GoRogue.Rectangle @@ -114,7 +113,7 @@

      - e -

        : GoRogue.Utility
      • ExtendToString< T >() -: GoRogue.MapViews.IMapViewExtensions +: GoRogue.MapViews.IMapViewExtensions , GoRogue.Utility
      • ExtendToStringGrid< T >() diff --git a/docs/functions_func_e.html b/docs/functions_func_e.html index 34638103..f4f4eb3f 100644 --- a/docs/functions_func_e.html +++ b/docs/functions_func_e.html @@ -73,9 +73,8 @@

        - e -

        • Equals() : GoRogue.Coord -, GoRogue.IDComparer< T > , GoRogue.MapGeneration.MapArea -, GoRogue.Rectangle +, GoRogue.Rectangle
        • EuclideanDistanceMagnitude() : GoRogue.Coord @@ -88,10 +87,10 @@

          - e -

          diff --git a/docs/functions_func_g.html b/docs/functions_func_g.html index cef254f9..18d6329b 100644 --- a/docs/functions_func_g.html +++ b/docs/functions_func_g.html @@ -68,8 +68,8 @@

          - g -

          • Generate() : GoRogue.MapGeneration.Generators.BasicRoomsGenerator , GoRogue.MapGeneration.Generators.CellularAutomataAreaGenerator -, GoRogue.MapGeneration.Generators.MazeGenerator -, GoRogue.MapGeneration.Generators.RoomsGenerator +, GoRogue.MapGeneration.Generators.MazeGenerator +, GoRogue.MapGeneration.Generators.RoomsGenerator
          • GenerateCellularAutomataMap() : GoRogue.MapGeneration.QuickGenerators @@ -115,7 +115,6 @@

            - g -

            • GetHashCode() : GoRogue.Coord -, GoRogue.IDComparer< T > , GoRogue.MapGeneration.MapArea , GoRogue.Rectangle
              • @@ -170,7 +169,7 @@

              - g -

                : GoRogue.Pathing.Path
              • GetTerrain() -: GoRogue.GameFramework.Map< BaseObject > +: GoRogue.GameFramework.Map< BaseObject >
              • GetUnion() : GoRogue.MapGeneration.MapArea diff --git a/docs/functions_g.html b/docs/functions_g.html index a8e27a26..690137f7 100644 --- a/docs/functions_g.html +++ b/docs/functions_g.html @@ -68,8 +68,8 @@

                - g -

                • Generate() : GoRogue.MapGeneration.Generators.BasicRoomsGenerator , GoRogue.MapGeneration.Generators.CellularAutomataAreaGenerator -, GoRogue.MapGeneration.Generators.MazeGenerator -, GoRogue.MapGeneration.Generators.RoomsGenerator +, GoRogue.MapGeneration.Generators.MazeGenerator +, GoRogue.MapGeneration.Generators.RoomsGenerator
                • GenerateCellularAutomataMap() : GoRogue.MapGeneration.QuickGenerators @@ -118,7 +118,6 @@

                  - g -

                  • GetHashCode() : GoRogue.Coord -, GoRogue.IDComparer< T > , GoRogue.MapGeneration.MapArea , GoRogue.Rectangle
                    • @@ -173,7 +172,7 @@

                    - g -

                      : GoRogue.Pathing.Path
                    • GetTerrain() -: GoRogue.GameFramework.Map< BaseObject > +: GoRogue.GameFramework.Map< BaseObject >
                    • GetUnion() : GoRogue.MapGeneration.MapArea diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 67cf8b41..c6b6deff 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -118,84 +118,82 @@  CGoRogue.MultiSpatialMap< T >See SpatialMap documentation – similar in principle. However, this implementation allows multiple items to exist at one point in the SpatialMap, in exchange for the loss of the convenience functions like GetItem vs GetItems, as well as potential performance differences (although unless the number of objects at any given location is large, the performance is asymptotically the same).  ►CGoRogue.AdvancedSpatialMap< T >Advanced version of SpatialMap that allows for use of a custom IEqualityComparer for hashing and comparison of type T. May be useful for cases where one does not want to implement IHasID, or if you need to use a value type in a SpatialMap. For simple cases, it is recommended to use SpatialMap instead.  CGoRogue.SpatialMap< T >Designed as an more efficient data structure for recording objects on a map. The simple version: if you're about to use a List to store a bunch of objects in your map, consider using this or MultiSpatialMap instead! - ►CIEqualityComparer - CGoRogue.IDComparer< T >Class intended for comparing/hashing objects that implement IHasID. Type T must be a reference type. - ►CIEquatable - CGoRogue.RectangleRepresents a rectangle in terms of grid squares. Provides numerous functions pertaining to area. - ►CIGenerator - CGoRogue.Random.KnownSeriesGenerator"Random number generator" that takes in a series of values, and simply returns them sequentially when RNG functions are called. - CGoRogue.Random.MaxRandomA "random" number generator that always returns the maxValue parameter given. Again this may be useful in testing, testing the upper range or repeatedly returning a value. Also used in DiceExpressions for certain max roll functions. - CGoRogue.Random.MinRandomA "random" number generator that always returns the minValue parameter given, or 0 on the Next overload that only takes maxValue. Again, may be useful for testing. Also used in DiceExpression for certain minimum roll functions. - ►CGoRogue.IHasIDInterface for a class that has an ID, typically used for hashing purposes. The ID should be unique or close to unique over all instances of the class (for efficiency). Typical implementation could be simply random-genning the ID, or for completely unique IDs can involve using an IDGenerator, potentially as follows: + ►CIEquatable + CGoRogue.RectangleRepresents a rectangle in terms of grid squares. Provides numerous functions pertaining to area. + ►CIGenerator + CGoRogue.Random.KnownSeriesGenerator"Random number generator" that takes in a series of values, and simply returns them sequentially when RNG functions are called. + CGoRogue.Random.MaxRandomA "random" number generator that always returns the maxValue parameter given. Again this may be useful in testing, testing the upper range or repeatedly returning a value. Also used in DiceExpressions for certain max roll functions. + CGoRogue.Random.MinRandomA "random" number generator that always returns the minValue parameter given, or 0 on the Next overload that only takes maxValue. Again, may be useful for testing. Also used in DiceExpression for certain minimum roll functions. + ►CGoRogue.IHasIDInterface for a class that has an ID, typically used for hashing purposes. The ID should be unique or close to unique over all instances of the class (for efficiency). Typical implementation could be simply random-genning the ID, or for completely unique IDs can involve using an IDGenerator, potentially as follows: + CGoRogue.GameFramework.GameObject< BaseSubclass >Base class for any object that has a grid position and can be added to a Map. BaseSubclass must be the type that is deriving from this types, eg. class MyDerivingGameObject : GameObject<MyDerivingGameObject> + ►CGoRogue.IHasLayerInterface to be implemented by objects that will be used in LayeredSpatialMap/Map classes.  CGoRogue.GameFramework.GameObject< BaseSubclass >Base class for any object that has a grid position and can be added to a Map. BaseSubclass must be the type that is deriving from this types, eg. class MyDerivingGameObject : GameObject<MyDerivingGameObject> - ►CGoRogue.IHasLayerInterface to be implemented by objects that will be used in LayeredSpatialMap/Map classes. - CGoRogue.GameFramework.GameObject< BaseSubclass >Base class for any object that has a grid position and can be added to a Map. BaseSubclass must be the type that is deriving from this types, eg. class MyDerivingGameObject : GameObject<MyDerivingGameObject> - ►CGoRogue.MapViews.IMapView< T >Interface designed to act as a standardized input/output for algorithms. - ►CGoRogue.MapViews.ISettableMapView< T >Interface designed to act as a standardized input/output for algorithms that need to make modifications to data. - CGoRogue.MapViews.ArrayMap< T >Default implementation of the ISettableMapView interface, exposing the interface using an actual 2D array to store data. - CGoRogue.MapViews.LambdaSettableMapView< T >Class designed to make implementing simple ISettableMapViews more convenient, by providing the "get" and "set" functionality via lambda functions. For a version that implements IMapView as opposed to ISettableMapView, see LambdaMapView. - CGoRogue.MapViews.SettableViewport< T >Similar to Viewport, but implements ISettableMapView and thus implements set functionality via relative coordinates. - CGoRogue.MapViews.LambdaMapView< T >Class designed to make implementing simple IMapViews more convenient, by providing the "get" functionality via a lambda function. For a version that implements ISettableMapView as opposed to IMapView, see LambdaSettableMapView. - ►CGoRogue.MapViews.Viewport< T >Since some algorithms that use MapViews can be expensive to run entirely on large maps (such as GoalMaps), Viewport is a class that effectively creates and maintains a "viewport" of the map. Its indexers perform relative to absolute coordinate translations, and return the proper value of type T from the underlying map.. - CGoRogue.MapViews.SettableViewport< T >Similar to Viewport, but implements ISettableMapView and thus implements set functionality via relative coordinates. - CGoRogue.MapViews.IMapView< BaseObject > - CGoRogue.MapViews.IMapView< bool > - ►CGoRogue.MapViews.IMapView< double > - CGoRogue.FOVClass responsible for caculating basic FOV (see SenseMap for more advanced lighting). Effectively a simplified, slightly faster interface compared to SenseMap, that supports only a single source and only shadowcasting. This is more conducive to the typical use case for FOV. It can calculate the FOV with a finite or infinite max radius, and can use a variety of radius types, as specified in Radius class (all the same ones that SenseMap supports). It also supports both 360 degree FOV and a "field of view" (cone) FOV. One may access this class like a 2D array of doubles (FOV values), wherein the values will range from 0.0 to 1.0, where 1.0 means the corresponding map grid coordinate is at maximum visibility, and 0.0 means the cooresponding coordinate is outside of FOV entirely (not visible). Values fall off linearly with respect to radius as distance from the center increases. - ►CGoRogue.IReadOnlyFOVRead-only interface of the FOV class. - CGoRogue.FOVClass responsible for caculating basic FOV (see SenseMap for more advanced lighting). Effectively a simplified, slightly faster interface compared to SenseMap, that supports only a single source and only shadowcasting. This is more conducive to the typical use case for FOV. It can calculate the FOV with a finite or infinite max radius, and can use a variety of radius types, as specified in Radius class (all the same ones that SenseMap supports). It also supports both 360 degree FOV and a "field of view" (cone) FOV. One may access this class like a 2D array of doubles (FOV values), wherein the values will range from 0.0 to 1.0, where 1.0 means the corresponding map grid coordinate is at maximum visibility, and 0.0 means the cooresponding coordinate is outside of FOV entirely (not visible). Values fall off linearly with respect to radius as distance from the center increases. - CGoRogue.SenseMapping.IReadOnlySenseMapRead-only interface of a SenseMap. - CGoRogue.SenseMapping.SenseMapClass responsible for calculating a map for senses (sound, light, etc). Anything that has a resistance map, where 1.0 is completely impenetrable, and 0.0 is no resistance at all, can use this system. Typically used for FOV, however can also be used for sound maps, etc. Supports a few different types of spreading mechanics, including every one in the SourceType enum. Included in these is FOV/FOV-style shadowcasting. This will be much faster than ripple variations. Once one calls Calculate, one can use Coords, or x and y values, to access this class like an array. The double one gets back will be the "sensory value". This is a number between 1.0 and 0.0, where 1.0 is maximum intensity (max brightness in the case of the sources being light, for example), and 0.0 is no intensity at all. - ►CGoRogue.MapViews.IMapView< double?> - CGoRogue.Pathing.FleeMapImplements the concept of a "safety map", also known as "flee map", as described in the roguebasin article http://www.roguebasin.com/index.php?title=The_Incredible_Power_of_Dijkstra_Maps. - CGoRogue.Pathing.GoalMapImplementation of a goal map system, also known as Dijkstra maps ( http://www.roguebasin.com/index.php?title=The_Incredible_Power_of_Dijkstra_Maps ) - CGoRogue.Pathing.WeightedGoalMapImplementation of the second half of the goal map system described in http://www.roguebasin.com/index.php?title=The_Incredible_Power_of_Dijkstra_Maps , the ability to combine multiple goal maps with different weights. - ►CIMapView< IEnumerable< BaseObject >> - CGoRogue.GameFramework.Map< BaseObject >Base class for a map that consists of one or more objects of type BaseObject. It implements basic functionality to manage these objects, as well as commonly needed functinonality like tile exploration, FOV, and pathfinding. BaseObject must be a type that derives from GameObject<BaseObject>. - ►CGoRogue.MapViews.IMapView< T2 > - ►CGoRogue.MapViews.TranslationMap< T1, T2 >Map view class capable of taking complex data and providing a simpler view of it. For a version that provides "set" functionality, see SettableTranslationMap. - CGoRogue.MapViews.LambdaTranslationMap< T1, T2 >A simple TranslationMap implementation that allows you to provide a lambda for the translation function. For a version offering "set" functionality, see SettableLambdaTranslationMap. - CGoRogue.MapViews.IMapViewExtensionsExtensions for the IMapView class that effectively act as methods with default implementations for them. - ►CGoRogue.DiceNotation.IParserInterface for a class that parses a string representing a dice expression into a IDiceExpression instance. - CGoRogue.DiceNotation.ParserDefault class for parsing a string representing a dice expression into an IDiceExpression instance. - ►CGoRogue.IReadOnlyDisjointSetBasic read-only representation of a Disjoint set data structure. Assumes it is holding integers between 0 and size - 1. - CGoRogue.DisjointSetBasic representation of a Disjoint set data structure. Assumes it is holding integers between 0 and size - 1. - CGoRogue.IReadOnlyLayeredSpatialMap< BaseObject > - ►CGoRogue.MapGeneration.IReadOnlyMapAreaRead-only interface for an arbitrarily-shaped area of the map. - CGoRogue.MapGeneration.MapAreaRepresents an arbitrarily-shaped area of a map. Stores and provides access to a list of each unique position considered connected. - ►CGoRogue.IReadOnlyRadiusAreaProviderRead-only interface of a RadiusAreaProvider. - CGoRogue.RadiusAreaProviderClass capable of getting all unique positions inside of a given radius and (optional) bounds. - CGoRogue.MapViews.ISettableMapView< BaseObject > - ►CGoRogue.MapViews.ISettableMapView< T2 > - ►CGoRogue.MapViews.SettableTranslationMap< T1, T2 >Settable map view class capable of taking complex data and providing a simpler view of it. For a version that provides only "get" functionality, see TranslationMap. - CGoRogue.MapViews.LambdaSettableTranslationMap< T1, T2 >A simple TranslationMap implementation that allows you to provide lambdas for the translation functions. For a version offering only "get" functionality, see LambdaTranslationMap. - CGoRogue.ISpatialTuple< T >Interface specifying return type for item-location pairs in a spatial map implementation. - ►CGoRogue.DiceNotation.Terms.ITermInterface for an evaluatable term of a dice expression. - CGoRogue.DiceNotation.Terms.AddTermTerm representing the addition operator – adds two terms together. - CGoRogue.DiceNotation.Terms.ConstantTermBase term – represents a numerical constant. - CGoRogue.DiceNotation.Terms.DiceTermRepresents a dice term, eg 1d4 or 2d6. - CGoRogue.DiceNotation.Terms.DivideTermTerm representing the division operator – divides the first term by the second. - CGoRogue.DiceNotation.Terms.KeepTermTerm represnting the keep operator – keeping only the n highest dice from a dice term. - CGoRogue.DiceNotation.Terms.MultiplyTermTerm representing the division operator – multiplies Term1 and Term2. - CGoRogue.DiceNotation.Terms.SubtractTermTerm representing the subtraction operator – subtracts the second term from the first. - ►CGoRogue.MapGeneration.Connectors.ITunnelCreatorInterface for implementing an algorithm for creating a tunnel between two positions on a walkability map. - CGoRogue.MapGeneration.Connectors.DirectLineTunnelCreatorImplements a tunnel creation algorithm that sets as walkable a direct line between the two points. In the case that MAHNATTAN distance is being used, the line is calculated via the Coord.CardinalPositionOnLine function. Otherwise, the line is calculated using Coord.PositionsOnLine (brensham's). - CGoRogue.MapGeneration.Connectors.HorizontalVerticalTunnelCreatorImplements a tunnel creation algorithm that creates a tunnel that performs all needed vertical movement before horizontal movement, or vice versa (depending on rng). - CGoRogue.LayeredSpatialMap< BaseObject > - CGoRogue.LayerMaskerAllows convenient interpretation and creation of layer masks (bit-masks) mask layers represented by integers [0-NumberOfLayers - 1]. - CGoRogue.LinesProvides implementations of various (line-drawing) algorithms for generating points closest to a line between two points on a grid. - CGoRogue.MapGeneration.MapAreaFinderClass designed to calculate and produce a list of MapAreas representing each unique connected area of the map. - CGoRogue.MathHelpersStatic class consisting of mathematical "helper" functions and constants – things like angle unit conversions, and other helpful functions. - CGoRogue.MapGeneration.Generators.MazeGeneratorGenerates a maze, and adds it to the given map. - CGoRogue.MapGeneration.Connectors.OrderedMapAreaConnectorSame as ClosestMapAreaConnector, but connects random rooms instead of determining the closest one, or connects rooms in the order specified if you give it a list of MapAreas. - CGoRogue.Pathing.PathEncapsulates a path as returned by pathfinding algorithms like AStar. - CGoRogue.MapGeneration.QuickGeneratorsCollection of algorithms that put map generation pieces together, in ways that allow you to quickly and easily generate a given type of map in a single function call. The implementation of these functions may also be used as the basis for implementing more customized generation processes. - CGoRogue.RadiusClass representing different radius types. Similar in architecture to Coord in architecture – it cannot be instantiated. Instead it simply has pre-allocated static variables for each type of radius, that should be used whenever a variable of type Radius is required. - CGoRogue.MapGeneration.Connectors.RoomDoorConnectorOpens up room walls to connect tunnels that are placed near rooms. - CGoRogue.MapGeneration.Generators.RoomsGeneratorCarves out non-overlapping rooms in a map. Rooms generated will not overlap with themselves, or any existing open areas on the given map. Rooms will not be connected – for automatic connection of rooms generated by this generator, see GoRogue.MapGeneration.QuickGenerator.GenerateDungeonMazeMap(). - CGoRogue.SenseMapping.SenseSourceRepresents a source location to be used in a SenseMap. One would typically create these and call SenseMap.AddSenseSource with them, and perhaps retain a reference for the sake of moving it around or toggling it on-off. The player might have one of these that follows it around if SenseMap is being used as a lighting map, for instance. Note that changing values such as Position and Radius after the source is created is possible, however changes will not be reflected in any SenseSources using this source until their next Calculate call. - CGoRogue.Random.SingletonRandomStatic class that contains 1 variable, which is a DefaultRNG instance. Used as the default rng by other features (dice, etc) wherever needed, and can also be used if you need a random number generator for your own code. - CGoRogue.UtilityStatic class full of miscellaneous helper methods. + ►CGoRogue.MapViews.IMapView< T >Interface designed to act as a standardized input/output for algorithms. + ►CGoRogue.MapViews.ISettableMapView< T >Interface designed to act as a standardized input/output for algorithms that need to make modifications to data. + CGoRogue.MapViews.ArrayMap< T >Default implementation of the ISettableMapView interface, exposing the interface using an actual 2D array to store data. + CGoRogue.MapViews.LambdaSettableMapView< T >Class designed to make implementing simple ISettableMapViews more convenient, by providing the "get" and "set" functionality via lambda functions. For a version that implements IMapView as opposed to ISettableMapView, see LambdaMapView. + CGoRogue.MapViews.SettableViewport< T >Similar to Viewport, but implements ISettableMapView and thus implements set functionality via relative coordinates. + CGoRogue.MapViews.LambdaMapView< T >Class designed to make implementing simple IMapViews more convenient, by providing the "get" functionality via a lambda function. For a version that implements ISettableMapView as opposed to IMapView, see LambdaSettableMapView. + ►CGoRogue.MapViews.Viewport< T >Since some algorithms that use MapViews can be expensive to run entirely on large maps (such as GoalMaps), Viewport is a class that effectively creates and maintains a "viewport" of the map. Its indexers perform relative to absolute coordinate translations, and return the proper value of type T from the underlying map.. + CGoRogue.MapViews.SettableViewport< T >Similar to Viewport, but implements ISettableMapView and thus implements set functionality via relative coordinates. + CGoRogue.MapViews.IMapView< BaseObject > + CGoRogue.MapViews.IMapView< bool > + ►CGoRogue.MapViews.IMapView< double > + CGoRogue.FOVClass responsible for caculating basic FOV (see SenseMap for more advanced lighting). Effectively a simplified, slightly faster interface compared to SenseMap, that supports only a single source and only shadowcasting. This is more conducive to the typical use case for FOV. It can calculate the FOV with a finite or infinite max radius, and can use a variety of radius types, as specified in Radius class (all the same ones that SenseMap supports). It also supports both 360 degree FOV and a "field of view" (cone) FOV. One may access this class like a 2D array of doubles (FOV values), wherein the values will range from 0.0 to 1.0, where 1.0 means the corresponding map grid coordinate is at maximum visibility, and 0.0 means the cooresponding coordinate is outside of FOV entirely (not visible). Values fall off linearly with respect to radius as distance from the center increases. + ►CGoRogue.IReadOnlyFOVRead-only interface of the FOV class. + CGoRogue.FOVClass responsible for caculating basic FOV (see SenseMap for more advanced lighting). Effectively a simplified, slightly faster interface compared to SenseMap, that supports only a single source and only shadowcasting. This is more conducive to the typical use case for FOV. It can calculate the FOV with a finite or infinite max radius, and can use a variety of radius types, as specified in Radius class (all the same ones that SenseMap supports). It also supports both 360 degree FOV and a "field of view" (cone) FOV. One may access this class like a 2D array of doubles (FOV values), wherein the values will range from 0.0 to 1.0, where 1.0 means the corresponding map grid coordinate is at maximum visibility, and 0.0 means the cooresponding coordinate is outside of FOV entirely (not visible). Values fall off linearly with respect to radius as distance from the center increases. + CGoRogue.SenseMapping.IReadOnlySenseMapRead-only interface of a SenseMap. + CGoRogue.SenseMapping.SenseMapClass responsible for calculating a map for senses (sound, light, etc). Anything that has a resistance map, where 1.0 is completely impenetrable, and 0.0 is no resistance at all, can use this system. Typically used for FOV, however can also be used for sound maps, etc. Supports a few different types of spreading mechanics, including every one in the SourceType enum. Included in these is FOV/FOV-style shadowcasting. This will be much faster than ripple variations. Once one calls Calculate, one can use Coords, or x and y values, to access this class like an array. The double one gets back will be the "sensory value". This is a number between 1.0 and 0.0, where 1.0 is maximum intensity (max brightness in the case of the sources being light, for example), and 0.0 is no intensity at all. + ►CGoRogue.MapViews.IMapView< double?> + CGoRogue.Pathing.FleeMapImplements the concept of a "safety map", also known as "flee map", as described in the roguebasin article http://www.roguebasin.com/index.php?title=The_Incredible_Power_of_Dijkstra_Maps. + CGoRogue.Pathing.GoalMapImplementation of a goal map system, also known as Dijkstra maps ( http://www.roguebasin.com/index.php?title=The_Incredible_Power_of_Dijkstra_Maps ) + CGoRogue.Pathing.WeightedGoalMapImplementation of the second half of the goal map system described in http://www.roguebasin.com/index.php?title=The_Incredible_Power_of_Dijkstra_Maps , the ability to combine multiple goal maps with different weights. + ►CIMapView< IEnumerable< BaseObject >> + CGoRogue.GameFramework.Map< BaseObject >Base class for a map that consists of one or more objects of type BaseObject. It implements basic functionality to manage these objects, as well as commonly needed functinonality like tile exploration, FOV, and pathfinding. BaseObject must be a type that derives from GameObject<BaseObject>. + ►CGoRogue.MapViews.IMapView< T2 > + ►CGoRogue.MapViews.TranslationMap< T1, T2 >Map view class capable of taking complex data and providing a simpler view of it. For a version that provides "set" functionality, see SettableTranslationMap. + CGoRogue.MapViews.LambdaTranslationMap< T1, T2 >A simple TranslationMap implementation that allows you to provide a lambda for the translation function. For a version offering "set" functionality, see SettableLambdaTranslationMap. + CGoRogue.MapViews.IMapViewExtensionsExtensions for the IMapView class that effectively act as methods with default implementations for them. + ►CGoRogue.DiceNotation.IParserInterface for a class that parses a string representing a dice expression into a IDiceExpression instance. + CGoRogue.DiceNotation.ParserDefault class for parsing a string representing a dice expression into an IDiceExpression instance. + ►CGoRogue.IReadOnlyDisjointSetBasic read-only representation of a Disjoint set data structure. Assumes it is holding integers between 0 and size - 1. + CGoRogue.DisjointSetBasic representation of a Disjoint set data structure. Assumes it is holding integers between 0 and size - 1. + CGoRogue.IReadOnlyLayeredSpatialMap< BaseObject > + ►CGoRogue.MapGeneration.IReadOnlyMapAreaRead-only interface for an arbitrarily-shaped area of the map. + CGoRogue.MapGeneration.MapAreaRepresents an arbitrarily-shaped area of a map. Stores and provides access to a list of each unique position considered connected. + ►CGoRogue.IReadOnlyRadiusAreaProviderRead-only interface of a RadiusAreaProvider. + CGoRogue.RadiusAreaProviderClass capable of getting all unique positions inside of a given radius and (optional) bounds. + CGoRogue.MapViews.ISettableMapView< BaseObject > + ►CGoRogue.MapViews.ISettableMapView< T2 > + ►CGoRogue.MapViews.SettableTranslationMap< T1, T2 >Settable map view class capable of taking complex data and providing a simpler view of it. For a version that provides only "get" functionality, see TranslationMap. + CGoRogue.MapViews.LambdaSettableTranslationMap< T1, T2 >A simple TranslationMap implementation that allows you to provide lambdas for the translation functions. For a version offering only "get" functionality, see LambdaTranslationMap. + CGoRogue.ISpatialTuple< T >Interface specifying return type for item-location pairs in a spatial map implementation. + ►CGoRogue.DiceNotation.Terms.ITermInterface for an evaluatable term of a dice expression. + CGoRogue.DiceNotation.Terms.AddTermTerm representing the addition operator – adds two terms together. + CGoRogue.DiceNotation.Terms.ConstantTermBase term – represents a numerical constant. + CGoRogue.DiceNotation.Terms.DiceTermRepresents a dice term, eg 1d4 or 2d6. + CGoRogue.DiceNotation.Terms.DivideTermTerm representing the division operator – divides the first term by the second. + CGoRogue.DiceNotation.Terms.KeepTermTerm represnting the keep operator – keeping only the n highest dice from a dice term. + CGoRogue.DiceNotation.Terms.MultiplyTermTerm representing the division operator – multiplies Term1 and Term2. + CGoRogue.DiceNotation.Terms.SubtractTermTerm representing the subtraction operator – subtracts the second term from the first. + ►CGoRogue.MapGeneration.Connectors.ITunnelCreatorInterface for implementing an algorithm for creating a tunnel between two positions on a walkability map. + CGoRogue.MapGeneration.Connectors.DirectLineTunnelCreatorImplements a tunnel creation algorithm that sets as walkable a direct line between the two points. In the case that MAHNATTAN distance is being used, the line is calculated via the Coord.CardinalPositionOnLine function. Otherwise, the line is calculated using Coord.PositionsOnLine (brensham's). + CGoRogue.MapGeneration.Connectors.HorizontalVerticalTunnelCreatorImplements a tunnel creation algorithm that creates a tunnel that performs all needed vertical movement before horizontal movement, or vice versa (depending on rng). + CGoRogue.LayeredSpatialMap< BaseObject > + CGoRogue.LayerMaskerAllows convenient interpretation and creation of layer masks (bit-masks) mask layers represented by integers [0-NumberOfLayers - 1]. + CGoRogue.LinesProvides implementations of various (line-drawing) algorithms for generating points closest to a line between two points on a grid. + CGoRogue.MapGeneration.MapAreaFinderClass designed to calculate and produce a list of MapAreas representing each unique connected area of the map. + CGoRogue.MathHelpersStatic class consisting of mathematical "helper" functions and constants – things like angle unit conversions, and other helpful functions. + CGoRogue.MapGeneration.Generators.MazeGeneratorGenerates a maze, and adds it to the given map. + CGoRogue.MapGeneration.Connectors.OrderedMapAreaConnectorSame as ClosestMapAreaConnector, but connects random rooms instead of determining the closest one, or connects rooms in the order specified if you give it a list of MapAreas. + CGoRogue.Pathing.PathEncapsulates a path as returned by pathfinding algorithms like AStar. + CGoRogue.MapGeneration.QuickGeneratorsCollection of algorithms that put map generation pieces together, in ways that allow you to quickly and easily generate a given type of map in a single function call. The implementation of these functions may also be used as the basis for implementing more customized generation processes. + CGoRogue.RadiusClass representing different radius types. Similar in architecture to Coord in architecture – it cannot be instantiated. Instead it simply has pre-allocated static variables for each type of radius, that should be used whenever a variable of type Radius is required. + CGoRogue.MapGeneration.Connectors.RoomDoorConnectorOpens up room walls to connect tunnels that are placed near rooms. + CGoRogue.MapGeneration.Generators.RoomsGeneratorCarves out non-overlapping rooms in a map. Rooms generated will not overlap with themselves, or any existing open areas on the given map. Rooms will not be connected – for automatic connection of rooms generated by this generator, see GoRogue.MapGeneration.QuickGenerator.GenerateDungeonMazeMap(). + CGoRogue.SenseMapping.SenseSourceRepresents a source location to be used in a SenseMap. One would typically create these and call SenseMap.AddSenseSource with them, and perhaps retain a reference for the sake of moving it around or toggling it on-off. The player might have one of these that follows it around if SenseMap is being used as a lighting map, for instance. Note that changing values such as Position and Radius after the source is created is possible, however changes will not be reflected in any SenseSources using this source until their next Calculate call. + CGoRogue.Random.SingletonRandomStatic class that contains 1 variable, which is a DefaultRNG instance. Used as the default rng by other features (dice, etc) wherever needed, and can also be used if you need a random number generator for your own code. + CGoRogue.UtilityStatic class full of miscellaneous helper methods. diff --git a/docs/interface_go_rogue_1_1_i_read_only_f_o_v.html b/docs/interface_go_rogue_1_1_i_read_only_f_o_v.html index 45bc6973..37d0c5b5 100644 --- a/docs/interface_go_rogue_1_1_i_read_only_f_o_v.html +++ b/docs/interface_go_rogue_1_1_i_read_only_f_o_v.html @@ -86,6 +86,9 @@ + + + @@ -95,9 +98,6 @@ - - - diff --git a/docs/interface_go_rogue_1_1_i_read_only_layered_spatial_map.html b/docs/interface_go_rogue_1_1_i_read_only_layered_spatial_map.html index 6c9eff80..31016865 100644 --- a/docs/interface_go_rogue_1_1_i_read_only_layered_spatial_map.html +++ b/docs/interface_go_rogue_1_1_i_read_only_layered_spatial_map.html @@ -91,18 +91,18 @@ - - - - - - + + + + + + @@ -131,18 +131,18 @@

                      Properties

                      IMapView< bool > BooleanFOV [get]
                       A view of the FOV results in boolean form, where true indicates a location is in FOV, and false indicates it is not. More...
                       
                      IEnumerable< Coord > CurrentFOV [get]
                       IEnumerable of only positions currently in FOV. More...
                       
                      IEnumerable< Coord > NewlyUnseen [get]
                       IEnumerable of positions that are NOT in FOV as of the most current Calculate call, but WERE in FOV after the previous time Calculate was called. More...
                       
                      IMapView< bool > BooleanFOV [get]
                       A view of the FOV results in boolean form, where true indicates a location is in FOV, and false indicates it is not. More...
                       
                      - Properties inherited from GoRogue.MapViews.IMapView< double >
                      int Height [get]
                       The height of the map being represented. More...
                      new IReadOnlyLayeredSpatialMap< T > AsReadOnly ()
                       Returns a read-only reference to the data structure. Convenient for "safely" exposing the structure as a property. More...
                       
                      IEnumerable< T > GetItems (Coord position, uint layerMask=uint.MaxValue)
                       Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
                       
                      IEnumerable< T > GetItems (int x, int y, uint layerMask=uint.MaxValue)
                       Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
                       
                      bool Contains (Coord position, uint layerMask=uint.MaxValue)
                       Returns whether or not there is an item in the data structure at the given position that is on a layer included in the given layer mask. Defaults to searching on all layers. More...
                       
                      bool Contains (int x, int y, uint layerMask=uint.MaxValue)
                       Returns whether or not there is an item in the data structure at the given position, that is on a layer included in the given layer mask. More...
                       
                      IEnumerable< T > GetItems (Coord position, uint layerMask=uint.MaxValue)
                       Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
                       
                      IEnumerable< T > GetItems (int x, int y, uint layerMask=uint.MaxValue)
                       Gets the item(s) associated with the given position that reside on any layer included in the given layer mask. Returns nothing if there is nothing at that position on a layer included in the given layer mask. More...
                       
                      IReadOnlySpatialMap< T > GetLayer (int layer)
                       Gets a read-only spatial map representing the layer given. More...
                       
                      - - - - - - + + + + + + @@ -158,7 +158,7 @@

                      Read-only interface for LayeredSpatialMap – useful for exposing LayeredSpatialMap instances as read-only properties.

                      Template Parameters

                      Properties

                      int StartingLayer [get]
                       Starting index for layers included in this structure. More...
                       
                      IEnumerable< IReadOnlySpatialMap< T > > Layers [get]
                       Gets read-only spatial maps representing each layer. To access a specific layer, instead use GetLayer. More...
                       
                      LayerMasker LayerMasker [get]
                       Object that helps get layer masks as they pertain to this LayeredSpatialMap More...
                       
                      IEnumerable< IReadOnlySpatialMap< T > > Layers [get]
                       Gets read-only spatial maps representing each layer. To access a specific layer, instead use GetLayer. More...
                       
                      int NumberOfLayers [get]
                       Gets the number of layers represented. More...
                       
                      int StartingLayer [get]
                       Starting index for layers included in this structure. More...
                       
                      - Properties inherited from GoRogue.IReadOnlySpatialMap< T >
                      int Count [get]
                       The number of items in the data structure. More...
                      - +
                      TType of element stored in the layered spatial map – must implement IHasLayer.
                      TType of element stored in the layered spatial map – must implement IHasLayer.
                      @@ -225,11 +225,11 @@

                      Parameters
                      - +
                      positionThe position to check for.
                      layerMaskLayer mask that indicates which layers to check. Defaults to all layers.
                      layerMaskLayer mask that indicates which layers to check. Defaults to all layers.
                      -
                      Returns
                      True if there is some item at the given position on a layer included in the given layer mask, false if not.
                      +
                      Returns
                      True if there is some item at the given position on a layer included in the given layer mask, false if not.

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >.

                      @@ -272,11 +272,11 @@

                      xX-value of the position to check for. yY-value of the position to check for. - layerMaskLayer mask that indicates which layers to check. Defaults to all layers. + layerMaskLayer mask that indicates which layers to check. Defaults to all layers. -
                      Returns
                      True if there is some item at the given position on a layer included in the given layer mask, false if not.
                      +
                      Returns
                      True if there is some item at the given position on a layer included in the given layer mask, false if not.

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >.

                      @@ -312,7 +312,7 @@

                      Parameters
                      - +
                      positionThe position to return the item(s) for.
                      layerMaskLayer mask that indicates which layers to check. Defaults to all layers.
                      layerMaskLayer mask that indicates which layers to check. Defaults to all layers.
                      @@ -359,7 +359,7 @@

                      xX-value of the position to return the item(s) for. yY-value of the position to return the item(s) for. - layerMaskLayer mask that indicates which layers to check. Defaults to all layers. + layerMaskLayer mask that indicates which layers to check. Defaults to all layers. @@ -417,7 +417,7 @@

                      Parameters
                      - +
                      layerMaskLayer mask indicating which layers to return. Defaults to all layers.
                      layerMaskLayer mask indicating which layers to return. Defaults to all layers.
                      diff --git a/docs/interface_go_rogue_1_1_i_read_only_spatial_map.html b/docs/interface_go_rogue_1_1_i_read_only_spatial_map.html index 73f61298..ba0cd0b5 100644 --- a/docs/interface_go_rogue_1_1_i_read_only_spatial_map.html +++ b/docs/interface_go_rogue_1_1_i_read_only_spatial_map.html @@ -150,7 +150,7 @@

                      Returns
                      The current data structure, as a "read-only" reference.
                      -

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.IReadOnlyLayeredSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, and GoRogue.IReadOnlyLayeredSpatialMap< T >.

                      @@ -179,7 +179,7 @@

                      Returns
                      True if the given item is in the data structure, false if not.
                      -

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedSpatialMap< T >.

                      @@ -208,7 +208,7 @@

                      Returns
                      True if there is some item at the given position, false if not.
                      -

                      Implemented in GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedSpatialMap< T >.

                      @@ -248,7 +248,7 @@

                      Returns
                      True if there is some item at the given position, false if not.
                      -

                      Implemented in GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedSpatialMap< T >.

                      diff --git a/docs/interface_go_rogue_1_1_i_spatial_map.html b/docs/interface_go_rogue_1_1_i_spatial_map.html index 5f0d2dfb..30a351d8 100644 --- a/docs/interface_go_rogue_1_1_i_spatial_map.html +++ b/docs/interface_go_rogue_1_1_i_spatial_map.html @@ -216,7 +216,7 @@

                      Returns
                      True if item was successfully added, false otherwise.
                      -

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedSpatialMap< T >.

                      @@ -263,7 +263,7 @@

                      Returns
                      True if item was successfully added, false otherwise.
                      -

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedSpatialMap< T >.

                      @@ -284,7 +284,7 @@

                      GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedSpatialMap< T >.

                      @@ -324,7 +324,7 @@

                      Returns
                      True if item was successfully moved, false otherwise.
                      -

                      Implemented in GoRogue.AdvancedSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedLayeredSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      @@ -371,7 +371,7 @@

                      Returns
                      True if item was successfully moved, false otherwise.
                      -

                      Implemented in GoRogue.AdvancedSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedLayeredSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      @@ -494,7 +494,7 @@

                      Returns
                      True if item was removed, false otherwise.
                      -

                      Implemented in GoRogue.AdvancedSpatialMap< T >, GoRogue.AdvancedMultiSpatialMap< T >, and GoRogue.AdvancedLayeredSpatialMap< T >.

                      +

                      Implemented in GoRogue.AdvancedLayeredSpatialMap< T >, GoRogue.AdvancedSpatialMap< T >, and GoRogue.AdvancedMultiSpatialMap< T >.

                      diff --git a/docs/namespace_go_rogue.html b/docs/namespace_go_rogue.html index f297428e..f60e30f5 100644 --- a/docs/namespace_go_rogue.html +++ b/docs/namespace_go_rogue.html @@ -111,8 +111,8 @@ class  FOV  Class responsible for caculating basic FOV (see SenseMap for more advanced lighting). Effectively a simplified, slightly faster interface compared to SenseMap, that supports only a single source and only shadowcasting. This is more conducive to the typical use case for FOV. It can calculate the FOV with a finite or infinite max radius, and can use a variety of radius types, as specified in Radius class (all the same ones that SenseMap supports). It also supports both 360 degree FOV and a "field of view" (cone) FOV. One may access this class like a 2D array of doubles (FOV values), wherein the values will range from 0.0 to 1.0, where 1.0 means the corresponding map grid coordinate is at maximum visibility, and 0.0 means the cooresponding coordinate is outside of FOV entirely (not visible). Values fall off linearly with respect to radius as distance from the center increases. More...
                        -class  IDComparer - Class intended for comparing/hashing objects that implement IHasID. Type T must be a reference type. More...
                      +class  IDComparer + Class intended for comparing/hashing objects that implement IHasID. Type T must be a reference type.
                        class  IDGenerator  Class designed as a helper for situations where you need to generate and assign a unique integer to each instance of a class, eg. for a class implementing IHasID (see that interface documentation for usage example). One may initialize it with a starting unsigned integer, or 0 if none is specified. Then, every time one wants to use an integer, one should call UseID(), and use the one it returns. It is not thread-safe on its own – if it needs to be, one might consider using a lock around any UseID calls. More...
                      diff --git a/docs/search/all_4.js b/docs/search/all_4.js index cef647d7..9d835418 100644 --- a/docs/search/all_4.js +++ b/docs/search/all_4.js @@ -12,7 +12,7 @@ var searchData= ['enabled',['Enabled',['../class_go_rogue_1_1_sense_mapping_1_1_sense_source.html#a86aa00aa626eded78fa22c9c6f449cd6',1,'GoRogue::SenseMapping::SenseSource']]], ['end',['End',['../class_go_rogue_1_1_pathing_1_1_path.html#a599daf668b14ff4951e4efe07a41d593',1,'GoRogue::Pathing::Path']]], ['entities',['Entities',['../class_go_rogue_1_1_game_framework_1_1_map.html#ab86d4310d6fcbe76ef18b1b3c01f9e09',1,'GoRogue::GameFramework::Map']]], - ['equals',['Equals',['../class_go_rogue_1_1_coord.html#aee8eebff28c6d73c89629909c0d0aec8',1,'GoRogue.Coord.Equals()'],['../class_go_rogue_1_1_i_d_comparer.html#abdd0e35f375b1031893a40d5c7389313',1,'GoRogue.IDComparer.Equals()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a0b4c97e4e85688e81353f9c3ee81493c',1,'GoRogue.MapGeneration.MapArea.Equals()'],['../struct_go_rogue_1_1_rectangle.html#a36c1b915fed2d8d1d5f54902b050cc1d',1,'GoRogue.Rectangle.Equals(Rectangle other)'],['../struct_go_rogue_1_1_rectangle.html#af29b13a3b96a366d66bd6d81c4362191',1,'GoRogue.Rectangle.Equals(Object obj)']]], + ['equals',['Equals',['../class_go_rogue_1_1_coord.html#aee8eebff28c6d73c89629909c0d0aec8',1,'GoRogue.Coord.Equals()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a0b4c97e4e85688e81353f9c3ee81493c',1,'GoRogue.MapGeneration.MapArea.Equals()'],['../struct_go_rogue_1_1_rectangle.html#a36c1b915fed2d8d1d5f54902b050cc1d',1,'GoRogue.Rectangle.Equals(Rectangle other)'],['../struct_go_rogue_1_1_rectangle.html#af29b13a3b96a366d66bd6d81c4362191',1,'GoRogue.Rectangle.Equals(Object obj)']]], ['euclidean',['EUCLIDEAN',['../class_go_rogue_1_1_distance.html#a1345b527b5854a4c11b815049eac13ec',1,'GoRogue.Distance.EUCLIDEAN()'],['../class_go_rogue_1_1_distance.html#aec5155b711e7b1950fc00a665c05aabcab142d642e537e694b9314e1a56835f8d',1,'GoRogue.Distance.EUCLIDEAN()']]], ['euclideandistancemagnitude',['EuclideanDistanceMagnitude',['../class_go_rogue_1_1_coord.html#a1ecee2b7034831c1d701bf40b7af3764',1,'GoRogue.Coord.EuclideanDistanceMagnitude(Coord c1, Coord c2)'],['../class_go_rogue_1_1_coord.html#a610fc4c98a88e87f06ced09711e1ce4b',1,'GoRogue.Coord.EuclideanDistanceMagnitude(int x1, int y1, int x2, int y2)'],['../class_go_rogue_1_1_coord.html#aa0316c59cba8d57d577342d548116a5a',1,'GoRogue.Coord.EuclideanDistanceMagnitude(Coord deltaChange)'],['../class_go_rogue_1_1_coord.html#a61691fbedf8b17be8787818323ac862d',1,'GoRogue.Coord.EuclideanDistanceMagnitude(int dx, int dy)']]], ['expand',['Expand',['../struct_go_rogue_1_1_rectangle.html#acdfe857800cb541080f02d86f4063fc9',1,'GoRogue::Rectangle']]], diff --git a/docs/search/all_6.js b/docs/search/all_6.js index 1ac8d457..c194e5ac 100644 --- a/docs/search/all_6.js +++ b/docs/search/all_6.js @@ -6,7 +6,7 @@ var searchData= ['gameframework',['GameFramework',['../namespace_go_rogue_1_1_game_framework.html',1,'GoRogue']]], ['gameobject',['GameObject',['../class_go_rogue_1_1_game_framework_1_1_game_object.html',1,'GoRogue::GameFramework']]], ['gameobject',['GameObject',['../class_go_rogue_1_1_game_framework_1_1_game_object.html#a10e301c6865f988679e17a3a31ba07b5',1,'GoRogue::GameFramework::GameObject']]], - ['generate',['Generate',['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html#adad47cf50910c22ba057f39dbbd55ce8',1,'GoRogue.MapGeneration.Generators.BasicRoomsGenerator.Generate(ISettableMapView< bool > map, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html#a3c5df2a69d4de422fe08044ebe25c263',1,'GoRogue.MapGeneration.Generators.BasicRoomsGenerator.Generate(ISettableMapView< bool > map, IGenerator rng, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_cellular_automata_area_generator.html#ae4b934b0787f5393c2f4387fcf735d0e',1,'GoRogue.MapGeneration.Generators.CellularAutomataAreaGenerator.Generate()'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html#af50febfaad55610ed072707429b664db',1,'GoRogue.MapGeneration.Generators.MazeGenerator.Generate()'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html#a4fab1b53b796e03ba718a0ff64f3d31b',1,'GoRogue.MapGeneration.Generators.RoomsGenerator.Generate(ISettableMapView< bool > map, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html#ada1bcaadcf3771bffc8eb135c6547799',1,'GoRogue.MapGeneration.Generators.RoomsGenerator.Generate(ISettableMapView< bool > map, IGenerator rng, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10)']]], + ['generate',['Generate',['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html#adad47cf50910c22ba057f39dbbd55ce8',1,'GoRogue.MapGeneration.Generators.BasicRoomsGenerator.Generate(ISettableMapView< bool > map, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html#a3c5df2a69d4de422fe08044ebe25c263',1,'GoRogue.MapGeneration.Generators.BasicRoomsGenerator.Generate(ISettableMapView< bool > map, IGenerator rng, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_cellular_automata_area_generator.html#ae4b934b0787f5393c2f4387fcf735d0e',1,'GoRogue.MapGeneration.Generators.CellularAutomataAreaGenerator.Generate()'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html#a446e8d4a6d87a55479963b9282e20b9f',1,'GoRogue.MapGeneration.Generators.MazeGenerator.Generate(ISettableMapView< bool > map, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html#af50febfaad55610ed072707429b664db',1,'GoRogue.MapGeneration.Generators.MazeGenerator.Generate(ISettableMapView< bool > map, IGenerator rng=null, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html#a4fab1b53b796e03ba718a0ff64f3d31b',1,'GoRogue.MapGeneration.Generators.RoomsGenerator.Generate(ISettableMapView< bool > map, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html#ada1bcaadcf3771bffc8eb135c6547799',1,'GoRogue.MapGeneration.Generators.RoomsGenerator.Generate(ISettableMapView< bool > map, IGenerator rng, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10)']]], ['generatecellularautomatamap',['GenerateCellularAutomataMap',['../class_go_rogue_1_1_map_generation_1_1_quick_generators.html#abac0005f47bf4e0f66b8d5ada144b23b',1,'GoRogue::MapGeneration::QuickGenerators']]], ['generatedungeonmazemap',['GenerateDungeonMazeMap',['../class_go_rogue_1_1_map_generation_1_1_quick_generators.html#a3954ceb2fae541ce658e6e3bd959fe56',1,'GoRogue.MapGeneration.QuickGenerators.GenerateDungeonMazeMap(ISettableMapView< bool > map, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0, int minSidesToConnect=1, int maxSidesToConnect=4, int cancelSideConnectionSelectChance=50, int cancelConnectionPlacementChance=70, int cancelConnectionPlacementChanceIncrease=10)'],['../class_go_rogue_1_1_map_generation_1_1_quick_generators.html#af8d8883b1340bf8cad1fbd924a64da1b',1,'GoRogue.MapGeneration.QuickGenerators.GenerateDungeonMazeMap(ISettableMapView< bool > map, IGenerator rng, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0, int minSidesToConnect=1, int maxSidesToConnect=4, int cancelSideConnectionSelectChance=50, int cancelConnectionPlacementChance=70, int cancelConnectionPlacementChanceIncrease=10)']]], ['generateid',['GenerateID',['../class_go_rogue_1_1_game_framework_1_1_game_object.html#adc3d2b472426d8f6a27f6c8ab5acbd7f',1,'GoRogue::GameFramework::GameObject']]], @@ -21,7 +21,7 @@ var searchData= ['getdirectionofminvalue',['GetDirectionOfMinValue',['../class_go_rogue_1_1_pathing_1_1_goal_map.html#a1d49a20a69e97abf9237f673330db608',1,'GoRogue.Pathing.GoalMap.GetDirectionOfMinValue()'],['../class_go_rogue_1_1_pathing_1_1_goal_map_extensions.html#ab3a181c681be137bd6929799dc9051c5',1,'GoRogue.Pathing.GoalMapExtensions.GetDirectionOfMinValue()']]], ['getenumerator',['GetEnumerator',['../class_go_rogue_1_1_advanced_layered_spatial_map.html#a86156c4d7450e9300bde5044f0da64fe',1,'GoRogue.AdvancedLayeredSpatialMap.GetEnumerator()'],['../class_go_rogue_1_1_advanced_multi_spatial_map.html#a4324e13a8bb32c01e7588a9e3467a75f',1,'GoRogue.AdvancedMultiSpatialMap.GetEnumerator()'],['../class_go_rogue_1_1_sense_mapping_1_1_sense_map.html#a6ad5d226916a9d331b6d4570680d0057',1,'GoRogue.SenseMapping.SenseMap.GetEnumerator()'],['../class_go_rogue_1_1_advanced_spatial_map.html#a78951f7fbb66d5c85eaa90958fd46fc4',1,'GoRogue.AdvancedSpatialMap.GetEnumerator()']]], ['getexactunion',['GetExactUnion',['../struct_go_rogue_1_1_rectangle.html#a629203e2f2f66870467f34851af54b32',1,'GoRogue::Rectangle']]], - ['gethashcode',['GetHashCode',['../class_go_rogue_1_1_coord.html#acc0cb4f91fb9942e4ecb7216a56ed240',1,'GoRogue.Coord.GetHashCode()'],['../class_go_rogue_1_1_i_d_comparer.html#a0611bdb3484603f680eb90e81772466d',1,'GoRogue.IDComparer.GetHashCode()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a5c7b4efd3dc2dc25c1584cee8ab01815',1,'GoRogue.MapGeneration.MapArea.GetHashCode()'],['../struct_go_rogue_1_1_rectangle.html#aa2072ce16f29e71a25c744244a9de8bb',1,'GoRogue.Rectangle.GetHashCode()']]], + ['gethashcode',['GetHashCode',['../class_go_rogue_1_1_coord.html#acc0cb4f91fb9942e4ecb7216a56ed240',1,'GoRogue.Coord.GetHashCode()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a5c7b4efd3dc2dc25c1584cee8ab01815',1,'GoRogue.MapGeneration.MapArea.GetHashCode()'],['../struct_go_rogue_1_1_rectangle.html#aa2072ce16f29e71a25c744244a9de8bb',1,'GoRogue.Rectangle.GetHashCode()']]], ['getintersection',['GetIntersection',['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a3e4ee55f38563b42fc532dc2671db8fa',1,'GoRogue.MapGeneration.MapArea.GetIntersection()'],['../struct_go_rogue_1_1_rectangle.html#a51ede39a39c668cc0efd14461e3bae9a',1,'GoRogue.Rectangle.GetIntersection()']]], ['getitem',['GetItem',['../class_go_rogue_1_1_advanced_spatial_map.html#a50caaa647455cc316f106a624f79db1f',1,'GoRogue.AdvancedSpatialMap.GetItem(Coord position)'],['../class_go_rogue_1_1_advanced_spatial_map.html#ad473496acb120599fd9b4ef5e3f09708',1,'GoRogue.AdvancedSpatialMap.GetItem(int x, int y)']]], ['getitems',['GetItems',['../interface_go_rogue_1_1_i_read_only_layered_spatial_map.html#a0efbbf7de62bc17fc8046b28606e0225',1,'GoRogue.IReadOnlyLayeredSpatialMap.GetItems(Coord position, uint layerMask=uint.MaxValue)'],['../interface_go_rogue_1_1_i_read_only_layered_spatial_map.html#ad724467cdbfc47c090b26f2169bb1301',1,'GoRogue.IReadOnlyLayeredSpatialMap.GetItems(int x, int y, uint layerMask=uint.MaxValue)'],['../interface_go_rogue_1_1_i_read_only_spatial_map.html#a14896069cf39a12287e723f34037b594',1,'GoRogue.IReadOnlySpatialMap.GetItems(Coord position)'],['../interface_go_rogue_1_1_i_read_only_spatial_map.html#aa49f6c8c2640bbe019cb5a0837bc4bcf',1,'GoRogue.IReadOnlySpatialMap.GetItems(int x, int y)'],['../class_go_rogue_1_1_advanced_layered_spatial_map.html#adffcc0606ef9d013e02e20acf5c8a573',1,'GoRogue.AdvancedLayeredSpatialMap.GetItems(Coord position, uint layerMask=uint.MaxValue)'],['../class_go_rogue_1_1_advanced_layered_spatial_map.html#a0f484cbac48c4d1fcb286d0663cb4723',1,'GoRogue.AdvancedLayeredSpatialMap.GetItems(int x, int y, uint layerMask=uint.MaxValue)'],['../class_go_rogue_1_1_advanced_multi_spatial_map.html#a5bef78cf8155acd12a1fae761aa93bc4',1,'GoRogue.AdvancedMultiSpatialMap.GetItems(Coord position)'],['../class_go_rogue_1_1_advanced_multi_spatial_map.html#a9db0b62eb8575b07d38bd7b18e8750bf',1,'GoRogue.AdvancedMultiSpatialMap.GetItems(int x, int y)'],['../class_go_rogue_1_1_advanced_spatial_map.html#a113b5c32ea982c004e5f12b33b27c65b',1,'GoRogue.AdvancedSpatialMap.GetItems(Coord position)'],['../class_go_rogue_1_1_advanced_spatial_map.html#aaf8a325c971a3d94a70d376d28a9df2d',1,'GoRogue.AdvancedSpatialMap.GetItems(int x, int y)']]], diff --git a/docs/search/all_8.js b/docs/search/all_8.js index a951270a..7caffd3d 100644 --- a/docs/search/all_8.js +++ b/docs/search/all_8.js @@ -2,9 +2,8 @@ var searchData= [ ['iareaconnectionpointselector',['IAreaConnectionPointSelector',['../interface_go_rogue_1_1_map_generation_1_1_connectors_1_1_i_area_connection_point_selector.html',1,'GoRogue::MapGeneration::Connectors']]], ['id',['ID',['../class_go_rogue_1_1_game_framework_1_1_game_object.html#abe04e5be11788bafd184c89817c9495d',1,'GoRogue.GameFramework.GameObject.ID()'],['../interface_go_rogue_1_1_i_has_i_d.html#a8dc6bb60696aaba9e75b14557ef9c5cb',1,'GoRogue.IHasID.ID()']]], - ['idcomparer',['IDComparer',['../class_go_rogue_1_1_i_d_comparer.html',1,'GoRogue']]], - ['idgenerator',['IDGenerator',['../class_go_rogue_1_1_i_d_generator.html#aff04d019ee417af21044b5f71ab0b245',1,'GoRogue::IDGenerator']]], ['idgenerator',['IDGenerator',['../class_go_rogue_1_1_i_d_generator.html',1,'GoRogue']]], + ['idgenerator',['IDGenerator',['../class_go_rogue_1_1_i_d_generator.html#aff04d019ee417af21044b5f71ab0b245',1,'GoRogue::IDGenerator']]], ['idiceexpression',['IDiceExpression',['../interface_go_rogue_1_1_dice_notation_1_1_i_dice_expression.html',1,'GoRogue::DiceNotation']]], ['ihasid',['IHasID',['../interface_go_rogue_1_1_i_has_i_d.html',1,'GoRogue']]], ['ihaslayer',['IHasLayer',['../interface_go_rogue_1_1_i_has_layer.html',1,'GoRogue']]], @@ -23,8 +22,8 @@ var searchData= ['intersects',['Intersects',['../interface_go_rogue_1_1_map_generation_1_1_i_read_only_map_area.html#a8fd829ad6a34b2680188678dbb8d034a',1,'GoRogue.MapGeneration.IReadOnlyMapArea.Intersects()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#abfabb0037b7bd94d22f13eea3c78d1cb',1,'GoRogue.MapGeneration.MapArea.Intersects()'],['../struct_go_rogue_1_1_rectangle.html#a02ad05add215d3d996851bce48136bd1',1,'GoRogue.Rectangle.Intersects()']]], ['invalidchooseexception',['InvalidChooseException',['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_choose_exception.html#acec96b5e948bde0cb5441152a41d7746',1,'GoRogue.DiceNotation.Exceptions.InvalidChooseException.InvalidChooseException()'],['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_choose_exception.html#a7b6e3a4c26141da78f33cf17ad97b964',1,'GoRogue.DiceNotation.Exceptions.InvalidChooseException.InvalidChooseException(string message)'],['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_choose_exception.html#a2c08c3d99ec0a075cfaf99cee4b28331',1,'GoRogue.DiceNotation.Exceptions.InvalidChooseException.InvalidChooseException(string message, Exception innerException)']]], ['invalidchooseexception',['InvalidChooseException',['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_choose_exception.html',1,'GoRogue::DiceNotation::Exceptions']]], - ['invalidmultiplicityexception',['InvalidMultiplicityException',['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_multiplicity_exception.html',1,'GoRogue::DiceNotation::Exceptions']]], ['invalidmultiplicityexception',['InvalidMultiplicityException',['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_multiplicity_exception.html#a5b5ba3974d5b21fe5003929ba5476146',1,'GoRogue.DiceNotation.Exceptions.InvalidMultiplicityException.InvalidMultiplicityException()'],['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_multiplicity_exception.html#a8f4c3ec35b85d0e5c8469e1f4161cad3',1,'GoRogue.DiceNotation.Exceptions.InvalidMultiplicityException.InvalidMultiplicityException(string message)'],['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_multiplicity_exception.html#ada05c4df95663ada088b1b3810dc9cb5',1,'GoRogue.DiceNotation.Exceptions.InvalidMultiplicityException.InvalidMultiplicityException(string message, Exception innerException)']]], + ['invalidmultiplicityexception',['InvalidMultiplicityException',['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_multiplicity_exception.html',1,'GoRogue::DiceNotation::Exceptions']]], ['invalidsyntaxexception',['InvalidSyntaxException',['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_syntax_exception.html',1,'GoRogue::DiceNotation::Exceptions']]], ['invalidsyntaxexception',['InvalidSyntaxException',['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_syntax_exception.html#aebacab6443f549ab9711e5beae1d2d5c',1,'GoRogue.DiceNotation.Exceptions.InvalidSyntaxException.InvalidSyntaxException()'],['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_syntax_exception.html#a3d697730281c56b4940ab55de261aecb',1,'GoRogue.DiceNotation.Exceptions.InvalidSyntaxException.InvalidSyntaxException(string message)'],['../class_go_rogue_1_1_dice_notation_1_1_exceptions_1_1_invalid_syntax_exception.html#a67f64f1251cb3a4477b0c5ca2eeec152',1,'GoRogue.DiceNotation.Exceptions.InvalidSyntaxException.InvalidSyntaxException(string message, Exception innerException)']]], ['iparser',['IParser',['../interface_go_rogue_1_1_dice_notation_1_1_i_parser.html',1,'GoRogue::DiceNotation']]], @@ -48,8 +47,8 @@ var searchData= ['iswalkable',['IsWalkable',['../class_go_rogue_1_1_game_framework_1_1_game_object.html#a9f6dacb48535b73cd4da10cac3671a9a',1,'GoRogue::GameFramework::GameObject']]], ['item',['Item',['../interface_go_rogue_1_1_i_spatial_tuple.html#ac9cbce699125edaca2979a097d0fdd84',1,'GoRogue.ISpatialTuple.Item()'],['../class_go_rogue_1_1_item_event_args.html#a19ecaf650988f3a56e93497f79d2d202',1,'GoRogue.ItemEventArgs.Item()'],['../class_go_rogue_1_1_item_moved_event_args.html#a13da8795d1f4bd8828b967471f3b7f66',1,'GoRogue.ItemMovedEventArgs.Item()']]], ['itemadded',['ItemAdded',['../interface_go_rogue_1_1_i_spatial_map.html#a0ecfa5b443e064340260102b65b5d5e6',1,'GoRogue.ISpatialMap.ItemAdded()'],['../class_go_rogue_1_1_advanced_layered_spatial_map.html#a49a7603e155088a9131b253a9f7a8948',1,'GoRogue.AdvancedLayeredSpatialMap.ItemAdded()'],['../class_go_rogue_1_1_advanced_multi_spatial_map.html#ab0365d188fdb88409ae3535631e65828',1,'GoRogue.AdvancedMultiSpatialMap.ItemAdded()'],['../class_go_rogue_1_1_advanced_spatial_map.html#a9fc9d0b4795c5b1adf28c0d2c9141d4f',1,'GoRogue.AdvancedSpatialMap.ItemAdded()']]], - ['itemeventargs',['ItemEventArgs',['../class_go_rogue_1_1_item_event_args.html',1,'GoRogue']]], ['itemeventargs',['ItemEventArgs',['../class_go_rogue_1_1_item_event_args.html#a4e905e442816f036034a2e4d65f2dd46',1,'GoRogue.ItemEventArgs.ItemEventArgs(T item, Coord position)'],['../class_go_rogue_1_1_item_event_args.html#ac8ee7421a5b5765024a56d7c297844be',1,'GoRogue.ItemEventArgs.ItemEventArgs(T item, int x, int y)']]], + ['itemeventargs',['ItemEventArgs',['../class_go_rogue_1_1_item_event_args.html',1,'GoRogue']]], ['itemmoved',['ItemMoved',['../interface_go_rogue_1_1_i_spatial_map.html#aeaa536f408fa24a3a82ba684ba886642',1,'GoRogue.ISpatialMap.ItemMoved()'],['../class_go_rogue_1_1_advanced_layered_spatial_map.html#ac60d0c6feb3caa928b3fc01ac8ca3733',1,'GoRogue.AdvancedLayeredSpatialMap.ItemMoved()'],['../class_go_rogue_1_1_advanced_multi_spatial_map.html#ac99f62275f60f3f3b2dab36d71868599',1,'GoRogue.AdvancedMultiSpatialMap.ItemMoved()'],['../class_go_rogue_1_1_advanced_spatial_map.html#a2d244655859edc0c85b3003dca651676',1,'GoRogue.AdvancedSpatialMap.ItemMoved()']]], ['itemmovedeventargs',['ItemMovedEventArgs',['../class_go_rogue_1_1_item_moved_event_args.html#aa971967f8a0cb920507d4a53acab9d55',1,'GoRogue.ItemMovedEventArgs.ItemMovedEventArgs(T item, Coord oldPosition, Coord newPosition)'],['../class_go_rogue_1_1_item_moved_event_args.html#a6da1be312ac70ce08ec1c582ee53b25e',1,'GoRogue.ItemMovedEventArgs.ItemMovedEventArgs(T item, int oldPositionX, int oldPositionY, int newPositionX, int newPositionY)']]], ['itemmovedeventargs',['ItemMovedEventArgs',['../class_go_rogue_1_1_item_moved_event_args.html',1,'GoRogue']]], diff --git a/docs/search/classes_8.js b/docs/search/classes_8.js index 490fe78e..e89d8696 100644 --- a/docs/search/classes_8.js +++ b/docs/search/classes_8.js @@ -1,7 +1,6 @@ var searchData= [ ['iareaconnectionpointselector',['IAreaConnectionPointSelector',['../interface_go_rogue_1_1_map_generation_1_1_connectors_1_1_i_area_connection_point_selector.html',1,'GoRogue::MapGeneration::Connectors']]], - ['idcomparer',['IDComparer',['../class_go_rogue_1_1_i_d_comparer.html',1,'GoRogue']]], ['idgenerator',['IDGenerator',['../class_go_rogue_1_1_i_d_generator.html',1,'GoRogue']]], ['idiceexpression',['IDiceExpression',['../interface_go_rogue_1_1_dice_notation_1_1_i_dice_expression.html',1,'GoRogue::DiceNotation']]], ['ihasid',['IHasID',['../interface_go_rogue_1_1_i_has_i_d.html',1,'GoRogue']]], diff --git a/docs/search/functions_4.js b/docs/search/functions_4.js index 0a5fa8ed..579cceb9 100644 --- a/docs/search/functions_4.js +++ b/docs/search/functions_4.js @@ -3,7 +3,7 @@ var searchData= ['effect',['Effect',['../class_go_rogue_1_1_effect.html#ae3b656f69ebb26020c12feb77a37f513',1,'GoRogue::Effect']]], ['effectargs',['EffectArgs',['../class_go_rogue_1_1_effect_args.html#a8d368d99a5254df8284d4749dc50f3dc',1,'GoRogue::EffectArgs']]], ['effecttrigger',['EffectTrigger',['../class_go_rogue_1_1_effect_trigger.html#a7dbb4f4f693a8ef02247ec733d8fc672',1,'GoRogue::EffectTrigger']]], - ['equals',['Equals',['../class_go_rogue_1_1_coord.html#aee8eebff28c6d73c89629909c0d0aec8',1,'GoRogue.Coord.Equals()'],['../class_go_rogue_1_1_i_d_comparer.html#abdd0e35f375b1031893a40d5c7389313',1,'GoRogue.IDComparer.Equals()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a0b4c97e4e85688e81353f9c3ee81493c',1,'GoRogue.MapGeneration.MapArea.Equals()'],['../struct_go_rogue_1_1_rectangle.html#a36c1b915fed2d8d1d5f54902b050cc1d',1,'GoRogue.Rectangle.Equals(Rectangle other)'],['../struct_go_rogue_1_1_rectangle.html#af29b13a3b96a366d66bd6d81c4362191',1,'GoRogue.Rectangle.Equals(Object obj)']]], + ['equals',['Equals',['../class_go_rogue_1_1_coord.html#aee8eebff28c6d73c89629909c0d0aec8',1,'GoRogue.Coord.Equals()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a0b4c97e4e85688e81353f9c3ee81493c',1,'GoRogue.MapGeneration.MapArea.Equals()'],['../struct_go_rogue_1_1_rectangle.html#a36c1b915fed2d8d1d5f54902b050cc1d',1,'GoRogue.Rectangle.Equals(Rectangle other)'],['../struct_go_rogue_1_1_rectangle.html#af29b13a3b96a366d66bd6d81c4362191',1,'GoRogue.Rectangle.Equals(Object obj)']]], ['euclideandistancemagnitude',['EuclideanDistanceMagnitude',['../class_go_rogue_1_1_coord.html#a1ecee2b7034831c1d701bf40b7af3764',1,'GoRogue.Coord.EuclideanDistanceMagnitude(Coord c1, Coord c2)'],['../class_go_rogue_1_1_coord.html#a610fc4c98a88e87f06ced09711e1ce4b',1,'GoRogue.Coord.EuclideanDistanceMagnitude(int x1, int y1, int x2, int y2)'],['../class_go_rogue_1_1_coord.html#aa0316c59cba8d57d577342d548116a5a',1,'GoRogue.Coord.EuclideanDistanceMagnitude(Coord deltaChange)'],['../class_go_rogue_1_1_coord.html#a61691fbedf8b17be8787818323ac862d',1,'GoRogue.Coord.EuclideanDistanceMagnitude(int dx, int dy)']]], ['expand',['Expand',['../struct_go_rogue_1_1_rectangle.html#acdfe857800cb541080f02d86f4063fc9',1,'GoRogue::Rectangle']]], ['extendtostring_3c_20k_2c_20v_20_3e',['ExtendToString< K, V >',['../class_go_rogue_1_1_utility.html#a62bfc0c8fb660afb3bf643c2dbc23832',1,'GoRogue::Utility']]], diff --git a/docs/search/functions_6.js b/docs/search/functions_6.js index 8e8fd1fb..6f496067 100644 --- a/docs/search/functions_6.js +++ b/docs/search/functions_6.js @@ -1,7 +1,7 @@ var searchData= [ ['gameobject',['GameObject',['../class_go_rogue_1_1_game_framework_1_1_game_object.html#a10e301c6865f988679e17a3a31ba07b5',1,'GoRogue::GameFramework::GameObject']]], - ['generate',['Generate',['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html#adad47cf50910c22ba057f39dbbd55ce8',1,'GoRogue.MapGeneration.Generators.BasicRoomsGenerator.Generate(ISettableMapView< bool > map, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html#a3c5df2a69d4de422fe08044ebe25c263',1,'GoRogue.MapGeneration.Generators.BasicRoomsGenerator.Generate(ISettableMapView< bool > map, IGenerator rng, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_cellular_automata_area_generator.html#ae4b934b0787f5393c2f4387fcf735d0e',1,'GoRogue.MapGeneration.Generators.CellularAutomataAreaGenerator.Generate()'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html#af50febfaad55610ed072707429b664db',1,'GoRogue.MapGeneration.Generators.MazeGenerator.Generate()'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html#a4fab1b53b796e03ba718a0ff64f3d31b',1,'GoRogue.MapGeneration.Generators.RoomsGenerator.Generate(ISettableMapView< bool > map, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html#ada1bcaadcf3771bffc8eb135c6547799',1,'GoRogue.MapGeneration.Generators.RoomsGenerator.Generate(ISettableMapView< bool > map, IGenerator rng, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10)']]], + ['generate',['Generate',['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html#adad47cf50910c22ba057f39dbbd55ce8',1,'GoRogue.MapGeneration.Generators.BasicRoomsGenerator.Generate(ISettableMapView< bool > map, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_basic_rooms_generator.html#a3c5df2a69d4de422fe08044ebe25c263',1,'GoRogue.MapGeneration.Generators.BasicRoomsGenerator.Generate(ISettableMapView< bool > map, IGenerator rng, int maxRooms, int roomMinSize, int roomMaxSize, int attemptsPerRoom)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_cellular_automata_area_generator.html#ae4b934b0787f5393c2f4387fcf735d0e',1,'GoRogue.MapGeneration.Generators.CellularAutomataAreaGenerator.Generate()'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html#a446e8d4a6d87a55479963b9282e20b9f',1,'GoRogue.MapGeneration.Generators.MazeGenerator.Generate(ISettableMapView< bool > map, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_maze_generator.html#af50febfaad55610ed072707429b664db',1,'GoRogue.MapGeneration.Generators.MazeGenerator.Generate(ISettableMapView< bool > map, IGenerator rng=null, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html#a4fab1b53b796e03ba718a0ff64f3d31b',1,'GoRogue.MapGeneration.Generators.RoomsGenerator.Generate(ISettableMapView< bool > map, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10)'],['../class_go_rogue_1_1_map_generation_1_1_generators_1_1_rooms_generator.html#ada1bcaadcf3771bffc8eb135c6547799',1,'GoRogue.MapGeneration.Generators.RoomsGenerator.Generate(ISettableMapView< bool > map, IGenerator rng, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10)']]], ['generatecellularautomatamap',['GenerateCellularAutomataMap',['../class_go_rogue_1_1_map_generation_1_1_quick_generators.html#abac0005f47bf4e0f66b8d5ada144b23b',1,'GoRogue::MapGeneration::QuickGenerators']]], ['generatedungeonmazemap',['GenerateDungeonMazeMap',['../class_go_rogue_1_1_map_generation_1_1_quick_generators.html#a3954ceb2fae541ce658e6e3bd959fe56',1,'GoRogue.MapGeneration.QuickGenerators.GenerateDungeonMazeMap(ISettableMapView< bool > map, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0, int minSidesToConnect=1, int maxSidesToConnect=4, int cancelSideConnectionSelectChance=50, int cancelConnectionPlacementChance=70, int cancelConnectionPlacementChanceIncrease=10)'],['../class_go_rogue_1_1_map_generation_1_1_quick_generators.html#af8d8883b1340bf8cad1fbd924a64da1b',1,'GoRogue.MapGeneration.QuickGenerators.GenerateDungeonMazeMap(ISettableMapView< bool > map, IGenerator rng, int minRooms, int maxRooms, int roomMinSize, int roomMaxSize, float roomSizeRatioX=1f, float roomSizeRatioY=1f, int maxCreationAttempts=10, int maxPlacementAttempts=10, int crawlerChangeDirectionImprovement=10, int saveDeadEndChance=0, int minSidesToConnect=1, int maxSidesToConnect=4, int cancelSideConnectionSelectChance=50, int cancelConnectionPlacementChance=70, int cancelConnectionPlacementChanceIncrease=10)']]], ['generateid',['GenerateID',['../class_go_rogue_1_1_game_framework_1_1_game_object.html#adc3d2b472426d8f6a27f6c8ab5acbd7f',1,'GoRogue::GameFramework::GameObject']]], @@ -14,7 +14,7 @@ var searchData= ['getdirectionofminvalue',['GetDirectionOfMinValue',['../class_go_rogue_1_1_pathing_1_1_goal_map.html#a1d49a20a69e97abf9237f673330db608',1,'GoRogue.Pathing.GoalMap.GetDirectionOfMinValue()'],['../class_go_rogue_1_1_pathing_1_1_goal_map_extensions.html#ab3a181c681be137bd6929799dc9051c5',1,'GoRogue.Pathing.GoalMapExtensions.GetDirectionOfMinValue()']]], ['getenumerator',['GetEnumerator',['../class_go_rogue_1_1_advanced_layered_spatial_map.html#a86156c4d7450e9300bde5044f0da64fe',1,'GoRogue.AdvancedLayeredSpatialMap.GetEnumerator()'],['../class_go_rogue_1_1_advanced_multi_spatial_map.html#a4324e13a8bb32c01e7588a9e3467a75f',1,'GoRogue.AdvancedMultiSpatialMap.GetEnumerator()'],['../class_go_rogue_1_1_sense_mapping_1_1_sense_map.html#a6ad5d226916a9d331b6d4570680d0057',1,'GoRogue.SenseMapping.SenseMap.GetEnumerator()'],['../class_go_rogue_1_1_advanced_spatial_map.html#a78951f7fbb66d5c85eaa90958fd46fc4',1,'GoRogue.AdvancedSpatialMap.GetEnumerator()']]], ['getexactunion',['GetExactUnion',['../struct_go_rogue_1_1_rectangle.html#a629203e2f2f66870467f34851af54b32',1,'GoRogue::Rectangle']]], - ['gethashcode',['GetHashCode',['../class_go_rogue_1_1_coord.html#acc0cb4f91fb9942e4ecb7216a56ed240',1,'GoRogue.Coord.GetHashCode()'],['../class_go_rogue_1_1_i_d_comparer.html#a0611bdb3484603f680eb90e81772466d',1,'GoRogue.IDComparer.GetHashCode()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a5c7b4efd3dc2dc25c1584cee8ab01815',1,'GoRogue.MapGeneration.MapArea.GetHashCode()'],['../struct_go_rogue_1_1_rectangle.html#aa2072ce16f29e71a25c744244a9de8bb',1,'GoRogue.Rectangle.GetHashCode()']]], + ['gethashcode',['GetHashCode',['../class_go_rogue_1_1_coord.html#acc0cb4f91fb9942e4ecb7216a56ed240',1,'GoRogue.Coord.GetHashCode()'],['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a5c7b4efd3dc2dc25c1584cee8ab01815',1,'GoRogue.MapGeneration.MapArea.GetHashCode()'],['../struct_go_rogue_1_1_rectangle.html#aa2072ce16f29e71a25c744244a9de8bb',1,'GoRogue.Rectangle.GetHashCode()']]], ['getintersection',['GetIntersection',['../class_go_rogue_1_1_map_generation_1_1_map_area.html#a3e4ee55f38563b42fc532dc2671db8fa',1,'GoRogue.MapGeneration.MapArea.GetIntersection()'],['../struct_go_rogue_1_1_rectangle.html#a51ede39a39c668cc0efd14461e3bae9a',1,'GoRogue.Rectangle.GetIntersection()']]], ['getitem',['GetItem',['../class_go_rogue_1_1_advanced_spatial_map.html#a50caaa647455cc316f106a624f79db1f',1,'GoRogue.AdvancedSpatialMap.GetItem(Coord position)'],['../class_go_rogue_1_1_advanced_spatial_map.html#ad473496acb120599fd9b4ef5e3f09708',1,'GoRogue.AdvancedSpatialMap.GetItem(int x, int y)']]], ['getitems',['GetItems',['../interface_go_rogue_1_1_i_read_only_layered_spatial_map.html#a0efbbf7de62bc17fc8046b28606e0225',1,'GoRogue.IReadOnlyLayeredSpatialMap.GetItems(Coord position, uint layerMask=uint.MaxValue)'],['../interface_go_rogue_1_1_i_read_only_layered_spatial_map.html#ad724467cdbfc47c090b26f2169bb1301',1,'GoRogue.IReadOnlyLayeredSpatialMap.GetItems(int x, int y, uint layerMask=uint.MaxValue)'],['../interface_go_rogue_1_1_i_read_only_spatial_map.html#a14896069cf39a12287e723f34037b594',1,'GoRogue.IReadOnlySpatialMap.GetItems(Coord position)'],['../interface_go_rogue_1_1_i_read_only_spatial_map.html#aa49f6c8c2640bbe019cb5a0837bc4bcf',1,'GoRogue.IReadOnlySpatialMap.GetItems(int x, int y)'],['../class_go_rogue_1_1_advanced_layered_spatial_map.html#adffcc0606ef9d013e02e20acf5c8a573',1,'GoRogue.AdvancedLayeredSpatialMap.GetItems(Coord position, uint layerMask=uint.MaxValue)'],['../class_go_rogue_1_1_advanced_layered_spatial_map.html#a0f484cbac48c4d1fcb286d0663cb4723',1,'GoRogue.AdvancedLayeredSpatialMap.GetItems(int x, int y, uint layerMask=uint.MaxValue)'],['../class_go_rogue_1_1_advanced_multi_spatial_map.html#a5bef78cf8155acd12a1fae761aa93bc4',1,'GoRogue.AdvancedMultiSpatialMap.GetItems(Coord position)'],['../class_go_rogue_1_1_advanced_multi_spatial_map.html#a9db0b62eb8575b07d38bd7b18e8750bf',1,'GoRogue.AdvancedMultiSpatialMap.GetItems(int x, int y)'],['../class_go_rogue_1_1_advanced_spatial_map.html#a113b5c32ea982c004e5f12b33b27c65b',1,'GoRogue.AdvancedSpatialMap.GetItems(Coord position)'],['../class_go_rogue_1_1_advanced_spatial_map.html#aaf8a325c971a3d94a70d376d28a9df2d',1,'GoRogue.AdvancedSpatialMap.GetItems(int x, int y)']]],