Show / Hide Table of Contents

    Class Map

    Class that represents the map for the game server.

    Inheritance
    System.Object
    Map
    Implements
    IMap
    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
    Assembly: Fibula.Map.dll
    Syntax
    public class Map : IMap

    Constructors

    | Improve this Doc View Source

    Map(ILogger, IMapLoader, ICreatureFinder)

    Initializes a new instance of the Map class.

    Declaration
    public Map(ILogger logger, IMapLoader mapLoader, ICreatureFinder creatureFinder)
    Parameters
    Type Name Description
    Serilog.ILogger logger

    A reference to the logger to use.

    IMapLoader mapLoader

    The map loader to use to load this map.

    ICreatureFinder creatureFinder

    A reference to the creature finder.

    Properties

    | Improve this Doc View Source

    CreatureFinder

    Gets the reference to the creature finder.

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

    Loader

    Gets the reference to the selected map loader.

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

    Logger

    Gets the reference to the current logger.

    Declaration
    public ILogger Logger { get; }
    Property Value
    Type Description
    Serilog.ILogger

    Methods

    | Improve this Doc View Source

    GetTileAt(Location)

    Attempts to get a ITile at a given Location, if any.

    Declaration
    public ITile GetTileAt(Location location)
    Parameters
    Type Name Description
    Location location

    The location to get the file from.

    Returns
    Type Description
    ITile

    A reference to the ITile found, if any.

    | Improve this Doc View Source

    GetTileAt(Location, out ITile, Boolean)

    Attempts to get a ITile at a given Location, if any.

    Declaration
    public bool GetTileAt(Location location, out ITile tile, bool loadAsNeeded = true)
    Parameters
    Type Name Description
    Location location

    The location to get the file from.

    ITile tile

    A reference to the ITile found, if any.

    System.Boolean loadAsNeeded

    Optional. A value indicating whether to attempt to load tiles if the loader hasn't loaded them yet.

    Returns
    Type Description
    System.Boolean

    A value indicating whether a ITile was found, false otherwise.

    Events

    | Improve this Doc View Source

    WindowLoaded

    Event invoked when a window of coordinates in the map is loaded.

    Declaration
    public event WindowLoaded WindowLoaded
    Event Type
    Type Description
    WindowLoaded

    Implements

    IMap

    Extension Methods

    ObjectExtensions.YieldSingleItem<T>(T)
    ObjectExtensions.GetPropertyValue(Object, String)
    Validate.ThrowIfNull(Object, String)
    MapExtensions.CanThrowBetweenLocations(IMap, Location, Location, Boolean)
    MapExtensions.AreInLineOfSight(IMap, Location, Location)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2018-2020 | The Fibula Project
    Generated using DocFX | Jose L. Nuñez de Caceres et al.