Beta Documentation - Subject to change.

Provides classes for accessing game related information.

Classes

  NameDescription
ActiveSkillInformation about an active player's skill.
ActorBase class for any entity that interacts in the world.
AttributesRepresents a collection of information about an entity.
BackpackProvides access to a player's backpack.
BankA container of items that are only accessible at designated bank locations.
BasicMountA basic mount.
ClassAttributesBase class for class information.
CombatMountA mount that can be used in combat.
EffectRepresents an effect that can be applied to an entity.
EffectListA utility class used by Actors to hold the list of effects.
EntityBase class for any entity in the game.
EntityReference
EquipmentProvides access to a player's equipment.
GambitSkillInformation about a gambit skill.
GambitSkillInfoInformation about a gambit skill.
ItemAn item that a user can have.
ItemInfoContainer for various item information.
LocalPlayerA class that represents the local player.
MountClass representing an in game mount.
PartyThis class provides access to party information. This is either your fellowship or your tribe depending on your alliance.
PartyMember
PetA pet is an actor that a player owns and controls.
PlayerA class that represents a player in the game.
ProfessionInfoInformation about a profession.
PropertyHandler
RecipeInformation about a recipe.
RecipeIngredientInformation about a recipe ingredient.
SharedStorageA bank that represents the player's shared storage. This storage is available to all characters on the same account.
SkillInformation about a skill.
SkillInfoInformation about a skill.
SkillListA list of skills.
UntrainedSkillInformation about a skill the player has not trained yet.
VaultA bank that represents the player's vault storage. This storage is only available to the current logged in character.
WalletProvides access to a player's wallet.
WalletItemAn item that is contained in a user's wallet.

Enumerations

  NameDescription
AlignmentThe alignment of a player.
ClassThe Class of a player.
CraftTierA crafting tier.
EffectCategoryDescribes the category of an effect.
EquipmentSlotThe equipment slot in the player's equipment.
ItemCategoryDescribes the category of an item.
ItemDurabilityDescribes the durability of an item.
ItemQualityDescribes the quality of an item.
ItemWearStateDescribes the current wear state of an item.
ProfessionA profession a free people player can have.
RaceThe Race of a player.
ReadyStateThe ready state of a player.
SkillTypeA type of skill.
VocationThe vocation of a free people player.

Remarks

This package is used to access various information about the game that is available to a player.