Talk:API

From ESOUI Wiki

Jump to: navigation, search

Contents

These were distributed as docs in early beta days. Someone care to sort these into the proper page?

Config

 * 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 protected  (integer system, integer settingId, string value, integer setOptions)
 * ApplySettings protected  ()
 * ResetSettingToDefault protected  (integer system, integer settingId)
 * ResetToDefaultSettings protected  (integer system)
 * RefreshSettings protected  ()
 * IsPrivateFunction (string functionName)
   * Returns: bool isPrivate

GUI

 * SetGuiHidden (string guiName, bool hidden)
 * GetGuiHidden (string guiName)
   * Returns: bool hidden
 * ToggleFullScreen ()
 * GetInterfaceColor (integer interfaceColorType, integer fieldValue)
   * Returns: number red, number green, number blue, number alpha
 * GetFramerate ()
   * Returns: number currentFramerate
 * GetDisplayModes ()
   * Uses variable returns...
   * Returns: integer width, integer height
 * IsMinSpecMachine ()
   * Returns: bool minspec
 * SetGameCameraUIMode (bool active)
 * IsGameCameraUIModeActive ()
   * Returns: bool active
 * LockCameraRotation (bool locked)
 * IsGameCameraActive ()
   * Returns: bool isActive
 * IsInteractionCameraActive ()
   * Returns: bool isActive
 * GameCameraInteractStart ()
 * GetGameCameraMinCameraDistance ()
   * Returns: number minCameraDistance
 * GetGameCameraMaxCameraDistance ()
   * Returns: number maxCameraDistance
 * ToggleGameCameraPadlockTarget ()
 * IsGameCameraPadlockedTarget ()
   * Returns: bool isPadlocked
 * IsGameCameraTargetInMeleeRange ()
   * Returns: bool inMeleeRange
 * IsGameCameraTargetOutOfRange ()
   * Returns: bool outOfRange
 * IsGameCameraUnitHightlightedValid ()
   * Returns: bool valid
 * 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 ()
 * IsGameCameraSiegeControlled ()
   * Returns: bool valid
 * ReleaseGameCameraSiegeControlled ()
 * IsReticleHidden ()
   * Returns: bool isHidden
 * ToggleShowIngameGui ()
 * ReloadUI (string guiName)

Time

 * 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
 * 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

Strings

 * 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
 * Id64ToString (id64 id)
   * Returns: string stringDesc
 * ComputeStringDistance (string source, string target, integer maxDistance)
   * Returns: integer distance

Character

 * GetAllianceName (integer alliance)
   * Returns: string name
 * GetShortAllianceName (integer alliance)
   * Returns: string name
 * GetWorldName ()
   * Returns: string worldName
 * GetUniqueNameForCharacter (string characterName)
   * Returns: string uniqueName
 * GetDisplayName ()
   * Returns: string displayName
 * GetPlayerStatus ()
   * Returns: integer status
 * SelectPlayerStatus (integer status)
 * GetNumPlayerStatuses ()
   * Returns: integer numStatuses
 * GetNumEmotes ()
   * Returns: integer success
 * GetEmoteSlashName (luaindex index)
   * Returns: string slashName
 * PlayEmote (luaindex index)

Guild

 * GetGuildId (luaindex index)
   * Returns: integer guildId
 * GetNumGuildPermissions ()
   * Returns: integer numPermissions
 * GetNumGuildHistoryCategories ()
   * Returns: integer numCategories
 * GetNumGuildMembersRequiredForPrivilege (GuildPrivilege privilege)
   * Returns: integer numGuildMembers
 * CalculateCubicBezierEase (number progress, number x1, number y1, number x2, number y2)
   * Returns: number result
 * ExecuteChatCommand (string text)

System

 * Logout ()
 * Quit ()
 * SendPlayerStuck ()
 * TakeScreenshot ()
 * SetFullscreenEffect (FullscreenEffectType effectType, number param1, number param2)
 * DoesGameHaveFocus ()
   * Returns: bool hasFocus
 * IsPlayerActivated ()
   * Returns: bool activated
 * GetSecondsPlayed ()
   * Returns: integer secondsPlayed
 * GetString (string stringVariablePrefix, integer contextId)
   * Returns: string stringValue
 * IsShiftKeyDown ()
   * Returns: bool isShiftDown
 * IsControlKeyDown ()
   * Returns: bool isCtrlDown
 * IsAltKeyDown ()
   * Returns: bool isAltDown
 * GetKeyName (KeyCode keyCode)
   * Returns: string keyName
 * ConvertMouseButtonToKeyCode (integer mouseButton)
   * Returns: KeyCode key
 * PlaySound (string soundName)
 * ResetAllBindsToDefault ()

Language

 * LoadLanguageCSV (string languageName, bool localizeDefStrings, bool override)
   * Returns: bool result
 * ClearLanguageOverrides ()
 * SetL10nVisualizationEnabled (bool enabled)
 * SetGrammarLoggingEnabled (bool enabled)

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
 * GetUnitNameHighlightedByReticle ()
   * Returns: string name
 * GetUnitClass (string unitTag)
   * Returns: string className
 * GetUnitClassType (string unitTag)
   * Returns: integer classType
 * GetUnitLevel (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
 * 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
 * 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
 * IsUnitFollowingPlayer (string unitTag)
   * Returns: bool isFollowing
 * GetUnitReaction (string unitTag)
   * Returns: integer unitReaction
 * GetUnitAvARankPoints (string unitTag)
   * Returns: integer AvARankPoints
 * GetUnitAvARank (string unitTag)
   * Returns: integer rank, integer subRank
 * 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
 * GetUnitStat (string unitTag, integer derivedStatId)
   * Returns: integer baseDerivedStat, integer finalDerivedStat
 * 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

AvA

 * GetAvARankName (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

Target

 * TargetUnit private (string unitTag)
 * TargetUnitByName private (string unitName, bool exact)
 * ClearTarget private ()
 * TargetNearestEnemy private ()
 * CancelCast private ()
   * Returns: bool cancelled
 * IsTargetSameAsLastValidTarget ()
   * Returns: bool same
 * TogglePlayerWield ()
 * IsPlayerMoving ()
   * Returns: bool moving
 * IsPlayerGroundTargeting ()
   * Returns: bool isGroundTargeting
 * GetGroundTargetingError ()
   * Returns: integer:nilable error
 * StartSoulGemResurrection private ()
 * CancelSoulGemResurrection private ()
 * GetPlayerCameraHeading ()
   * Returns: number heading

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, bool longTerm
 * 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)


Group

 * GetGroupInviterName ()
   * Returns: string name
 * AcceptGroupInvite ()
 * DeclineGroupInvite ()
 * GroupLeave ()
 * GroupInvite (string unitTag)
 * GroupInviteByName (string name)
 * GroupKick (string unitTag)
 * GroupKickByName (string name)
 * GroupDisband ()
 * GroupPromote (string unitTag)
 * IsPlayerInGroup (string name)
   * Returns: bool inGroup
 * GetGroupSize ()
   * Returns: integer groupSize
 * MoveGroupMember (string sourceUnitTag, string destUnitTag)
   * Returns: bool shouldBeAbleToMove
 * JumpToGroupLeader ()
 * JumpToGroupMember (string name)
 * GetGroupMemberRoles (string unitTag)
   * Returns: bool isDps, bool isHealer, bool isTank

Quests

 * GetNumJournalQuests ()
   * Returns: integer numQuests
 * GetJournalQuestInfo (luaindex journalQuestIndex)
   * Returns: string questName, string backgroundText, string activeStepText, integer [[../globals/#QuestStepComparisonType|activeStepType]], string activeStepTrackerOverrideText, bool completed, bool tracked, integer questLevel, bool pushed, integer [[../globals/#QuestType|questType]]
   * ... entails:
   * GetJournalQuestName (luaindex journalQuestIndex)
     * Returns: string questName
   * GetJournalQuestLevel (luaindex journalQuestIndex)
     * Returns: integer level
   * GetJournalQuestIsComplete (luaindex journalQuestIndex)
     * Returns: bool completed
   * GetJournalQuestIsPushed (luaindex journalQuestIndex)
     * Returns: bool isPushed
   * GetJournalQuestType (luaindex journalQuestIndex)
     * Returns: integer type
 * GetJournalQuestNumRewards (luaindex journalQuestIndex)
   * Returns: integer count
 * GetJournalQuestRewardInfo (luaindex journalQuestIndex, luaindex rewardIndex)
   * Returns: integer type, string name, integer amount, string iconFile, bool failedEquipRequirement, integer itemQuality
 * GetQuestRewardItemLink (luaindex rewardIndex)
   * Returns: string link
 * GetJournalQuestTimerInfo (luaindex journalQuestIndex)
   * Returns: number timerStart, number timerEnd, bool isVisible, bool isPaused
 * GetJournalQuestTimerCaption (luaindex journalQuestIndex)
   * Returns: string caption


 * GetOfferedQuestInfo ()
   * Returns: string dialogue, string response
 * GetOfferedQuestShareInfo ()
   * Returns: string questName, string playerName
 * HasQuestShare ()
   * Returns: bool hasShare
 * AcceptOfferedQuest ()
 * AcceptSharedQuest ()
 * CompleteQuest ()
 * AbandonQuest (luaindex journalQuestIndex)
 * GetIsQuestSharable (luaindex journalQuestIndex)
   * Returns: bool isSharable
 * ShareQuest (luaindex journalQuestIndex)
 * IsValidQuestIndex (luaindex journalQuestIndex)
   * Returns: bool isValid
 * GetJournalQuestRepeatType (luaindex journalQuestIndex)
   * Returns: integer repeatType
 * 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

quest steps

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

quest conditions

 * GetJournalQuestNumConditions (luaindex journalQuestIndex, luaindex stepIndex)
   * Returns: integer conditionCount
 * GetJournalQuestConditionInfo (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
   * Returns: string conditionText, integer current, integer max, bool isFailCondition, bool isComplete, bool isCreditShared
   * ... entails:
   * GetJournalQuestConditionValues (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
     * Returns: integer current, integer max, bool isFailCondition, bool isComplete, bool isCreditShared
 * GetJournalQuestConditionAssistance (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex, bool assisted)
   * Returns: integer pinType, number xLocation, number yLocation, number areaRadius, bool insideCurrentMapWorld
   * ... entails:
 * GetJournalQuestConditionType (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex, bool assisted)
   * Returns: integer pinType
 * GetJournalQuestConditionPosition (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
   * Returns: number xLocation, number yLocation

quest tool/item

 * 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
 * UseQuestTool (luaindex journalQuestIndex, luaindex toolIndex)
 * GetQuestItemInfo (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
   * Returns: string iconFilename, integer stackCount, string name
 * UseQuestItem (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

quests misc

 * GetQuestDailyCount ()
   * Returns: integer dailyCount, integer dailyMax
 * GetNearestQuestCondition (integer considerType)
   * Returns: bool foundValidCondition, luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex

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 ()

Misc

 * GetWeaponSwapUnlockedLevel ()
   * Returns: integer level
 * 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
 * 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
 * GetStaminaBulletBaseCost ()
   * Returns: integer baseCost
 * GetStaminaBulletCostPerLevel ()
   * Returns: number costPerLevel
 * GetNumClassTypes ()
   * Returns: integer classTypeCount
 * GetClassType (luaindex index)
   * Returns: ClassType classType
 * GetNumAbilities ()
   * Returns: integer num
 * GetAbilityInfoByIndex (luaindex abilityIndex)
   * 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, luaindex actionSlotIndex)
   * Returns: bool valid
 * PlaceInTradeWindow private (luaindex:nilable tradeIndex)
 * PlaceInUnitFrame private (string target)

Chat

 * LogChatText (string text)
 * ToggleChatLog ()
 * AcceptChatInvite (bool accept, string channelName)
 * SendChatMessage (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, integer fontSize, 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, integer fontSize, 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)
 * GetChatCategoryColor (integer category)
   * Returns: number red, number green, number blue
 * SetChatCategoryColor (integer category, number red, number green, number blue)
 * ResetChatCategoryColorToDefault (integer category)
 * DecorateDisplayName (string displayName)
   * Returns: string decoratedDisplayName
 * IsDecoratedDisplayName (string displayName)
   * Returns: bool isDecorated
 * UndecorateDisplayName (string displayName)
   * Returns: string undecoratedDisplayName

Movement (prot'd)

 * 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 ()
 * LeftMouseDownInWorld private ()
 * LeftMouseUpInWorld private ()
 * LeftAndRightMouseDownInWorld private ()
 * LeftAndRightMouseUpInWorld private ()
 * RightMouseDownInWorld private ()
 * RightMouseUpInWorld private ()
 * CameraZoomIn private ()
 * CameraZoomOut private ()
 * ToggleAutoRun private ()
 * RollDodgeStart private ()
 * RollDodgeStop private ()
 * PrepareAttack private ()
 * PerformAttack private ()
 * StartBlock private ()
 * StopBlock private ()
 * PerformInterrupt private ()

Camera

 * SetUseInteractionCamera (bool enabled)
 * EndInteraction (integer interactionType)
 * SetFrameLocalPlayerInGameCamera (bool enabled)
 * SetFrameLocalPlayerTarget (number normalizedScreenX, number normalizedScreenY)
 * SetFramingScreenType (GameCameraFramingScreenType sreenType)

Chatter

A.k.a. NPC dialogue.

 * 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

Inventory

 * GetMaxBags ()
   * Returns: integer maxBags
 * GetBagInfo (integer bagId)
   * Returns: string bagIcon, integer bagSlots
 * GetItemInfo (integer bagId, integer slotIndex)
   * Returns: string icon, integer stack, integer sellPrice, bool failedEquipRequirement, bool locked, integer equipType, integer itemStyle, integer quality
 * GetItemId (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
 * SetItemIsJunk (integer bagId, integer slotIndex, bool junk)
 * GetItemTypeInfo (integer bagId, integer slotIndex)
   * Uses variable returns...
   * Returns: integer itemType
 * GetItemStatValue (integer bagId, integer slotIndex)
   * Returns: integer statValue
 * GetItemLink (integer bagId, integer slotIndex)
   * Returns: string link
 * GetComparisonEquipSlotsFromItemLink (string itemLink)
   * Returns: integer:nilable comparisonSlot1, integer:nilable comparisonSlot2
 * GetItemName (integer bagId, integer slotIndex)
   * Returns: string name
 * GetItemUsable (integer bagId, integer slotIndex)
   * Returns: bool usable
 * 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 failedEquipRequirement, integer equipType, integer itemStyle
 * UseItem private (integer bagId, integer slotIndex)
 * 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
 * PlayItemSound (integer itemSoundCategory, integer itemSoundAction)
 * IsLockedWeaponSlot (integer equipSlot)
   * Returns: bool locked

Bank

 * GetNextBankUpgradePrice ()
   * Returns: integer cost
 * GetItemCooldownInfo (integer bagId, integer slotIndex)
   * Returns: integer remain, integer duration
 * BuyBankSpace ()
 * BuyBagSpace ()
 * DisplayBankUpgrade ()
 * IsBankUpgradeAvailable ()
   * Returns: bool isAvailable
 * GetSelectedGuildBankId ()
   * Returns: integer:nilable guildId

Maps

 * GetCurrentMapIndex ()
   * Returns: luaindex:nilable index
 * GetCurrentMapZoneIndex ()
   * Returns: luaindex zoneIndex
 * GetNumMaps ()
   * Returns: integer numMaps
 * GetMapInfo (luaindex index)
   * Returns: string name, integer mapType, integer mapContentType
 * GetMapParentCategories (luaindex index)
   * Uses variable returns...
   * Returns: string categoryName, luaindex categoryIndex
 * GetCurrentMapName ()
   * Returns: string mapName
 * GetCurrentMapType ()
   * Returns: integer mapType
 * GetCurrentMapContentType ()
   * Returns: integer mapContentType
 * GetCurrentPlayerZoneIndex ()
   * Returns: luaindex zoneIndex
 * GetPlayerMapName ()
   * Returns: string mapName
 * GetCurrentMapPlayerPosition (string unitTag)
   * Returns: number normalizedX, number normalizedZ, number heading
 * SetWorldMapUITileSize (number tileSize)

zones

 * GetNumZones ()
   * Returns: integer numZones
 * GetZoneInfo (luaindex zoneIndex) -- 2=Glenumbra, 3=Vaults of Madness, 4=Stormhaven, 5=Rivenspire...
   * Returns: string zoneName, string worldName

locations

These are icon-marked points, like important buildings or shops.

 * GetNumMapLocations ()
   * Returns: integer numMapLocations
 * GetMapLocation (luaindex locationIndex) -- somehow returns nil always...
   * 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, number normalizedRadius, string tooltipText
   * Returns: string icon, number normalizedX, number normalizedZ
 * GetMapLocationTooltipHeader (luaindex locationIndex) -- aka the location's name
   * Returns: string title
 * GetNumMapLocationTooltipLines (luaindex locationIndex) -- use with the one below
   * Returns: integer numMapTooltipLines
 * GetMapLocationTooltipLineInfo (luaindex locationIndex, luaindex lineIndex) -- features inside the location
   * Returns: string texture, string name, integer groupnum
 /run for i=1,GetNumMapLocations() do d(GetMapLocationTooltipHeader(i)) for j=1,GetNumMapLocationTooltipLines(i) do d(" - "..select(2,GetMapLocationTooltipLineInfo(i,j))) end end

key sections

Used in the map key panel.

 * GetNumMapKeySections ()
   * Returns: integer numKeySections
 * GetMapKeySectionName (keyNum) -- keyNum: 1..numKeySections
 * GetNumMapKeySectionSymbols (keyNum)
   * Returns: integer numKeySymbols
 * GetMapKeySectionSymbolInfo (keyNum,symbolNum) -- symbolNum: 1..numKeySymbols
   * Returns: string tooltip,string texture,string _UNKNOWN_

set map to...

 * SetMapToZone (luaindex zoneIndex)
 * SetMapToQuest (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)
 * SetMapToPlayerLocation ()
   * Returns: bool mapChanged
 * SetMapByMapListIndex (luaindex index)
   * Returns: bool mapChanged

POI

 * GetNumPOIInZone (luaindex zoneIndex)
   * Returns: integer numPOI
 * GetCurrentMapNumTiles ()
   * Returns: integer numTiles
 * GetCurrentMapTileTexture (luaindex tileIndex)
   * Returns: string tileFilename
 * GetNumPOIs (luaindex zoneIndex)
   * Returns: integer numPOIs
 * GetPOIMapInfo (luaindex zoneIndex, luaindex poiIndex)
   * Returns: number normalizedX, number normalizedZ, MapDisplayPinType poiType, string icon
 * GetPOIPinType (luaindex zoneIndex, luaindex poiIndex)
   * Returns: MapDisplayPinType iconType
 * GetCurrentSubZonePOIIndices ()
   * Returns: luaindex:nilable zoneIndex, luaindex:nilable poiIndex

map misc

 * MapZoomOut ()
   * Returns: bool mapChanged
 * ProcessMapClick (number normalizedClickX, number normalizedClickY) -- aka Zoom In
   * Returns: bool mapChanged
 * GetMapMouseoverInfo (number normalizedMouseX, number normalizedMouseY)
   * Returns: string locationName, string textureFile, number textureUIWidth, number textureUIHeight, number textureXOffset, number textureYOffset
 * IsPointOnCurrentMap (number normalizedX, number normalizedZ)
   * Returns: bool onMap
 * GetMapFloorInfo ()
   * Returns: integer currentFloor, integer numFloors
 * SetMapFloor (integer desiredFloorIndex)
   * Returns: bool floorChanged
 * GetPOIInfo (luaindex zoneIndex, luaindex poiIndex)
   * Returns: string objectiveName, integer objectiveLevel, string startDescription, string finishedDescription
 * GetNumQuestsInPOI (luaindex zoneIndex, luaindex poiIndex)
   * Returns: integer numQuests, integer maxQuests, integer numCompletedQuests
 * PingMap (integer pingType, integer mapDisplayType, number normalizedX, number normalizedZ)
 * GetMapPing (string unitTag)
   * Returns: number normalizedX, number normalizedY
 * RemoveRallyPoint ()
 * GetMapRallyPoint ()
   * Returns: number normalizedX, number normalizedY

Fast travel

 * GetNumKeepTravelNetworkNodes ()
   * Returns: integer numNodes
 * GetNumKeepTravelNetworkLinks ()
   * Returns: integer numLinks
 * GetKeepTravelNetworkNodeInfo (luaindex nodeIndex)
   * Returns: integer keepId, bool accessible, number normalizedX, number normalizedY
 * GetKeepTravelNetworkLinkInfo (luaindex linkIndex)
   * Returns: integer linkType, integer linkOwner, integer restricedToAlliance, number startX, number startY, number endX, number endY
 * GetKeepTravelNetworkLinkEndpoints (luaindex linkIndex)
   * Returns: luaindex keepAIndex, luaindex keepBIndex
 * GetKeepAccessible (integer keepId)
   * Returns: bool accessible
 * GetKeepHasResourcesForTravel (integer keepId)
   * 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 (luaindex nodeIndex)
   * Returns: integer cost

AvA

 * 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
 * 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)
 * 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
 * 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
 * GetKeepResourceRate (integer keepId, integer battlegroundContext, integer resourceType)
   * 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, integer index)
   * Returns: string upgradeName, string upgradeDetails, integer upgradeAtPercent, bool active
 * GetNumUpgradesForKeepAtPathLevel (integer keepId, integer battlegroundContext, integer upgradePath, integer level)
   * Returns: integer numUpgrades
 * GetKeepUpgradePathDetails (integer keepId, integer battlegroundContext, integer upgradePath, integer level, integer index)
   * Returns: string upgradeName, string upgradeDetails, 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
 * ClaimOrReleaseGuildInteractionKeep ()
 * IsGuildInteractionKeepClaimedByPlayerGuild ()
   * Returns: bool isClaimed
 * IsGuildInteractionKeepClaimedByAnotherGuild ()
   * Returns: bool isClaimed
 * CanClaimGuildInteractionKeep ()
   * Returns: bool canClaim
 * CanReleaseGuildInteractionKeep ()
   * Returns: bool canRelease
 * GetGuildInteractionKeepGuildName ()
   * Returns: string guildName
 * CancelKeepGuildClaimInteraction ()
 * 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

Loot

 * LootAll (bool ignoreBindOnPickup)
 * LootItemById (integer lootId, bool ignoreBindOnPickup)
 * LootMoney (bool finesseMoney)
 * CloseLoot ()
 * GetNumLootItems ()
   * Returns: integer count
 * GetLootItemLink (integer lootId)
   * Returns: string link
 * GetLootMoney ()
   * Returns: integer nonFinessemoney, integer finesseMoney
 * GetLootItemInfo (luaindex lootIndex)
   * Returns: integer lootId, string name, string icon, integer count, integer quality, integer value, bool isQuest, bool isFinesse
 * GetMaxTransformPlugs ()
   * Returns: integer numPlugs
 * GetPlugItemInfo (integer bagId, integer slotId, luaindex socketIndex)
   * Returns: string name, string icon
 * GetPlugItemLink (integer bagId, integer slotId, luaindex socketIndex)
   * Returns: string link
 * 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

Misc

 * GetCurrentMoney ()
   * Returns: integer money
 * GetAlliancePoints ()
   * Returns: integer alliancePoints
 * GetBattleTokens ()
   * Returns: integer battleTokens
 * AcceptResurrect ()
 * DeclineResurrect ()
 * IsResurrectPending ()
   * Returns: bool resurrectPending
 * GetPendingResurrectInfo ()
   * Returns: string casterName, integer timeLeft
 * GetDeathInfo ()
   * Returns: integer timeUntilReincarnate, integer timeUntilAutoRelease, integer respawnQueueOrCorpseSummonTime, bool isPenaltyTooHighToReincarnate, bool encounterIsInProgress, bool isAVADeath, bool isBattleGroundDeath, bool isReleaseOnly, bool noSoulGem
 * Reincarnate ()
 * Release ()
 * JoinRespawnQueue ()
 * RespawnAtKeep (integer keepId)
 * CanRespawnAtKeep (integer keepId)
   * Returns: bool canRespawn
 * TradeInvite (string target)
 * TradeInviteByName (string playerName)
 * TradeInviteAccept ()
 * TradeInviteDecline ()
 * TradeSetMoney (integer amount)
 * TradeInviteCancel ()
 * TradeCancel ()
 * TradeAccept ()
 * TradeEdit ()
 * TradeAddItem (integer bagId, integer itemIndex, luaindex:nilable tradeIndex)
 * TradeRemoveItem (luaindex tradeIndex)
 * GetTradeItemInfo (integer who, luaindex tradeIndex)
   * Returns: string name, string icon, integer stack, integer quality
 * GetTradeItemLink (integer who, luaindex tradeIndex)
   * 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)
 * 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)
 * RemoveMapPinsInRange (integer startType, integer endType)
 * 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
 * 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
 * IsPlayerEscortingRam ()
   * Returns: bool isPlayerEscorting
 * GetNumPlayersEscortingRam ()
   * Returns: integer numPlayersEscorting
 * GetMinMaxRamEscorts ()
   * Returns: integer minEscorts, integer maxEscorts
 * GetNumGuildReputationRanks ()
   * Returns: integer numRepRanks
 * GetGuildReputationRankInfo (luaindex repRankIndex)
   * Returns: string guildName, string rankName, integer curPoints, integer pointsToNextRank, bool isMaxRank, integer rankNumber
 * SetHealthWarningStage (integer stage)
 * FlashHealthWarningStage (integer stage, integer flashTimeMs)
 * ClearHealthWarnings ()
 * SetFlashWaitTime (integer waitTimeMs)
 * GetNumUsedPlayerAuras ()
   * Returns: integer numUsed
 * GetPlayerAuraInfo (luaindex auraIndex)
   * Returns: bool active, integer position, string textureFilename
 * GetMaxMailItems ()
   * Returns: integer maxMail
 * QueueItemAttachment (integer bagId, integer itemIndex, luaindex attachmentSlot)
   * Returns: integer itemAttachmentResult
 * GetAchievementRewardInfo (integer achievementId, luaindex rewardIndex)
   * Returns: integer achievementRewardType, integer points, string name, string icon, integer quality
 * FormatAchievementLinkTimestamp (string timestamp)
   * Returns: string date, string time
 * 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
 * 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
 * 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
 * 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
 * AcceptWorldEventInvite (integer eventId)
 * DeclineWorldEventInvite (integer eventId)
 * GetNumActiveCombatTips ()
   * Returns: integer numTips
 * GetActiveCombatTipInfo (integer activeCombatTipId)
   * Returns: string name, string tipText, string iconPath, string actionKey
 * StopSettingChamber private ()
 * GetSettingChamberStress ()
   * Returns: number stress
 * AttemptForceLock private ()
 * GetLockpickingTimeLeft ()
   * Returns: integer timeLeftMs
 * GetChanceToForceLock ()
   * Returns: integer chance
 * GetNumLockpicksLeft ()
   * Returns: integer picksLeft
 * GetLockQuality ()
   * Returns: integer lockQuality
 * GetChamberState (luaindex chamberIndex)
   * Returns: integer chamberState, number chamberProgress
 * IsChamberSolved (luaindex chamberIndex)
   * Returns: bool solved
 * StartSettingChamber private (luaindex chamberIndex)
   * Returns: bool succesfullyStarted
 * GetKeepWallInfo ()
   * Returns: string keepName, string hookPointStoreLeftImage, string hookPointStoreRightImage, integer numAvailableHookPoints, integer numTotalHookPoints
 * 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 ()
 * GetNumKeepPieceHealItems ()
   * Returns: integer numItems
 * RepairKeepPiece ()
 * GetNumPendingFeedback ()
   * Returns: integer pendingFeedback
 * GetFeedbackIdByIndex (luaindex feedbackIndex)
   * Returns: integer:nilable feedbackId
 * GetFeedbackType (integer feedbackId)
   * Returns: integer feedbackType
 * RemovePendingFeedback (integer feedbackId)
 * IsFeedbackGatheringEnabled ()
   * Returns: bool enabled

Crafting

 * GetCraftingInteractionType ()
   * Returns: integer currentCraftingInteraction
 * GetNumKnownCraftingSkills ()
   * Returns: integer numCraftingSkills
 * GetCraftingSkillInfo (luaindex craftingSkillIndex)
   * Returns: integer craftingType, string name, integer rank, integer rankStart, integer rankUp, integer rankProgress, integer advancementMode
 * ChangeCraftingSkillAdvanceMode (integer craftingType, integer newAdvancementMode)
 * GetNumCraftingTools (integer craftingType)
   * Returns: integer numTools
 * GetCraftingToolInfo (integer craftingType, luaindex craftingToolIndex)
   * Returns: integer numPatterns, string name
 * HasAnyMaterialsToCraftPattern (integer craftingType, luaindex craftingToolIndex, luaindex craftingPatternIndex)
   * Returns: bool hasMaterials
 * GetCraftingPatternInfo (integer craftingType, luaindex craftingToolIndex, luaindex craftingPatternIndex)
   * Returns: string name, integer numStyles, integer numRequiredStyleMaterials, string primaryMaterialCategory, string secondaryMaterialCategory, integer minPrimaryQuantity, integer maxPrimaryQuantity, integer minSecondaryQuantity, integer maxSecondaryQuantity, integer maxAdditiveQuantity
 * GetCraftingPatternStyleInfo (integer craftingType, luaindex craftingToolIndex, luaindex craftingPatternIndex, luaindex craftingStyleIndex)
   * Returns: integer style, bool playerKnows, string styleComponentName, integer:nilable componentId
 * GetIngredientComponentsList (integer craftingType, luaindex craftingToolIndex, luaindex craftingPatternIndex, luaindex ingredientIndex, integer otherCraftingComponentId, integer otherCraftingComponentQuantity)
   * Uses variable returns...
   * Returns: integer componentId
 * GetAdditiveComponentsList (integer craftingType, luaindex craftingToolIndex, luaindex craftingPatternIndex, integer ingredientComponentId1, integer ingredientComponentId2)
   * Uses variable returns...
   * Returns: integer componentId
 * GetDeconstructableComponentsList (integer craftingType)
   * Uses variable returns...
   * Returns: integer componentId
 * GetRefinableComponentsList (integer craftingType)
   * Uses variable returns...
   * Returns: integer componentId
 * GetCraftingComponentInfo (integer componentId)
   * Returns: string name, string icon, integer totalQuantity, integer sellPrice, integer quality
 * GetCraftingComponentType (integer componentId)
   * Returns: integer componentType
 * GetCraftingComponentTraits (integer componentId)
   * Uses variable returns...
   * Returns: string:nilable traits
 * GetComponentLink (integer componentId)
   * Returns: string link
 * GetCostToCraftItem (integer craftingType, luaindex craftingToolIndex, luaindex craftingPatternIndex, integer ingredientComponentId1, integer ingredientQuantity1, integer ingredientComponentId2, integer ingredientQuantity2)
   * Returns: integer cost
 * CraftItem (integer craftingType, luaindex craftingToolIndex, luaindex craftingPatternIndex, luaindex craftingStyleIndex, integer ingredientComponentId1, integer ingredientQuantity1, integer ingredientComponentId2, integer ingredientQuantity2, integer additiveComponentId1, integer additiveQuantity1, integer additiveComponentId2, integer additiveQuantity2, integer additiveComponentId3, integer additiveQuantity3)
 * GetLastCraftResultItemInfo ()
   * Returns: string name, string icon, integer stack, integer sellPrice, bool failedEquipRequirement, integer equipType, integer itemStyle, integer quality
 * GetLastDeconstructResultItemInfo ()
   * Returns: string name, string icon, integer stack, integer sellPrice, bool failedEquipRequirement, integer equipType, integer itemStyle, integer quality
 * GetLastRefinementResultItemInfo ()
   * Returns: string name, string icon, integer stack, integer sellPrice, bool failedEquipRequirement, integer equipType, integer itemStyle, integer quality
 * GetDeconstructResultInfo (integer componentId)
   * Returns: integer inspiration
 * GetRefinementResultInfo (integer craftingType, integer componentId)
   * Returns: integer requiredQuantity, string name, string icon, integer stack, integer sellPrice, integer quality
 * GetRefinementResultLink (integer craftingType, integer componentId)
   * Returns: string link
 * GetItemDeconstructionInfo (integer bagId, integer slotIndex)
   * Returns: bool deconstructable, integer craftingSkillRequired, integer rankRequired
 * PerformDeconstruction (integer componentId)
 * PerformRefinement (integer componentId, integer quantity)
 * GetCraftingComponentSoundCategory (integer componentId)
   * Returns: integer soundCategory
Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox