API

From ESOUI Wiki

Contents 1 Global 2 Display Name 3 Friends 4 Ignore 5 Guild 6 Guild Reputation 7 Unit 8 Targeting 9 Soul Gem Resurrection 10 Buffs 11 Synergy 12 Group 13 Slot 14 Quest 15 Chat 16 Movement 17 Mouse Events 18 Combat Actions 19 Interaction 20 Camera 21 Chatter 22 Container Functions 23 Game(?) 24 Socketing 25 Keep 26 Map Pin 27 Siege Weapon 28 Player Escorting 29 Health Warning 30 Player Auras 31 Achievement 32 Player Stats 33 Player Attributes 34 Weapon Set 35 Ability Progression 36 World Event 37 Combat Tips 38 Camera 39 Lockpicking 40 Chamber 41 Hook Points 42 Feedback 43 Emotes 44 Logout 45 Cursor 46 Group 47 Action Bar / Quick Slot 48 Mount 49 Quest Tracker 50 Item Enchanting 51 Imperial Style conversion 52 Soul Gem (Item Charging) 53 Repair/Durability 54 Weapon 55 Item Information 56 Junk 57 Bank 58 Guild Bank 59 Trading House 60 Map 61 Campaign 62 Store (Buy/Sell) 63 Repair 64 Loot 65 Guild Keep Claim 66 Historical Keep 67 Title 68 Resurrection/Reviving 69 Trade 70 Skills 71 Mail 72 Achievements 73 Lore 74 Mara 75 Tutorial 76 Help 77 Crafting Global 78 Last Crafting 79 Alchemy 80 Recipe 81 Provisioner 82 Enchanting 83 Smithing 84 LFG 85 Fishing 86 Treasure 87 Marker 88 Agent

Global

• GetCVar(string CVarName)
  • Returns: string value

• SetCVar(string CVarName, string value)

• GetSetting(integer system, integer settingId)
  • Returns: string value

• GetSetting_Bool(integer system, integer settingId)
  • Returns: bool value

• SetSetting(integer system, integer settingId, string value, integer setOptions)

• ApplySettings()

• ResetSettingToDefault(integer system, integer settingId)

• ResetToDefaultSettings(integer system)

• RefreshSettings()

• GetString(string stringVariablePrefix, integer contextId)
  • Returns: string stringValue

• IsShiftKeyDown()
  • Returns: bool isShiftDown

• IsControlKeyDown()
  • Returns: bool isCtrlDown

• IsAltKeyDown()
  • Returns: bool isAltDown

• IsCommandKeyDown()
  • Returns: bool isCommandDown

• IsCapsLockOn()
  • Returns: bool isCapsLockOn

• GetKeyName(KeyCode keyCode)
  • Returns: string keyName

• PlaySound(string soundName)

• SetGuiHidden(string guiName, bool hidden)

• GetGuiHidden(string guiName)
  • Returns: bool hidden

• ToggleFullScreen()

• IsMouseWithinClientArea()
  • Returns: bool insideClient

• IsUserAdjustingClientWindow()
  • Returns: bool isAdjusting

• GetInterfaceColor(integer interfaceColorType, integer fieldValue)
  • Returns: number red, number green, number blue, number alpha

• GetSecondsSinceMidnight()
  • Returns: integer secondsSinceMidnight

• GetFrameTimeSeconds()
  • Returns: number frameTimeInSeconds

• GetFrameDeltaTimeSeconds()
  • Returns: number frameDeltaTimeInSeconds

• GetFrameTimeMilliseconds()
  • Returns: integer frameTimeInMilliseconds

• GetFrameDeltaTimeMilliseconds()
  • Returns: integer frameDeltaTimeInMilliseconds

• GetDateStringFromTimestamp(integer timestamp)
  • Returns: string dateString

• GetGameTimeMilliseconds()
  • Returns: integer gameTimeInMilliseconds

• GetFramerate()
  • Returns: number currentFramerate

• GetTimeString()
  • Returns: string currentTimeString

• GetDate()
  • Returns: integer currentTime

• GetTimeStamp()
  • Returns: id64 timestamp

• GetDiffBetweenTimeStamps(id64 laterTime, id64 earlierTime)
  • Returns: number difference

• GetFormattedTime()
  • Returns: integer formattedTime

• FormatTimeSeconds(number timeValueInSeconds, TimeFormatStyleCode formatType, TimeFormatPrecisionCode precisionType, TimeFormatDirectionCode direction)
  • Returns: string formattedTimeString, number nextUpdateTimeInSec

• FormatTimeMilliseconds(integer timeValueInMilliseconds, TimeFormatStyleCode formatType, TimeFormatPrecisionCode precisionType, TimeFormatDirectionCode direction)
  • Returns: string formattedTimeString, integer nextUpdateTimeInMilliseconds

• GetErrorString(integer errorStringId)
  • Returns: string stringValue

• GetAllianceName(integer alliance)
  • Returns: string name

• GetShortAllianceName(integer alliance)
  • Returns: string name

• GetNumClasses()
  • Returns: integer classCount

• GetClassInfo(luaindex index)
  • Returns: integer defId, string lore, textureName normalIcon, textureName pressedIcon, textureName mouseoverIcon, bool isSelectable, textureName ingameIcon

• GetClassName(Gender gender, integer classId)
  • Returns: string className

• GetGenderFromNameDescriptor(string nameDescriptor)
  • Returns: Gender gender

• PlainStringFind(string string, string searchFor)
  • Returns: bool found, integer startIndex, integer endIndex

• SplitString(string delims, string stringToSplit)
  • _Uses variable returns..._
  • Returns: string strings

• LocaleAwareToUpper(string stringToUppercase)
  • Returns: string upperCasedString

• LocaleAwareToLower(string stringToLowercase)
  • Returns: string lowerCasedString

• GetDisplayModes()
  • _Uses variable returns..._
  • Returns: integer width, integer height

• IsMinSpecMachine()
  • Returns: bool minspec

• IsPrivateFunction(string functionName)
  • Returns: bool isPrivate

• IsProtectedFunction(string functionName)
  • Returns: bool isProtected

• Id64ToString(id64 id)
  • Returns: string stringDesc

• HideMouse(bool onlyConsiderWhileMoving)

• ShowMouse(bool onlyConsiderWhileMoving)

• SetGameCameraUIMode(bool active)

• IsGameCameraUIModeActive()
  • Returns: bool active

• LockCameraRotation(bool locked)

• CalculateCubicBezierEase(number progress, number x1, number y1, number x2, number y2)
  • Returns: number result

• GetFrameDeltaNormalizedForTargetFramerate(number targetFramesPerSecond)
  • Returns: number frameDeltaNormalizedForTargetFramerate

• ComputeStringDistance(string source, string target, integer maxDistance)
  • Returns: integer distance

• ExecuteChatCommand(string text)

• ToggleShowIngameGui()

• ReloadUI(string guiName)

• SendPlayerStuck private ()

• GetWorldName()
  • Returns: string worldName

• GetUniqueNameForCharacter(string characterName)
  • Returns: string uniqueName

• GetPlayerStatus()
  • Returns: integer status

• SelectPlayerStatus(integer status)

• GetNumPlayerStatuses()
  • Returns: integer numStatuses

• TakeScreenshot()

• SetFullscreenEffect(FullscreenEffectType effectType, number param1, number param2)

• DoesGameHaveFocus()
  • Returns: bool hasFocus

• IsPlayerActivated()
  • Returns: bool activated

• GetSecondsPlayed()
  • Returns: integer secondsPlayed

• PlaceInTradeWindow protected (luaindex:nilable tradeIndex)

• PlaceInUnitFrame protected (string target)

• ConvertMouseButtonToKeyCode(integer mouseButton)
  • Returns: KeyCode key

• ResetAllBindsToDefault()

• zo_callLater(function functionToCall, integer delayInMs)

Display Name

• GetDisplayName()
  • Returns: string displayName

• DecorateDisplayName(string displayName)
  • Returns: string decoratedDisplayName

• IsDecoratedDisplayName(string displayName)
  • Returns: bool isDecorated

• UndecorateDisplayName(string displayName)
  • Returns: string undecoratedDisplayName

Friends

• GetNumFriends()
  • Returns: integer numFriends

• GetFriendInfo(luaindex friendIndex)
  • Returns: string displayName, string note, integer playerStatus, integer secsSinceLogoff

• GetFriendCharacterInfo(luaindex friendIndex)
  • Returns: bool hasCharacter, string characterName, string zoneName, integer classType, integer alliance, integer level, integer veteranRank

• RequestFriend(string charOrDisplayName, string message)

• RemoveFriend(string displayName)

• SetFriendNote(luaindex friendIndex, string note)

• IsFriend(string charOrDisplayName)
  • Returns: bool isFriend

• GetNumIncomingFriendRequests()
  • Returns: integer numRequests

• GetIncomingFriendRequestInfo(luaindex index)
  • Returns: string displayName, integer secsSinceRequest, string message

• GetNumOutgoingFriendRequests()
  • Returns: integer numRequests

• GetOutgoingFriendRequestInfo(luaindex index)
  • Returns: string displayName, integer secsSinceRequest, string note

• AcceptFriendRequest(string displayName)

• RejectFriendRequest(string displayName)

• CancelFriendRequest(luaindex index)

Ignore

• GetNumIgnored()
  • Returns: integer numIgnored

• GetIgnoredInfo(luaindex index)
  • Returns: string displayName, string note

• IsIgnored(string characterName)
  • Returns: bool isIgnored

• AddIgnore(string charOrDisplayName)

• RemoveIgnore(string displayName)

• SetIgnoreNote(luaindex ignoreIndex, string note)

Guild

• GetGuildId(luaindex index)
  • Returns: integer guildId

• GetNumGuildPermissions()
  • Returns: integer numPermissions

• GetNumGuildHistoryCategories()
  • Returns: integer numCategories

• GetNumGuildMembersRequiredForPrivilege(GuildPrivilege privilege)
  • Returns: integer numGuildMembers

• GetNumGuilds()
  • Returns: integer numGuilds

• GetGuildName(integer guildId)
  • Returns: string name

• GetGuildDescription(integer guildId)
  • Returns: string description

• GetGuildMotD(integer guildId)
  • Returns: string motd

• GetGuildFoundedDate(integer guildId)
  • Returns: string foundedDate

• GetGuildAlliance(integer guildId)
  • Returns: integer alliance

• GetNumGuildMembers(integer guildId)
  • Returns: integer numGuildMembers

• GetGuildMemberInfo(integer guildId, luaindex memberIndex)
  • Returns: string name, string note, luaindex rankIndex, integer playerStatus, integer secsSinceLogoff

• GetGuildMemberCharacterInfo(integer guildId, luaindex memberIndex)
  • Returns: bool hasCharacter, string characterName, string zoneName, integer classType, integer alliance, integer level, integer veteranRank

• GetPlayerGuildMemberIndex(integer guildId)
  • Returns: luaindex memberIndex

• GuildInvite(integer guildId, string displayName)

• IsValidGuildName(string guildName)
  • _Uses variable returns..._
  • Returns: integer violationCode

• GuildCreate(string guildName, Alliance guildAlliance)

• GuildRemove(integer guildId, string displayName)

• GuildLeave(integer guildId)

• GuildPromote(integer guildId, string displayName)

• GuildDemote(integer guildId, string displayName)

• SetGuildDescription(integer guildId, string description)

• SetGuildMotD(integer guildId, string motd)

• DoesGuildRankHavePermission(integer guildId, luaindex rankIndex, integer permission)
  • Returns: bool hasPermission

• DoesPlayerHaveGuildPermission(integer guildId, integer permission)
  • Returns: bool hasPermission

• CanEditGuildRankPermission(integer rankId, integer permission)
  • Returns: bool hasPermission

• DoesGuildHavePrivilege(integer guildId, GuildPrivilege privilege)
  • Returns: bool hasPrivilege

• GetNumGuildRanks(integer guildId)
  • Returns: integer numRanks

• GetGuildRankId(integer guildId, luaindex rankIndex)
  • Returns: integer rankId

• IsGuildRankGuildMaster(integer guildId, luaindex rankIndex)
  • Returns: bool isGuildMaster

• InitializePendingGuildRanks(integer guildId)

• AddPendingGuildRank(integer rankId, string name, integer permissions)

• SavePendingGuildRanks()
  • Returns: bool success

• ComposeGuildRankPermissions(integer permissions, integer permission, bool enabled)
  • Returns: integer newPermissions

• RequestOfflineGuildMembers(integer guildId)

• DoesGuildHistoryCategoryHaveMoreEvents(integer guildId, GuildHistoryCategory category)
  • Returns: bool hasMoreEvents

• RequestGuildHistoryCategoryNewest(integer guildId, GuildHistoryCategory category)
  • Returns: bool requested

• RequestGuildHistoryCategoryOlder(integer guildId, GuildHistoryCategory category)
  • Returns: bool requested

• GetNumGuildEvents(integer guildId, GuildHistoryCategory category)
  • Returns: integer numEvents

• GetGuildEventInfo(integer guildId, GuildHistoryCategory category, luaindex eventIndex)
  • Returns: integer eventType, integer secsSinceEvent, variant param1, variant param2, variant param3, variant param4, variant param5

• SetGuildMemberNote(integer guildId, luaindex memberIndex, string note)

• GetGuildRankCustomName(integer guildId, luaindex rankIndex)
  • Returns: string rankName

• GetNumGuildInvites()
  • Returns: integer numGuildInvites

• GetGuildInviteInfo(luaindex index)
  • Returns: integer guildId, string guildName, Alliance guildAlliance, string inviterDisplayName, string note

• AcceptGuildInvite(integer guildId)

• RejectGuildInvite(integer guildId)

• JumpToGuildMember(string name)

• GetGuildClaimedKeep(integer guildLuaId)
  • Returns: integer claimedKeepId, integer claimedKeepCampaignId

• DoesGuildHaveClaimedKeep(integer guildLuaId)
  • Returns: bool hasClaimedKeep

• CheckGuildKeepClaim(integer guildLuaId, integer keepId)
  • Returns: integer result

• CheckGuildKeepRelease(integer guildLuaId)
  • Returns: integer result

• ReleaseKeepForGuild(integer guildLuaId)

• ClaimInteractionKeepForGuild(integer guildLuaId)

• ReleaseInteractionKeepForGuild()

• SetDisplayedGuild(integer guildId)
  • Returns: bool succeeded

Guild Reputation

• GetNumGuildReputationRanks()
  • Returns: integer numRepRanks

• GetGuildReputationRankInfo(luaindex repRankIndex)
  • Returns: string guildName, string rankName, integer curPoints, integer pointsToNextRank, bool isMaxRank, integer rankNumber

Unit

• DoesUnitExist(string unitTag)
  • Returns: bool exists

• DoesUnitHaveTooltip(string unitTag)
  • Returns: bool hasTooltip

• GetUnitName(string unitTag)
  • Returns: string name

• GetRawUnitName(string unitTag)
  • Returns: string rawName

• GetUnitGender(string unitTag)
  • Returns: Gender gender

• GetUnitNameHighlightedByReticle()
  • Returns: string name

• GetUnitClass(string unitTag)
  • Returns: string className

• GetUnitClassId(string unitTag)
  • Returns: integer classId

• GetUnitLevel(string unitTag)
  • Returns: integer level

• GetUnitVeteranRank(string unitTag)
  • Returns: integer veteranRank

• GetUnitEffectiveLevel(string unitTag)
  • Returns: integer level

• GetUnitZone(string unitTag)
  • Returns: string zoneName

• GetUnitFinesseRankInfo(string unitTag)
  • Returns: integer rankNum, string name, integer xpBonus, bool loot

• GetUnitXP(string unitTag)
  • Returns: integer exp

• GetUnitXPMax(string unitTag)
  • Returns: integer maxExp

• GetUnitXPDebt(string unitTag)
  • Returns: integer debt

• IsUnitVeteran(string unitTag)
  • Returns: bool isVeteran

• GetUnitVeteranPoints(string unitTag)
  • Returns: integer points

• GetUnitVeteranPointsMax(string unitTag)
  • Returns: integer maxPoints

• IsUnitUsingVeteranDifficulty(string unitTag)
  • Returns: bool isVeteranDifficulty

• GetUnitPrimaryPowerType(string unitTag)
  • Returns: integer powerType

• GetUnitPrimaryPowerIndex(string unitTag)
  • Returns: luaindex:nilable powerIndex

• GetUnitDrownTime(string unitTag)
  • Returns: number startTime, number endTime

• IsUnitInGroupSupportRange(string unitTag)
  • Returns: bool result

• GetUnitType(string unitTag)
  • Returns: integer type

• CanUnitTrade(string unitTag)
  • Returns: bool canTrade

• AreUnitsEqual(string unitTag, string secondUnitTag)
  • Returns: bool areEqual

• IsUnitGrouped(string unitTag)
  • Returns: bool isGrouped

• IsUnitGroupLeader(string unitTag)
  • Returns: bool isGroupLeader

• GetGroupLeaderUnitTag()
  • Returns: string leaderUnitTag

• IsUnitFriend(string unitTag)
  • Returns: bool isOnFriendList

• IsUnitIgnored(string unitTag)
  • Returns: bool isIgnored

• IsUnitPlayer(string unitTag)
  • Returns: bool isPlayer

• IsUnitPvPFlagged(string unitTag)
  • Returns: bool isPvPFlagged

• IsUnitAttackable(string unitTag)
  • Returns: bool attackable

• GetUnitAlliance(string unitTag)
  • Returns: integer alliance

• GetUnitRace(string unitTag)
  • Returns: string race

• IsUnitFriendlyFollower(string unitTag)
  • Returns: bool isFollowing

• GetUnitReaction(string unitTag)
  • Returns: UnitReactionType unitReaction

• GetUnitAvARankPoints(string unitTag)
  • Returns: integer AvARankPoints

• GetUnitAvARank(string unitTag)
  • Returns: integer rank, integer subRank

• GetAvARankName(Gender gender, integer rank)
  • Returns: string rankName

• GetAvARankIcon(integer rank)
  • Returns: textureName rankIcon

• GetLargeAvARankIcon(integer rank)
  • Returns: textureName largeRankIcon

• GetAvARankProgress(integer currentRankPoints)
  • Returns: integer subRankStartsAt, integer nextSubRankAt, integer rankStartsAt, integer nextRankAt

• GetNumPointsNeededForAvARank(integer rank)
  • Returns: integer numPointsRequired

• GetUnitReactionColor(string unitTag)
  • Returns: number red, number green, number blue

• IsUnitInCombat(string unitTag)
  • Returns: bool isInCombat

• IsUnitDead(string unitTag)
  • Returns: bool isDead

• GetUnitStealthState(string unitTag)
  • Returns: integer stealthState

• GetUnitDisguiseState(string unitTag)
  • Returns: integer disguiseState

• GetUnitHidingEndTime(string unitTag)
  • Returns: number endTime

• IsUnitOnline(string unitTag)
  • Returns: bool isOnline

• IsUnitInspectableSiege(string unitTag)
  • Returns: bool isInspectableSiege

• GetUnitCaption(string unitTag)
  • Returns: string caption

• GetUnitSilhouetteTexture(string unitTag)
  • Returns: string icon

• GetMaxPowerPools()
  • Returns: integer maxPowerPools

• GetUnitPowerInfo(string unitTag, luaindex poolIndex)
  • Returns: integer:nilable type, integer current, integer max, integer effectiveMax

• GetUnitPower(string unitTag, CombatMechanicType powerType)
  • Returns: integer current, integer max, integer effectiveMax

• DoesUnitUsePowerType(string unitTag, integer powerType)
  • Returns: bool usesPowerType

• GetUnitCastingInfo(string unitTag)
  • Returns: string actionName, number timeStarted, number timeEnding, bool isChannel, integer barType, bool canBlock, bool canInterrupt, bool isChargeUp, bool hideBar

• GetPlayerStat(DerivedStats derivedStat, StatBonusOption statBonusOption, StatSoftCapOption statSoftCapOption)
  • Returns: integer value

• GetStatSoftCap(DerivedStats derivedStat)
  • Returns: integer:nilable softCap

• GetAllUnitAttributeVisualizerEffectInfo(string unitTag)
  • _Uses variable returns..._
  • Returns: UnitAttributeVisual unitAttributeVisual, DerivedStats statType, Attributes attributeType, CombatMechanicType powerType, number value, number maxValue

• GetUnitAttributeVisualizerEffectInfo(string unitTag, UnitAttributeVisual unitAttributeVisual, DerivedStats statType, Attributes attributeType, CombatMechanicType powerType)
  • Returns: number:nilable value, number:nilable maxValue

• GetUnitDifficulty(string unitTag)
  • Returns: UIMonsterDifficulty difficult

• GetUnitTitle(string unitTag)
  • Returns: string title

Targeting

• TargetUnit protected (string unitTag)

• TargetUnitByName protected (string unitName, bool exact)

• ClearTarget protected ()

• TargetNearestEnemy protected ()

• CancelCast()
  • Returns: bool cancelled

• IsTargetSameAsLastValidTarget()
  • Returns: bool same

• TogglePlayerWield()

• IsPlayerMoving()
  • Returns: bool moving

• IsPlayerGroundTargeting()
  • Returns: bool isGroundTargeting

• GetGroundTargetingError()
  • Returns: integer:nilable error

Soul Gem Resurrection

• StartSoulGemResurrection private ()

• CancelSoulGemResurrection private ()

Buffs

• GetUnitBuffInfo(string unitTag, luaindex buffIndex)
  • Returns: string buffName, number timeStarted, number timeEnding, integer buffSlot, integer stackCount, textureName iconFilename, string buffType, BuffEffectType effectType, AbilityType abilityType, StatusEffectType statusEffectType

• GetUnitBuffSlot(string unitTag, luaindex buffIndex)
  • Returns: integer buffSlot

• GetNumBuffs(string unitTag)
  • Returns: integer numBuffs

• GetBuffEffectType(string unitTag, integer serverSlot)
  • Returns: integer buffEffectType

• GetBuffAbilityType(string unitTag, integer serverSlot)
  • Returns: integer buffAbilityType

• GetBuffStatusEffectType(string unitTag, integer serverSlot)
  • Returns: integer statusEffectType

• CheckUnitBuffsForAbilityType(string unitTag, integer abilityType)
  • Returns: bool found

• GetPoisonEffectColorIndex(string unitTag, integer serverSlot)
  • Returns: integer poisonColor

• GetPlayerBuffPriorities()
  • _Uses variable returns..._
  • Returns: integer statusEffectType

• CancelBuff(integer buffIndex)

• ActivateBuff(integer buffIndex)

Synergy

• GetSynergyInfo(luaindex synergyIndex)
  • Returns: integer synergyBuffSlot, string grantedAbilityName, number timeStarted, number timeEnding, string iconFilename, bool active

• GetNumSynergies()
  • Returns: integer numSynergies

• UseSynergyEffect private (integer synergyBuffSlot)

• UseMostRecentSynergyEffect private ()

Group

• GroupInvite(string unitTag)

• GroupKick(string unitTag)

• GroupPromote(string unitTag)

• GetGroupMemberRoles(string unitTag)
  • Returns: bool isDps, bool isHealer, bool isTank

• GetWeaponSwapUnlockedLevel()
  • Returns: integer level

Slot

• DoesInventoryContainEmptySoulGem()
  • Returns: bool hasEmptyGem

• GetSlotType(luaindex slotIndex)
  • Returns: integer type

• GetSlotAbilityRank(luaindex slotIndex)
  • Returns: integer abilityRank

• GetSlotAbilityCost(luaindex slotIndex)
  • Returns: integer abilityCost, integer mechanicType

• CheckSlotAbilityStatusLine(luaindex slotIndex, integer statusLine)
  • Returns: bool isUsed

• GetSlotBoundId(luaindex slotIndex)
  • Returns: integer id

• GetSlotTexture(luaindex slotIndex)
  • Returns: string texture, string weapontexture, string activationAnimation

• GetSlotName(luaindex slotIndex)
  • Returns: string name

• GetSlotItemQuality(luaindex slotIndex)
  • Returns: integer:nilable quality

• GetSlotCooldownInfo(luaindex slotIndex)
  • Returns: integer remain, integer duration, bool global

• IsSlotToggled(luaindex slotIndex)
  • Returns: bool toggledOn

• IsSlotUsed(luaindex slotIndex)
  • Returns: bool used

• IsSlotUsable(luaindex slotIndex)
  • Returns: bool useable

• HasCostFailure(luaindex slotIndex)
  • Returns: bool status

• HasRequirementFailure(luaindex slotIndex)
  • Returns: bool status

• HasWeaponSlotFailure(luaindex slotIndex)
  • Returns: bool status

• HasTargetFailure(luaindex slotIndex)
  • Returns: bool status

• HasRangeFailure(luaindex slotIndex)
  • Returns: bool status

• HasStatusEffectFailure(luaindex slotIndex)
  • Returns: bool status

• HasFallingFailure(luaindex slotIndex)
  • Returns: bool status

• HasSwimmingFailure(luaindex slotIndex)
  • Returns: bool status

• HasMountedFailure(luaindex slotIndex)
  • Returns: bool status

• HasReincarnatingFailure(luaindex slotIndex)
  • Returns: bool status

• HasOtherAbilityOngoingFailure(luaindex slotIndex)
  • Returns: bool status

• HasActivationHighlight(luaindex slotIndex)
  • Returns: bool status

• GetActionSlotType(luaindex slotIndex)
  • Returns: integer slotType

• IsSlotActionInRange(luaindex slotIndex)
  • Returns: bool inRange

• IsSlotActionTooClose(luaindex slotIndex)
  • Returns: bool inRange

• OnSlotDown private (luaindex slotIndex)

• OnSlotUp private (luaindex slotIndex)

• OnSpecialMoveKeyDown private (integer moveIndex)

• OnSpecialMoveKeyUp private (integer moveIndex)

• GetSlotItemCount(luaindex slotIndex)
  • Returns: integer count

• GetSlotItemSound(luaindex slotIndex)
  • Returns: integer itemSoundCategory

• IsSlotItemConsumable(luaindex slotIndex)
  • Returns: bool consumable

• InventoryContainsEmptySoulGem()
  • Returns: bool hasEmptyGem

• IsSlotSoulTrap(luaindex slotIndex)
  • Returns: bool isSoulTrap

• SelectSlotSkillAbility(SkillType skillType, luaindex skillLineIndex, luaindex abilityIndex, luaindex slotIndex)

• SlotSkillAbilityInSlot(SkillType skillType, luaindex skillLineIndex, luaindex abilityIndex, luaindex slotIndex)

• GetFirstFreeValidSlotForSkillAbility(SkillType skillType, luaindex skillLineIndex, luaindex abilityIndex)
  • Returns: luaindex:nilable freeSlot

• GetNumAbilities()
  • Returns: integer num

• GetAbilityInfoByIndex(luaindex slotIndex)
  • Returns: string name, string texture, integer rank, integer actionSlotType, bool passive, bool showInSpellbook

• IsValidAbilityForSlot(luaindex abilityIndex, luaindex slotIndex)
  • Returns: bool valid

• IsValidItemForSlot(integer bagId, integer bagSlotId, luaindex actionSlotIndex)
  • Returns: bool valid

• IsValidItemForSlotByItemInfo(integer itemId, integer itemQualityDefId, integer itemRequiredLevel, integer itemInstanceData, luaindex actionSlotIndex)
  • Returns: bool valid

Quest

• GetOfferedQuestInfo()
  • Returns: string dialogue, string response

• GetOfferedQuestShareInfo(integer questId)
  • Returns: string questName, string playerName, integer millisecondsSinceRequest

• GetOfferedQuestShareIds()
  • _Uses variable returns..._
  • Returns: integer questId

• AcceptOfferedQuest()

• AcceptSharedQuest(integer questId)

• DeclineSharedQuest(integer questId)

• CompleteQuest()

• AbandonQuest(luaindex journalQuestIndex)

• GetIsQuestSharable(luaindex journalQuestIndex)
  • Returns: bool isSharable

• ShareQuest(luaindex journalQuestIndex)

• GetNumJournalQuests()
  • Returns: integer numQuests

• IsValidQuestIndex(luaindex journalQuestIndex)
  • Returns: bool isValid

• GetJournalQuestType(luaindex journalQuestIndex)
  • Returns: integer type

• GetJournalQuestRepeatType(luaindex journalQuestIndex)
  • Returns: integer repeatType

• GetJournalQuestInfo(luaindex journalQuestIndex)
  • Returns: string questName, string backgroundText, string activeStepText, integer activeStepType, string activeStepTrackerOverrideText, bool completed, bool tracked, integer questLevel, bool pushed, integer questType

• GetJournalQuestIsComplete(luaindex journalQuestIndex)
  • Returns: bool completed

• GetJournalQuestIsPushed(luaindex journalQuestIndex)
  • Returns: bool isPushed

• GetJournalQuestName(luaindex journalQuestIndex)
  • Returns: string questName

• GetJournalQuestLevel(luaindex journalQuestIndex)
  • Returns: integer level

• GetJournalQuestStepInfo(luaindex journalQuestIndex, luaindex stepIndex)
  • Returns: string stepText, integer:nilable visibility, integer stepType, string trackerOverrideText, integer numConditions

• GetJournalQuestLocationInfo(luaindex journalQuestIndex)
  • Returns: string zoneName, string objectiveName, luaindex zoneIndex, luaindex poiIndex

• GetJournalQuestEnding(luaindex journalQuestIndex)
  • Returns: string goal, string dialog, string confirmComplete, string declineComplete, string backgroundText, string journalStepText

• GetJournalQuestNumConditions(luaindex journalQuestIndex, luaindex stepIndex)
  • Returns: integer conditionCount

• GetJournalQuestConditionType(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex, bool assisted)
  • Returns: integer pinType

• RequestJournalQuestConditionAssistance(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex, bool assisted)
  • Returns: integer:nilable taskId

• GetNearestQuestCondition(integer considerType)
  • Returns: bool foundValidCondition, luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex

• GetJournalQuestConditionInfo(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
  • Returns: string conditionText, integer current, integer max, bool isFailCondition, bool isComplete, bool isCreditShared

• GetJournalQuestConditionValues(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
  • Returns: integer current, integer max, bool isFailCondition, bool isComplete, bool isCreditShared

• GetJournalQuestTimerInfo(luaindex journalQuestIndex)
  • Returns: number timerStart, number timerEnd, bool isVisible, bool isPaused

• GetJournalQuestTimerCaption(luaindex journalQuestIndex)
  • Returns: string caption

• GetJournalQuestNumSteps(luaindex journalQuestIndex)
  • Returns: integer numSteps

• GetQuestToolCount(luaindex journalQuestIndex)
  • Returns: integer toolCount

• GetQuestToolInfo(luaindex journalQuestIndex, luaindex toolIndex)
  • Returns: string iconFilename, integer stackCount, bool isUsable, string name

• GetQuestToolCooldownInfo(luaindex journalQuestIndex, luaindex toolIndex)
  • Returns: integer remain, integer duration

• GetQuestItemInfo(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
  • Returns: string iconFilename, integer stackCount, string name

• UseQuestItem(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

• UseQuestTool(luaindex journalQuestIndex, luaindex toolIndex)

• GetQuestDailyCount()
  • Returns: integer dailyCount, integer dailyMax

• GetJournalQuestNumRewards(luaindex journalQuestIndex)
  • Returns: integer count

• GetJournalQuestRewardInfo(luaindex journalQuestIndex, luaindex rewardIndex)
  • Returns: integer type, string name, integer amount, string iconFile, bool meetsUsageRequirement, integer itemQuality

• GetQuestRewardItemLink(luaindex rewardIndex, LinkStyle linkStyle)
  • Returns: string link

• GetIsTracked(integer trackType, integer param1, integer param2)
  • Returns: bool tracked

• SetTracked(integer trackType, bool tracked, integer param1, integer param2)
  • Returns: bool success

• GetNumTracked()
  • Returns: integer numTracked

• GetTrackedByIndex(luaindex index)
  • Returns: integer trackType, integer param1, integer param2

• GetTrackedIsAssisted(integer trackType, integer param1, integer param2)
  • Returns: bool assisted

• SetTrackedIsAssisted(integer trackType, bool assisted, integer param1, integer param2)

Chat

• LogChatText private (string text)

• ToggleChatLog()

• AcceptChatInvite(bool accept, string channelName)

• SendChatMessage private (string message, integer channelId, string target)

• GetDynamicChatChannelName(integer channelId)
  • Returns: string name

• GetChatChannelId(string name)
  • Returns: integer channelId

• IsInCustomChatChannel(integer channelId)
  • Returns: bool isJoined

• IsCustomChatChannel(integer channelId)
  • Returns: bool isCustom

• JoinChatChannel(string name)

• CanWriteGuildChannel(integer channelId)
  • Returns: bool canWrite

• LeaveChatChannel(string name)

• GetNumChatContainers()
  • Returns: integer numContainers

• GetNumChatContainerTabs(luaindex chatContainerIndex)
  • Returns: integer numContainerTabs

• GetChatContainerTabInfo(luaindex chatContainerIndex, luaindex tabIndex)
  • Returns: string name, bool isLocked, bool isInteractable, bool isCombatLog, bool areTimestampsEnabled

• GetNumChatCategories()
  • Returns: integer numCategories

• IsChatContainerTabCategoryEnabled(luaindex chatContainerIndex, luaindex tabIndex, integer chatCategory)
  • Returns: bool enabled

• SetChatContainerTabCategoryEnabled(luaindex chatContainerIndex, luaindex tabIndex, integer chatCategory, bool enabled)

• SetChatContainerTabInfo(luaindex chatContainerIndex, luaindex tabIndex, string name, bool isLocked, bool isInteractable, bool areTimestampsEnabled)

• ResetChatContainerTabToDefault(luaindex chatContainerIndex, luaindex tabIndex)

• GetChatContainerColors(luaindex chatContainerIndex)
  • Returns: number bgRed, number bgGreen, number bgBlue, number bgMinAlpha, number bgMaxAlpha

• SetChatContainerColors(luaindex chatContainerIndex, number bgRed, number bgGreen, number bgBlue, number bgMinAlpha, number bgMaxAlpha)

• ResetChatContainerColorsToDefault(luaindex chatContainerIndex)

• AddChatContainer()

• RemoveChatContainer(luaindex chatContainerIndex)

• AddChatContainerTab(luaindex chatContainerIndex, string name, bool isCombatLog)

• RemoveChatContainerTab(luaindex chatContainerIndex, luaindex tabIndex)

• TransferChatContainerTab(luaindex fromChatContainerIndex, luaindex fromTabIndex, luaindex toChatContainerIndex, luaindex toTabIndex)

• GetChatFontSize()
  • Returns: integer fontSize

• SetChatFontSize(integer fontSize)

• ResetChatFontSizeToDefault()

• GetChatCategoryColor(integer category)
  • Returns: number red, number green, number blue

• SetChatCategoryColor(integer category, number red, number green, number blue)

• ResetChatCategoryColorToDefault(integer category)

Movement

• MoveForwardStart private ()

• MoveForwardStop private ()

• MoveBackwardStart private ()

• MoveBackwardStop private ()

• ToggleWalk private ()

• TurnLeftStart private ()

• TurnLeftStop private ()

• TurnRightStart private ()

• TurnRightStop private ()

• StrafeLeftStart private ()

• StrafeLeftStop private ()

• StrafeRightStart private ()

• StrafeRightStop private ()

• JumpAscendStart private ()

• AscendStop private ()

• DescendStart private ()

• DescendStop private ()

Mouse Events

• LeftMouseDownInWorld private ()

• LeftMouseUpInWorld private ()

• LeftAndRightMouseDownInWorld private ()

• LeftAndRightMouseUpInWorld private ()

• RightMouseDownInWorld private ()

• RightMouseUpInWorld private ()

Combat Actions

• ToggleAutoRun private ()

• RollDodgeStart private ()

• RollDodgeStop private ()

• PrepareAttack private ()

• PerformAttack private ()

• StartBlock private ()

• StopBlock private ()

• PerformInterrupt private ()

Interaction

• SetUseInteractionCamera(bool enabled)

• EndInteraction(integer interactionType)

• IsInteractionPending()
  • Returns: bool isPending

• EndPendingInteraction()

Camera

• CameraZoomIn()

• CameraZoomOut()

• GetPlayerCameraHeading()
  • Returns: number heading

• SetFrameLocalPlayerInGameCamera(bool enabled)

• SetFrameLocalPlayerTarget(number normalizedScreenX, number normalizedScreenY)

• SetFramingScreenType(GameCameraFramingScreenType sreenType)

Chatter

• GetChatterGreeting()
  • Returns: string optionString

• GetChatterFarewell()
  • Returns: string backToTOCString, string farewellString

• GetChatterOption(luaindex optionIndex)
  • Returns: string optionString, integer optionType, integer optionalArgument, bool isImportant, bool chosenBefore

• GetChatterOptionCount()
  • Returns: integer optionCount

• ResetChatter()

• SelectChatterOption(luaindex optionIndex)

• IsPlayerInteractingWithObject()
  • Returns: bool areThey

• GetChatterData()
  • Returns: string text, integer numOptions, bool atGreeting

• GetInteractionType()
  • Returns: integer interactMode

Container Functions

• GetMaxBags()
  • Returns: integer maxBags

• GetBagInfo(integer bagId)
  • Returns: string bagIcon, integer bagSlots

• GetItemInstanceId(integer bagId1, integer slotIndex1)
  • Returns: integer:nilable id

• GetItemTotalCount(integer bagId, integer slotIndex)
  • Returns: integer count

• IsItemConsumable(integer bagId, integer slotIndex)
  • Returns: bool consumable

• IsItemJunk(integer bagId, integer slotIndex)
  • Returns: bool junk

• GetItemFilterTypeInfo(integer bagId, integer slotIndex)
  • _Uses variable returns..._
  • Returns: ItemFilterType itemFilterType

• GetItemStatValue(integer bagId, integer slotIndex)
  • Returns: integer statValue

• GetItemLink(integer bagId, integer slotIndex, LinkStyle linkStyle)
  • Returns: string link

• GetComparisonEquipSlotsFromItemLink(string itemLink)
  • Returns: integer:nilable comparisonSlot1, integer:nilable comparisonSlot2

• GetItemName(integer bagId, integer slotIndex)
  • Returns: string name

• IsItemUsable(integer bagId, integer slotIndex)
  • Returns: bool usable, bool usableOnlyFromActionSlot

• GetSlotStackSize(integer bagId, integer slotIndex)
  • Returns: integer stack, integer maxStack

• GetEquippedItemInfo(integer equipSlot)
  • Returns: string icon, bool slotHasItem, integer sellPrice, bool isHeldSlot, bool isHeldNow, bool locked

• GetHeldSlots()
  • Returns: integer heldMain, integer heldOff, integer lastHeldMain, integer lastHeldOff

• GetItemNumSockets(integer bagId, integer slotIndex)
  • Returns: integer sockets

• GetItemSocketType(integer bagId, integer slotIndex, luaindex socketIndex)
  • Returns: integer socketType

• CheckInventorySpaceAndWarn(integer numItems)
  • Returns: bool haveSpace

• CheckInventorySpaceSilently(integer numItems)
  • Returns: bool haveSpace

• EquipItem(integer bagId, integer slotIndex, integer:nilable equipSlotIndex)

• UnequipItem(integer equipSlot)

• FindFirstEmptySlotInBag(integer bagId)
  • Returns: integer:nilable slotIndex

• DestroyItem(integer bagId, integer slotIndex)

• IsEquipable(integer bagId, integer slotIndex)
  • Returns: bool isEquipable, integer resultErrorCodeIfFailed

• GetItemLinkInfo(string itemLink)
  • Returns: string icon, integer sellPrice, bool meetsUsageRequirement, integer equipType, integer itemStyle

• UseItem protected (integer bagId, integer slotIndex)

• GetNextBankUpgradePrice()
  • Returns: integer cost

• GetItemCooldownInfo(integer bagId, integer slotIndex)
  • Returns: integer remain, integer duration

• BuyBankSpace()

• BuyBagSpace()

• DisplayBankUpgrade()

• IsBankUpgradeAvailable()
  • Returns: bool isAvailable

• IsItemBound(integer bagId, integer slotIndex)
  • Returns: bool isBound

• GetFirstFreeValidSlotForItem(integer bagId, integer slotIndex)
  • Returns: luaindex:nilable freeSlot

• GetItemCurrentActionBarSlot(integer bagId, integer slotIndex)
  • Returns: luaindex:nilable currentSlot

• GetItemSoundCategory(integer bagId, integer slotIndex)
  • Returns: integer itemSoundCategory

• GetItemSoundCategoryFromLink(string link)
  • Returns: integer itemSoundCategory

• PlayItemSound(integer itemSoundCategory, integer itemSoundAction)

• IsLockedWeaponSlot(integer equipSlot)
  • Returns: bool locked

• GetSelectedGuildBankId()
  • Returns: integer:nilable guildId

Game(?)

• GetNumScoreEntries()
  • Returns: integer numItems

• GetGameType()
  • Returns: integer type

• GetGameName()
  • Returns: string name

• GetGameDescription()
  • Returns: string description

• GetGameInfoTexture()
  • Returns: string path

• GetSharedScoreEntryInfo(luaindex slotIndex)
  • Returns: string name, integer classId, integer alliance, integer kills, integer deaths, integer assists, integer healing, integer damage, integer score, integer seconds, integer numMedals

• GetCTFScoreEntryInfo(luaindex slotIndex)
  • Returns: integer flags

• GetNumScoreboardMedals(luaindex index)
  • Returns: integer numMedals

• GetScoreboardMedalInfo(luaindex scoreIndex, luaindex medalIndex)
  • Returns: string name, string iconTexture, string condition

• GetNumBattlegroundMedals()
  • Returns: integer numMedals

• GetBattlegroundMedalInfo(luaindex medalIndex)
  • Returns: string name, string iconTexture, string condition

• RefreshScoreBoard()

• SendScoreBoardClosed()

• GetShowScoreButton()
  • Returns: bool result

• GetNumTeams()
  • Returns: integer result

• GetScoringTeam()
  • Returns: integer result

• GetGameScore(integer alliance)
  • Returns: integer value

• GetNumObjectivesOwnedByAlliance(integer alliance)
  • Returns: integer objectives

• GetGameState()
  • Returns: integer result

• GetGameStateIsTimed()
  • Returns: bool isTimed

• GetGameStateIsPaused()
  • Returns: bool result

• GetScoreToWin()
  • Returns: integer result

• GetGameTimeRemaining()
  • Returns: integer result

• GetNumAvAObjectives()
  • Returns: integer num

• GetAvAObjectiveKeysByIndex(luaindex index)
  • Returns: integer keepId, integer objectiveId, integer battlegroundContext

• GetAvAObjectivePvPSystem(integer keepId, integer objectiveId, integer battlegroundContext)
  • Returns: integer AvASystem

• GetAvAObjectiveRelatedUnitName(integer keepId, integer objectiveId, integer battlegroundContext)
  • Returns: string unitName

• GetAvAObjectiveInfo(integer keepId, integer objectiveId, integer battlegroundContext)
  • Returns: string objectiveName, integer objectiveType, integer objectiveState, integer allianceParam1, integer allianceParam2

• GetAvAObjectivePinInfo(integer keepId, integer objectiveId, integer battlegroundContext)
  • Returns: integer pinType, number currentNormalizedX, number currentNormalizedY, bool continuousUpdate

• GetAvAObjectiveSpawnPinInfo(integer keepId, integer objectiveId, integer battlegroundContext)
  • Returns: integer pinType, number spawnNormalizedX, number spawnNormalizedY

• IsAvAObjectiveInBattleground(integer keepId, integer objectiveId, integer battlegroundContext)
  • Returns: bool isInBattleground

• GetAvAArtifactScore(integer campaignId, integer alliance, integer artifactType)
  • Returns: bool allOwnHeld, integer enemyHeld

• GetNumArtifactScoreBonuses(integer alliance, integer artifactType)
  • Returns: integer numBonuses

• GetArtifactScoreBonusInfo(integer alliance, integer artifactType, luaindex index)
  • Returns: string name, textureName icon, string description

• GetNumKillLocations()
  • Returns: integer numLocations

• GetKillLocationPinInfo(luaindex index)
  • Returns: integer pinType, number normalizedX, number normalizedY

• IsLocalBattlegroundContext(integer battlegroundContext)
  • Returns: bool isLocal

• IsAssignedBattlegroundContext(integer battlegroundContext)
  • Returns: bool isAssigned

• DoBattlegroundContextsIntersect(integer context1, integer context2)
  • Returns: bool intersects

• IsPlayerInAvAWorld()
  • Returns: bool isInAvAWorld

• GetCurrentCampaignId()
  • Returns: integer currentCampaignId

• GetAssignedCampaignId()
  • Returns: integer assignedCampaignId

• GetCampaignAllianceScore(integer campaignId, integer alliance)
  • Returns: integer score

• GetSecondsUntilCampaignScoreReevaluation(integer campaignId)
  • Returns: integer seconds

• GetSecondsUntilCampaignStart(integer campaignId)
  • Returns: integer seconds

• GetSecondsUntilCampaignEnd(integer campaignId)
  • Returns: integer seconds

• GetCampaignUnderdogLeaderAlliance(integer campaignId)
  • Returns: integer alliance

• GetSecondsUntilCampaignUnderdogReevaluation(integer campaignId)
  • Returns: integer seconds

• GetCampaignHoldings(integer campaignId, integer elementType, integer alliance, integer targetAlliance)
  • Returns: integer elementsControlled

• GetTotalCampaignHoldings(integer campaignId, integer elementType, integer alliance)
  • Returns: integer elementsControlled

• GetCampaignAlliancePotentialScore(integer campaignId, integer alliance)
  • Returns: integer potentialScore

• GetCampaignHoldingScoreValues(integer campaignId)
  • Returns: integer keepValue, integer resourceValue, integer outpostValue, integer defensiveArtifactValue, integer offensiveArtifactValue

• GetCampaignName(integer campaignId)
  • Returns: string campaignName

• GetPendingAssignedCampaign()
  • Returns: integer campaignId

• GetNumCampaignRulesetTypes()
  • Returns: integer numRulesetTypes

• GetCampaignSocialConnectionInfo(integer connectionIndex)
  • Returns: integer accountId, Alliance alliance, integer assignedCampaignId, integer currentCampaignId, bool isFriend, bool isGuildMate

• SwitchGuestCampaign(integer campaignId)

• GetNumLootItems()
  • Returns: integer count

• GetMaxTransformPlugs()
  • Returns: integer numPlugs

• GetPlugItemInfo(integer bagId, integer slotId, luaindex socketIndex)
  • Returns: string name, string icon

• GetPlugItemLink(integer bagId, integer slotId, luaindex socketIndex, LinkStyle linkStyle)
  • Returns: string link

Socketing

• StartSocketingItem(integer bagId, integer slotId)
  • Returns: bool success

• StartSocketingUnit(string unitTag)
  • Returns: bool success

• ResetSocketing()

• StopSocketing()

• ApplySocketing()

• ClearSocket(luaindex socketIndex)

• ApplyPlugToSocket(luaindex socketIndex, integer bagId, integer slotId)

• IsCurrentlySocketingItem(integer bagId, integer slotId)
  • Returns: bool isItem

• IsCurrentlySocketingUnit(string unitTag)
  • Returns: bool isSocketing

• CanPlayerModifySockets()
  • Returns: bool canModify

• AreSocketingChangesPending(luaindex socketIndex)
  • Returns: bool changesPending

• SocketingChangesWillDestroyUpgrades()
  • Returns: bool upgradesDestroyed

• CanPlugGoInSocket(integer plugBagId, integer plugSlotId, luaindex socketIndex)
  • Returns: bool plugFits

Keep

• GetKeepWallInfo()
  • Returns: string keepName, string hookPointStoreLeftImage, string hookPointStoreRightImage, integer numAvailableHookPoints, integer numTotalHookPoints

• RepairKeepPiece()

• GetNumKeepPieceHealItems()
  • Returns: integer numItems

• GetClosestKeep(integer battlegroundContext)
  • Returns: integer keepId

• GetClosestKeepOfType(integer keepType, integer resourceType, integer battlegroundContext)
  • Returns: integer keepId

• GetKeepType(integer keepId)
  • Returns: integer keepType

• GetNumKeeps()
  • Returns: integer numKeeps

• GetKeepKeysByIndex(luaindex index)
  • Returns: integer keepId, integer battlegroundContext

• GetAvAKeepScore(integer campaignId, integer alliance)
  • Returns: bool allOwnHeld, integer enemyHeld

• GetAvAKeepsHeld(integer campaignId, integer alliance)
  • Returns: integer keepCount

• GetNumKeepScoreBonuses()
  • Returns: integer numBonuses

• GetKeepScoreBonusInfo(luaindex index)
  • Returns: string name, textureName icon, string description

• GetKeepPinInfo(integer keepId, integer battlegroundContext)
  • Returns: integer pinType, number normalizedX, number normalizedY

• GetKeepName(integer keepId)
  • Returns: string keepName

• GetKeepAlliance(integer keepId, integer battlegroundContext)
  • Returns: integer alliance

• GetKeepPvPSystem(integer keepId)
  • Returns: integer PvPSystem

• GetResourceKeepForKeep(integer parentKeepId, integer resourceType)
  • Returns: integer keepId

• GetNumKeepResourceTypes()
  • Returns: integer numTypes

• GetNumKeepUpgradePaths()
  • Returns: integer numPaths

• GetParentKeepForKeep(integer keepId)
  • Returns: integer parentKeepId

• GetKeepResourceLevel(integer keepId, integer battlegroundContext, integer resourceType)
  • Returns: integer resourceLevel

• GetKeepUnderAttack(integer keepId, integer battlegroundContext)
  • Returns: bool underAttack

• GetKeepResourceInfo(integer keepId, integer battlegroundContext, integer resourceType, integer level)
  • Returns: integer currentAmount, integer amountForNextLevel, integer upkeepPerMinute

• GetKeepUpgradeRate(integer keepId, integer battlegroundContext, KeepUpgradeLine upgradeLine)
  • Returns: integer rate

• GetKeepUpgradeInfo(integer keepId, integer battlegroundContext, integer upgradePath, integer level)
  • Returns: integer currentAmount, integer amountForNextLevel, integer upkeepPerMinute

• GetKeepProductionLevel(integer keepId, integer battlegroundContext)
  • Returns: integer productionLevel

• GetKeepDefensiveLevel(integer keepId, integer battlegroundContext)
  • Returns: integer defensiveLevel

• GetNumUpgradesForKeepAtResourceLevel(integer keepId, integer battlegroundContext, integer resourceType, integer level)
  • Returns: integer numUpgrades

• GetKeepUpgradeDetails(integer keepId, integer battlegroundContext, integer resourceType, integer level, luaindex index)
  • Returns: string upgradeName, string upgradeDetails, textureName upgradeIcon, integer upgradeAtPercent, bool active

• GetKeepUpgradeLineFromResourceType(KeepResourceType resourceType)
  • Returns: KeepUpgradeLine upgradeLine

• GetKeepUpgradeLineFromUpgradePath(KeepUpgradePath upgradePath)
  • Returns: KeepUpgradeLine upgradeLine

• GetNumUpgradesForKeepAtPathLevel(integer keepId, integer battlegroundContext, integer upgradePath, integer level)
  • Returns: integer numUpgrades

• GetKeepUpgradePathDetails(integer keepId, integer battlegroundContext, integer upgradePath, integer level, luaindex index)
  • Returns: string upgradeName, string upgradeDetails, textureName icon, integer upgradeAtPercent, bool active

• GetInteractionKeepId()
  • Returns: integer keepId

• GetActiveKeepId()
  • Returns: integer keepId

• DepositBattleTokens(integer keepId, integer upgradePath, integer quantity)

• GetBattleTokensForKeepUpgradePathLevel(integer keepId, integer battlegroundContext, integer upgradePath, integer level)
  • Returns: integer battleTokens

• GetKeepInCombat(integer keepId, integer battlegroundContext)
  • Returns: bool inCombat

• GetClaimedKeepGuildName(integer keepId, integer battlegroundContext)
  • Returns: string guildName

• RequestKeepInfoForKeep(integer keepId, bool on)

• GetKeepArtifactObjectiveId(integer keepId)
  • Returns: integer objectiveId

• GetMaxKeepSieges(integer keepId, integer battlegroundContext)
  • Returns: integer maxSiege

• GetMaxKeepNPCs(integer keepId, integer battlegroundContext)
  • Returns: integer maxNPC

• GetNumFriendlyKeepNPCs(integer keepId, integer battlegroundContext)
  • Returns: integer numFriendlyNPC

• GetNumSieges(integer keepId, integer battlegroundContext, integer alliance)
  • Returns: integer numSieges

• GetCurrentMoney()
  • Returns: integer money

• GetAlliancePoints()
  • Returns: integer alliancePoints

• GetBattleTokens()
  • Returns: integer battleTokens

• CanRespawnAtKeep(integer keepId)
  • Returns: bool canRespawn

Map Pin

• AddMapPin(integer pinType, integer param1, integer param2, integer param3)

• RemoveMapPin(integer pinType, integer param1, integer param2, integer param3)

• StopMapPinAnimation(integer pinType, integer param1, integer param2, integer param3)

• RemoveMapPinsByType(integer pinType)

• SetMapPinAssisted(integer pinType, bool assisted, integer param1, integer param2, integer param3)

• SetMapPinContinuousPositionUpdate(integer pinType, bool continuousUpdate, integer param1, integer param2, integer param3)

• AddMapQuestPins(luaindex journalQuestIndex)

• RemoveMapQuestPins(luaindex journalQuestIndex)

• SetMapQuestPinsAssisted(luaindex journalQuestIndex, bool assisted)

• IsMapPinFilterSet(integer filter)
  • Returns: bool isSet

• SetMapPinFilter(integer filter, bool showFilter)

• GetNumMapPinFilters()
  • Returns: integer numFilters

• StartMapPinAnimation(object animationTimeline, MapPinAnimationTarget animationTarget, ControlType:nilable limitToMapType, MapDisplayPinType pinType, integer param1, integer param2, integer param3, integer playOffset, bool ignoreBreadcrumbs)
  • Returns: bool played

• IsPlayerInsidePinArea(MapDisplayPinType pinType, integer param1, integer param2, integer param3)
  • Returns: bool isPlayerInside

• RemoveMapPinsInRange(MapDisplayPinType startType, MapDisplayPinType endType, integer:nilable param1, integer:nilable param2, integer:nilable param3)

Siege Weapon

• StartMouseSiegeWeaponAim private ()

• StopMouseSiegeWeaponAim private ()

• SiegeWeaponPackUp private ()

• SiegeWeaponRelease private ()

• SiegeWeaponFire private ()

• CanSiegeWeaponPackUp()
  • Returns: bool canPackup

• CanSiegeWeaponFire()
  • Returns: bool canFire

• CanSiegeWeaponAim()
  • Returns: bool canAim

• IsPlayerControllingSiegeWeapon()
  • Returns: bool isPlayerControlling

• GetSiegeAmmoIcon()
  • Returns: string iconFilename

Player Escorting

• IsPlayerEscortingRam()
  • Returns: bool isPlayerEscorting

• GetNumPlayersEscortingRam()
  • Returns: integer numPlayersEscorting

• GetMinMaxRamEscorts()
  • Returns: integer minEscorts, integer maxEscorts

Health Warning

• SetHealthWarningStage(integer stage)

• FlashHealthWarningStage(integer stage, integer flashTimeMs)

• ClearHealthWarnings()

• SetFlashWaitTime(integer waitTimeMs)

Player Auras

• GetNumUsedPlayerAuras()
  • Returns: integer numUsed

• GetPlayerAuraInfo(luaindex auraIndex)
  • Returns: bool active, integer position, string textureFilename

Achievement

• GetAchievementRewardInfo(integer achievementId, luaindex rewardIndex)
  • Returns: integer achievementRewardType, integer points, string name, string icon, integer quality

• FormatAchievementLinkTimestamp(string timestamp)
  • Returns: string date, string time

Player Stats

• GetPlayerMaxLevel()
  • Returns: integer maxLevel

• GetNumStats()
  • Returns: integer numStats

• GetStatIncreasePerLevel(integer statId)
  • Returns: integer increasePerLevel

• GetNumAbilitiesLearnedForLevel(integer level, bool progression)
  • Returns: integer abilitiesLearned

• GetLearnedAbilityInfoForLevel(integer level, luaindex learnedIndex, bool progression)
  • Returns: string name, string texture, luaindex abilityIndex, luaindex progressionIndex

• PlayerHasAttributeUpgrades()
  • Returns: bool hasLevelUpgrades

Player Attributes

• GetNumAttributePassives(integer attributeType)
  • Returns: integer numPassives

• GetAttributePassiveInfo(integer attributeType, luaindex index)
  • Returns: integer points, string icon, string name

• GetAttributeSpentPoints(integer attributeType)
  • Returns: integer points

• GetAttributeUnspentPoints()
  • Returns: integer points

• PurchaseAttributes(integer health, integer magicka, integer stamina)

• GetNumAttributeDerivedStats(integer attribute)
  • Returns: integer numDerivedStats

• GetAttributeDerivedStatInfo(integer attribute, luaindex index)
  • Returns: integer stat, number amountPerPoint

• GetAttributeDerivedStatPerPointValue(integer attribute, integer stat)
  • Returns: number amountPerPoint

Weapon Set

• GetNumWeaponSets()
  • Returns: integer numSets

• GetCurrentWeaponSet()
  • Returns: integer activeWeaponSetIndex

• GetWeaponSetInfo(luaindex weaponSetIndex)
  • Returns: string name, string texture, integer rank

• GetWeaponSetXPInfo(luaindex weaponSetIndex)
  • Returns: integer lastRankXp, integer nextRankXP, integer currentXP

• GetNumWeaponSetRanks(luaindex weaponSetIndex)
  • Returns: integer numRanks

• GetWeaponSetAbilityInfo(luaindex weaponSetIndex, integer rank)
  • Returns: string name, string texture, luaindex abilityIndex

Ability Progression

• ChooseAbilityProgressionMorph(luaindex progressionIndex, integer morph)

• RespecAbilityProgression(luaindex progressionIndex)

• GetNumAbilityProgressions()
  • Returns: integer numProgressions

• GetAbilityProgressionInfo(luaindex progressionIndex)
  • Returns: string name, integer morph, integer rank

• GetAbilityProgressionXPInfo(luaindex progressionIndex)
  • Returns: integer lastRankXp, integer nextRankXP, integer currentXP, bool atMorph

• GetNumAbilityProgressionRanks(luaindex progressionIndex, integer morph)
  • Returns: integer numRanks

• GetAbilityProgressionAbilityInfo(luaindex progressionIndex, integer morph, integer rank)
  • Returns: string name, string texture, luaindex abilityIndex

World Event

• AcceptWorldEventInvite(integer eventId)

• DeclineWorldEventInvite(integer eventId)

Combat Tips

• GetNumActiveCombatTips()
  • Returns: integer numTips

• GetActiveCombatTipInfo(integer activeCombatTipId)
  • Returns: string name, string tipText, string iconPath

Camera

• IsGameCameraActive()
  • Returns: bool isActive

• IsInteractionCameraActive()
  • Returns: bool isActive

• GameCameraInteractStart()

• GetGameCameraMinCameraDistance()
  • Returns: number minCameraDistance

• GetGameCameraMaxCameraDistance()
  • Returns: number maxCameraDistance

• IsReticleHidden()
  • Returns: bool isHidden

• IsGameCameraTargetInMeleeRange()
  • Returns: bool inMeleeRange

• IsGameCameraTargetOutOfRange()
  • Returns: bool outOfRange

• IsGameCameraUnitHighlightedValid()
  • Returns: bool valid

• IsGameCameraUnitHighlightedAttackable()
  • Returns: bool attackable

• GameCameraMouseFreeLookStart()

• GameCameraMouseFreeLookStop()

• CycleGameCameraPreferredEnemyTarget()

• IsGameCameraPreferredTargetValid()
  • Returns: bool valid

• ClearGameCameraPreferredTarget()

• IsGameCameraPreferredTargetHighlightedByReticle()
  • Returns: bool highlighted

• GetGameCameraInteractableActionInfo()
  • Returns: string:nilable action, string:nilable name, bool interactBlocked, integer additionalInfo, integer:nilable contextualInfo

• GetGameCameraInteractableInfo()
  • Returns: bool interactionPossible, bool questInteraction, bool questTargetBased, luaindex questJournalIndex, luaindex questToolIndex, bool questToolOnCooldown

• GetNameOfGameCameraQuestToolTarget()
  • Returns: string name

• ToggleGameCameraFirstPerson()

• IsGameCameraFirstPerson()
  • Returns: bool isInFirstPerson

• IsGameCameraSiegeControlled()
  • Returns: bool valid

• ReleaseGameCameraSiegeControlled()

Lockpicking

• AttemptForceLock private ()

• GetLockpickingTimeLeft()
  • Returns: integer timeLeftMs

• GetChanceToForceLock()
  • Returns: integer chance

• GetNumLockpicksLeft()
  • Returns: integer picksLeft

• GetLockQuality()
  • Returns: integer lockQuality

Chamber

• StopSettingChamber private ()

• GetSettingChamberStress()
  • Returns: number stress

• GetChamberState(luaindex chamberIndex)
  • Returns: integer chamberState, number chamberProgress

• IsChamberSolved(luaindex chamberIndex)
  • Returns: bool solved

• StartSettingChamber private (luaindex chamberIndex)
  • Returns: bool succesfullyStarted

Hook Points

• GetNumHookPoints()
  • Returns: integer numHookPoints

• GetHookPointInfo(luaindex index)
  • Returns: number normalizedX, number normalizedY, integer type, bool enabled, bool occupied, luaindex:nilable occupiedStoreIndex

• GetNumHookPointStoreEntries(luaindex hookPointIndex)
  • Returns: integer numStoreEntries

• GetHookPointStoreInfo(luaindex hookPointIndex, luaindex storeIndex)
  • Returns: string name, string description, integer alliancePointsCost, string iconFile

• AddHookPointPurchase(luaindex hookPointIndex, luaindex storeIndex)

• CompleteHookPointPurchase()

Feedback

• GetNumPendingFeedback()
  • Returns: integer pendingFeedback

• GetFeedbackIdByIndex(luaindex feedbackIndex)
  • Returns: integer:nilable feedbackId

• GetFeedbackType(integer feedbackId)
  • Returns: integer feedbackType

• RemovePendingFeedback(integer feedbackId)

• IsFeedbackGatheringEnabled()
  • Returns: bool enabled

Emotes

• GetNumEmotes()
  • Returns: integer success

• GetEmoteSlashName(luaindex index)
  • Returns: string slashName

• PlayEmote(luaindex index)

Logout

• Logout()

• Quit()

• ConfirmLogout(bool quitGame, LogoutType option, LogoutResult initialResult)

• CancelLogout()

Cursor

• ClearCursor()
  • Returns: bool clearedSomething

• SetCursorItemSoundsEnabled(bool enabled)

• GetCursorContentType()
  • Returns: integer cursorType

• GetCursorBagId()
  • Returns: integer:nilable originatingBag

• GetCursorSlotIndex()
  • Returns: integer:nilable slotIndex

• PlaceInActionBar protected (luaindex actionSlot)

• PlaceInInventory protected (integer bagId, integer slotIndex)

• PlaceInEquipSlot protected (integer slot)

• PlaceInStoreWindow protected ()

• PlaceInSocket protected (luaindex socketIndex)

• PlaceInTransfer protected ()

• PlaceInWorldLeftClick protected ()

• PlaceInAttachmentSlot protected (luaindex attachmentSlot)

• PickupAction protected (luaindex actionSlot)

• PickupAbility protected (luaindex abilityIndex)

• PickupAbilityBySkillLine protected (SkillType skillType, luaindex skillLineIndex, luaindex abilityIndex)

• PickupInventoryItem protected (integer bagId, integer slotIndex, integer count)

• PickupEquippedItem protected (integer slot)

• PickupTradeItem protected (luaindex tradeIndex)

• PickupQuestTool protected (luaindex journalQuestIndex, luaindex toolIndex)

• PickupQuestItem protected (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

• PickupStoreItem protected (luaindex entryIndex)

• PickupStoreBuybackItem protected (luaindex entryIndex)

• PickupMount protected (luaindex mountIndex)

• RespondToDestroyRequest private (bool choice)

• PlaceInTradingHouse protected ()

• GetNumActionLayers()
  • Returns: integer actionLayers

• GetActionLayerInfo(luaindex layerIndex)
  • Returns: string layerName, integer numLayerCategories

• GetActionLayerCategoryInfo(luaindex layerIndex, luaindex categoryIndex)
  • Returns: string categoryName, integer numActions

• GetActionInfo(luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex)
  • Returns: string actionName, bool isRebindable, bool isHidden

• GetActionBindingInfo(luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex, luaindex bindingIndex)
  • Returns: KeyCode keyCode, KeyCode mod1, KeyCode mod2, KeyCode mod3, KeyCode mod4

• GetMaxBindingsPerAction()
  • Returns: integer maxNumBindings

• CreateDefaultActionBind(string actionName, KeyCode key, KeyCode modifier1, KeyCode modifier2, KeyCode modifier3, KeyCode modifier4)

• BindKeyToAction protected (luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex, luaindex bindingIndex, KeyCode key, KeyCode modifier1, KeyCode modifier2, KeyCode modifier3, KeyCode modifier4)

• UnbindKeyFromAction protected (luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex, luaindex bindingIndex)

• UnbindAllKeysFromAction protected (luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex)

• GetActionIndicesFromName(string actionName)
  • Returns: luaindex:nilable layerIndex, luaindex:nilable categoryIndex, luaindex:nilable actionIndex

• GetBindingIndicesFromKeys(luaindex layerIndex, KeyCode keyCode, KeyCode mod1, KeyCode mod2, KeyCode mod3, KeyCode mod4)
  • Returns: luaindex:nilable categoryIndex, luaindex:nilable actionIndex, luaindex:nilable bindingIndex

• PushActionLayerByName(string layerName)

• InsertActionLayerByName(string layerName, luaindex activeLayerIndex)

• RemoveActionLayerByName(string layerName)

• IsActionLayerActiveByName(string layerName)
  • Returns: bool active

• PopActionLayer()

• GetNumActiveActionLayers()
  • Returns: integer numActiveActionLayers

• GetActiveActionLayerIndex(luaindex activeActionLayerIndex)
  • Returns: luaindex:nilable layerIndex

• ApplySoftCapToStat(DerivedStats derivedStat, integer value)
  • Returns: integer softCappedValue

• GetCon(integer otherLevel, integer:nilable playerLevel)
  • Returns: DifficultyCon con

• IsWerewolf()
  • Returns: bool isWerewolf

Group

• GetGroupInviteInfo()
  • Returns: string name, integer millisecondsSinceRequest

• AcceptGroupInvite()

• DeclineGroupInvite()

• GroupLeave()

• GroupInviteByName(string name)

• GroupKickByName(string name)

• GroupDisband()

• IsPlayerInGroup(string name)
  • Returns: bool inGroup

• GetGroupSize()
  • Returns: integer groupSize

• PingMap(integer pingType, integer mapDisplayType, number normalizedX, number normalizedZ)

• RemoveRallyPoint()

• RemovePlayerWaypoint()

• JumpToGroupLeader()

• JumpToGroupMember(string name)

• SetVeteranDifficulty(bool isVeteranDifficulty)

• GetGroupUnitTagByIndex(luaindex sortIndex)
  • Returns: string:nilable unitTag

• JumpToFriend(string name)

Action Bar / Quick Slot

• IsSlotLocked(luaindex slotIndex)
  • Returns: bool locked

• GetActionBarPage(luaindex physicalPageId)
  • Returns: luaindex logicalPageId

• SetActionBarPage protected (luaindex physicalPageId, luaindex logicalPageId)

• ClearSlot protected (luaindex slotIndex)

• SelectSlotAbility protected (luaindex abilityIndex, luaindex slotIndex)

• SelectSlotItem protected (integer bagId, integer bagSlotId, luaindex slotIndex)

• GetCurrentQuickslot()
  • Returns: integer slotId

• SetCurrentQuickslot(integer slotId)

Mount

• GetMaxMountLevel()
  • Returns: integer maxLevel

• GetNumStableSlots()
  • Returns: integer stableSlots

• GetMaxStableSlots()
  • Returns: integer maxStableSlots

• BuyStableSlot()

• GetNextStableSlotCost()
  • Returns: integer cost

• CanBuyStableSlotUpgrade()
  • Returns: bool canBuy

• IsStableSlotEmpty(luaindex stableIndex)
  • Returns: bool empty

• SetActiveMount(luaindex stableIndex)

• SellMount(luaindex stableIndex)

• GetStableSlotInfo(luaindex stableIndex)
  • Returns: string name, textureName iconTexture, textureName portraitTexture, string breed, string description, integer sellPrice

• GetStableSlotMountStats(luaindex stableIndex)
  • Returns: integer level, integer inventoryBonus, integer maxInventoryBonus, integer staminaBonus, integer maxStaminaBonus, integer speedBonus, integer maxSpeedBonus

• GetTimeUntilMountCanBeFed(luaindex stableIndex)
  • Returns: integer:nilable timeMs, integer:nilable totalDurationMs

• GetNumMountFeedOptions()
  • Returns: integer numFeedOptions

• GetMountFeedOptionInfo(integer feedIndex)
  • Returns: string name, integer cost

• FeedMount(integer feedIndex)

• IsValidMountName(string mountName)
  • _Uses variable returns..._
  • Returns: integer violationCode

• RenameMount(luaindex stableIndex, string name)

• IsMounted()
  • Returns: bool mounted

• ToggleMount private ()

Quest Tracker

• CanUseQuestItem(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
  • Returns: bool canUse

• CanUseQuestTool(luaindex journalQuestIndex, luaindex toolIndex)
  • Returns: bool canUse

• IsJournalQuestInCurrentMapZone(luaindex questIndex)
  • Returns: bool isInCurrentZone

• DoesJournalQuestConditionHavePosition(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
  • Returns: bool hasPosition

• SetMapToQuestCondition(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
  • Returns: SetMapResultCode setMapResult

• SetMapToQuestZone(luaindex questIndex)
  • Returns: SetMapResultCode setMapResult

Item Enchanting

• IsItemEnchantable(integer bagId, integer slotIndex)
  • Returns: bool enchantable

• IsItemEnchantment(integer bagId, integer slotIndex)
  • Returns: bool enchantment

• CanItemTakeEnchantment(integer itemToEnchantBagId, integer itemToEnchantSlotIndex, integer enchantmentToUseBagId, integer enchantmentToUseSlotIndex)
  • Returns: bool canEnchant

• EnchantItem(integer itemToEnchantBagId, integer itemToEnchantSlotIndex, integer enchantmentToUseBagId, integer enchantmentToUseSlotIndex)

Imperial Style conversion

• CanConvertItemStyleToImperial(integer itemToBagId, integer itemToSlotIndex)
  • Returns: bool canConvert

• ConvertItemStyleToImperial(integer itemToBagId, integer itemToSlotIndex)

Soul Gem (Item Charging)

• IsItemChargeable(integer bagId, integer slotIndex)
  • Returns: bool rechargeable

• GetAmountSoulGemWouldChargeItem(integer itemToChargeBagId, integer itemToChargeSlotIndex, integer soulGemToConsumeBagId, integer soulGemToConsumeSlotIndex)
  • Returns: integer chargeAmount

• ChargeItemWithSoulGem(integer itemToChargeBagId, integer itemToChargeSlotIndex, integer soulGemToConsumeBagId, integer soulGemToConsumeSlotIndex)

• IsItemSoulGem(SoulGemType soulGemType, integer bagId, integer slotIndex)
  • Returns: bool isSoulGem

• GetChargeInfoForItem(integer bagId, integer slotIndex)
  • Returns: integer charges, integer maxCharges

• GetSoulGemItemInfo(integer bagId, integer slotIndex)
  • Returns: integer tier, SoulGemType soulGemType

• GetSoulGemInfo(SoulGemType soulGemType, integer targetLevel, bool onlyInInventory)
  • Returns: string name, textureName icon, integer stackCount

Repair/Durability

• DoesItemHaveDurability(integer bagId, integer slotIndex)
  • Returns: bool hasDurability

• GetItemCondition(integer bagId, integer slotIndex)
  • Returns: integer condition

• GetItemRepairCost(integer bagId, integer slotIndex)
  • Returns: integer repairCost

• GetRepairAllCost()
  • Returns: integer repairCost

• IsItemRepairKit(integer bagId, integer slotIndex)
  • Returns: bool isRepairKit

• GetRepairKitTier(integer bagId, integer slotIndex)
  • Returns: integer tier

• GetAmountRepairKitWouldRepairItem(integer itemToRepairBagId, integer itemToRepairSlotIndex, integer repairKitToConsumeBagId, integer repairKitToConsumeSlotIndex)
  • Returns: integer amountRepaired

• RepairItemWithRepairKit(integer itemToRepairBagId, integer itemToRepairSlotIndex, integer repairKitToConsumeBagId, integer repairKitToConsumeSlotIndex)

Weapon

• GetActiveWeaponPairInfo()
  • Returns: ActiveWeaponPair activeWeaponPair, bool locked

Item Information

• GetItemLevel(integer bagId, integer slotIndex)
  • Returns: integer level

• GetItemTrait(integer bagId, integer slotIndex)
  • Returns: ItemTraitType trait

• GetItemInfo(integer bagId, integer slotIndex)
  • Returns: textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, bool locked, integer equipType, integer itemStyle, integer quality

• GetItemCraftingInfo(integer bagId, integer slotIndex)
  • Returns: TradeskillType usedInCraftingType, ItemType itemType, integer:nilable extraInfo1, integer:nilable extraInfo2, integer:nilable extraInfo3

• GetItemType(integer bagId, integer slotIndex)
  • Returns: ItemType itemType

Junk

• HasAnyJunk(integer bagId)
  • Returns: bool hasJunk

• DestroyAllJunk()

• DoesBagHaveSpaceFor(Bag destinationBagId, Bag sourceBagId, integer sourceSlot)
  • Returns: bool hasSpace

• SetItemIsJunk(integer bagId, integer slotIndex, bool junk)

Bank

• GetBankedMoney()
  • Returns: integer money

• DepositMoneyIntoBank(integer money)

• WithdrawMoneyFromBank(integer money)

Guild Bank

• GetNextGuildBankSlotId(integer:nilable lastSlotId)
  • Returns: integer:nilable nextSlotId

• SelectGuildBank(integer guildId)

• TransferToGuildBank(integer sourceBag, integer sourceSlot)

• TransferFromGuildBank(integer slotId)

Trading House

• GetNumTradingHouseGuilds()
  • Returns: integer numGuilds

• GetTradingHouseGuildDetails(luaindex index)
  • Returns: integer guildId, string guildName, integer guildAlliance

• CanBuyFromTradingHouse(integer guildId)
  • Returns: bool canBuy

• CanSellOnTradingHouse(integer guildId)
  • Returns: bool canSell

• GetSelectedTradingHouseGuildId()
  • Returns: integer:nilable guildId

• SelectTradingHouseGuildId(integer guildId)
  • Returns: bool success

• GetTradingHouseListingCounts()
  • Returns: integer currentListingCount, integer maxListingCount

• GetTradingHousePostPriceInfo(integer desiredPostPrice)
  • Returns: integer listingFee, integer tradingHouseCut, integer expectedProfit

• GetTradingHouseListingPercentage()
  • Returns: number listingPercentage

• GetTradingHouseCutPercentage()
  • Returns: number cutPercentage

• SetPendingItemPost(Bag bag, integer slot, integer quantity)

• RequestPostItemOnTradingHouse(Bag bag, integer slot, integer quantity, number postingPrice)

• SetPendingItemPurchase(luaindex index)

• ClearPendingItemPurchase()

• ConfirmPendingItemPurchase()

• ClearAllTradingHouseSearchTerms()

• SetTradingHouseFilter(TradingHouseFilterType filterType, integer:nilable data1, integer:nilable data2, integer:nilable data3, integer:nilable data4, integer:nilable data5, integer:nilable data6, integer:nilable data7, integer:nilable data8)

• SetTradingHouseFilterRange(TradingHouseFilterType filterType, integer:nilable minOrExactValue, integer:nilable maxValue)

• ExecuteTradingHouseSearch(integer page, TradingHouseSortField sortField, bool sortAscending)

• GetTradingHouseSearchResultItemInfo(luaindex index)
  • Returns: textureName icon, string itemName, integer quality, integer stackCount, string sellerName, integer timeRemaining, integer purchasePrice

• RequestTradingHouseListings()

• GetNumTradingHouseListings()
  • Returns: integer numListings

• CancelTradingHouseListing(luaindex index)

• GetTradingHouseListingItemInfo(luaindex index)
  • Returns: textureName icon, string itemName, integer quality, integer stackCount, string sellerName, integer timeRemaining, integer purchasePrice

Map

• SetMapToPlayerLocation()
  • Returns: SetMapResultCode setMapResult

• SetMapToMapListIndex(luaindex index)
  • Returns: SetMapResultCode setMapResult

• GetCurrentMapIndex()
  • Returns: luaindex:nilable index

• GetCurrentMapZoneIndex()
  • Returns: luaindex zoneIndex

• GetNumMaps()
  • Returns: integer numMaps

• MapZoomOut()
  • Returns: SetMapResultCode setMapResult

• WouldProcessMapClick(number normalizedClickX, number normalizedClickY)
  • Returns: bool wouldProcess

• ProcessMapClick(number normalizedClickX, number normalizedClickY)
  • Returns: SetMapResultCode setMapResult

• GetMapInfo(luaindex index)
  • Returns: string name, UIMapType mapType, MapContentType mapContentType

• GetMapParentCategories(luaindex index)
  • _Uses variable returns..._
  • Returns: string categoryName, luaindex categoryIndex

• GetMapNumTiles()
  • Returns: integer numHorizontalTiles, integer numVerticalTiles

• GetMapTileTexture(luaindex tileIndex)
  • Returns: string tileFilename

• GetMapName()
  • Returns: string mapName

• GetMapType()
  • Returns: UIMapType mapType

• GetMapContentType()
  • Returns: MapContentType mapContentType

• GetNumMapLocations()
  • Returns: integer numMapLocations

• IsMapLocationVisible(luaindex locationIndex)
  • Returns: bool isVisible

• GetMapLocation(luaindex locationIndex)
  • _Uses variable returns..._
  • Returns: string locationName, integer fontSize, number colorR, number colorG, number colorB, number normalizedX, number normalizedZ

• GetMapLocationIcon(luaindex locationIndex)
  • Returns: string icon, number normalizedX, number normalizedZ

• GetNumMapLocationTooltipLines(luaindex locationIndex)
  • Returns: integer numLines

• IsMapLocationTooltipLineVisible(luaindex locationIndex, luaindex tooltipLineIndex)
  • Returns: bool isVisible

• GetMapLocationTooltipLineInfo(luaindex locationIndex, luaindex tooltipLineIndex)
  • Returns: textureName icon, string name, integer grouping

• GetMapLocationTooltipHeader(luaindex locationIndex)
  • Returns: string header

• GetMapMouseoverInfo(number normalizedMouseX, number normalizedMouseY)
  • Returns: string locationName, string textureFile, number textureWidthNormalized, number textureHeightNormalized, number textureXOffsetNormalized, number textureYOffsetNormalized

• GetNumMapKeySections()
  • Returns: integer numSections

• GetMapKeySectionName(luaindex sectionIndex)
  • Returns: string sectionName

• GetNumMapKeySectionSymbols(luaindex sectionIndex)
  • Returns: integer numSymbols

• GetMapKeySectionSymbolInfo(luaindex sectionIndex, luaindex symbolIndex)
  • Returns: string name, textureName icon, string tooltip

• GetMapFloorInfo()
  • Returns: luaindex currentFloor, integer numFloors

• SetMapFloor(luaindex desiredFloorIndex)
  • Returns: SetMapResultCode setMapResult

• GetNumPOIs(luaindex zoneIndex)
  • Returns: integer numPOIs

• GetPOIInfo(luaindex zoneIndex, luaindex poiIndex)
  • Returns: string objectiveName, integer objectiveLevel, string startDescription, string finishedDescription

• IsPOIWayshrine(luaindex zoneIndex, luaindex poiIndex)
  • Returns: bool isWayshrine

• IsPOIPublicDungeon(luaindex zoneIndex, luaindex poiIndex)
  • Returns: bool isPublicDungeon

• IsPOIGroupDungeon(luaindex zoneIndex, luaindex poiIndex)
  • Returns: bool isGroupDungeon

• GetPOIMapInfo(luaindex zoneIndex, luaindex poiIndex)
  • Returns: number normalizedX, number normalizedZ, MapDisplayPinType poiType, textureName icon

• GetCurrentSubZonePOIIndices()
  • Returns: luaindex:nilable zoneIndex, luaindex:nilable poiIndex

• GetPlayerDifficultyLevel()
  • Returns: PlayerDifficultyLevel difficultyLevel

• GetNumZonesForDifficultyLevel(PlayerDifficultyLevel difficultyLevel)
  • Returns: integer numZones

• GetCadwellZoneInfo(PlayerDifficultyLevel difficultyLevel, luaindex zoneIndex)
  • Returns: string zoneName, string zoneDescription, luaindex zoneOrder

• GetNumPOIsForDifficultyLevelAndZone(PlayerDifficultyLevel difficultyLevel, luaindex zoneIndex)
  • Returns: integer numPOIs

• GetCadwellZonePOIInfo(PlayerDifficultyLevel difficultyLevel, luaindex zoneIndex, luaindex poiIndex)
  • Returns: string poiName, string poiOpeningText, string poiClosingText, luaindex poiOrder, bool discovered, bool completed

• GetPlayerLocationName()
  • Returns: string mapName

• GetHistoricalKeepTravelNetworkLinkInfo(luaindex linkIndex, integer bgContext, number historyPercent)
  • Returns: integer linkType, integer linkOwner, integer restricedToAlliance, number startX, number startY, number endX, number endY

• GetHistoricalAvAObjectivePinInfo(integer keepId, integer objectiveId, integer battlegroundContext, number historyPercent)
  • Returns: integer pinType, number currentNormalizedX, number currentNormalizedY, bool continuousUpdate

• GetMapPlayerPosition(string unitTag)
  • Returns: number normalizedX, number normalizedZ, number heading

• GetMapPing(string unitTag)
  • Returns: number normalizedX, number normalizedY

• GetMapRallyPoint()
  • Returns: number normalizedX, number normalizedY

• GetMapPlayerWaypoint()
  • Returns: number normalizedX, number normalizedY

• GetNumKeepTravelNetworkNodes(BattlegroundQueryContextType bgContext)
  • Returns: integer numNodes

• GetNumKeepTravelNetworkLinks(BattlegroundQueryContextType bgContext)
  • Returns: integer numLinks

• GetKeepTravelNetworkNodeInfo(luaindex nodeIndex, BattlegroundQueryContextType bgContext)
  • Returns: integer keepId, bool accessible, number normalizedX, number normalizedY

• GetKeepTravelNetworkLinkInfo(luaindex linkIndex, BattlegroundQueryContextType bgContext)
  • Returns: integer linkType, integer linkOwner, integer restricedToAlliance, number startX, number startY, number endX, number endY

• GetKeepTravelNetworkLinkEndpoints(luaindex linkIndex, BattlegroundQueryContextType bgContext)
  • Returns: luaindex keepAIndex, luaindex keepBIndex

• GetKeepAccessible(integer keepId, BattlegroundQueryContextType bgContext)
  • Returns: bool accessible

• GetKeepHasResourcesForTravel(integer keepId, BattlegroundQueryContextType bgContext)
  • Returns: bool hasResources

• GetKeepFastTravelInteraction()
  • Returns: integer:nilable startKeepId

• TravelToKeep(integer destinationKeepId)

• GetNumFastTravelNodes()
  • Returns: integer numFastTravelNodes

• GetFastTravelNodeInfo(luaindex nodeIndex)
  • Returns: bool known, string name, number normalizedX, number normalizedY, textureName icon, textureName:nilable glowIcon, PointOfInterestType poiType

• FastTravelToNode(luaindex nodeIndex)

• GetRecallCooldown()
  • Returns: integer remain, integer duration

• GetRecallCost()
  • Returns: integer cost

Campaign

• IsInCampaign()
  • Returns: bool inCampaign

• DoesCampaignHaveEmperor(integer campaignId)
  • Returns: bool hasEmperor

• GetCampaignEmperorInfo(integer campaignId)
  • Returns: integer emperorAlliance, string emperorName

• GetCampaignEmperorReignDuration(integer campaignId)
  • Returns: integer durationInSeconds

• GetCampaignAbdicationStatus(integer campaignId)
  • Returns: integer abdicatedAlliance, string abdicatedName

• GetEmperorAllianceBonusInfo(integer campaignId, Alliance alliance)
  • Returns: string name, textureName icon

• GetCampaignReassignCooldown()
  • Returns: integer cooldownSeconds

• GetCampaignGuestCooldown()
  • Returns: integer cooldownSeconds

• GetCampaignReassignCost(CampaignReassignmentRequestType reassignType)
  • Returns: integer cost

• GetGuestCampaignId()
  • Returns: integer campaignId

• GetNumFreeAnytimeCampaignReassigns()
  • Returns: integer reassignCount

• GetNumFreeEndCampaignReassigns()
  • Returns: integer reassignCount

• GetPreferredCampaign()
  • Returns: integer preferredCampaign

• GetCampaignPreference()
  • Returns: CampaignPreferenceType campaignPreference

• SetCampaignPreference(CampaignPreferenceType campaignPreference)

• AssignCampaignToPlayer(integer campaignId, CampaignReassignmentRequestType reassignOnEnd)

• QueryCampaignSelectionData()

• GetCampaignSequenceId(integer campaignId)
  • Returns: integer sequenceId

• QueryCampaignLeaderboardData()

• GetLeaderboardCampaignSequenceId(integer campaignId)
  • Returns: integer campaignSequenceId

• GetCampaignLeaderboardMaxRank(integer campaignId)
  • Returns: integer maxRank

• GetNumCampaignLeaderboardEntries(integer campaignId)
  • Returns: integer entryCount

• GetNumCampaignClassLeaderboardEntries(integer campaignId, integer classId)
  • Returns: integer entryCount

• GetNumCampaignAllianceLeaderboardEntries(integer campaignId, integer allianceId)
  • Returns: integer entryCount

• GetCampaignLeaderboardEntryInfo(integer campaignId, luaindex entryIndex)
  • Returns: bool isPlayer, integer ranking, string charName, integer alliancePoints, integer classId, integer allianceId

• GetCampaignClassLeaderboardEntryInfo(integer campaignId, integer classId, luaindex entryIndex)
  • Returns: bool isPlayer, integer ranking, string charName, integer alliancePoints, integer allianceId

• GetCampaignAllianceLeaderboardEntryInfo(integer campaignId, integer allianceId, luaindex entryIndex)
  • Returns: bool isPlayer, integer ranking, string charName, integer alliancePoints, integer classId

• GetPlayerCampaignRewardTierInfo(integer campaignId)
  • Returns: integer earnedTier, integer nextTierProgress, integer nextTierTotal

• GetNumSelectionCampaigns()
  • Returns: integer campaignCount

• GetSelectionCampaignAllianceScore(luaindex campaignIndex, integer alliance)
  • Returns: integer score

• GetSelectionCampaignId(luaindex campaignIndex)
  • Returns: integer campaignId

• GetSelectionCampaignTimes(luaindex campaignIndex)
  • Returns: integer secondsUntilCampaignStart, integer secondsUntilCampaignEnd

• GetSelectionCampaignUnderdogLeaderAlliance(luaindex campaignIndex)
  • Returns: integer alliance

• GetNumSelectionCampaignFriends(luaindex campaignIndex)
  • Returns: integer numFriends

• GetNumSelectionCampaignGuildMembers(luaindex campaignIndex)
  • Returns: integer numGuilds

• GetNumSelectionCampaignGroupMembers(luaindex campaignIndex)
  • Returns: integer numGroupmates

• GetSelectionCampaignPopulationData(luaindex campaignIndex, integer alliance)
  • Returns: CampaignPopulationType currentPopulationEstimate

• DoesPlayerMeetCampaignRequirements(integer campaignId)
  • Returns: bool meetsJoiningRequirements

• GetCampaignRulesetId(integer campaignId)
  • Returns: integer rulesetId

• GetCampaignRulesetName(integer campaignId)
  • Returns: string name

• GetCampaignRulesetType(integer rulesetId)
  • Returns: CampaignRulesetType rulesetType

• GetCampaignRulesetDescription(integer rulesetId)
  • Returns: string description

• GetNumCampaignSocialConnections()
  • Returns: integer connectionCount

• GetCurrentCampaignLoyaltyStreak()
  • Returns: integer currentLoyaltyStreak

• GetCampaignRulesetNumImperialKeeps(integer rulesetId, Alliance alliance)
  • Returns: integer numKeeps

• GetCampaignRulesetImperialKeepId(integer rulesetId, Alliance alliance, luaindex index)
  • Returns: integer keepId

• GetCampaignRulsetMinEmperorAlliancePoints(integer rulesetId, Alliance alliance)
  • Returns: integer minPoints

• RegisterForAssignedCampaignData()

• UnregisterForAssignedCampaignData()

• ResetCampaignHistoryWindow(integer battlegroundContext, number currentHistoryPercent)
  • Returns: bool requiresRebuild

• GetCampaignHistoryWindow(integer battlegroundContext)
  • Returns: integer windowStartSecsAgo, integer windowEndSecsAgo

• DoesHistoryRequireMapRebuild(integer battlegroundContext, number oldHistoryPercent, number newHistoryPercent)
  • Returns: bool needsRebuild

• QueueForCampaign(integer campaignId, bool queueAsGroup)

• LeaveCampaignQueue(integer campaignId, bool queueAsGroup)

• GetNumCampaignQueueEntries()
  • Returns: integer entryCount

• IsQueuedForCampaign(integer campaignId, bool queueAsGroup)
  • Returns: bool isQueued

• GetCampaignQueueEntry(luaindex entryIndex)
  • Returns: integer campaignId, bool queueAsGroup

• GetSecondsInCampaignQueue(integer campaignId, bool queueAsGroup)
  • Returns: integer timeInQueueInSeconds

• GetCampaignQueuePosition(integer campaignId, bool queueAsGroup)
  • Returns: integer queuePosition

• GetCampaignQueueRemainingConfirmationSeconds(integer campaignId, bool queueAsGroup)
  • Returns: integer confirmationTimeRemainingInSeconds

• GetCampaignQueueState(integer campaignId, bool queueAsGroup)
  • Returns: CampaignQueueRequestStateType currentState

• ConfirmCampaignEntry(integer campaignId, bool queueAsGroup, bool accept)

• GetCampaignQueueConfirmationDuration()
  • Returns: integer numSeconds

Store (Buy/Sell)

• GetStoreEntryInfo(luaindex entryIndex)
  • Returns: textureName icon, string name, integer stack, integer price, integer sellPrice, bool meetsRequirementsToBuy, bool meetsRequirementsToUse, integer quality, bool questNameColor, integer currencyType1, integer currencyId1, integer currencyQuantity1, textureName currencyIcon1, string currencyName1, integer currencyType2, integer currencyId2, integer currencyQuantity2, textureName currencyIcon2, string currencyName2

• GetNumStoreItems()
  • Returns: integer numItems

• GetNumBuybackItems()
  • Returns: integer numBuybackItems

• GetStoreCurrencyTypes()
  • Returns: bool usesMoney, bool usesAlliancePoints, bool usesBattleTokens, bool usesItems

• GetStoreItemLink(luaindex entryIndex, LinkStyle linkStyle)
  • Returns: string link

• GetStoreEntryTypeInfo(luaindex entryIndex)
  • _Uses variable returns..._
  • Returns: integer itemType

• GetStoreEntryStatValue(luaindex entryIndex)
  • Returns: integer statValue

• GetStoreEntryMaxBuyable(luaindex entryIndex)
  • Returns: integer quantity

• GetBuybackItemInfo(luaindex entryIndex)
  • Returns: textureName icon, string name, integer stack, integer price, integer quality, bool meetsRequirementsToEquip

• GetBuybackItemLink(luaindex entryIndex, LinkStyle linkStyle)
  • Returns: string link

• BuyStoreItem(luaindex entryIndex, integer quantity)

• BuybackItem(luaindex entryIndex)

• GetItemCurrencyQuantity(integer itemCurrencyId)
  • Returns: integer quantity

• SellInventoryItem(Bag bagId, integer slotIndex, integer quantity)

• SellAllJunk()

• CloseStore()

Repair

• RepairAll()

• RepairItem(Bag bagId, integer slotIndex)

Loot

• LootAll()

• GetLootItemLink(integer lootId, LinkStyle linkStyle)
  • Returns: string link

• LootItemById(integer lootId)

• LootMoney()

• EndLooting()

• GetLootTargetInfo()
  • Returns: string name, InteractTargetType targetType, string actionName

• GetLootItemInfo(luaindex lootIndex)
  • Returns: integer lootId for current game session, string name, textureName icon, integer count, integer quality, integer value, bool isQuest

• GetLootMoney()
  • Returns: integer totalMoney

• GetKeepResourceType(integer keepId)
  • Returns: KeepResourceType resourceType

Guild Keep Claim

• GetSecondsUntilKeepClaimAvailable(integer keepId, BattlegroundQueryContextType battlegroundContext)
  • Returns: integer secondsUntilAvailable

• GetGuildClaimInteractionKeepId()
  • Returns: integer keepId

• GetGuildReleaseInteractionKeepId()
  • Returns: integer keepId

• CancelKeepGuildClaimInteraction()

• CancelKeepGuildReleaseInteraction()

Historical Keep

• GetHistoricalKeepUnderAttack(integer keepId, integer battlegroundContext, number historyPercent)
  • Returns: bool underAttack

• GetHistoricalKeepPinInfo(integer keepId, integer battlegroundContext, number historyPercent)
  • Returns: integer pinType, number normalizedX, number normalizedY

• GetHistoricalKeepAlliance(integer keepId, integer battlegroundContext, number historyPercent)
  • Returns: integer alliance

Title

• GetNumTitles()
  • Returns: integer titleCount

• GetTitle(luaindex titleIndex)
  • Returns: string titleString

• GetCurrentTitleIndex()
  • Returns: luaindex:nilable titleIndex

• SelectTitle(luaindex:nilable titleIndex)

Resurrection/Reviving

• AcceptResurrect()

• DeclineResurrect()

• IsResurrectPending()
  • Returns: bool resurrectPending

• GetPendingResurrectInfo()
  • Returns: string casterName, integer timeLeft

• GetDeathInfo()
  • Returns: integer timeUntilRevive, integer timeUntilAutoRelease, integer respawnQueueOrCorpseSummonTime, bool isPenaltyTooHighToRevive, bool encounterIsInProgress, bool isAVADeath, bool isBattleGroundDeath, bool isReleaseOnly, bool soulGemAvailable, bool freeRevive

• GetReviveSoulGemInfo(bool includeOnlyInInventory)
  • Returns: string name, ItemQuality quality

• Revive()

• Release()

• JoinRespawnQueue()

• RespawnAtKeep(integer keepId)

• IsFriendlyForwardCampAvailable()
  • Returns: bool available

• RespawnAtForwardCamp(luaindex index)

• GetNumForwardCamps(integer battlegroundContext)
  • Returns: integer num

• GetForwardCampPinInfo(integer battlegroundContext, luaindex index)
  • Returns: integer pinType, number normalizedX, number normalizedY, number normalizedRadius

Trade

• TradeInvite(string target)

• TradeInviteByName(string playerName)

• TradeInviteAccept()

• TradeInviteDecline()

• GetTradeInviteInfo()
  • Returns: string name, integer millisecondsSinceRequest

• TradeSetMoney(integer amount)

• TradeInviteCancel()

• TradeCancel()

• TradeAccept()

• TradeEdit()

• TradeAddItem(Bag bagId, integer itemIndex, luaindex:nilable tradeIndex)

• TradeRemoveItem(luaindex tradeIndex)

• GetTradeItemInfo(TradeParticipant who, luaindex tradeIndex)
  • Returns: string name, textureName icon, integer stack, integer quality

• GetTradeItemBagAndSlot(TradeParticipant who, luaindex tradeIndex)
  • Returns: Bag bagId, integer slotIndex

• GetTradeItemLink(TradeParticipant who, luaindex tradeIndex, LinkStyle linkStyle)
  • Returns: string link

Skills

• GetAvailableSkillPoints()
  • Returns: integer numPoints

• GetNumSkyShards()
  • Returns: integer numShards

• GetNumSkillTypes()
  • Returns: integer numSkillTypes

• GetNumSkillLines(SkillType skillType)
  • Returns: integer numSkillLines

• GetSkillLineInfo(SkillType skillType, luaindex skillIndex)
  • Returns: string name, luaindex rank

• GetSkillLineXPInfo(SkillType skillType, luaindex skillIndex)
  • Returns: integer lastRankXp, integer nextRankXP, integer currentXP

• GetNumSkillAbilities(SkillType skillType, luaindex skillIndex)
  • Returns: integer numAbilities

• GetSkillAbilityInfo(SkillType skillType, luaindex skillIndex, luaindex abilityIndex)
  • Returns: string name, textureName texture, luaindex earnedRank, bool passive, bool ultimate, bool purchased, luaindex:nilable progressionIndex

• GetSkillAbilityUpgradeInfo(SkillType skillType, luaindex skillIndex, luaindex abilityIndex)
  • Returns: integer:nilable currentUpgradeLevel, integer:nilable maxUpgradeLevel

• GetSkillAbilityNextUpgradeInfo(SkillType skillType, luaindex skillIndex, luaindex abilityIndex)
  • Returns: string name, textureName texture, luaindex:nilable earnedRank

• GetCraftingSkillLineIndices(TradeskillType craftingSkillType)
  • Returns: SkillType skillType, luaindex skillIndex

• PutPointIntoSkillAbility(SkillType skillType, luaindex skillIndex, luaindex index, bool putPointInNextUpgrade)

Mail

• GetMaxMailItems()
  • Returns: integer maxMail

• IsLocalMailboxFull()
  • Returns: bool isFull

• GetNumMailItems()
  • Returns: integer numMail

• GetNextMailId(id64:nilable lastMailId)
  • Returns: id64:nilable nextMailId

• GetMailItemInfo(id64 mailId)
  • Returns: string senderDisplayName, string senderCharacterName, string subject, textureName icon, bool unread, bool fromSystem, bool fromCustomerService, bool returned, integer numAttachments, integer attachedMoney, integer codAmount, integer expiresInDays, integer secsSinceReceived

• SendMail(string to, string subject, string body)

• GetQueuedMailPostage()
  • Returns: integer postage

• ClearQueuedMail()

• CloseMailbox()

• RequestReadMail(id64 mailId)

• DeleteMail(id64 mailId, bool forceDelete)

• IsMailReturnable(id64 mailId)
  • Returns: bool isReturnable

• ReturnMail(id64 mailId)

• ReadMail(id64 mailId)
  • Returns: string body

• HasUnreadMail()
  • Returns: bool unread

• GetNumUnreadMail()
  • Returns: integer numUnread

• CanQueueItemAttachment(Bag bagId, integer itemIndex, luaindex attachmentSlot)
  • Returns: bool canAttach

• QueueItemAttachment(integer bagId, integer itemIndex, luaindex attachmentSlot)
  • Returns: integer itemAttachmentResult

• RemoveQueuedItemAttachment(luaindex attachmentSlot)

• QueueMoneyAttachment(integer amount)

• GetQueuedMoneyAttachment()
  • Returns: integer amount

• QueueCOD(integer amount)

• GetQueuedCOD()
  • Returns: integer amount

• GetMailQueuedAttachmentLink(luaindex attachmentSlot, LinkStyle linkStyle)
  • Returns: string link

• GetQueuedItemAttachmentInfo(luaindex attachmentSlot)
  • Returns: integer bagId, integer itemIndex, textureName icon, integer stack

• GetAttachedItemLink(id64 mailId, luaindex attachIndex, LinkStyle linkStyle)
  • Returns: string link

• GetAttachedItemInfo(id64 mailId, luaindex attachIndex)
  • Returns: textureName icon, integer stack, string creatorName

• TakeMailAttachedItems(id64 mailId)

• TakeMailAttachedMoney(id64 mailId)

• RequestOpenMailbox()

Achievements

• GetNumAchievementCategories()
  • Returns: integer numCategories

• GetAchievementCategoryInfo(luaindex topLevelIndex)
  • Returns: string name, integer numSubCatgories, integer numAchievements, integer earnedPoints, integer totalPoints, bool hidesPoints, textureName normalIcon, textureName pressedIcon, textureName mouseoverIcon

• GetAchievementSubCategoryInfo(luaindex topLevelIndex, luaindex subCategoryIndex)
  • Returns: string name, integer numAchievements, integer earnedPoints, integer totalPoints, bool hidesPoints

• GetEarnedAchievementPoints()
  • Returns: integer points

• GetTotalAchievementPoints()
  • Returns: integer points

• GetAchievementId(luaindex topLevelIndex, luaindex:nilable categoryIndex, luaindex achievementIndex)
  • Returns: integer achievementId

• GetAchievementInfo(integer achievementId)
  • Returns: string name, string description, integer points, textureName icon, bool completed, string date, string time

• GetAchievementNumRewards(integer achievementId)
  • Returns: integer numRewards

• GetAchievementItemLink(integer achievementId, luaindex rewardIndex, LinkStyle linkStyle)
  • Returns: string link

• GetAchievementNumCriteria(integer achievementId)
  • Returns: integer numCriteria

• GetAchievementCriterion(integer achievementId, luaindex criterionIndex)
  • Returns: string description, integer numCompleted, integer numRequired

• GetRecentlyCompletedAchievements(integer numAchievementsToGet)
  • _Uses variable returns..._
  • Returns: integer achievementId

• GetCategoryInfoFromAchievementId(integer achievementId)
  • Returns: luaindex topLevelIndex, luaindex:nilable categoryIndex, luaindex achievementIndex

• GetNextAchievementInLine(integer achievementId)
  • Returns: integer nextAchievementId

• GetPreviousAchievementInLine(integer achievementId)
  • Returns: integer previousAchievementId

• GetAchievementLink(integer achievementId, LinkStyle linkStyle)
  • Returns: string link

• GetAchievementProgressFromLinkData(integer achievementId, string progress)
  • _Uses variable returns..._
  • Returns: integer numCompleted

Lore

• GetNumLoreCategories()
  • Returns: integer numTopCategories

• GetLoreCategoryInfo(luaindex categoryIndex)
  • Returns: string name, integer numCollections

• GetLoreCollectionInfo(luaindex categoryIndex, luaindex collectionIndex)
  • Returns: string name, string description, integer numKnownBooks, integer totalBooks, bool hidden

• GetLoreBookInfo(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)
  • Returns: string title, textureName icon, bool known

• ReadLoreBook(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)
  • Returns: string body, BookMedium medium, bool showTitle

• GetLoreBookLink(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex, LinkStyle linkStyle)
  • Returns: string link

• GetGameCameraNonInteractableName()
  • Returns: string:nilable name

Mara

• GetPledgeOfMaraOfferInfo()
  • Returns: string targetName, integer millisecondsSinceRequest

• SendPledgeOfMaraResponse(PledgeOfMaraResponse response)

• GetRingOfMaraExperienceBonus()
  • Returns: number bonusPercentage

Tutorial

• GetNumTutorials()
  • Returns: integer numTutorials

• GetTutorialType(luaindex tutorialIndex)
  • Returns: TutorialType:nilable tutorialType

• GetTutorialInfo(luaindex tutorialIndex)
  • Returns: string title, string description, integer displayPriority

• GetTutorialLinkedHelpInfo(luaindex tutorialIndex)
  • Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

• TriggerTutorial(TutorialTrigger triggerType)

• ResetAllTutorials()

• SetTutorialSeen(luaindex tutorialIndex)

Help

• GetHelpCategoryInfo(luaindex helpCategoryIndex)
  • Returns: string name, string description, textureName upIcon, textureName downIcon, textureName overIcon

• GetNumHelpCategories()
  • Returns: integer numHelpCategories

• GetNumHelpEntriesWithinCategory(luaindex helpCategoryIndex)
  • Returns: integer numHelpEntries

• GetHelpInfo(luaindex helpCategoryIndex, luaindex helpIndex)
  • Returns: string name, string description, string description2, textureName:nilable image

• GetHelpSearchResults()
  • _Uses variable returns..._
  • Returns: luaindex helpCategoryIndex, luaindex helpIndex

• StartHelpSearch(string searchString)

Crafting Global

• GetCraftingInteractionType()
  • Returns: TradeskillType currentCraftingInteraction

• IsPerformingCraftProcess()
  • Returns: bool isCrafting

Last Crafting

• GetLastCraftingResultTotalInspiration()
  • Returns: integer totalInspiration

• GetNumLastCraftingResultLearnedTranslations()
  • Returns: integer numLearnedTranslations

• GetLastCraftingResultLearnedTranslationInfo(luaindex resultIndex)
  • Returns: string translationName, string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, integer equipType, integer itemStyle, integer quality

• GetNumLastCraftingResultLearnedTraits()
  • Returns: integer numLearnedTraits

• GetLastCraftingResultLearnedTraitInfo(luaindex resultIndex)
  • Returns: string traitName, string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, integer equipType, integer itemStyle, integer quality

• GetNumLastCraftingResultItems()
  • Returns: integer numItems

• GetLastCraftingResultItemInfo(luaindex resultIndex)
  • Returns: string name, textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, integer equipType, ItemType itemType, integer itemStyle, integer quality, ItemUISoundCategory soundCategory, integer itemInstanceId

Alchemy

• GetCostToCraftAlchemyItem(integer solventBagId, integer solventSlotIndex)
  • Returns: integer cost

• CraftAlchemyItem(integer solventBagId, integer solventSlotIndex, integer reagent1BagId, integer reagent1SlotIndex, integer reagent2BagId, integer reagent2SlotIndex, integer:nilable reagent3BagId, integer:nilable reagent3SlotIndex)

• GetAlchemyResultingItemInfo(integer solventBagId, integer solventSlotIndex, integer reagent1BagId, integer reagent1SlotIndex, integer reagent2BagId, integer reagent2SlotIndex, integer:nilable reagent3BagId, integer:nilable reagent3SlotIndex)
  • Returns: string name, textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, integer equipType, integer itemStyle, integer quality

• GetAlchemyResultingItemLink(integer solventBagId, integer solventSlotIndex, integer reagent1BagId, integer reagent1SlotIndex, integer reagent2BagId, integer reagent2SlotIndex, integer:nilable reagent3BagId, integer:nilable reagent3SlotIndex, LinkStyle linkStyle)
  • Returns: string link

• GetAlchemyResultInspiration(integer solventBagId, integer solventSlotIndex, integer reagent1BagId, integer reagent1SlotIndex, integer reagent2BagId, integer reagent2SlotIndex, integer:nilable reagent3BagId, integer:nilable reagent3SlotIndex)
  • Returns: integer inspiration

• GetAlchemyItemTraits(integer reagentBagId, integer reagentSlotIndex)
  • _Uses variable returns..._
  • Returns: string:nilable trait, textureName:nilable icon, textureName:nilable matchIcon

Recipe

• GetNumRecipeLists()
  • Returns: integer numRecipeLists

• GetRecipeListInfo(luaindex recipeListIndex)
  • Returns: string name, integer numRecipes, textureName upIcon, textureName downIcon, textureName overIcon, textureName disabledIcon, string createSound

• GetRecipeInfo(luaindex recipeListIndex, luaindex recipeIndex)
  • Returns: bool known, string name, integer numIngredients, integer provisionerLevelReq, integer qualityReq, ProvisionerSpecialIngredientType specialIngredientType

• GetRecipeIngredientItemInfo(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex)
  • Returns: string name, textureName icon, integer requiredQuantity, integer sellPrice, integer quality

• GetRecipeIngredientItemLink(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex, LinkStyle linkStyle)
  • Returns: string link

• GetRecipeResultItemInfo(luaindex recipeListIndex, luaindex recipeIndex)
  • Returns: string name, textureName icon, integer stack, integer sellPrice, integer quality

• GetRecipeResultItemLink(luaindex recipeListIndex, luaindex recipeIndex, LinkStyle linkStyle)
  • Returns: string link

• GetCurrentRecipeIngredientCount(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex)
  • Returns: integer count

Provisioner

• GetCostToCraftProvisionerItem(luaindex recipeListIndex, luaindex recipeIndex)
  • Returns: integer cost

• CraftProvisionerItem(luaindex recipeListIndex, luaindex recipeIndex)

Enchanting

• GetCostToCraftEnchantingItem(integer potencyRuneBagId, integer potencyRuneSlotIndex, integer essenceRuneBagId, integer essenceRuneSlotIndex, integer aspectRuneBagId, integer aspectRuneSlotIndex)
  • Returns: integer cost

• CraftEnchantingItem(integer potencyRuneBagId, integer potencyRuneSlotIndex, integer essenceRuneBagId, integer essenceRuneSlotIndex, integer aspectRuneBagId, integer aspectRuneSlotIndex)

• ExtractEnchantingItem(integer bagId, integer slotIndex)

• GetEnchantingResultingItemInfo(integer potencyRuneBagId, integer potencyRuneSlotIndex, integer essenceRuneBagId, integer essenceRuneSlotIndex, integer aspectRuneBagId, integer aspectRuneSlotIndex)
  • Returns: string name, textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, integer quality

• GetEnchantingResultingItemLink(integer potencyRuneBagId, integer potencyRuneSlotIndex, integer essenceRuneBagId, integer essenceRuneSlotIndex, integer aspectRuneBagId, integer aspectRuneSlotIndex, LinkStyle linkStyle)
  • Returns: string link

• GetRunestoneTranslatedName(integer bagId, integer slotIndex)
  • Returns: string:nilable name

• GetRunestoneSoundInfo(integer bagId, integer slotIndex)
  • Returns: string soundName, integer soundLength

Smithing

• GetCostToCraftSmithingItem(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, luaindex styleIndex, luaindex traitIndex)
  • Returns: integer cost

• CraftSmithingItem(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, luaindex styleIndex, luaindex traitIndex)

• GetSmithingPatternResultLink(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, luaindex styleIndex, luaindex traitIndex, LinkStyle linkStyle)
  • Returns: string link

• CanSmithingWeaponPatternsBeCraftedHere()
  • Returns: bool canBeCrafted

• CanSmithingApparelPatternsBeCraftedHere()
  • Returns: bool canBeCrafted

• CanSmithingSetPatternsBeCraftedHere()
  • Returns: bool canBeCrafted

• GetNumSmithingPatterns()
  • Returns: integer smithingPatterns

• GetSmithingPatternInfo(luaindex patternIndex, luaindex:nilable materialIndexOverride, integer:nilable materialQuanityOverride, ItemStyle:nilable styleOverride, ItemTraitType:nilable traitTypeOverride)
  • Returns: string patternName, string baseName, textureName icon, integer numMaterials, integer numTraitsRequired, integer numTraitsKnown, ItemFilterType resultItemFilterType

• GetSmithingPatternMaterialItemInfo(luaindex patternIndex, luaindex materialIndex)
  • Returns: string itemName, textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, integer equipType, integer itemStyle, integer quality, integer itemInstanceId, integer skillRequirement

• GetSmithingPatternMaterialItemLink(luaindex patternIndex, luaindex materialIndex, LinkStyle linkStyle)
  • Returns: string link

• GetCurrentSmithingMaterialItemCount(luaindex patternIndex, luaindex materialIndex)
  • Returns: integer count

• GetNumSmithingStyleItems()
  • Returns: integer numStyleItems

• GetSmithingStyleItemInfo(luaindex styleItemIndex)
  • Returns: string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, integer itemStyle, integer quality

• GetSmithingStyleItemLink(luaindex styleItemIndex, LinkStyle linkStyle)
  • Returns: string link

• GetCurrentSmithingStyleItemCount(luaindex styleItemIndex)
  • Returns: integer count

• IsSmithingStyleKnown(luaindex styleItemIndex)
  • Returns: bool known

• CanSmithingStyleBeUsedOnPattern(luaindex styleIndex, luaindex patternIndex, luaindex materialIndex, integer materialQuantity)
  • Returns: bool canBeUsed, integer levelRequirement, integer veteranLevelRequirement

• GetNumSmithingTraitItems()
  • Returns: integer numTraitItems

• GetSmithingTraitItemInfo(luaindex traitItemIndex)
  • Returns: ItemTraitType:nilable traitType, string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, integer itemStyle, integer quality

• GetSmithingTraitItemLink(luaindex traitItemIndex, LinkStyle linkStyle)
  • Returns: string link

• GetCurrentSmithingTraitItemCount(luaindex traitItemIndex)
  • Returns: integer count

• IsSmithingTraitItemValidForPattern(luaindex patternIndex, luaindex traitItemIndex)
  • Returns: bool valid

• IsSmithingTraitKnownForResult(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, luaindex styleIndex, luaindex traitIndex)
  • Returns: bool known

• GetNumSmithingResearchLines(TradeskillType craftingSkillType)
  • Returns: integer numLines

• GetMaxSimultaneousSmithingResearch(TradeskillType craftingSkillType)
  • Returns: integer maxSimultaneousResearch

• GetSmithingResearchLineInfo(TradeskillType craftingSkillType, luaindex researchLineIndex)
  • Returns: string name, textureName icon, integer numTraits, integer timeRequiredForNextResearchSecs

• GetSmithingResearchLineTraitInfo(TradeskillType craftingSkillType, luaindex researchLineIndex, luaindex traitIndex)
  • Returns: ItemTraitType traitType, string traitDescription, bool known

• GetSmithingResearchLineTraitTimes(TradeskillType craftingSkillType, luaindex researchLineIndex, luaindex traitIndex)
  • Returns: integer:nilable duration, integer:nilable timeRemainingSecs

• CanItemBeSmithingTraitResearched(integer bagId, integer slotIndex, TradeskillType craftingSkillType, luaindex researchLineIndex, luaindex traitIndex)
  • Returns: bool canBeResearched

• ResearchSmithingTrait(integer bagId, integer slotIndex)

• CanItemBeSmithingExtractedOrRefined(integer bagId, integer slotIndex, TradeskillType craftingSkillType)
  • Returns: bool canItemBeExtractedOrRefined

• GetRequiredSmithingRefinementStackSize()
  • Returns: integer requiredStackSize

• ExtractOrRefineSmithingItem(integer bagId, integer slotIndex)

• CanItemBeSmithingImproved(integer bagId, integer slotIndex, TradeskillType craftingSkillType)
  • Returns: bool canBeImproved

• GetSmithingImprovementChance(integer itemToImproveBagId, integer itemToImproveSlotIndex, integer numBoostersToUse, TradeskillType craftingSkillType)
  • Returns: number chance

• GetNumSmithingImprovementItems()
  • Returns: integer numImprovementItems

• GetSmithingImprovementItemInfo(TradeskillType craftingSkillType, luaindex improvementItemIndex)
  • Returns: string itemName, textureName icon, integer currentStack, integer sellPrice, bool meetsUsageRequirement, integer equipType, integer itemStyle, integer quality

• GetSmithingImprovementItemLink(TradeskillType craftingSkillType, luaindex improvementItemIndex, LinkStyle linkStyle)
  • Returns: string link

• GetSmithingImprovedItemInfo(integer itemToImproveBagId, integer itemToImproveSlotIndex, TradeskillType craftingSkillType)
  • Returns: string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, integer equipType, integer itemStyle, integer quality

• GetSmithingImprovedItemLink(integer itemToImproveBagId, integer itemToImproveSlotIndex, TradeskillType craftingSkillType, LinkStyle linkStyle)
  • Returns: string link

• ImproveSmithingItem(integer itemToImproveBagId, integer itemToImproveSlotIndex, integer numBoostersToUse)

• GetNonCombatBonus(NonCombatBonusType nonCombatBonus)
  • Returns: integer bonusValue

LFG

• GetNumLFGOptions(LFGActivity activity)
  • Returns: integer count

• GetLFGOption(LFGActivity activity, luaindex index)
  • Returns: integer id, string name, integer levelMin, integer levelMax, integer veteranRankMin, integer veteranRankMax, bool largeGroupsAllowed, bool passedReqs

• GetLFGDisplayLevels(LFGActivity activity, luaindex index)
  • Returns: integer displayLevelMin, integer displayLevelMax, integer displayVeteranRankMin, integer displayVeteranRankMax

• UpdatePlayerRole(LFGRole activity, bool selected)

• GetPlayerRoles()
  • Returns: bool isDPS, bool isHeal, bool isTank

• StartLFGSearch(LFGActivity activity, luaindex index, bool largeGroup)

• StartLFMSearch(LFGActivity activity, luaindex index, bool largeGroup, integer numDpsOnly, integer numTankOnly, integer numHealerOnly, integer numDpsTank, integer numDpsHealer, integer numTankHealer, integer numAnyRole)

• CancelGroupSearches()

• IsCurrentlySearchingForGroup()
  • Returns: bool isSearching

Fishing

• GetNumFishingLures()
  • Returns: integer numLures

• GetFishingLureInfo(luaindex lureIndex)
  • Returns: string name, textureName icon, integer stack, integer sellPrice, ItemQuality quality

• SetFishingLure(luaindex lureIndex)

• GetFishingLure()
  • Returns: luaindex:nilable lureIndex

Treasure

• GetNumViewableTreasureMaps()
  • Returns: integer numViewableMaps

• GetTreasureMapInfo(luaindex treasureMapIndex)
  • Returns: string name, textureName imagePath

Marker

• SetFloatingMarkerInfo(MapDisplayPinType markerType, number size, string primaryTexturePath, string secondaryTexturePath, bool primaryPulses, bool secondaryPulses)

• SetFloatingMarkerGlobalAlpha(number alpha)

Agent

• GetAgentChatRequestInfo()
  • Returns: bool isChatRequested, integer millisecondsSinceRequest

• IsAgentChatActive()
  • Returns: bool isActive

• AcceptAgentChat()

• DeclineAgentChat()