Skip to content

Game API · LIVE

LIVE

Game API from ESOUIDocumentationP49.txt with 4440 functions. View source-order listing.

A

B

BitAnd

(integer53 valueA, integer53 valueB)

  • # Returns: integer53 result

BitNot

(integer53 value, integer numBits)

  • # Returns: integer53 result

BitOr

(integer53 valueA, integer53 valueB)

  • # Returns: integer53 result

BitXor

(integer53 valueA, integer53 valueB)

  • # Returns: integer53 result

C

CanSmithingStyleBeUsedOnPattern

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

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

CanUseQuestItem

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

  • # Returns: bool canUse

CraftAlchemyItem

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

CraftEnchantingItem

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

CraftSmithingItem

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

D

E

EnchantItem

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

F

G

GetAbilityCastInfo

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

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

GetAbilityDuration

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

  • # Returns: integer:nilable durationMs

GetAbilityInfoByIndex

(luaindex abilityIndex)

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

GetAbilityRadius

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

  • # Returns: integer:nilable radius

GetAbilityRange

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

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

GetAbilityRoles

(integer abilityId)

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

GetAchievementCategoryInfo

(luaindex topLevelIndex)

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

GetAchievementId

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

  • # Returns: integer achievementId

GetAchievementInfo

(integer achievementId)

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

GetAchievementSubCategoryInfo

(luaindex topLevelIndex, luaindex subCategoryIndex)

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

GetActionInfo

(luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex)

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

GetActivityInfo

(integer activityId)

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

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

(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

GetAlchemyResultInspiration

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

  • # Returns: integer inspiration

GetAttachedItemInfo

(id64 mailId, luaindex attachIndex)

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

GetAvAKeepScore

(integer campaignId, integer alliance)

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

GetAvARankProgress

(integer currentRankPoints)

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

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

(integer mediumId)

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

GetCampaignHoldingScoreValues

(integer campaignId)

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

GetChatContainerColors

(luaindex chatContainerIndex)

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

GetChatContainerTabInfo

(luaindex chatContainerIndex, luaindex tabIndex)

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

GetChatterOption

(luaindex optionIndex)

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

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

(luaindex topLevelIndex)

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

GetCollectibleCategoryKeyboardIcons

(luaindex topLevelIndex, luaindex:nilable subCategoryIndex)

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

GetCollectibleId

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

  • # Returns: integer collectibleId

GetCollectibleInfo

(integer collectibleId)

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

GetCollectibleSubCategoryInfo

(luaindex topLevelIndex, luaindex subCategoryIndex)

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

GetCostToCraftEnchantingItem

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

  • # Returns: integer cost

GetCostToCraftSmithingItem

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

  • # Returns: integer cost

GetCostToScribeScripts

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

  • # Returns: integer cost

GetCrownCrateCardTextures

(integer crateId)

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

GetCrownCrateRewardInfo

(luaindex rewardIndex)

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

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

GetDyeInfo

(luaindex dyeIndex)

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

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

GetEULADetails

(EULAType eulaType)

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

GetFastTravelNodeInfo

(luaindex nodeIndex)

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

GetFriendCharacterInfo

(luaindex friendIndex)

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

GetFurnitureCategoryInfo

(integer furnitureCategoryId)

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

GetGameCameraInteractableActionInfo

()

GetGameCameraInteractableInfo

()

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

GetGiftInfo

(id64 giftId)

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

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

(integer guildId, luaindex index)

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

GetGuildHeraldryAttribute

(integer guildId)

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

GetGuildInfo

(integer guildId)

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

GetGuildMemberCharacterInfo

(integer guildId, luaindex memberIndex)

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

GetGuildSpecificItemInfo

(luaindex index)

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

GetHeatDecayInfo

()

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

GetHeldSlots

()

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

GetHelpCategoryInfo

(luaindex helpCategoryIndex)

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

GetHelpId

(luaindex helpCategoryIndex, luaindex helpIndex)

  • # Returns: integer:nilable helpId

GetHelpInfo

(luaindex helpCategoryIndex, luaindex helpIndex)

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

GetHeraldryCustomizationCosts

()

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

GetItemLinkContainerSetInfo

(string itemLink, luaindex containerSetIndex)

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

GetItemLinkOnUseAbilityInfo

(string itemLink)

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

GetItemLinkSetBonusInfo

(string itemLink, bool equipped, luaindex index)

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

GetItemLinkSetInfo

(string itemLink, bool equipped)

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

GetItemLinkStacks

(string itemLink)

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

GetItemLinkTraitOnUseAbilityInfo

(string itemLink, luaindex index)

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

GetItemSetBonusInfo

(integer itemSetId, luaindex index)

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

GetItemSetInfo

(integer itemSetId)

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

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

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

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

GetJournalQuestEnding

(luaindex journalQuestIndex)

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

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

GetKillingAttackerInfo

(luaindex index)

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

GetKillingAttackInfo

(luaindex index)

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

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

(integer rewardUIDataId, luaindex nodeIndex)

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

GetLFGReadyCheckCounts

()

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

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

GetLoreBookInfo

(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)

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

GetLoreCollectionInfo

(luaindex categoryIndex, luaindex collectionIndex)

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

GetMailFlags

(id64 mailId)

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

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

GetMapBlobNameInfo

(luaindex blobIndex)

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

GetMapMouseoverInfo

(number normalizedMouseX, number normalizedMouseY)

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

GetMapPlayerPosition

(string unitTag)

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

GetMarketProductInfo

private (integer marketProductId)

  • # Returns: string name, string description, textureName icon, bool isNew, bool isFeatured

GetMedalInfo

(integer medalId)

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

GetNearestQuestCondition

(integer considerType)

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

GetPendingHeraldryIndices

()

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

GetPOIInfo

(luaindex zoneIndex, luaindex poiIndex)

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

GetPOIMapInfo

(luaindex zoneIndex, luaindex poiIndex)

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

GetPromotionalEventCampaignInfo

(id64 campaignKey)

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

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

GetQuestItemInfo

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

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

GetQuestToolInfo

(luaindex journalQuestIndex, luaindex toolIndex)

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

GetRecipeListInfo

(luaindex recipeListIndex)

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

GetRidingStats

()

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

GetSCTCloudOffset

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

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

(integer skillBuildId, luaindex skillBuildAbilityIndex)

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

GetSkillBuildInfo

(integer skillBuildId)

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

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

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

GetSpecificSkillAbilityInfo

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

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

GetStoreCurrencyTypes

()

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

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

(string stringVariablePrefix, integer contextId)

  • # Returns: string stringValue

GetSynergyInfoAtIndex

(luaindex synergyIndex)

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

GetTextureLayerRevealAnimationWindowEndPoints

(integer animationId)

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

GetTrialInfo

()

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

GetTrialLeaderboardEntryInfo

(integer raidId, luaindex entryIndex)

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

GetTutorialInfo

(luaindex tutorialIndex)

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

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

(string unitTag, luaindex poolIndex)

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

H

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

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

IsEquipable

(Bag bagId, integer slotIndex)

  • # Returns: bool isEquipable, integer resultErrorCodeIfFailed

J

L

M

N

O

P

PickupQuestItem

protected (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

PlainStringFind

(string string, string searchFor)

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

PlayVideo

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

PreviewCraftItem

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

Q

R

ReadLoreBook

(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)

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

RequestScribe

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

S

SetChatContainerColors

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

SetChatContainerTabInfo

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

SetGamepadVibration

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

SetPendingHeraldryIndices

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

SetPendingSlotDyes

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

SetSavedDyeSetDyes

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

SplitString

(string delims, string stringToSplit)

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

T

U

UnbindKeyFromAction

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

UseQuestItem

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

V

W

WouldProcessMapClick

(number normalizedClickX, number normalizedClickY)

  • # Returns: bool wouldProcess, luaindex:nilable resultingMapIndex

Z