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

GWMapInfoClient

class GWMapInfoClient

Client for characters endpoint. Includes the /maps and /continents endpoints

See also

for errors

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
@JvmOverloads
fun getContinent(continentId: Int, language: ApiLanguage? = null): Continent?

Returns the continent corresponding to the specified ID, or null if no such continent exists Documentation can be found in the GW2 Wiki

Link copied to clipboard
fun getContinents(): List<Int>

Returns a list of continent IDs Documentation can be found in the GW2 Wiki

Link copied to clipboard
@JvmOverloads
fun getFloor(continentId: Int, floorId: Int, language: ApiLanguage? = null): Floor

Returns the floor corresponding to the specified continentId and floorID Documentation can be found in the GW2 Wiki

Link copied to clipboard
fun getFloors(continentId: Int): List<Int>

Returns a list of floor IDs on the specified continent Documentation can be found in the GW2 Wiki

Link copied to clipboard
@JvmOverloads
fun getMap(mapId: Int, language: ApiLanguage? = null): Map?

Returns a single io.github.kryszak.gwatlin.api.mapinfo.model.Map instance corresponding to the specidfed ID from the /maps endpoint Documentation can be found in the GW2 Wiki

@JvmOverloads
fun getMap(continentId: Int, floorId: Int, regionId: Int, mapId: Int, language: ApiLanguage? = null): ContinentMap

Returns the map corresponding to the specified continentId, floorId, regionId and mapId. This function differs from the other getMap function in that it uses the /continents endpoint instead of the /maps endpoint, resulting in a different result object. Documentation can be found in the GW2 Wiki

Link copied to clipboard
fun getMaps(): List<Int>

Returns a list of map IDs from the /maps endpoint

@JvmOverloads
fun getMaps(mapIds: Collection<Int>, language: ApiLanguage? = null): List<Map>

Returns a list of io.github.kryszak.gwatlin.api.mapinfo.model.Map instances corresponding to the specified IDs from the /maps endpoint Documentation can be found in the GW2 Wiki

fun getMaps(continentId: Int, floorId: Int, regionId: Int): List<Int>

Returns a list of region IDs on the specified continent, floor and region Documentation can be found in the GW2 Wiki

Link copied to clipboard
fun getPointsOfInterest(continentId: Int, floorId: Int, regionId: Int, mapId: Int): List<Int>

Returns a list of points of interest (aka POI) IDs on the specified map Documentation can be found in the GW2 Wiki

Link copied to clipboard
@JvmOverloads
fun getRegion(continentId: Int, floorId: Int, regionId: Int, language: ApiLanguage? = null): Region

Returns the region corresponding to the specified continentId, floorId and regionId Documentation can be found in the GW2 Wiki

Link copied to clipboard
fun getRegions(continentId: Int, floorId: Int): List<Int>

Returns a list of region IDs on the specified continent and floor Documentation can be found in the GW2 Wiki

Link copied to clipboard
fun getSectors(continentId: Int, floorId: Int, regionId: Int, mapId: Int): List<Int>

Returns a list of sector IDs on the specified map Documentation can be found in the GW2 Wiki

Link copied to clipboard
fun getTasks(continentId: Int, floorId: Int, regionId: Int, mapId: Int): List<Int>

Returns a list of tasks (aka Hearts) IDs on the specified map Documentation can be found in the GW2 Wiki