Module gw2rs::prelude

The gw2rs::prelude module provides common functionality in an easy to consume package. It's primary use is to quickly import the various data structures that are found throughout the system in a single interface. The most common usage of this module is through a glob import, which brings all of the structs in the library into visibility.

Structs

Achievement	Achievements represent achievements within Guild Wars 2.
AchievementCategory	AchievementCategorys represent broad categories of achievements in Guild Wars 2.
AchievementCategoryId
AchievementGroup	AchievementGroups represent broad groupings of achievements in Guild Wars 2.
AchievementGroupId
AchievementId
AchievementTier	AchievementTiers represent a specific tier within an achievement.
BackstoryAnswer
BackstoryAnswerId
BackstoryQuestion
BackstoryQuestionId
Build
Cat
CatId
Color
ColorId
Currency
CurrencyConversion	CurrencyConversions represent data surrounding the conversion of gems and gold via the Trading Post.
CurrencyId
DailyAchievement	DailyAchievements represent single daily achievements within Guild Wars 2.
DailyAchievementId
DailyAchievements	DailyAchievements are the response of the daily achievement endpoints and map to the various categories of daily achievements found in the Game.
ErrorResponse	ErrorResponses represent the JSON payloads from API calls that resulted in errors.
GW2	The Guild Wars 2 API Wrapper.
Glider
GliderId
GoldValue	GoldValues are a convenience around monetary values provided by the ArenaNet API. In particular, endpoints that return monetary values natively return the number of copper coins that represents that cost. GoldValue is a convenience to convert that amount into gold, silver, and copper coins.
ItemId
Legend
LegendId
LevelRange	LevelRanges represent a range of levels, inclusive, that an including type is valid for.
Listing	Listings represent trading post listing data for particular items.
ListingId
ListingItem	ListingItems represent an individual instance of a Trading Post buy or sell order for the associated item. They are always tied to a Listing.
Objective	Objectives represent capturable or interactable objective points in World vs World maps.
ObjectiveId
Prices	Prices represent an overview of the associated item on the Trading Post. They represent things like whether free accounts can list or buy the item, and the associated buy and sell orders.
PricesId
Pricing	Pricings represent an item's pricing data on the Trading Post. More specifically, they represent the quantity and unit price of a particular buy or sell order placed for the associated item.
SkillId
Specialization
SpecializationId
Story
StoryChapter
StoryId
StorySeason
StorySeasonId
Title
TitleId
TokenInfo	TokenInfos provide information on what an API token allows applications to look at on behalf of the user who created them.
TradingPostDeliveries	TradingPostDeliveries represents a user's items and gold waiting for pickup from the Trading Post.
TradingPostDeliveryItem	TradingPostDeliveryItems represent items waiting for pickup from the Trading Post.
TradingPostDeliveryItemId
TradingPostTransaction	TradingPostTransactions represent historical or current buy or sell orders on the Trading Post.
TradingPostTransactionId
TraitId
Upgrade	Ranks one can unlock in World versus World.
UpgradeId
UpgradeTier	Represents a tier of upgraded status on structures within World versus World maps.
UpgradeTierUpgrade	Represents an individual structure upgrade within World versus World.
WVWAbility
WVWAbilityId
WVWAbilityRank
WVWMatch	The WVWMatch struct represents all associated data related to a World versus World matchup.
WVWMatchId
WVWRank	Ranks one can unlock in World versus World.
WVWRankId
World	The World struct provides datapoints related to a world (server). It includes things like the localized name and general server population.
WorldId

Enums

APIError	Enumerates error conditions expected throughout the library.
AchievementReward	AchievementRewards represent the various types of rewards you can receive for completing achievements within the game.
Locale	Represents valid language options, for endpoints that support it. It corresponds to the GET parameter lang in request URIs.
ObjectiveType	ObjectiveTypes provide instances of the set of possible objective types.
Region	Regions represent the broad categorizations of regions within Guild Wars 2.
RequiredAccess	RequiredAccesses represent whether access to a type is restricted based on a particular expansion of Guild Wars 2.
WVWMap	The WVWMap enum provides variants for all World versus World maps.
WorldPopulation	The WorldPopulation enum provides compile-time checks around the population restrictions for worlds (servers).