Namespace GoRogue.GameFramework
Classes
FullMapTransparencyView
Grid view used as the TransparencyView for a map when non-terrain layers can have non-transparent objects.
FullMapWalkabilityView
Grid view used as the WalkabilityView for a map when non-terrain layers can have non-walkable objects.
GameObject
Concrete implementation of IGameObject that works for most use cases.
GameObjectCurrentMapChanged
Event arguments for events fired when an IGameObject is added to/removed from a Map.
GameObjectExtensions
A collection of helpful extension methods for IGameObject instances.
Map
Base class for a map that consists of one or more objects of base type IGameObject. It implements basic functionality to manage and access these objects, as well as commonly needed functionality like tile exploration, FOV, and pathfinding. It also provides methods to easily access these objects as instances of some derived type. This can be used to easily access functionality you've implemented in a subclass. Finally, it provides the ability to attach components to the map.
TerrainOnlyMapTransparencyView
Grid view used as the TransparencyView for a map when only the terrain layer can have non-transparent tiles.
TerrainOnlyMapWalkabilityView
Grid view used as the WalkabilityView for a map when only the terrain layer can have non-walkable tiles.
Structs
MapEntitiesAtCastEnumerator<T>
A custom enumerator used to iterate over all entities on a Map which are at a given location on given layers and are of a given type efficiently. Entities are returned in order from highest layer to lowest, as applicable. Any entities not of the given type are ignored.
Generally, you should use GetEntitiesAt<TEntity>(Point, uint) or one of that function's overloads to get an instance of this enumerator, rather than creating one yourself.
MapObjectsAtCastEnumerator<T>
A custom enumerator used to iterate over all objects on a Map which are at a given location on given layers and are of a given type efficiently. Items are returned in order from highest layer to lowest, as applicable. Any items not of the given type are ignored.
Generally, you should use GetObjectsAt<TObject>(Point, uint) or one of that function's overloads to get an instance of this enumerator, rather than creating one yourself.
MapObjectsAtEnumerator
A custom enumerator used to iterate over all objects on a Map which are at a given location on given layers efficiently. Items are returned in order from highest layer to lowest, as applicable.
Generally, you should use GetObjectsAt(Point, uint) or one of that function's overloads to get an instance of this enumerator, rather than creating one yourself.
Interfaces
IGameObject
Base interface required for any object that has a grid position and can be added to a Map. Implements basic attributes generally common to all objects on a map, as well as properties/methods that Map needs to function. It also provides a container that you may attach arbitrary components to (via the IObjectWithComponents interface).
For a concrete implementation, see GameObject.