Skip to content

Game API · LIVE

LIVE

Game API from ESOUIDocumentationP49.txt with 4440 functions.

A

AddSCTCloudOffset

AddSCTCloudOffset(integer SCTCloudId, integer ordering, number UIOffsetX, number UIOffsetY)

AreAllEnchantingRunesKnown

AreAllEnchantingRunesKnown(Bag potencyRuneBagId, integer potencyRuneSlotIndex, Bag essenceRuneBagId, integer essenceRuneSlotIndex, Bag aspectRuneBagId, integer aspectRuneSlotIndex)

  • # Returns: bool isKnown

B

BindKeyToAction *protected* (*luaindex* _layerIndex_, *luaindex* _categoryIndex_, *luaindex* _actionIndex_, *luaindex* _bindingIndex_, *[KeyCode|#KeyCode]* _key_, *[KeyCode|#KeyCode]* _modifier1_, *[KeyCode|#KeyCode]* _modifier2_, *[KeyCode|#KeyCode]* _modifier3_, *[KeyCode|#KeyCode]* _modifier4_)

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

BitAnd

BitAnd(integer53 valueA, integer53 valueB)

  • # Returns: integer53 result

BitLShift

BitLShift(integer53 value, integer numBits)

  • # Returns: integer53 result

BitNot

BitNot(integer53 value, integer numBits)

  • # Returns: integer53 result

BitOr

BitOr(integer53 valueA, integer53 valueB)

  • # Returns: integer53 result

BitRShift

BitRShift(integer53 value, integer numBits)

  • # Returns: integer53 result

BitXor

BitXor(integer53 valueA, integer53 valueB)

  • # Returns: integer53 result

C

CanCommunicateWith

CanCommunicateWith(string characterOrDisplayName, id64 consoleId)

  • # Returns: bool isCommunicationPermitted

CanItemTakeEnchantment

CanItemTakeEnchantment(Bag itemToEnchantBagId, integer itemToEnchantSlotIndex, Bag enchantmentToUseBagId, integer enchantmentToUseSlotIndex)

  • # Returns: bool canEnchant

CanSmithingStyleBeUsedOnPattern

CanSmithingStyleBeUsedOnPattern(integer itemStyleId, luaindex patternIndex, luaindex materialIndex, integer materialQuantity)

  • # Returns: bool canBeUsed, integer levelRequirement, integer championPointsRequirement

CanUseQuestItem

CanUseQuestItem(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

  • # Returns: bool canUse

ChargeItemWithSoulGem

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

CraftAlchemyItem

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

CraftEnchantingItem

CraftEnchantingItem(Bag potencyRuneBagId, integer potencyRuneSlotIndex, Bag essenceRuneBagId, integer essenceRuneSlotIndex, Bag aspectRuneBagId, integer aspectRuneSlotIndex, integer numIterations)

CraftSmithingItem

CraftSmithingItem(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, integer itemStyleId, luaindex traitIndex, bool useUniversalStyleItem, integer numIterations)

D

E

EnchantItem

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

F

G

GetAbilityCastInfo

GetAbilityCastInfo(integer abilityId, integer:nilable overrideRank, string casterUnitTag)

  • # Returns: bool:nilable channeled, integer:nilable durationValue

GetAbilityDescription

GetAbilityDescription(integer abilityId, integer:nilable overrideRank, string casterUnitTag)

  • # Returns: string description

GetAbilityDuration

GetAbilityDuration(integer abilityId, integer:nilable overrideRank, string casterUnitTag)

  • # Returns: integer:nilable durationMs

GetAbilityInfoByIndex

GetAbilityInfoByIndex(luaindex abilityIndex)

  • # Returns: string name, string texture, integer rank, integer actionSlotType, bool passive, bool showInSpellbook

GetAbilityProgressionXPInfoFromAbilityId

GetAbilityProgressionXPInfoFromAbilityId(integer abilityId)

  • # Returns: bool hasProgression, luaindex progressionIndex, integer lastRankXp, integer nextRankXP, integer currentXP, bool atMorph

GetAbilityRadius

GetAbilityRadius(integer abilityId, integer:nilable overrideRank, string casterUnitTag)

  • # Returns: integer:nilable radius

GetAbilityRange

GetAbilityRange(integer abilityId, integer:nilable overrideRank, string casterUnitTag)

  • # Returns: integer:nilable minRangeCM, integer:nilable maxRangeCM

GetAbilityRoles

GetAbilityRoles(integer abilityId)

  • # Returns: bool isTankRoleAbility, bool isHealerRoleAbility, bool isDamageRoleAbility

GetAbilityTargetDescription

GetAbilityTargetDescription(integer abilityId, integer:nilable overrideRank, string casterUnitTag)

  • # Returns: string:nilable targetDescription

GetAchievementCategoryInfo

GetAchievementCategoryInfo(luaindex topLevelIndex)

  • # Returns: string name, integer numSubCatgories, integer numAchievements, integer earnedPoints, integer totalPoints, bool hidesPoints

GetAchievementCriterion

GetAchievementCriterion(integer achievementId, luaindex criterionIndex)

  • # Returns: string description, integer numCompleted, integer numRequired

GetAchievementId

GetAchievementId(luaindex topLevelIndex, luaindex:nilable categoryIndex, luaindex achievementIndex)

  • # Returns: integer achievementId

GetAchievementInfo

GetAchievementInfo(integer achievementId)

  • # Returns: string name, string description, integer points, textureName icon, bool completed, string date, string time

GetAchievementsSearchResult

GetAchievementsSearchResult(luaindex searchResultIndex)

  • # Returns: luaindex categoryIndex, luaindex:nilable subcategoryIndex, luaindex achievementIndex

GetAchievementSubCategoryInfo

GetAchievementSubCategoryInfo(luaindex topLevelIndex, luaindex subCategoryIndex)

  • # Returns: string name, integer numAchievements, integer earnedPoints, integer totalPoints, bool hidesPoints

GetActionIndicesFromName

GetActionIndicesFromName(string actionName)

  • # Returns: luaindex:nilable layerIndex, luaindex:nilable categoryIndex, luaindex:nilable actionIndex

GetActionInfo

GetActionInfo(luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex)

  • # Returns: string actionName, bool isRebindable, bool isHidden

GetActivityInfo

GetActivityInfo(integer activityId)

  • # Returns: string name, integer levelMin, integer levelMax, integer championPointsMin, integer championPointsMax, LFGGroupType groupType, integer minGroupSize, string description, integer sortOrder

GetActivitySetInfo

GetActivitySetInfo(integer activitySetId)

  • # Returns: string name, string description, integer sortOrder

GetAlchemyItemTraits

GetAlchemyItemTraits(Bag reagentBagId, integer reagentSlotIndex)

  • # Uses variable returns...
  • # Returns: string:nilable trait, textureName:nilable icon, textureName:nilable matchIcon, string:nilable cancellingTrait, textureName:nilable conflictIcon

GetAlchemyResultingItemIdIfKnown

GetAlchemyResultingItemIdIfKnown(Bag solventBagId, integer solventSlotIndex, Bag reagent1BagId, integer reagent1SlotIndex, Bag reagent2BagId, integer reagent2SlotIndex, Bag:nilable reagent3BagId, integer:nilable reagent3SlotIndex, integer:nilable desiredEncodedTraits)

  • # Returns: integer:nilable resultingItemId

GetAlchemyResultingItemInfo

GetAlchemyResultingItemInfo(Bag solventBagId, integer solventSlotIndex, Bag reagent1BagId, integer reagent1SlotIndex, Bag reagent2BagId, integer reagent2SlotIndex, Bag:nilable reagent3BagId, integer:nilable reagent3SlotIndex)

GetAlchemyResultInspiration

GetAlchemyResultInspiration(Bag solventBagId, integer solventSlotIndex, Bag reagent1BagId, integer reagent1SlotIndex, Bag reagent2BagId, integer reagent2SlotIndex, Bag:nilable reagent3BagId, integer:nilable reagent3SlotIndex)

  • # Returns: integer inspiration

GetAntiquityCategoryKeyboardIcons

GetAntiquityCategoryKeyboardIcons(integer antiquityCategoryId)

  • # Returns: textureName unpressedButtonIcon, textureName pressedButtonIcon, textureName mouseoverButtonIcon

GetAntiquityLoreEntry

GetAntiquityLoreEntry(integer antiquityId, luaindex loreEntryIndex)

  • # Returns: string displayName, string description

GetAttachedItemInfo

GetAttachedItemInfo(id64 mailId, luaindex attachIndex)

  • # Returns: textureName icon, integer stack, string creatorName, integer sellPrice, bool meetsUsageRequirement, integer equipType, integer itemStyleId, ItemDisplayQuality displayQuality

GetAvAKeepScore

GetAvAKeepScore(integer campaignId, integer alliance)

  • # Returns: bool isAllianceHoldingAllNativeKeeps, integer numEnemyKeepsThisAllianceHolds, integer numNativeKeepsThisAllianceHolds, integer totalNativeKeepsInThisAlliancesArea, integer numEdgeKeepBonusesActive

GetAvARankProgress

GetAvARankProgress(integer currentRankPoints)

  • # Returns: integer subRankStartsAt, integer nextSubRankAt, integer rankStartsAt, integer nextRankAt

GetBookMediumFontInfo

GetBookMediumFontInfo(integer mediumId, bool isGamepad)

  • # Returns: string titleFontName, integer titleFontSize, FontStyle titleFontStyle, string bodyFontName, integer bodyFontSize, FontStyle bodyFontStyle, number fontColorR, number fontColorG, number fontColorB, number fontColorA, number fontStyleColorR, number fontStyleColorG, number fontStyleColorB, number fontStyleColorA

GetBookMediumInfo

GetBookMediumInfo(integer mediumId)

  • # Returns: textureName bg, integer numPages, integer pageWidthPixels, integer pageHeightPixels, integer pageYOffsetPixels, integer leftPageXOffsetPixels, integer rightPageXOffsetPixels, string openUISound, string closeUISound, string turnPageUISound

GetBountyDecayInfo

GetBountyDecayInfo()

  • # Returns: integer amountPerInterval, integer intervalDurationS, integer progressThroughIntervalS

GetCadwellZonePOIInfo

GetCadwellZonePOIInfo(CadwellProgressionLevel cadwellProgressionLevel, luaindex zoneIndex, luaindex poiIndex)

  • # Returns: string poiName, string poiOpeningText, string poiClosingText, luaindex poiOrder, bool discovered, bool completed

GetCampaignHoldingScoreValues

GetCampaignHoldingScoreValues(integer campaignId)

  • # Returns: integer keepValue, integer resourceValue, integer outpostValue, integer defensiveArtifactValue, integer offensiveArtifactValue

GetCampaignLeaderboardEntryInfo

GetCampaignLeaderboardEntryInfo(integer campaignId, luaindex entryIndex)

  • # Returns: bool isPlayer, integer ranking, string charName, integer alliancePoints, integer classId, Alliance alliance, string displayName

GetCategoryInfoFromAchievementId

GetCategoryInfoFromAchievementId(integer achievementId)

  • # Returns: luaindex:nilable topLevelIndex, luaindex:nilable categoryIndex, luaindex:nilable achievementIndex

GetCategoryInfoFromCollectibleId

GetCategoryInfoFromCollectibleId(integer collectibleId)

  • # Returns: luaindex:nilable topLevelIndex, luaindex:nilable categoryIndex, luaindex:nilable collectibleIndex

GetChallengeLeaderboardEntryInfo

GetChallengeLeaderboardEntryInfo(integer raidId, luaindex entryIndex)

  • # Returns: integer ranking, string charName, integer time, integer retClassId, integer allianceId, string displayName

GetChamberState

GetChamberState(luaindex chamberIndex)

  • # Returns: integer chamberState, number chamberProgress

GetChampionSkillId

GetChampionSkillId(luaindex disciplineIndex, luaindex championSkillIndex)

  • # Returns: integer championSkillId

GetChapterBasicRewardInfo

GetChapterBasicRewardInfo(integer chapterUpgradeId, luaindex index)

  • # Returns: integer marketProductId, bool isStandardReward, bool isCollectorsReward

GetChapterPreOrdereRewardInfo

GetChapterPreOrdereRewardInfo(integer chapterUpgradeId, luaindex index)

  • # Returns: integer marketProductId, bool isStandardReward, bool isCollectorsReward

GetChapterPrePurchaseRewardInfo

GetChapterPrePurchaseRewardInfo(integer chapterUpgradeId, luaindex index)

  • # Returns: integer marketProductId, bool isStandardReward, bool isCollectorsReward

GetCharacterInfo

GetCharacterInfo(luaindex index)

  • # Returns: string name, Gender gender, integer level, integer classId, integer raceId, Alliance alliance, string id, integer locationId

GetChatContainerColors

GetChatContainerColors(luaindex chatContainerIndex)

  • # Returns: number bgRed, number bgGreen, number bgBlue, number bgMinAlpha, number bgMaxAlpha

GetChatContainerTabInfo

GetChatContainerTabInfo(luaindex chatContainerIndex, luaindex tabIndex)

  • # Returns: string name, bool isLocked, bool isInteractable, bool isCombatLog, bool areTimestampsEnabled

GetChatterOption

GetChatterOption(luaindex optionIndex)

  • # Returns: string optionString, integer optionType, integer optionalArgument, bool isImportant, bool chosenBefore, integer teleportNPC, DialogueToneType dialogueTone

GetClassInfo

GetClassInfo(luaindex index)

  • # Returns: integer classId, string lore, textureName normalIconKeyboard, textureName pressedIconKeyboard, textureName mouseoverIconKeyboard, bool isSelectable, textureName ingameIconKeyboard, textureName ingameIconGamepad, textureName normalIconGamepad, textureName pressedIconGamepad

GetCollectibleCategoryInfo

GetCollectibleCategoryInfo(luaindex topLevelIndex)

  • # Returns: string name, integer numSubCatgories, integer numCollectibles, integer unlockedCollectibles, integer totalCollectibles, bool hidesLocked

GetCollectibleCategoryKeyboardIcons

GetCollectibleCategoryKeyboardIcons(luaindex topLevelIndex, luaindex:nilable subCategoryIndex)

  • # Returns: textureName normalIcon, textureName pressedIcon, textureName mouseoverIcon, textureName disabledIcon

GetCollectibleId

GetCollectibleId(luaindex topLevelIndex, luaindex:nilable categoryIndex, luaindex collectibleIndex)

  • # Returns: integer collectibleId

GetCollectibleInfo

GetCollectibleInfo(integer collectibleId)

  • # Returns: string name, string description, textureName icon, textureName deprecatedLockedIcon, bool unlocked, bool purchasable, bool isActive, CollectibleCategoryType categoryType, string hint

GetCollectiblesSearchResult

GetCollectiblesSearchResult(luaindex searchResultIndex)

  • # Returns: luaindex categoryIndex, luaindex:nilable subcategoryIndex, luaindex collectibleIndex

GetCollectibleSubCategoryInfo

GetCollectibleSubCategoryInfo(luaindex topLevelIndex, luaindex subCategoryIndex)

  • # Returns: string name, integer numCollectibles, integer unlockedCollectibles, integer totalCollectibles

GetCostToCraftEnchantingItem

GetCostToCraftEnchantingItem(Bag potencyRuneBagId, integer potencyRuneSlotIndex, Bag essenceRuneBagId, integer essenceRuneSlotIndex, Bag aspectRuneBagId, integer aspectRuneSlotIndex, integer numIterations)

  • # Returns: integer cost

GetCostToCraftSmithingItem

GetCostToCraftSmithingItem(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, integer itemStyleId, luaindex traitIndex, bool useUniversalStyleItem, integer numIterations)

  • # Returns: integer cost

GetCostToScribeScripts

GetCostToScribeScripts(integer craftedAbilityId, integer primaryScriptId, integer secondaryScriptId, integer tertiaryScriptId)

  • # Returns: integer cost

GetCraftedAbilityIdsFromLink(string link)

GetCraftedAbilityLink(integer craftedAbilityId, integer primaryScriptId, integer secondaryScriptId, integer tertiaryScriptId, LinkStyle linkStyle)

GetCrownCrateCardTextures

GetCrownCrateCardTextures(integer crateId)

  • # Returns: textureName cardBackImage, textureName cardBackGlowImage, textureName cardFaceImage, textureName cardFaceGlowImage

GetCrownCrateRewardInfo

GetCrownCrateRewardInfo(luaindex rewardIndex)

  • # Returns: string rewardName, string rewardTypeText, textureName cardFaceImage, textureName cardFaceFrameAccentImage, integer gemsExchanged, bool isBonus, integer crownCrateTierId, integer stackCount

GetCurrentItemDyes

GetCurrentItemDyes(Bag bagId, integer slotIndex)

  • # Returns: integer primaryDyeIndex, integer secondaryDyeIndex, integer accentDyeIndex

GetCurrentSynergyInfo

GetCurrentSynergyInfo()

  • # Returns: bool hasSynergy, string synergyName, textureName iconFilename, string prompt, integer priority

GetDeathInfo

GetDeathInfo()

  • # Returns: integer timeUntilRevive, integer timeUntilAutoRelease, integer corpseSummonTime, bool isPenaltyTooHighToRevive, bool encounterIsInProgress, bool isAVADeath, bool isBattleGroundDeath, bool isReleaseOnly, bool soulGemAvailable, bool freeRevive, bool isRaidDeath, bool deprecatedParam, integer cyclicRespawnQueueDuration, integer cyclicRespawnQueueTimeLeft

GetDisplayModes

GetDisplayModes(luaindex displayIndex)

  • # Uses variable returns...
  • # Returns: integer width, integer height

GetDuelInfo

GetDuelInfo()

  • # Returns: DuelState duelState, string partnerCharacterName, string partnerDisplayName, integer timeRemainingMS

GetDyeInfo

GetDyeInfo(luaindex dyeIndex)

  • # Returns: string dyeName, bool known, DyeRarity rarity, DyeHueCategory hueCategory, integer achievementId, number r, number g, number b, integer sortKey, integer dyeId

GetEmoteInfo

GetEmoteInfo(luaindex emoteIndex)

  • # Returns: string slashName, EmoteCategory category, integer emoteId, string displayName, bool showInGamepadUI

GetEnchantingResultingItemInfo

GetEnchantingResultingItemInfo(Bag potencyRuneBagId, integer potencyRuneSlotIndex, Bag essenceRuneBagId, integer essenceRuneSlotIndex, Bag aspectRuneBagId, integer aspectRuneSlotIndex)

  • # Returns: string name, textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, ItemDisplayQuality displayQuality

GetEndlessDungeonDuoLeaderboardEntryInfo

GetEndlessDungeonDuoLeaderboardEntryInfo(integer endlessDungeonId, luaindex entryIndex)

  • # Returns: integer ranking, string charName, integer score, integer classId, string displayName, integer stage, integer cycle, integer arc

GetEndlessDungeonSoloLeaderboardEntryInfo

GetEndlessDungeonSoloLeaderboardEntryInfo(integer endlessDungeonId, luaindex entryIndex)

  • # Returns: integer ranking, string charName, integer score, integer retClassId, string displayName, integer stage, integer cycle, integer arc

GetEULADetails

GetEULADetails(EULAType eulaType)

  • # Returns: string message, string agreeText, string disagreeText, bool hasAgreed, string dialogText, string readCheckText

GetFallbackReward

GetFallbackReward(integer rewardId)

  • # Returns: integer fallbackRewardId, integer fallbackRewardQuantity

GetFastTravelNodeInfo

GetFastTravelNodeInfo(luaindex nodeIndex)

  • # Returns: bool known, string name, number normalizedX, number normalizedY, textureName icon, textureName:nilable glowIcon, PointOfInterestType poiType, bool isShownInCurrentMap, bool linkedCollectibleIsLocked

GetFriendCharacterInfo

GetFriendCharacterInfo(luaindex friendIndex)

  • # Returns: bool hasCharacter, string characterName, string zoneName, integer classType, Alliance alliance, integer level, integer championRank, integer zoneId, id64 consoleId

GetFurnitureCategoryInfo

GetFurnitureCategoryInfo(integer furnitureCategoryId)

  • # Returns: string displayName, integer:nilable parentCategoryId, bool availableInTradingHouse, integer categoryOrder

GetGameCameraInteractableActionInfo

GetGameCameraInteractableActionInfo()

GetGameCameraInteractableInfo

GetGameCameraInteractableInfo()

  • # Returns: bool interactionExists, bool interactionAvailableNow, bool questInteraction, bool questTargetBased, luaindex questJournalIndex, luaindex questToolIndex, bool questToolOnCooldown

GetGiftInfo

GetGiftInfo(id64 giftId)

  • # Returns: ClientGiftState state, bool seen, integer marketProductId, string senderDisplayName, string recipientDisplayName, integer expirationTimestampS, string note, integer quantity

GetGroupInviteInfo

GetGroupInviteInfo()

  • # Returns: string characterName, integer millisecondsSinceRequest, string displayName

GetGuildFinderAccountApplicationInfo

GetGuildFinderAccountApplicationInfo(luaindex index)

  • # Returns: integer guildId, integer level, integer championPoints, Alliance alliance, integer classId, string guildName, Alliance guildAlliance, string accountName, string characterName, integer achievementPoints, string applicationMessage

GetGuildFinderGuildApplicationInfoAt

GetGuildFinderGuildApplicationInfoAt(integer guildId, luaindex index)

  • # Returns: integer level, integer championPoints, Alliance alliance, integer classId, string accountName, string characterName, integer achievementPoints, string applicationMessage

GetGuildHeraldryAttribute

GetGuildHeraldryAttribute(integer guildId)

  • # Returns: luaindex backgroundCategoryIndex, luaindex backgroundStyleIndex, luaindex backgroundPrimaryColorIndex, luaindex backgroundSecondaryColorIndex, luaindex crestCategoryIndex, luaindex crestStyleIndex, luaindex crestColorIndex

GetGuildHistoryTraderEventInfo

GetGuildHistoryTraderEventInfo(integer guildId, luaindex eventIndex)

GetGuildInfo

GetGuildInfo(integer guildId)

  • # Returns: integer numMembers, integer numOnline, string leaderName, integer numInvitees

GetGuildInviteInfo

GetGuildInviteInfo(luaindex index)

  • # Returns: integer guildId, string guildName, Alliance guildAlliance, string inviterDisplayName, string note

GetGuildKioskActiveBidInfo

GetGuildKioskActiveBidInfo(integer guildId, luaindex index)

  • # Returns: integer timeSinceBidS, integer bidAmount, string kioskName, string bidderDisplayName

GetGuildMemberCharacterInfo

GetGuildMemberCharacterInfo(integer guildId, luaindex memberIndex)

  • # Returns: bool hasCharacter, string characterName, string zoneName, integer classType, Alliance alliance, integer level, integer championRank, integer zoneId, id64 consoleId

GetGuildMemberInfo

GetGuildMemberInfo(integer guildId, luaindex memberIndex)

  • # Returns: string name, string note, luaindex rankIndex, PlayerStatus playerStatus, integer secsSinceLogoff

GetGuildSpecificItemInfo

GetGuildSpecificItemInfo(luaindex index)

  • # Returns: textureName icon, string itemName, integer quality, integer stackCount, integer requiredLevel, integer requiredChampionRank, integer purchasePrice, CurrencyType currencyType

GetHeatDecayInfo

GetHeatDecayInfo()

  • # Returns: integer amountPerInterval, integer intervalDurationS, integer progressThroughIntervalS

GetHeldSlots

GetHeldSlots()

  • # Returns: integer heldMain, integer heldOff, integer lastHeldMain, integer lastHeldOff

GetHelpCategoryInfo

GetHelpCategoryInfo(luaindex helpCategoryIndex)

  • # Returns: string name, string description, textureName upIcon, textureName downIcon, textureName overIcon, textureName gamepadIcon, string gamepadName

GetHelpId

GetHelpId(luaindex helpCategoryIndex, luaindex helpIndex)

  • # Returns: integer:nilable helpId

GetHelpInfo

GetHelpInfo(luaindex helpCategoryIndex, luaindex helpIndex)

  • # Returns: string name, string description, string description2, textureName:nilable image, string descriptionGamepad, string descriptionGamepad2, HelpShowOptions showOptions

GetHeraldryCustomizationCosts

GetHeraldryCustomizationCosts()

  • # Returns: integer backgroundStyleCost, integer backgroundPrimaryColorCost, integer backgroundSecondaryColorCost, integer crestStyleCost, integer crestColorCost

GetHousingEditorConstants

GetHousingEditorConstants()

  • # Returns: number pushSpeedPerSecond, number rotationStepSizeRadians, integer numTicksPerSecondForRotationChange

GetItemLinkContainerSetBonusInfo

GetItemLinkContainerSetBonusInfo(string itemLink, luaindex containerSetIndex, luaindex bonusIndex)

  • # Returns: integer numRequired, string bonusDescription, bool isPerfectedBonus

GetItemLinkContainerSetInfo

GetItemLinkContainerSetInfo(string itemLink, luaindex containerSetIndex)

  • # Returns: bool hasSet, string setName, integer numBonuses, integer numNormalEquipped, integer maxEquipped, integer setId, integer numPerfectedEquipped

GetItemLinkDyeIds

GetItemLinkDyeIds(string itemLink)

  • # Returns: integer primaryDefId, integer secondaryDefId, integer accentDefId

GetItemLinkInfo

GetItemLinkInfo(string itemLink)

  • # Returns: string icon, integer sellPrice, bool meetsUsageRequirement, EquipType equipType, integer itemStyleId

GetItemLinkOnUseAbilityInfo

GetItemLinkOnUseAbilityInfo(string itemLink)

  • # Returns: bool hasAbility, string abilityHeader, string abilityDescription, integer cooldown, bool hasScaling, integer minLevel, integer maxLevel, bool isChampionPoints, integer remainingCooldown

GetItemLinkRecipeIngredientInfo

GetItemLinkRecipeIngredientInfo(string itemLink, luaindex index)

  • # Returns: string ingredientName, integer amountInInventoryAndBank, integer amountRequired

GetItemLinkSetBonusInfo

GetItemLinkSetBonusInfo(string itemLink, bool equipped, luaindex index)

  • # Returns: integer numRequired, string bonusDescription, bool isPerfectedBonus

GetItemLinkSetInfo

GetItemLinkSetInfo(string itemLink, bool equipped)

  • # Returns: bool hasSet, string setName, integer numBonuses, integer numNormalEquipped, integer maxEquipped, integer setId, integer numPerfectedEquipped

GetItemLinkStacks

GetItemLinkStacks(string itemLink)

  • # Returns: integer stackCountBackpack, integer stackCountBank, integer stackCountCraftBag, integer stackCountHouseBanks, integer stackCountFurnitureVault, integer stackCountVengeanceBag

GetItemLinkTraitOnUseAbilityInfo

GetItemLinkTraitOnUseAbilityInfo(string itemLink, luaindex index)

  • # Returns: bool hasAbility, string abilityDescription, integer cooldown, bool hasScaling, integer minLevel, integer maxLevel, bool isChampionPoints

GetItemSetBonusInfo

GetItemSetBonusInfo(integer itemSetId, luaindex index)

  • # Returns: integer numRequired, string bonusDescription, bool isPerfectedBonus

GetItemSetInfo

GetItemSetInfo(integer itemSetId)

  • # Returns: bool hasSet, string setName, integer numBonuses, integer numNormalEquipped, integer numPerfectedEquipped, integer maxEquipped

GetJournalQuestConditionInfo

GetJournalQuestConditionInfo(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex, bool useShortDescription)

  • # Returns: string conditionText, integer current, integer max, bool isFailCondition, bool isComplete, bool isCreditShared, bool isVisible, QuestConditionType conditionType

GetJournalQuestConditionValues

GetJournalQuestConditionValues(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

  • # Returns: integer current, integer max, bool isFailCondition, bool isComplete, bool isCreditShared, bool isVisible

GetJournalQuestEnding

GetJournalQuestEnding(luaindex journalQuestIndex)

  • # Returns: string goal, string dialog, string confirmComplete, string declineComplete, string backgroundText, string journalStepText

GetJournalQuestInfo

GetJournalQuestInfo(luaindex journalQuestIndex)

  • # Returns: string questName, string backgroundText, string activeStepText, integer activeStepType, string activeStepTrackerOverrideText, bool completed, bool tracked, integer questLevel, bool pushed, integer questType, ZoneDisplayType zoneDisplayType

GetJournalQuestLocationInfo

GetJournalQuestLocationInfo(luaindex journalQuestIndex)

  • # Returns: string zoneName, string objectiveName, luaindex zoneIndex, luaindex poiIndex

GetJournalQuestTimerInfo

GetJournalQuestTimerInfo(luaindex journalQuestIndex)

  • # Returns: number timerStart, number timerEnd, bool isVisible, bool isPaused

GetKillingAttackerInfo

GetKillingAttackerInfo(luaindex index)

  • # Returns: string attackerRawName, integer attackerChampionPoints, integer attackerLevel, integer attackerAvARank, bool isPlayer, bool isBoss, Alliance alliance, string minionName, string attackerDisplayName

GetKillingAttackInfo

GetKillingAttackInfo(luaindex index)

  • # Returns: string attackName, integer attackDamage, textureName attackIcon, bool wasKillingBlow, integer castTimeAgoMS, integer durationMS, integer numAttackHits, integer abilityId, textureName:nilable abilityFxIcon

GetLevelUpGuiParticleEffectInfo

GetLevelUpGuiParticleEffectInfo(integer level, luaindex index)

  • # Returns: textureName texture, number normalizedVelocityMin, number normalizedVelocityMax, number durationMinS, number durationMaxS, integer particlesPerSecond, number startScaleMin, number startScaleMax, number endScaleMin, number endScaleMax, number startAlpha, number endAlpha, number r, number g, number b, number normalizedStartPoint1X, number normalizedStartPoint1Y, number normalizedStartPoint2X, number normalizedStartPoint2Y, number angleRadians

GetLFGActivityRewardUINodeInfo

GetLFGActivityRewardUINodeInfo(integer rewardUIDataId, luaindex nodeIndex)

  • # Returns: string displayName, textureName icon, number textColorRed, number textColorBlue, number textColorGreen

GetLFGReadyCheckCounts

GetLFGReadyCheckCounts()

  • # Returns: integer tanksAccepted, integer tanksPending, integer healersAccepted, integer healersPending, integer dpsAccepted, integer dpsPending

GetLootItemInfo

GetLootItemInfo(luaindex lootIndex)

  • # Returns: integer lootId, string name, textureName icon, integer count, integer quality, integer value, bool isQuest, bool stolen, LootItemType lootType, bool isLockedSetPiece, bool canBeUsedToLearn

GetLoreBookIndicesFromBookId

GetLoreBookIndicesFromBookId(integer bookId)

  • # Returns: luaindex:nilable categoryIndex, luaindex:nilable collectionIndex, luaindex:nilable bookIndex

GetLoreBookInfo

GetLoreBookInfo(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)

  • # Returns: string title, textureName icon, bool known, integer bookId

GetLoreCategoryInfo

GetLoreCategoryInfo(luaindex categoryIndex)

  • # Returns: string name, integer numCollections, integer categoryId

GetLoreCollectionInfo

GetLoreCollectionInfo(luaindex categoryIndex, luaindex collectionIndex)

  • # Returns: string name, string description, integer numKnownBooks, integer totalBooks, bool hidden, textureName gamepadIcon, integer collectionId

GetMailFlags

GetMailFlags(id64 mailId)

  • # Returns: bool unread, bool returned, bool fromSystem, bool fromCustomerService

GetMailItemInfo

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:nilable expiresInDays, integer secsSinceReceived, MailCategory category

GetMailSender

GetMailSender(id64 mailId)

  • # Returns: string senderDisplayName, string senderCharacterName

GetMapBlobNameInfo

GetMapBlobNameInfo(luaindex blobIndex)

  • # Returns: string locationName, number normalizedX, number normalizedZ, number normalizedWidth, number scale

GetMapLocationIcon

GetMapLocationIcon(luaindex locationIndex)

  • # Returns: string icon, number normalizedX, number normalizedZ

GetMapLocationTooltipLineInfo

GetMapLocationTooltipLineInfo(luaindex locationIndex, luaindex tooltipLineIndex)

  • # Returns: textureName icon, string name, integer grouping, string categoryName

GetMapMouseoverInfo

GetMapMouseoverInfo(number normalizedMouseX, number normalizedMouseY)

  • # Returns: string locationName, string textureFile, number textureWidthNormalized, number textureHeightNormalized, number textureXOffsetNormalized, number textureYOffsetNormalized, integer mapId

GetMapPing

GetMapPing(string unitTag)

  • # Returns: number normalizedX, number normalizedY

GetMapPlayerPosition

GetMapPlayerPosition(string unitTag)

  • # Returns: number normalizedX, number normalizedZ, number heading, bool isShownInCurrentMap, bool isSymbolicLocation

GetMarketProductCrownCrateRewardInfo

GetMarketProductCrownCrateRewardInfo(integer marketProductId)

  • # Returns: string rewardName, string rewardTypeText, textureName cardFaceImage, textureName cardFaceFrameAccentImage, integer stackCount

GetMedalInfo

GetMedalInfo(integer medalId)

  • # Returns: string name, textureName iconTexture, string condition, integer scoreReward

GetNearestQuestCondition

GetNearestQuestCondition(integer considerType)

  • # Returns: bool foundValidCondition, luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex

GetNextScoreboardEntryMedalId

GetNextScoreboardEntryMedalId(luaindex entryIndex, luaindex:nilable roundIndex, integer:nilable lastMedalId)

  • # Returns: integer:nilable nextMedalId

GetNormalizedWorldPosition

GetNormalizedWorldPosition(integer zoneId, integer worldX, integer worldY, integer worldZ)

  • # Returns: number normalizedX, number normalizedY

GetOfferedQuestShareInfo

GetOfferedQuestShareInfo(integer questId)

  • # Returns: string questName, string characterName, integer millisecondsSinceRequest, string displayName

GetOverscanOffsets

GetOverscanOffsets()

  • # Returns: integer offsetX, integer offsetY, integer offsetWidth, integer offsetHeight

GetPendingHeraldryIndices

GetPendingHeraldryIndices()

  • # Returns: luaindex backgroundCategoryIndex, luaindex backgroundStyleIndex, luaindex backgroundPrimaryColorIndex, luaindex backgroundSecondaryColorIndex, luaindex crestCategoryIndex, luaindex crestStyleIndex, luaindex crestColorIndex

GetPendingSlotDyes

GetPendingSlotDyes(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlotType)

  • # Returns: integer primaryDyeId, integer secondaryDyeId, integer accentDyeId

GetPledgeOfMaraOfferInfo

GetPledgeOfMaraOfferInfo()

  • # Returns: string targetCharacterName, integer millisecondsSinceRequest, bool isSender, string targetDisplayName

GetPOIInfo

GetPOIInfo(luaindex zoneIndex, luaindex poiIndex)

  • # Returns: string objectiveName, integer objectiveLevel, string startDescription, string finishedDescription

GetPOIMapInfo

GetPOIMapInfo(luaindex zoneIndex, luaindex poiIndex)

  • # Returns: number normalizedX, number normalizedZ, MapDisplayPinType poiPinType, textureName icon, bool isShownInCurrentMap, bool linkedCollectibleIsLocked, bool isDiscovered, bool isNearby

GetPromotionalEventCampaignActivityInfo

GetPromotionalEventCampaignActivityInfo(id64 campaignKey, luaindex activityIndex)

  • # Returns: integer activityId, string displayName, string description, integer completionThreshold, integer rewardId, integer rewardQuantity

GetPromotionalEventCampaignInfo

GetPromotionalEventCampaignInfo(id64 campaignKey)

  • # Returns: integer campaignId, integer numActivities, integer numMilestones, integer capstoneCompletionThreshold, integer capstoneRewardId, integer capstoneRewardQuantity

GetQuestConditionMasterWritInfo

GetQuestConditionMasterWritInfo(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

  • # Returns: integer:nilable itemId, integer:nilable materialItemId, TradeskillType:nilable craftingType, ItemQuality:nilable itemQuality, integer:nilable itemTemplateId, integer:nilable itemSetId, ItemTraitType:nilable itemTraitType, integer:nilable itemStyleId, integer:nilable encodedAlchemyTraits

GetQuestItemCooldownInfo

GetQuestItemCooldownInfo(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

  • # Returns: integer remain, integer duration

GetQuestItemInfo

GetQuestItemInfo(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

  • # Returns: textureName iconFilename, integer stackCount, string name, integer questItemId

GetQuestToolInfo

GetQuestToolInfo(luaindex journalQuestIndex, luaindex toolIndex)

  • # Returns: textureName iconFilename, integer stackCount, bool isUsable, string name, integer questItemId

GetRecipeListInfo

GetRecipeListInfo(luaindex recipeListIndex)

  • # Returns: string name, integer numRecipes, textureName upIcon, textureName downIcon, textureName overIcon, textureName deprecatedReturn, string createSound

GetRecipeResultQuantity

GetRecipeResultQuantity(luaindex recipeListIndex, luaindex recipeIndex, integer numIterations)

  • # Returns: integer quantity

GetRidingStats

GetRidingStats()

  • # Returns: integer inventoryBonus, integer maxInventoryBonus, integer staminaBonus, integer maxStaminaBonus, integer speedBonus, integer maxSpeedBonus

GetRunesForItemIdIfKnown

GetRunesForItemIdIfKnown(integer itemId, integer materialItemId, ItemQuality itemQuality)

  • # Returns: integer:nilable potencyRuneId, integer:nilable essenceRuneId, integer:nilable aspectRuneId

GetSavedDyeSetDyes

GetSavedDyeSetDyes(luaindex dyeSetIndex)

  • # Returns: integer primaryDyeId, integer secondaryDyeId, integer accentDyeId

GetScriptedEventInviteInfo

GetScriptedEventInviteInfo(integer eventId)

  • # Returns: bool isValid, string eventName, string inviterName, string questName, integer timeRemainingMS

GetSCTCloudOffset

GetSCTCloudOffset(integer SCTCloudId, luaindex offsetIndex, integer ordering, number UIOffsetX, number UIOffsetY)

GetSCTSlotClamping

GetSCTSlotClamping(luaindex slotIndex)

  • # Returns: number topEdgeUIOffsetBuffer, number bottomEdgeUIOffsetBuffer

GetSCTSlotZoomedInPosition

GetSCTSlotZoomedInPosition(luaindex slotIndex)

  • # Returns: number zoomedInCameraDistanceThreshold, number zoomedInUIOffsetX, number zoomedInUIOffsetY

GetSkillAbilityInfo

GetSkillAbilityInfo(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

  • # Returns: string name, textureName texture, luaindex earnedRank, bool passive, bool ultimate, bool purchased, luaindex:nilable progressionIndex, integer rank

GetSkillBuildEntryInfo

GetSkillBuildEntryInfo(integer skillBuildId, luaindex skillBuildAbilityIndex)

  • # Returns: SkillType skillType, luaindex skillLineIndex, luaindex abilityIndex, bool isActiveAbility, integer morphChoice, integer rank

GetSkillBuildInfo

GetSkillBuildInfo(integer skillBuildId)

  • # Returns: string name, string description, bool isTank, bool isHealer, bool isDPS

GetSkillLineDynamicInfo

GetSkillLineDynamicInfo(SkillType skillType, luaindex skillLineIndex)

  • # Returns: luaindex rank, bool isAdvised, bool isActive, bool isDiscovered, bool isAccountSkill, bool isInTraining

GetSkuPricingInfo

GetSkuPricingInfo(integer skuDefId)

  • # Returns: number currentPrice, number basePrice, string currency

GetSmithingPatternInfo

GetSmithingPatternInfo(luaindex patternIndex, luaindex:nilable materialIndexOverride, integer:nilable materialQuanityOverride, integer:nilable styleOverride, ItemTraitType:nilable traitTypeOverride)

  • # Returns: string patternName, string baseName, textureName icon, integer numMaterials, integer numTraitsRequired, integer numTraitsKnown, ItemFilterType resultItemFilterType

GetSmithingPatternInfoForItemSet

GetSmithingPatternInfoForItemSet(integer itemTemplateId, integer itemSetId, integer materialItemId, ItemTraitType traitType)

  • # Returns: luaindex:nilable patternIndex, luaindex:nilable materialIndex, integer:nilable resultingItemId

GetSmithingPatternMaterialItemInfo

GetSmithingPatternMaterialItemInfo(luaindex patternIndex, luaindex materialIndex)

  • # Returns: string itemName, textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, EquipType equipType, integer itemStyleId, ItemDisplayQuality displayQuality, integer itemInstanceId, integer skillRequirement, integer createsItemOfLevel, bool isChampionPoint

GetSmithingPatternResultLink(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, integer itemStyleId, luaindex traitIndex, LinkStyle linkStyle)

GetSpecificSkillAbilityInfo

GetSpecificSkillAbilityInfo(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex, integer morphChoice, integer rank)

  • # Returns: integer abilityId, luaindex skillLineRankNeeded, integer characterLevelNeeded

GetStoreCurrencyTypes

GetStoreCurrencyTypes()

  • # Returns: bool usesMoney, bool usesAlliancePoints, bool usesTelvarStones, bool usesWritVouchers, bool usesTradeBars

GetStoreEntryInfo

GetStoreEntryInfo(luaindex entryIndex)

  • # Returns: textureName icon, string name, integer stack, integer price, integer sellPrice, bool meetsRequirementsToBuy, bool meetsRequirementsToUse, integer quality, bool questNameColor, CurrencyType currencyType1, integer currencyQuantity1, CurrencyType currencyType2, integer currencyQuantity2, StoreEntryType entryType, StoreFailure buyStoreFailure, integer buyErrorStringId, integer actorCategory

GetString

GetString(string stringVariablePrefix, integer contextId)

  • # Returns: string stringValue

GetSynergyInfoAtIndex

GetSynergyInfoAtIndex(luaindex synergyIndex)

  • # Returns: string synergyName, textureName iconFilename, string prompt, integer priority, integer synergyAbilityId, bool canBeUsed

GetTextureLayerRevealAnimationWindowEndPoints

GetTextureLayerRevealAnimationWindowEndPoints(integer animationId)

  • # Returns: number normalizedStartX, number normalizedStartY, number normalizedStartRegistrationX, number normalizedStartRegistrationY, number normalizedEndX, number normalizedEndY, number normalizedEndRegistrationX, number normalizedEndRegistrationY

GetTradeInviteInfo

GetTradeInviteInfo()

  • # Returns: string characterName, integer millisecondsSinceRequest, string displayName

GetTrialInfo

GetTrialInfo()

  • # Returns: integer accountTypeId, string title, string description, integer version

GetTrialLeaderboardEntryInfo

GetTrialLeaderboardEntryInfo(integer raidId, luaindex entryIndex)

  • # Returns: integer ranking, string charName, integer time, integer classId, integer allianceId, string displayName

GetTutorialInfo

GetTutorialInfo(luaindex tutorialIndex)

  • # Returns: string title, string description, integer displayPriority

GetUnitBuffInfo

GetUnitBuffInfo(string unitTag, luaindex buffIndex)

  • # Returns: string buffName, number timeStarted, number timeEnding, integer buffSlot, integer stackCount, textureName iconFilename, string deprecatedBuffType, BuffEffectType effectType, AbilityType abilityType, StatusEffectType statusEffectType, integer abilityId, bool canClickOff, bool castByPlayer

GetUnitPowerInfo

GetUnitPowerInfo(string unitTag, luaindex poolIndex)

  • # Returns: integer:nilable type, integer current, integer max, integer effectiveMax

GetUnitWorldPosition

GetUnitWorldPosition(string unitTag)

  • # Returns: integer zoneId, integer worldX, integer worldY, integer worldZ

GetUniversallyNormalizedMapInfo

GetUniversallyNormalizedMapInfo(integer mapId)

  • # Returns: number normalizedOffsetX, number normalizedOffsetZ, number normalizedWidth, number normalizedHeight

GuildInvite

GuildInvite(integer guildId, string displayName)

  • # Returns: bool inviteSent

GuildSetRank

GuildSetRank(integer guildId, string displayName, luaindex rankIndex)

H

HousingEditorCalculateRotationAboutAxis

HousingEditorCalculateRotationAboutAxis(AxisTypes aAxis, number aOffsetRadians, number aInitialPitchRadians, number aInitialYawRadians, number aInitialRollRadians)

  • # Returns: number pitchRadians, number yawRadians, number rollRadians

HousingEditorClipLineSegmentToViewFrustum

HousingEditorClipLineSegmentToViewFrustum(integer aWorldX1, integer aWorldY1, integer aWorldZ1, integer aWorldX2, integer aWorldY2, integer aWorldZ2)

  • # Returns: integer aClippedWorldX1, integer aClippedWorldY1, integer aClippedWorldZ1, integer aClippedWorldX2, integer aClippedWorldY2, integer aClippedWorldZ2

HousingEditorGetFurnitureWorldBounds

HousingEditorGetFurnitureWorldBounds(id64 furnitureId)

  • # Returns: integer minWorldX, integer minWorldY, integer minWorldZ, integer maxWorldX, integer maxWorldY, integer maxWorldZ

HousingEditorGetScreenPointWorldPlaneIntersection

HousingEditorGetScreenPointWorldPlaneIntersection(integer aScreenX, integer aScreenY, integer aWorldX1, integer aWorldY1, integer aWorldZ1, integer aWorldX2, integer aWorldY2, integer aWorldZ2, integer aWorldX3, integer aWorldY3, integer aWorldZ3)

  • # Returns: integer aWorldX, integer aWorldY, integer aWorldZ

I

Id64ToNumber

Id64ToNumber(id64 id)

  • # Returns: integer53 number, bool lostPrecisionUseId64ToString

IsCraftedAbilityScriptCompatibleWithSelections

IsCraftedAbilityScriptCompatibleWithSelections(integer checkScriptId, integer craftedAbilityId, integer selectedPrimaryScriptId, integer selectedSecondaryScriptId, integer selectedTertiaryScriptId)

  • # Returns: bool isCompatible

IsEquipable

IsEquipable(Bag bagId, integer slotIndex)

  • # Returns: bool isEquipable, integer resultErrorCodeIfFailed

IsItemUsable

IsItemUsable(Bag bagId, integer slotIndex)

  • # Returns: bool usable, bool usableOnlyFromActionSlot

IsScribableScriptCombinationForCraftedAbility

IsScribableScriptCombinationForCraftedAbility(integer craftedAbilityId, integer selectedPrimaryScriptId, integer selectedSecondaryScriptId, integer selectedTertiaryScriptId)

  • # Returns: bool isScribableCombination

J

L

M

N

NumberToId64

NumberToId64(integer53 number)

  • # Returns: id64 id, bool lostPrecisionUseStringToId64

O

P

PlainStringFind

PlainStringFind(string string, string searchFor)

  • # Returns: bool found, integer startIndex, integer endIndex

PlayVideo

PlayVideo(string filename, bool playImmediately, VideoSkipMode skipMode, integer subtitleId, bool playInBackground, bool loopPlayback, bool mutePlayback)

PreviewCraftItem

PreviewCraftItem(luaindex patternIndex, luaindex materialIndex, integer materialQuantity, luaindex styleIndex, luaindex traitIndex, bool useUniversalStyleItem, integer dyeBrushId)

Q

R

ReadLoreBook

ReadLoreBook(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)

  • # Returns: string body, integer mediumId, bool showTitle

RepairItemWithRepairKit

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

RequestScribe

RequestScribe(integer craftedAbilityId, integer primaryScriptId, integer secondaryScriptId, integer tertiaryScriptId)

S

SendMail

SendMail(string to, string subject, string body)

SetChatContainerColors

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

SetChatContainerTabInfo

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

SetGamepadVibration

SetGamepadVibration(integer durationMs, number firstMotor, number secondMotor, number thirdMotor, number fourthMotor, string debugSourceInfo)

SetOverscanOffsets

SetOverscanOffsets(integer offsetX, integer offsetY, integer offsetWidth, integer offsetHeight)

SetPendingHeraldryIndices

SetPendingHeraldryIndices(luaindex backgroundCategoryIndex, luaindex backgroundStyleIndex, luaindex backgroundPrimaryColorIndex, luaindex backgroundSecondaryColorIndex, luaindex crestCategoryIndex, luaindex crestStyleIndex, luaindex crestColorIndex)

SetPendingSlotDyes

SetPendingSlotDyes(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlotType, integer primaryDyeId, integer secondaryDyeId, integer accentDyeId)

SetSavedDyeSetDyes

SetSavedDyeSetDyes(luaindex dyeSetIndex, integer primaryDyeId, integer secondaryDyeId, integer accentDyeId)

SetSCTSlotClamping

SetSCTSlotClamping(luaindex slotIndex, number topEdgeUIOffsetBuffer, number bottomEdgeUIOffsetBuffer)

SetSCTSlotZoomedInPosition

SetSCTSlotZoomedInPosition(luaindex slotIndex, number zoomedInCameraDistanceThreshold, number zoomedInUIOffsetX, number zoomedInUIOffsetY)

SplitString

SplitString(string delims, string stringToSplit)

  • # Uses variable returns...
  • # Returns: string strings

T

TransferChatContainerTab

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

U

UseQuestItem

UseQuestItem(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

V

W

WouldProcessMapClick

WouldProcessMapClick(number normalizedClickX, number normalizedClickY)

  • # Returns: bool wouldProcess, luaindex:nilable resultingMapIndex

Z