Interface IMapLoader
Common interface for map loaders.
Namespace: Fibula.Map.Contracts.Abstractions
Assembly: Fibula.Map.Contracts.dll
Syntax
public interface IMapLoaderProperties
| Improve this Doc View SourcePercentageComplete
Gets the percentage completed loading the map [0, 100].
Declaration
byte PercentageComplete { get; }Property Value
| Type | Description |
|---|---|
| System.Byte |
Methods
| Improve this Doc View SourceHasLoaded(Int32, Int32, SByte)
Gets a value indicating whether this loader has previously loaded the given coordinates.
Declaration
bool HasLoaded(int x, int y, sbyte z)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | x | The X coordinate. |
| System.Int32 | y | The Y coordinate. |
| System.SByte | z | The Z coordinate. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the loader has previously loaded the given coordinates, false otherwise. |
Load(Int32, Int32, Int32, Int32, SByte, SByte)
Attempts to load all tiles within a 3 dimensional coordinates window.
Declaration
IEnumerable<(Location Location, ITile Tile)> Load(int fromX, int toX, int fromY, int toY, sbyte fromZ, sbyte toZ)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | fromX | The start X coordinate for the load window. |
| System.Int32 | toX | The end X coordinate for the load window. |
| System.Int32 | fromY | The start Y coordinate for the load window. |
| System.Int32 | toY | The end Y coordinate for the load window. |
| System.SByte | fromZ | The start Z coordinate for the load window. |
| System.SByte | toZ | The end Z coordinate for the load window. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.ValueTuple<Location, ITile>> | A collection of ordered pairs containing the Location and its corresponding ITile. |