Class GrassOnlyDummyMapLoader

Class that represents a dummy map loader that yields all grass tiles.

Inheritance
System.Object
GrassOnlyDummyMapLoader
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Fibula.Map.GrassOnly
Assembly: Fibula.Map.GrassOnly.dll
Syntax
public class GrassOnlyDummyMapLoader : IMapLoader

Constructors

| Improve this Doc View Source

GrassOnlyDummyMapLoader(IItemFactory)

Initializes a new instance of the GrassOnlyDummyMapLoader class.

Declaration
public GrassOnlyDummyMapLoader(IItemFactory itemFactory)
Parameters
Type Name Description
IItemFactory itemFactory

A reference to the item factory.

Properties

| Improve this Doc View Source

ItemFactory

Gets the item factory instance.

Declaration
public IItemFactory ItemFactory { get; }
Property Value
Type Description
IItemFactory
| Improve this Doc View Source

PercentageComplete

Gets the percentage completed loading the map [0, 100].

Declaration
public byte PercentageComplete { get; }
Property Value
Type Description
System.Byte

Methods

| Improve this Doc View Source

HasLoaded(Int32, Int32, SByte)

Gets a value indicating whether this loader has previously loaded the given coordinates.

Declaration
public 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.
| Improve this Doc View Source

Load(Int32, Int32, Int32, Int32, SByte, SByte)

Attempts to load all tiles within a 3 dimensional coordinates window.

Declaration
public 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.

Events

| Improve this Doc View Source

WindowLoaded

Event not in use for this loader.

Declaration
public event WindowLoaded WindowLoaded
Event Type
Type Description
WindowLoaded

Implements

Extension Methods