UNPKG

guildwars2-ts

Version:

GuildWars 2 API Wrapper in Typescript

404 lines (403 loc) 19.1 kB
import { z } from 'zod'; export declare const ContinentsMapsDTO: z.ZodArray<z.ZodObject<{ /** The map name. */ name: z.ZodString; /** The minimum level of the map. */ min_level: z.ZodNumber; /** The maximum level of the map. */ max_level: z.ZodNumber; /** The default floor of the map. */ default_floor: z.ZodNumber; /** The coordinates of the map label. */ label_coord: z.ZodOptional<z.ZodArray<z.ZodNumber>>; /** The dimensions of the map, given as the coordinates of the lower-left (SW) and upper-right (NE) corners. */ map_rect: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** * The dimensions of the map within the continent coordinate system, * given as top-left (NW) and bottom-right (SE) corner coordinates. */ continent_rect: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** A list of points of interest (landmarks, waypoints, vistas, etc). */ points_of_interest: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The point of interest id. */ id: z.ZodNumber; /** The name of the point of interest. */ name: z.ZodOptional<z.ZodString>; /** Type of the point of interest. */ type: z.ZodString; /** The floor of this object. */ floor: z.ZodNumber; /** The coordinates of this object. */ coord: z.ZodArray<z.ZodNumber>; /** The point of interest chat link. */ chat_link: z.ZodString; /** PoI icon. Only available for unlock types */ icon: z.ZodOptional<z.ZodString>; }, z.core.$strict>>; /** A list of renown hearts. */ tasks: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The renown heart id. */ id: z.ZodNumber; /** The objective or name of the heart. */ objective: z.ZodString; /** The level of the heart. */ level: z.ZodNumber; /** The coordinates where it takes place. */ coord: z.ZodArray<z.ZodNumber>; /** A list of coordinates marking the boundary of the heart. */ bounds: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** The renown heart chat link. */ chat_link: z.ZodString; }, z.core.$strict>>; /** A list of skill challenges. */ skill_challenges: z.ZodArray<z.ZodObject<{ /** * The hero challenge id, formed of two numbers separated by a dash. * The first number represents the expansion (0 for Core Tyria, 1 for Heart of Thorns and 2 for Path of Fire), * and therefore could be used to change the hero challenge map marker icon. * If the first number and dash prefix is removed from the string, * the second number is no longer unique among other hero challenges. */ id: z.ZodOptional<z.ZodString>; /** The coordinates of this hero challenge. */ coord: z.ZodArray<z.ZodNumber>; }, z.core.$strict>>; /** A list of areas within the map. */ sectors: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The area id. */ id: z.ZodNumber; /** The name of the area. */ name: z.ZodOptional<z.ZodString>; /** The level of the area. */ level: z.ZodNumber; /** The coordinates of this area (this is usually the center position). */ coord: z.ZodArray<z.ZodNumber>; /** A list of coordinates marking the boundary of the area. */ bounds: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** The area chat link. */ chat_link: z.ZodString; }, z.core.$strict>>; /** A list of adventures within the map. */ adventures: z.ZodArray<z.ZodObject<{ /** The adventure guid (token length 8-4-4-4-12 with a dash between each group of digits). */ id: z.ZodString; /** The coordinates of the start of the adventure. */ coord: z.ZodArray<z.ZodNumber>; /** The name of the adventure. */ name: z.ZodString; /** The description of the adventure. */ description: z.ZodString; }, z.core.$strict>>; /** A list of mastery insights within the map. */ mastery_points: z.ZodArray<z.ZodObject<{ /** The mastery insight id. */ id: z.ZodNumber; /** The region of the mastery insight, which determines its color. */ region: z.ZodString; /** The coordinates of the mastery insight. */ coord: z.ZodArray<z.ZodNumber>; }, z.core.$strict>>; /** Id of the map */ id: z.ZodNumber; /** Shrines present in the map. Only appears in Orr maps */ god_shrines: z.ZodOptional<z.ZodArray<z.ZodObject<{ /** Id of the shrine. */ id: z.ZodNumber; /** Name of the shrine. May contain unsanitized html and/or game chat links. */ name: z.ZodString; /** Name of the shrine, when contested. May contain unsanitized html and/or game chat links. */ name_contested: z.ZodString; /** Shrine coordinates. */ coord: z.ZodArray<z.ZodNumber>; /** Id of the point of interest of the shrine. */ poi_id: z.ZodNumber; /** Icon of the shrine. */ icon: z.ZodURL; /** Icon of the shrine, when contested. */ icon_contested: z.ZodURL; }, z.core.$strict>>>; }, z.core.$strict>>; export declare const ContinentsRegionsDTO: z.ZodArray<z.ZodObject<{ /** Id of the region. */ id: z.ZodNumber; /** Name of the region. */ name: z.ZodString; /** The coordinates of the region label. */ label_coord: z.ZodArray<z.ZodNumber>; /** The dimensions of the continent, expressed as top-left (NW) and bottom-right (SE) corner coordinates. */ continent_rect: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** A mapping from the map id to an object. */ maps: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The map name. */ name: z.ZodString; /** The minimum level of the map. */ min_level: z.ZodNumber; /** The maximum level of the map. */ max_level: z.ZodNumber; /** The default floor of the map. */ default_floor: z.ZodNumber; /** The coordinates of the map label. */ label_coord: z.ZodOptional<z.ZodArray<z.ZodNumber>>; /** The dimensions of the map, given as the coordinates of the lower-left (SW) and upper-right (NE) corners. */ map_rect: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** * The dimensions of the map within the continent coordinate system, * given as top-left (NW) and bottom-right (SE) corner coordinates. */ continent_rect: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** A list of points of interest (landmarks, waypoints, vistas, etc). */ points_of_interest: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The point of interest id. */ id: z.ZodNumber; /** The name of the point of interest. */ name: z.ZodOptional<z.ZodString>; /** Type of the point of interest. */ type: z.ZodString; /** The floor of this object. */ floor: z.ZodNumber; /** The coordinates of this object. */ coord: z.ZodArray<z.ZodNumber>; /** The point of interest chat link. */ chat_link: z.ZodString; /** PoI icon. Only available for unlock types */ icon: z.ZodOptional<z.ZodString>; }, z.core.$strict>>; /** A list of renown hearts. */ tasks: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The renown heart id. */ id: z.ZodNumber; /** The objective or name of the heart. */ objective: z.ZodString; /** The level of the heart. */ level: z.ZodNumber; /** The coordinates where it takes place. */ coord: z.ZodArray<z.ZodNumber>; /** A list of coordinates marking the boundary of the heart. */ bounds: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** The renown heart chat link. */ chat_link: z.ZodString; }, z.core.$strict>>; /** A list of skill challenges. */ skill_challenges: z.ZodArray<z.ZodObject<{ /** * The hero challenge id, formed of two numbers separated by a dash. * The first number represents the expansion (0 for Core Tyria, 1 for Heart of Thorns and 2 for Path of Fire), * and therefore could be used to change the hero challenge map marker icon. * If the first number and dash prefix is removed from the string, * the second number is no longer unique among other hero challenges. */ id: z.ZodOptional<z.ZodString>; /** The coordinates of this hero challenge. */ coord: z.ZodArray<z.ZodNumber>; }, z.core.$strict>>; /** A list of areas within the map. */ sectors: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The area id. */ id: z.ZodNumber; /** The name of the area. */ name: z.ZodOptional<z.ZodString>; /** The level of the area. */ level: z.ZodNumber; /** The coordinates of this area (this is usually the center position). */ coord: z.ZodArray<z.ZodNumber>; /** A list of coordinates marking the boundary of the area. */ bounds: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** The area chat link. */ chat_link: z.ZodString; }, z.core.$strict>>; /** A list of adventures within the map. */ adventures: z.ZodArray<z.ZodObject<{ /** The adventure guid (token length 8-4-4-4-12 with a dash between each group of digits). */ id: z.ZodString; /** The coordinates of the start of the adventure. */ coord: z.ZodArray<z.ZodNumber>; /** The name of the adventure. */ name: z.ZodString; /** The description of the adventure. */ description: z.ZodString; }, z.core.$strict>>; /** A list of mastery insights within the map. */ mastery_points: z.ZodArray<z.ZodObject<{ /** The mastery insight id. */ id: z.ZodNumber; /** The region of the mastery insight, which determines its color. */ region: z.ZodString; /** The coordinates of the mastery insight. */ coord: z.ZodArray<z.ZodNumber>; }, z.core.$strict>>; /** Id of the map */ id: z.ZodNumber; /** Shrines present in the map. Only appears in Orr maps */ god_shrines: z.ZodOptional<z.ZodArray<z.ZodObject<{ /** Id of the shrine. */ id: z.ZodNumber; /** Name of the shrine. May contain unsanitized html and/or game chat links. */ name: z.ZodString; /** Name of the shrine, when contested. May contain unsanitized html and/or game chat links. */ name_contested: z.ZodString; /** Shrine coordinates. */ coord: z.ZodArray<z.ZodNumber>; /** Id of the point of interest of the shrine. */ poi_id: z.ZodNumber; /** Icon of the shrine. */ icon: z.ZodURL; /** Icon of the shrine, when contested. */ icon_contested: z.ZodURL; }, z.core.$strict>>>; }, z.core.$strict>>; }, z.core.$strict>>; export declare const ContinentsFloorsDTO: z.ZodArray<z.ZodObject<{ /** Floor id. */ id: z.ZodNumber; /** Dimensions of the region texture. */ texture_dims: z.ZodArray<z.ZodNumber>; /** * If present, represents a rectangle of textures. * Each tile coordinate outside this rectangle is not available on the server. */ clamped_view: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodNumber>>>; /** Mapping from the region id to an object. */ regions: z.ZodRecord<z.ZodString, z.ZodObject<{ /** Id of the region. */ id: z.ZodNumber; /** Name of the region. */ name: z.ZodString; /** The coordinates of the region label. */ label_coord: z.ZodArray<z.ZodNumber>; /** The dimensions of the continent, expressed as top-left (NW) and bottom-right (SE) corner coordinates. */ continent_rect: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** A mapping from the map id to an object. */ maps: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The map name. */ name: z.ZodString; /** The minimum level of the map. */ min_level: z.ZodNumber; /** The maximum level of the map. */ max_level: z.ZodNumber; /** The default floor of the map. */ default_floor: z.ZodNumber; /** The coordinates of the map label. */ label_coord: z.ZodOptional<z.ZodArray<z.ZodNumber>>; /** The dimensions of the map, given as the coordinates of the lower-left (SW) and upper-right (NE) corners. */ map_rect: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** * The dimensions of the map within the continent coordinate system, * given as top-left (NW) and bottom-right (SE) corner coordinates. */ continent_rect: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** A list of points of interest (landmarks, waypoints, vistas, etc). */ points_of_interest: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The point of interest id. */ id: z.ZodNumber; /** The name of the point of interest. */ name: z.ZodOptional<z.ZodString>; /** Type of the point of interest. */ type: z.ZodString; /** The floor of this object. */ floor: z.ZodNumber; /** The coordinates of this object. */ coord: z.ZodArray<z.ZodNumber>; /** The point of interest chat link. */ chat_link: z.ZodString; /** PoI icon. Only available for unlock types */ icon: z.ZodOptional<z.ZodString>; }, z.core.$strict>>; /** A list of renown hearts. */ tasks: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The renown heart id. */ id: z.ZodNumber; /** The objective or name of the heart. */ objective: z.ZodString; /** The level of the heart. */ level: z.ZodNumber; /** The coordinates where it takes place. */ coord: z.ZodArray<z.ZodNumber>; /** A list of coordinates marking the boundary of the heart. */ bounds: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** The renown heart chat link. */ chat_link: z.ZodString; }, z.core.$strict>>; /** A list of skill challenges. */ skill_challenges: z.ZodArray<z.ZodObject<{ /** * The hero challenge id, formed of two numbers separated by a dash. * The first number represents the expansion (0 for Core Tyria, 1 for Heart of Thorns and 2 for Path of Fire), * and therefore could be used to change the hero challenge map marker icon. * If the first number and dash prefix is removed from the string, * the second number is no longer unique among other hero challenges. */ id: z.ZodOptional<z.ZodString>; /** The coordinates of this hero challenge. */ coord: z.ZodArray<z.ZodNumber>; }, z.core.$strict>>; /** A list of areas within the map. */ sectors: z.ZodRecord<z.ZodString, z.ZodObject<{ /** The area id. */ id: z.ZodNumber; /** The name of the area. */ name: z.ZodOptional<z.ZodString>; /** The level of the area. */ level: z.ZodNumber; /** The coordinates of this area (this is usually the center position). */ coord: z.ZodArray<z.ZodNumber>; /** A list of coordinates marking the boundary of the area. */ bounds: z.ZodArray<z.ZodArray<z.ZodNumber>>; /** The area chat link. */ chat_link: z.ZodString; }, z.core.$strict>>; /** A list of adventures within the map. */ adventures: z.ZodArray<z.ZodObject<{ /** The adventure guid (token length 8-4-4-4-12 with a dash between each group of digits). */ id: z.ZodString; /** The coordinates of the start of the adventure. */ coord: z.ZodArray<z.ZodNumber>; /** The name of the adventure. */ name: z.ZodString; /** The description of the adventure. */ description: z.ZodString; }, z.core.$strict>>; /** A list of mastery insights within the map. */ mastery_points: z.ZodArray<z.ZodObject<{ /** The mastery insight id. */ id: z.ZodNumber; /** The region of the mastery insight, which determines its color. */ region: z.ZodString; /** The coordinates of the mastery insight. */ coord: z.ZodArray<z.ZodNumber>; }, z.core.$strict>>; /** Id of the map */ id: z.ZodNumber; /** Shrines present in the map. Only appears in Orr maps */ god_shrines: z.ZodOptional<z.ZodArray<z.ZodObject<{ /** Id of the shrine. */ id: z.ZodNumber; /** Name of the shrine. May contain unsanitized html and/or game chat links. */ name: z.ZodString; /** Name of the shrine, when contested. May contain unsanitized html and/or game chat links. */ name_contested: z.ZodString; /** Shrine coordinates. */ coord: z.ZodArray<z.ZodNumber>; /** Id of the point of interest of the shrine. */ poi_id: z.ZodNumber; /** Icon of the shrine. */ icon: z.ZodURL; /** Icon of the shrine, when contested. */ icon_contested: z.ZodURL; }, z.core.$strict>>>; }, z.core.$strict>>; }, z.core.$strict>>; }, z.core.$strict>>; export declare const ContinentsDTO: z.ZodArray<z.ZodObject<{ /** Continent id. */ id: z.ZodNumber; /** Continent name. */ name: z.ZodString; /** Width and height dimensions of the continent. */ continent_dims: z.ZodOptional<z.ZodArray<z.ZodNumber>>; /** Minimal zoom level for use with this map tile. */ min_zoom: z.ZodNumber; /** Maximum zoom level for use with this map tile. */ max_zoom: z.ZodNumber; /** List of floor ids available for this continent. */ floors: z.ZodArray<z.ZodNumber>; }, z.core.$strict>>;