gwatlin/io.github.kryszak.gwatlin.api.mapinfo.model

Package-level declarations

Types

@Serializable

data class Adventure(val id: String, val coord: Coordinates, val name: String, val description: String)

Data model for Adventures

@Serializable

data class Continent(val id: Int, val name: String, val continentDims: Dimensions, val minZoom: Int, val maxZoom: Int, val floors: List<Int>)

Data model for Continents

ContinentMap

@Serializable

data class ContinentMap(val id: Int, val name: String, val minLevel: Int, val maxLevel: Int, val defaultFloor: Int, val mapRect: Rectangle, val continentRect: Rectangle, val labelCoord: Coordinates, val pointsOfInterest: Map<Int, PointOfInterest>, val tasks: Map<Int, HeartTask>, val skillChallenges: List<SkillChallenge>, val sectors: Map<Int, Sector>, val adventures: List<Adventure>, val masteryPoints: List<MasteryPoint>)

Data model for map info returned by the /continents endpoint

Coordinates

typealias Coordinates = Dimensions

Data model for Coordinates. A coordinate is defined by one value each on the X and Y axis.

Dimensions

@Serializable(with = DimensionsSerializer::class)

data class Dimensions(val x: Float, val y: Float)

Data model for Dimensions. A dimension is something with a size in both the X and Y directions.

Floor

@Serializable

data class Floor(val id: Int, val textureDims: Dimensions, val clampedView: Rectangle, val regions: Map<Int, Region>)

Data model for Floors

HeartTask

@Serializable

data class HeartTask(val id: Int, val objective: String, val level: Int, val coord: Coordinates, val bounds: List<Coordinates>, val chatLink: String)

Data model for Tasks, aka "Hearts"

Map

@Serializable

data class Map(val id: Int, val name: String, val minLevel: Int, val maxLevel: Int, val defaultFloor: Int, val type: MapType, val floors: List<Int>, val regionId: Int, val regionName: String?, val continentId: Int, val continentName: String? = null, val mapRect: Rectangle, val continentRect: Rectangle)

Data model for map info returned by the /maps endpoint

MapType

enum MapType : Enum<MapType>

Enumeration for the possible types of a map

MasteryPoint

@Serializable

data class MasteryPoint(val id: Int, val coord: Coordinates, val region: String)

Data model mastery points.

PointOfInterest

@Serializable

data class PointOfInterest(val id: Int, val name: String? = null, val type: PointOfInterestType, val floor: Int, val coord: Coordinates, val chatLink: String, val icon: String? = null)

Data model for points of interest, aka "POI"

PointOfInterestType

enum PointOfInterestType : Enum<PointOfInterestType>

Enumeration for the possible types of a point of interest

Rectangle

@Serializable(with = RectangleSerializer::class)

data class Rectangle(val first: Coordinates, val second: Coordinates)

Data model for a Rectangle. A rectangle is defined by a pair of coordinates. The first coordinate represents the upper left corner, while the second is the lower right corner.

Region

@Serializable

data class Region(val id: Int, val name: String, val labelCoord: Coordinates, val continentRect: Rectangle, val maps: Map<Int, ContinentMap>)

Data model for regions. Regions are part of a io.github.kryszak.gwatlin.api.mapinfo.model.Floor

Sector

@Serializable

data class Sector(val id: Int, val name: String, val level: Int, val coord: Coordinates, val bounds: List<Coordinates>, val chatLink: String)

Data model for sectors. Regions are part of a io.github.kryszak.gwatlin.api.mapinfo.model.ContinentMap

SkillChallenge

@Serializable

data class SkillChallenge(val id: String, val coord: Coordinates)

Data model for skill challenges, aka "Hero Point"