Enum Class MapType

java.lang.Object
java.lang.Enum<MapType>
com.gw2tb.gw2ml.MapType
All Implemented Interfaces:
Serializable, Comparable<MapType>, Constable
public enum MapType extends Enum<MapType>
A utility class for interpreting the value of the mapType field.
Since:
1.0.0

  • Enum Constant Details

    • UNKNOWN

      public static final MapType UNKNOWN
      Represents any unknown or unexpected mapType value.

      This is used as a fallback.

      Since:
      1.0.0

    • REDIRECT

      public static final MapType REDIRECT
      Redirect "maps" (e.g. when logging in while in a PvP match).
      Since:
      1.0.0

    • CHARACTER_CREATION

      public static final MapType CHARACTER_CREATION
      Character creation screens.
      Since:
      1.0.0

    • PVP

      public static final MapType PVP
      Competitive Player vs Player (PvP) maps.
      Since:
      1.0.0

    • GVG

      public static final MapType GVG
      Guild vs Guild (GvG) maps.
      Since:
      1.0.0
      API Note:
      At the time of writing this `mapType` is unused.

    • INSTANCE

      public static final MapType INSTANCE
      Instance maps (such as dungeons and story content).
      Since:
      1.0.0

    • PUBLIC

      public static final MapType PUBLIC
      Public maps (e.g. open world).
      Since:
      1.0.0

    • TOURNAMENT

      public static final MapType TOURNAMENT
      Tournament maps.
      Since:
      1.0.0

    • TUTORIAL

      public static final MapType TUTORIAL
      Tutorial maps.
      Since:
      1.0.0

    • USER_TOURNAMENT

      public static final MapType USER_TOURNAMENT
      User tournament maps.
      Since:
      1.0.0

    • ETERNAL_BATTLEGROUNDS

      public static final MapType ETERNAL_BATTLEGROUNDS
      "Eternal Battlegrounds" maps.
      Since:
      1.0.0

    • BLUE_BORDERLANDS

      public static final MapType BLUE_BORDERLANDS
      "Blue Battlegrounds" maps.
      Since:
      1.0.0

    • GREEN_BORDERLANDS

      public static final MapType GREEN_BORDERLANDS
      "Green Battlegrounds" maps.
      Since:
      1.0.0

    • RED_BORDERLANDS

      public static final MapType RED_BORDERLANDS
      "Red Battlegrounds" maps.
      Since:
      1.0.0

    • FORTUNES_VALE

      public static final MapType FORTUNES_VALE
      This map type is currently unused and it's purpose is unknown.
      Since:
      1.0.0

    • OBSIDIAN_SANCTUM

      public static final MapType OBSIDIAN_SANCTUM
      "Obsidian Sanctum" maps.
      Since:
      1.0.0

    • EOTM

      public static final MapType EOTM
      "Edge of the Mists" maps.
      Since:
      1.0.0

    • PUBLIC_MINI

      public static final MapType PUBLIC_MINI
      Public "mini" maps (such as "Dry Top", "The Silverwastes", and "Mistlock Sanctuary").
      Since:
      1.0.0

    • BIG_BATTLE

      public static final MapType BIG_BATTLE
      This map type is currently unused and it's purpose is unknown.
      Since:
      1.3.0

    • WVW_LOUNGE

      public static final MapType WVW_LOUNGE
      "Armistice Bastion" maps.
      Since:
      1.0.0
      API Note:
      This map type might be re-used by other WvW lounge maps in the future.

    • WVW

      public static final MapType WVW
      This map type's purpose is unknown.
      Since:
      1.3.0

  • Method Details

    • values

      public static MapType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static MapType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • valueOf

      public static MapType valueOf(long mapType)
      Returns the appropriate MapType representation for the given numerical value.

      If the given value does not correspond to any known MapType, UNKNOWN is returned.

      Parameters:
      mapType - the map type to search
      Returns:
      the appropriate MapType representation for the given numerical value
      Since:
      1.0.0

    • numericalValue

      public long numericalValue()
      Returns the numerical value of this mount type.

      This is the same value as the value returned by MumbleLink.Context.getMapType().

      Returns:
      the numerical value of this mount type
      Throws:
      IllegalArgumentException - if this is UNKNOWN
      Since:
      1.0.0