Game API Source Order · PTS

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

GetClassName

(Gender gender, integer classId)

# Returns: string className

GetRaceName

(Gender gender, integer raceId)

# Returns: string raceName

GetLocationName

(integer worldId)

# Returns: string worldName

GetGenderFromNameDescriptor

(string nameDescriptor)

# Returns: Gender gender

PlainStringFind

(string string, string searchFor)

# Returns: bool found, integer startIndex, integer endIndex

SplitString

(string delims, string stringToSplit)

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

ComputeStringDistance

(string source, string target, integer maxDistance)

# Returns: integer distance

LocaleAwareToUpper

(string stringToUppercase)

# Returns: string upperCasedString

LocaleAwareToLower

(string stringToLowercase)

# Returns: string lowerCasedString

GetNumDisplays

()

# Returns: integer numDisplays

GetDisplayModes

(luaindex displayIndex)

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

IsPrivateFunction

(string functionName)

# Returns: bool isPrivate

IsProtectedFunction

(string functionName)

# Returns: bool isProtected

Id64ToString

(id64 id)

# Returns: string stringDesc

StringToId64

(string stringId)

# Returns: id64 id

AreId64sEqual

(id64 firstId, id64 secondId)

# Returns: bool areEqual

IsId64EqualToNumber

(id64 id, integer53 number)

# Returns: bool areEqual

CompareId64s

(id64 firstId, id64 secondId)

# Returns: integer result

CompareId64ToNumber

(id64 id, integer53 number)

# Returns: integer result

Id64ToNumber

(id64 id)

# Returns: integer53 number, bool lostPrecisionUseId64ToString

NumberToId64

(integer53 number)

# Returns: id64 id, bool lostPrecisionUseStringToId64

BitAnd

(integer53 valueA, integer53 valueB)

# Returns: integer53 result

BitOr

(integer53 valueA, integer53 valueB)

# Returns: integer53 result

BitXor

(integer53 valueA, integer53 valueB)

# Returns: integer53 result

BitNot

(integer53 value, integer numBits)

# Returns: integer53 result

BitLShift

(integer53 value, integer numBits)

# Returns: integer53 result

BitRShift

(integer53 value, integer numBits)

# Returns: integer53 result

IsInternalBuild

()

# Returns: bool isInternalBuild

SaveLoadDialogResult

(SaveLoadDialogError errorType, SaveLoadDialogAnswer result)

GetFrameTimeSeconds

()

# Returns: number frameTimeInSeconds

GetFrameDeltaTimeSeconds

()

# Returns: number frameDeltaTimeInSeconds

GetFrameDeltaTimeMilliseconds

()

# Returns: integer frameDeltaTimeInMilliseconds

GetDateStringFromTimestamp

(integer timestamp)

# Returns: string dateString

GetFrameDeltaMilliseconds

()

# Returns: integer deltaMilliseconds

GetFrameDeltaSeconds

()

# Returns: number deltaSeconds

GetGameTimeMilliseconds

()

# Returns: integer gameTimeInMilliseconds

GetGameTimeSeconds

()

# Returns: number gameTimeInSeconds

GetFramerate

()

# Returns: number currentFramerate

GetDiffBetweenTimeStamps

(integer53 laterTime, integer53 earlierTime)

# Returns: number difference

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

SetCameraOptionsPreviewModeEnabled

(bool enabled, CameraOptionsPreview option)

GetAvARankName

(Gender gender, integer rank)

# Returns: string rankName

GetAvARankIcon

(integer rank)

# Returns: textureName rankIcon

CalculateCubicBezierEase

(number progress, number x1, number y1, number x2, number y2)

# Returns: number result

GetGamepadIconPathForKeyCode

(KeyCode key, bool disabled)

# Returns: string:nilable gamepadIcon, integer:nilable width, integer:nilable height

GetMouseIconPathForKeyCode

(KeyCode key)

# Returns: string:nilable mouseIcon, integer:nilable width, integer:nilable height

FormatIntegerWithDigitGrouping

(integer number, string delimiter, integer digitGroupSize)

# Returns: string formattedNumber

IsVirtualKeyboardOnScreen

()

# Returns: bool isVirtualKeyboardOnScreen

HashString

(string text)

# Returns: integer hashValue

Set3DRenderSpaceToCurrentCamera

(string controlName)

ComputeDepthAtWhichWorldWidthRendersAsUIWidth

(number worldWidth, number UIWidth)

# Returns: number depth

ComputeDepthAtWhichWorldHeightRendersAsUIHeight

(number worldHeight, number UIHeight)

# Returns: number depth

GetWorldDimensionsOfViewFrustumAtDepth

(number depth)

# Returns: number frustumWidth, number frustumHeight

GetESOVersionString

()

# Returns: string versionString

DoesSystemSupportConsoleEnhancedRenderQuality

(ConsoleEnhancedRenderQuality consoleEnhancedRenderQuality)

# Returns: bool hasSupport

ShouldAllowFullscreenExclusive

()

# Returns: bool shouldAllowFullscreenExclusive

IsGameInWindowedMode

()

# Returns: bool isInWindowedMode

ShouldShowAdvancedUIErrors

()

# Returns: bool shouldShowAdvancedUIErrors

GetESOFullVersionString

()

# Returns: string versionString

IsInUI

(string guiName)

# Returns: bool isInUI

GetStringWidthScaled

(object fontObject, string text, number scale, Space space)

# Returns: number stringWidthScaled

GetTooltipStringForRenderQualitySetting

()

# Returns: string tooltipText

DoesPlatformSupportGraphicSetting

(integer settingId)

# Returns: bool isSettingSupported

DoesPlatformSupportFramerateCapInMenus

()

# Returns: bool isFramerateCapSupported

DoesPlatformSupportScreenDimAndResolutionDrop

()

# Returns: bool isScreenDimAndResolutionDropSupported

DoesPlatformSupportSpatialSound

()

# Returns: bool isSpatialSoundSupported

DoesPlatformSupportSpatialSoundQuality

()

# Returns: bool isSpatialSoundQualitySupported

ZoGetOfficialGameLanguage

()

# Returns: OfficialLanguage language

ZoGetOfficialGameLanguageDescriptor

()

# Returns: string languageDescriptor

ZoIsOfficialLanguageSupported

(OfficialLanguage language)

# Returns: bool isSupported

ZoIsIgnoringPatcherLanguage

()

# Returns: bool isIgnoringPatcherLanguage

BCP47StringForZoOfficialLanguage

(OfficialLanguage language)

# Returns: string languageDescriptor

DeleteSavedVariablesForAddonIndex

(luaindex addOnIndex)

GetTotalUserAddOnMemoryPoolUsageMB

()

# Returns: number totalUserAddOnMemoryPoolCapacityMB

GetTotalUserAddOnMemoryPoolCapacityMB

()

# Returns: number totalUserAddOnMemoryPoolCapacityMB

GetTotalUserAddOnCPUTimeUsedNowMS

()

# Returns: number totalUserAddOnCPUTimeUsedThisFrameMS

GetTotalUserAddOnCPUTimeUsedLastFrameMS

()

# Returns: number totalUserAddOnCPUTimeUsedLastFrameMS

GetTotalUserAddOnCPUTimeAvailableEachFrameMS

()

# Returns: number totalUserAddOnCPUTimeAvailableEachFrameMS

SetSetting

(SettingSystemType system, integer settingId, string value, SetOptions setOptions)

GetSetting

(SettingSystemType system, integer settingId)

# Returns: string value

GetSetting_Bool

(SettingSystemType system, integer settingId)

# Returns: bool value

IsSettingDeferred

(SettingSystemType system, integer settingId)

# Returns: bool isDeferred

IsDeferredSettingLoading

(SettingSystemType system, integer settingId)

# Returns: bool isLoaded

IsDeferredSettingLoaded

(SettingSystemType system, integer settingId)

# Returns: bool isLoaded

RequestLoadDeferredSetting

(SettingSystemType system, integer settingId)

ShouldShowDLSSSetting

()

# Returns: bool shouldShowDLSSSetting

ShouldShowFSRSetting

()

# Returns: bool shouldShowFSRSetting

GetEULADetails

(EULAType eulaType)

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

HasAgreedToEULA

(EULAType eulaType)

# Returns: bool hasAgreed

HasViewedEULA

(EULAType eulaType)

# Returns: bool hasViewed

ShouldShowEULA

(EULAType eulaType)

# Returns: bool shouldShow

OpenURLByType

private (ApprovedURLType urlType)

GetURLTextByType

private (ApprovedURLType urlType)

# Returns: string urlText

ShouldOpenURLTypeInOverlay

private (ApprovedURLType urlType)

# Returns: bool urlOpensInOverlay

OpenChapterUpgradeURL

private (integer chapterId, bool isCollectorsEdition, ChapterUpgradeSource source)

ShowPlatformESOPlusSubscriptionUI

private ()

ShowPlatformESOChapterUpgradeUI

private (integer chapterId, bool isCollectorsEdition, ChapterUpgradeSource source)

ShowPlatformESOVOAdditionalContentUI

private ()

GetPlatformServiceType

()

# Returns: PlatformServiceType platformServiceType

DoesPlatformSupportDisablingShareFeatures

()

# Returns: bool canDisableShareFeatures

DoesPlatformStoreUseExternalLinks

()

# Returns: bool usesExternalLinks

FlashTaskbarWindow

private (string reason, integer flashCount, integer flashRateMs)

GetFrameDeltaNormalizedForTargetFramerate

(number targetFramesPerSecond)

# Returns: number frameDeltaNormalizedForTargetFramerate

GetSecondsSinceMidnight

()

# Returns: integer secondsSinceMidnight

GetFrameTimeMilliseconds

()

# Returns: integer frameTimeInMilliseconds

GetTimeStamp

()

# Returns: integer53 timestamp

GetTimeStamp32

()

# Returns: integer timestamp

GetDate

()

# Returns: integer currentTime

GetTimeString

()

# Returns: string currentTimeString

GetDateElementsFromTimestamp

(integer53 timestamp)

# Returns: integer year, integer month, integer day

GetTimestampForStartOfDate

(integer year, integer month, integer day, bool inLocalTime)

# Returns: integer53 timestamp

GetFormattedTime

()

# Returns: integer formattedTime

GetDayOfTheWeekIndex

(integer53 timestamp)

# Returns: integer weekdayIndex

GetNumDaysInMonth

(integer year, integer month)

# Returns: integer numDays

GetDisplayName

()

# Returns: string displayName

DecorateDisplayName

(string displayName)

# Returns: string decoratedDisplayName

IsDecoratedDisplayName

(string displayName)

# Returns: bool isDecorated

UndecorateDisplayName

(string displayName)

# Returns: string undecoratedDisplayName

DecoratePlatformDisplayName

(string displayName)

# Returns: string decoratedDisplayName

GetNumFriends

()

# Returns: integer numFriends

GetFriendInfo

(luaindex friendIndex)

# Returns: string displayName, string note, PlayerStatus playerStatus, integer secsSinceLogoff

GetFriendCharacterInfo

(luaindex friendIndex)

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

GetNumIgnored

()

# Returns: integer numIgnored

GetIgnoredInfo

(luaindex index)

# Returns: string displayName, string note

IsIgnored

(string charOrDisplayName)

# Returns: bool isIgnored

RequestFriend

(string charOrDisplayName, string message)

SetFriendNote

(luaindex friendIndex, string note)

SetIgnoreNote

(luaindex ignoreIndex, string note)

IsFriend

(string charOrDisplayName)

# Returns: bool isFriend

GetNumIncomingFriendRequests

()

# Returns: integer numRequests

GetIncomingFriendRequestInfo

(luaindex index)

# Returns: string displayName, integer secsSinceRequest, string message

GetNumOutgoingFriendRequests

()

# Returns: integer numRequests

GetOutgoingFriendRequestInfo

(luaindex index)

# Returns: string displayName, integer secsSinceRequest, string note

GetGuildId

(luaindex guildIndex)

# Returns: integer guildId

GetNumGuilds

()

# Returns: integer numGuilds

GetGuildName

(integer guildId)

# Returns: string name

GetGuildDescription

(integer guildId)

# Returns: string description

GetGuildMotD

(integer guildId)

# Returns: string motd

GetGuildFoundedDate

(integer guildId)

# Returns: string foundedDate

GetGuildAlliance

(integer guildId)

# Returns: Alliance alliance

GetNumGuildMembers

(integer guildId)

# Returns: integer numGuildMembers

GetNumGuildInvitees

(integer guildId)

# Returns: integer numGuildInvitees

GetGuildInfo

(integer guildId)

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

IsPlayerInGuild

(integer guildId)

# Returns: bool isInGuild

IsPlayerWearingGuildTabard

()

# Returns: bool isWearingGuildTabard

GetGuildMemberInfo

(integer guildId, luaindex memberIndex)

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

GetGuildMemberCharacterInfo

(integer guildId, luaindex memberIndex)

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

GetGuildInviteeInfo

(integer guildId, luaindex inviteeIndex)

# Returns: string name, luaindex rankIndex

GetGuildMemberIndexFromDisplayName

(integer guildId, string displayName)

# Returns: luaindex:nilable memberIndex

GetPlayerGuildMemberIndex

(integer guildId)

# Returns: luaindex memberIndex

GuildInvite

(integer guildId, string displayName)

# Returns: bool inviteSent

IsValidGuildName

(string guildName)

# Uses variable returns...
# Returns: NamingError violationCode

GuildCreate

(string guildName, Alliance guildAlliance)

GuildRemove

(integer guildId, string displayName)

GuildUninvite

(integer guildId, string displayName)

GuildPromote

(integer guildId, string displayName)

GuildDemote

(integer guildId, string displayName)

GuildSetRank

(integer guildId, string displayName, luaindex rankIndex)

ShouldDisplayGuildMemberRemoveAlert

(string characterName)

# Returns: bool shouldDisplay

ShouldDisplaySelfKickedFromGuildAlert

(integer guildId)

# Returns: bool shouldDisplay

SetGuildDescription

(integer guildId, string description)

SetGuildMotD

(integer guildId, string motd)

DoesGuildRankHavePermission

(integer guildId, luaindex rankIndex, GuildPermission permission)

# Returns: bool hasPermission

DoesPlayerHaveGuildPermission

(integer guildId, GuildPermission permission)

# Returns: bool hasPermission

CanEditGuildRankPermission

(integer rankId, GuildPermission permission)

# Returns: bool hasPermission

DoesGuildHavePrivilege

(integer guildId, GuildPrivilege privilege)

# Returns: bool hasPrivilege

GetNumGuildRanks

(integer guildId)

# Returns: integer numRanks

GetGuildRankIconIndex

(integer guildId, luaindex rankIndex)

# Returns: luaindex iconIndex

GetNumGuildRankIcons

()

# Returns: integer numGuildRankIcons

GetGuildRankSmallIcon

(luaindex iconIndex)

# Returns: textureName icon

GetGuildRankLargeIcon

(luaindex iconIndex)

# Returns: textureName icon

GetGuildRankListHighlightIcon

(luaindex iconIndex)

# Returns: textureName icon

GetGuildRankListUpIcon

(luaindex iconIndex)

# Returns: textureName icon

GetGuildRankListDownIcon

(luaindex iconIndex)

# Returns: textureName icon

GetGuildRankId

(integer guildId, luaindex rankIndex)

# Returns: integer rankId

GetGuildRankIndex

(integer guildId, integer rankId)

# Returns: luaindex:nilable rankIndex

IsGuildRankGuildMaster

(integer guildId, luaindex rankIndex)

# Returns: bool isGuildMaster

IsPlayerGuildMaster

(integer guildId)

# Returns: bool isGuildMaster

AddPendingGuildRank

(integer rankId, string name, integer permissions, luaindex iconIndex)

ComposeGuildRankPermissions

(integer permissions, integer permission, bool enabled)

# Returns: integer newPermissions

SetGuildMemberNote

(integer guildId, luaindex memberIndex, string note)

GetGuildRankCustomName

(integer guildId, luaindex rankIndex)

# Returns: string rankName

GetNumGuildInvites

()

# Returns: integer numGuildInvites

GetGuildInviteInfo

(luaindex index)

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

GetGuildClaimedKeep

(integer guildId)

# Returns: integer claimedKeepId, integer claimedKeepCampaignId

DoesGuildHaveClaimedKeep

(integer guildId)

# Returns: bool hasClaimedKeep

CheckGuildKeepClaim

(integer guildId, integer keepId)

# Returns: integer result

CheckGuildKeepRelease

(integer guildId)

# Returns: integer result

ReleaseInteractionKeepForGuild

()

GetGuildOwnedKioskInfo

(integer guildId)

# Returns: string:nilable ownedKioskName

GetGuildKioskCycleTimes

()

# Returns: integer despawnTimestampS, integer bidEndTimestampS, integer respawnTimestampS

GetGuildSpecificItemInfo

(luaindex index)

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

GetGuildSpecificItemLink

(luaindex index, LinkStyle linkStyle)

# Returns: string link

GetNumGuildPermissionDependencies

(GuildPermission permission)

# Returns: integer numDependencies

GetGuildPermissionDependency

(GuildPermission permission, luaindex index)

# Returns: GuildPermission dependentPermission

GetNumGuildPermissionRequisites

(GuildPermission permission)

# Returns: integer numDependencies

GetGuildPermissionRequisite

(GuildPermission permission, luaindex index)

# Returns: GuildPermission requisitePermission

GetNumGuildMembersRequiredForPrivilege

(GuildPrivilege privilege)

# Returns: integer numGuildMembers

IsGuildMate

(string charOrDisplayName)

# Returns: bool isGuildMate

SetGuildApplicationAttributeValue

(GuildMetaDataAttribute attribute, integer value, bool useValue)

HasGuildRecruitmentDataChanged

(integer guildId)

# Returns: bool dataChanged

GetGuildRecruitmentInfo

(integer guildId)

# Returns: string recruitmentMessage, string headerMessage, GuildRecruitmentStatusAttributeValue recruitmentStatus, GuildFocusAttributeValue primaryFocus, GuildFocusAttributeValue secondaryFocus, GuildPersonalityAttributeValue personality, GuildLanguageAttributeValue language, integer minimumCP

GetGuildRecruitmentStatus

(integer guildId)

# Returns: GuildRecruitmentStatusAttributeValue recruitmentStatus

GetGuildRecruitmentRoleValue

(integer guildId, LFGRole role)

# Returns: bool selected

GetGuildRecruitmentActivityValue

(integer guildId, GuildActivityAttributeValue activity)

# Returns: bool selected

GetGuildRecruitmentStartTime

(integer guildId)

# Returns: integer localStartTimeHours

GetGuildRecruitmentEndTime

(integer guildId)

# Returns: integer localEndTimeHours

SetGuildRecruitmentRecruitmentStatus

(integer guildId, GuildRecruitmentStatusAttributeValue recruitmentStatus)

SetGuildRecruitmentPrimaryFocus

(integer guildId, GuildFocusAttributeValue primaryFocus)

SetGuildRecruitmentSecondaryFocus

(integer guildId, GuildFocusAttributeValue secondaryFocus)

SetGuildRecruitmentRoleValue

(integer guildId, LFGRole role, bool selected)

SetGuildRecruitmentActivityValue

(integer guildId, GuildActivityAttributeValue activity, bool selected)

SetGuildRecruitmentPersonality

(integer guildId, GuildPersonalityAttributeValue personality)

SetGuildRecruitmentLanguage

(integer guildId, GuildLanguageAttributeValue language)

SetGuildRecruitmentMinimumCP

(integer guildId, integer minimumCP)

SetGuildRecruitmentRecruitmentMessage

(integer guildId, string recruitmentMessage)

# Returns: UpdateGuildMetaDataResponse response

SetGuildRecruitmentHeaderMessage

(integer guildId, string headerMessage)

# Returns: UpdateGuildMetaDataResponse response

SetGuildRecruitmentStartTime

(integer guildId, integer startTimeHours)

SetGuildRecruitmentEndTime

(integer guildId, integer endTimeHours)

SaveGuildRecruitmentPendingChanges

(integer guildId)

# Uses variable returns...
# Returns: GuildMetaDataAttribute neededRequiredFields

GetNumGuildBlacklistEntries

(integer guildId)

# Returns: integer numBlacklistEntries

GetGuildBlacklistInfoAt

(integer guildId, luaindex index)

# Returns: string accountName, string note

IsGuildBlacklistAccountNameValid

(integer guildId, string accountName)

# Returns: GuildBlacklistResponse result

AddToGuildBlacklistByDisplayName

(integer guildId, string displayName, string note)

# Returns: GuildBlacklistResponse result

RemoveFromGuildBlacklist

(integer guildId, luaindex index)

# Returns: GuildBlacklistResponse result

SetGuildBlacklistNote

(integer guildId, luaindex index, string note)

# Returns: GuildBlacklistResponse result

GetGuildRecruitmentLink

(integer guildId, LinkStyle linkStyle)

# Returns: string link

DoesGuildHaveNewApplicationsNotification

(integer guildId)

# Returns: bool doesHaveNotification

ClearGuildHasNewApplicationsNotification

(integer guildId)

SetGamepadVibration

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

GetGamepadLeftStickX

(bool includeDeadzone)

# Returns: number x

GetGamepadLeftStickY

(bool includeDeadzone)

# Returns: number y

GetGamepadLeftStickDeltaX

(bool includeDeadzone)

# Returns: number deltaX

GetGamepadLeftStickDeltaY

(bool includeDeadzone)

# Returns: number deltaY

GetGamepadRightStickX

(bool includeDeadzone)

# Returns: number x

GetGamepadRightStickY

(bool includeDeadzone)

# Returns: number y

GetGamepadRightStickDeltaX

(bool includeDeadzone)

# Returns: number deltaX

GetGamepadRightStickDeltaY

(bool includeDeadzone)

# Returns: number deltaY

GetGamepadLeftTriggerMagnitude

()

# Returns: number magnitude

GetGamepadRightTriggerMagnitude

()

# Returns: number magnitude

SetGamepadLeftStickConsumedByUI

(bool consumed)

SetGamepadRightStickConsumedByUI

(bool consumed)

WasGamepadLeftStickConsumedByOverlay

()

# Returns: bool consumed

GetGamepadTouchpadX

()

# Returns: number gamepadTouchpadX

GetGamepadTouchpadY

()

# Returns: number gamepadTouchpadY

IsGamepadTouchpadActive

()

# Returns: bool gamepadTouchpadActive

GetGamepadType

()

# Returns: GamepadType gamepadType

GetMostRecentGamepadType

()

# Returns: GamepadType mostRecentGamepadType

GetGamepadVisualReferenceArt

()

# Returns: string referenceArt

GetGamepadLeftStickSlideAndScrollIcon

()

# Returns: string icon

GetGamepadRightStickScrollIcon

()

# Returns: string icon

GetGamepadBothDpadDownAndRightStickScrollIcon

()

# Returns: string icon

GetKeyboardIconPathForKeyCode

(KeyCode key, bool disabled)

# Returns: string:nilable keyboardIcon, integer:nilable width, integer:nilable height

IsMouseWithinClientArea

()

# Returns: bool insideClient

IsKeyboardUISupported

()

# Returns: bool isKeyboardUISupported

IsGamepadUISupported

()

# Returns: bool isGamepadUISupported

DoesPlatformAllowConfiguringAutomaticInputChanging

()

# Returns: bool doesPlatformAllowConfiguringAutomaticInputChanging

IsInGamepadPreferredMode

()

# Returns: bool inGamepadPreferredMode

IsGameCoreUI

()

# Returns: bool isGameCoreUI

WasLastInputGamepad

()

# Returns: bool lastInputWasGamepad

AreKeyboardBindingsSupportedInGamepadUI

()

# Returns: bool keyboardBindingsSupported

IsKeyCodeGamepadKey

(KeyCode key)

# Returns: bool isGamepadKey

IsKeyCodeMouseKey

(KeyCode key)

# Returns: bool isMouseKey

IsKeyCodeArrowKey

(KeyCode key)

# Returns: bool isArrowKey

IsKeyCodeKeyboardKey

(KeyCode key)

# Returns: bool isKeyboardKey

IsKeyCodeChordKey

(KeyCode key)

# Returns: bool isKeyChord

IsKeyCodeHoldKey

(KeyCode key)

# Returns: bool isKeyHold

IsKeyDown

private (KeyCode key)

# Returns: bool isKeyDown

ConvertKeyPressToHold

(KeyCode key)

# Returns: KeyCode holdKey

ConvertHoldKeyPressToNonHold

(KeyCode holdKey)

# Returns: KeyCode key

GetKeyChordsFromSingleKey

(KeyCode key)

# Uses variable returns...
# Returns: KeyCode keyChord

HasActiveEditControl

()

# Returns: bool hasActiveEditControl

GetUIPlatform

()

# Returns: UIPlatform platform

SetOverscanOffsets

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

GetOverscanOffsets

()

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

IsGUIResizing

()

# Returns: bool isGUIResizing

GetGamepadOrKeyboardLeftStickX

(bool includeDeadzone)

# Returns: number GamepadOrKeyboardX

GetGamepadOrKeyboardLeftStickY

(bool includeDeadzone)

# Returns: number GamepadOrKeyboardY

GetGamepadOrKeyboardRightStickX

(bool includeDeadzone)

# Returns: number GamepadOrKeyboardX

GetGamepadOrKeyboardRightStickY

(bool includeDeadzone)

# Returns: number GamepadOrKeyboardY

ShouldWarnConsoleAddOnMemoryLimit

()

# Returns: bool warnConsoleAddOnMemoryLimit

ShouldWarnConsoleAddOnSavedVariableLimit

()

# Returns: bool warnConsoleAddOnSavedVariableLimit

ClearWarnConsoleAddOnMemoryLimit

()

ClearWarnConsoleAddOnSavedVariableLimit

()

AreUserAddOnsSupported

()

# Returns: bool areUserAddOnsSupported

ShouldKeyCodeUseKeyMarkup

(KeyCode keyCode)

# Returns: bool shouldUseKeyMarkup

UpdatePlayerPresenceInformation

private ()

MakeRemoteSceneRequest

(SceneManagerMessageOrigin messageOrigin, RemoteSceneRequestType requestType, string sceneName)

(SceneManagerMessageOrigin messageOrigin, RemoteSceneSyncType syncType, string currentSceneName, string nextSceneName, integer sequenceNumber, bool currentSceneFragmentsComplete)

ChangeRemoteTopLevel

(SceneManagerMessageOrigin messageOrigin, RemoteSceneRequestType requestType)

NotifyThatFollowerFinishedFragmentTransition

(SceneManagerMessageOrigin messageOrigin, string sceneName, integer sequenceNumber)

GetOrCreateSynchronizingObject

(string name)

# Returns: object synchronizingObject

IsValidName

(string name)

# Returns: bool isValid

GetKeyName

(KeyCode keyCode)

# Returns: string keyName

GetKeyboardLayout

()

# Returns: string keyboardLayout

GetKeyNarrationText

(KeyCode keyCode)

# Returns: string keyName

GetDigitGroupingSize

()

# Returns: integer digitGroupingSize

AbbreviateNumber

(integer number, NumberAbbreviationPrecision precision, bool useUppercaseSuffix)

# Returns: number abbreviatedValue, string suffix

IsCountSingularForm

(integer number)

# Returns: bool isSingular

FormatFloatRelevantFraction

(number num)

# Returns: string formattedString

IsESOPlusSubscriber

()

# Returns: bool isESOPlusSubscriber

IsCommunicationRestrictedAccount

()

# Returns: bool isCommunicationRestrictedAccount

GetCurrentChapterUpgradeId

()

# Returns: integer chapterUpgradeId

GetChapterCollectibleId

(integer chapterUpgradeId)

# Returns: integer collectibleId

IsChapterOwned

(integer chapterUpgradeId)

# Returns: bool isChapterOwned

GetTrialInfo

()

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

GetPlayerMarketCurrency

(MarketCurrencyType type)

# Returns: integer currencyAmount

OnMarketPurchaseMoreCrowns

private ()

IsChromaSystemAvailable

()

# Returns: bool systemAvailable

ChromaClearKeyboardEffect

()

ChromaClearKeypadEffect

()

ChromaClearMouseEffect

()

ChromaClearMousepadEffect

()

ChromaClearHeadsetEffect

()

ChromaCreateKeyboardStaticEffect

(number red, number green, number blue)

ChromaCreateKeypadStaticEffect

(number red, number green, number blue)

ChromaCreateMouseStaticEffect

(number red, number green, number blue)

ChromaCreateMousepadStaticEffect

(number red, number green, number blue)

ChromaCreateHeadsetStaticEffect

(number red, number green, number blue)

ChromaCreateKeyboardBreathingEffect

(ChromaKeyboardBreathingEffectType breathingType, number red1, number green1, number blue1, number red2, number green2, number blue2)

ChromaCreateKeypadBreathingEffect

(ChromaKeypadBreathingEffectType breathingType, number red1, number green1, number blue1, number red2, number green2, number blue2)

ChromaCreateMouseBreathingEffect

(ChromaMouseBreathingEffectType breathingType, number red1, number green1, number blue1, number red2, number green2, number blue2)

ChromaCreateMousepadBreathingEffect

(ChromaMousepadBreathingEffectType breathingType, number red1, number green1, number blue1, number red2, number green2, number blue2)

ChromaCreateHeadsetBreathingEffect

(number red, number green, number blue)

ChromaCreateKeyboardWaveEffect

(ChromaKeyboardWaveEffectDirection waveDirection)

ChromaCreateKeypadWaveEffect

(ChromaKeypadWaveEffectDirection waveDirection)

ChromaCreateMouseWaveEffect

(ChromaMouseWaveEffectDirection waveDirection)

ChromaCreateMousepadWaveEffect

(ChromaMousepadWaveEffectDirection waveDirection)

ChromaCreateKeyboardReactiveEffect

(ChromaKeyboardReactiveEffectDuration reactionDuration, number red, number green, number blue)

ChromaCreateKeypadReactiveEffect

(ChromaKeypadReactiveEffectDuration reactionDuration, number red, number green, number blue)

ChromaCreateMouseReactiveEffect

(ChromaMouseReactiveEffectDuration reactionDuration, number red, number green, number blue)

ChromaCreateKeyboardSpectrumCyclingEffect

()

ChromaCreateKeypadSpectrumCyclingEffect

()

ChromaCreateMouseSpectrumCyclingEffect

()

ChromaCreateMousepadSpectrumCyclingEffect

()

ChromaResetCustomEffectObject

(ChromaDeviceType deviceType)

ChromaApplyCustomEffectFullColor

(ChromaDeviceType deviceType, number red, number green, number blue, number alpha, ChromaBlendMode blendMode)

ChromaApplyCustomEffectRowColor

(ChromaDeviceType deviceType, luaindex rowIndex, number red, number green, number blue, number alpha, ChromaBlendMode blendMode)

ChromaApplyCustomEffectColumnColor

(ChromaDeviceType deviceType, luaindex columnIndex, number red, number green, number blue, number alpha, ChromaBlendMode blendMode)

ChromaApplyCustomEffectCellColor

(ChromaDeviceType deviceType, luaindex rowIndex, luaindex columnIndex, number red, number green, number blue, number alpha, ChromaBlendMode blendMode)

ChromaApplyCustomEffectId

(integer effectId)

ChromaGetCustomEffectCellColor

(ChromaDeviceType deviceType, luaindex rowIndex, luaindex columnIndex)

# Returns: number red, number green, number blue

ChromaGetCustomEffectDimensions

(ChromaDeviceType deviceType)

# Returns: integer numRows, integer numColumn

ChromaFinalizeCustomEffect

(ChromaDeviceType deviceType)

GetChromaKeyboardKeyByZoGuiKey

(KeyCode zoGuiKeyCode)

# Returns: ChromaKeyboardKey chromaKeyboardKey

GetChromaKeyboardCellByChromaKeyboardKey

(ChromaKeyboardKey chromaKeyboardKey)

# Returns: luaindex rowIndex, luaindex columnIndex

GetChromaMouseCellByLED

(ChromaMouseLED2 ledId)

# Returns: luaindex rowIndex, luaindex columnIndex

GetChromaMousepadCellByLED

(ChromaMousepadLED ledId)

# Returns: luaindex rowIndex, luaindex columnIndex

ChromaGenerateCustomEffect

(ChromaDeviceType deviceType, ChromaCustomEffectType customEffectType, ChromaCustomEffectGridStyle gridStyle)

# Returns: integer effectId

ChromaDeleteCustomEffectById

(integer effectId)

ChromaDeleteAllCustomEffectIds

()

ChromaSetCustomEffectCellActive

(integer effectId, luaindex rowIndex, luaindex columnIndex, bool isActive)

ChromaSetCustomEffectSingleColorRGBA

(integer effectId, number red, number green, number blue, number alpha)

ChromaSetCustomEffectSingleColorBlendMode

(integer effectId, ChromaBlendMode blendMode)

ChromaSetCustomSingleColorFadingEffectValue

(integer effectId, number fadeValue)

ChromaSetCustomSingleColorFadingEffectUsesAlphaChannel

(integer effectId, bool useAlphaChannel)

CreateBackgroundListFilter

(BackgroundListFilterTarget target, string searchText)

# Returns: integer taskId

AddBackgroundListFilterType

(integer taskId, BackgroundListFilterType filterType)

AddBackgroundListFilterEntry

(integer taskId, integer value1, integer value2, integer value3, integer value4)

AddBackgroundListFilterEntry64

(integer taskId, id64 value)

StartBackgroundListFilter

(integer taskId)

DestroyBackgroundListFilter

(integer taskId)

GetNumBackgroundListFilterResults

(integer taskId)

# Returns: integer numResults

GetBackgroundListFilterResult

(integer taskId, luaindex resultIndex)

# Returns: integer value1, integer value2, integer value3, integer value4

GetBackgroundListFilterResult64

(integer taskId, luaindex resultIndex)

# Returns: id64 value

PlayVideo

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

PlayVideoById

(integer videoDataId, bool playImmediately, VideoSkipMode skipMode)

IsAnyVideoPlaying

()

# Returns: bool isPlaying

AbortVideoPlayback

()

CancelCurrentVideoPlayback

()

SetVideoCancelAllOnCancelAny

(bool cancelAll)

ResetVideoCancelConfirmation

()

SetCurrentVideoPlaybackVolume

(number volume, number lerpTime)

GetOpeningCinematicVideoDataId

()

# Returns: integer openingCinematicVideoDataId

GetCollectibleName

(integer collectibleId)

# Returns: string name

GetCollectibleCategoryNameByCollectibleId

(integer collectibleId)

# Returns: string categoryName

IsCollectiblePurchasable

(integer collectibleId)

# Returns: bool isPurchasable

GetPurchasableCollectibleIdForCollectible

(integer collectibleId)

# Returns: integer purchasableCollectibleId

GetNumServiceTokens

(ServiceTokenType tokenType)

# Returns: integer numTokens

GetServiceTokenDescription

(ServiceTokenType tokenType)

# Returns: string tokenDescription

GetNumOwnedCharacterSlots

()

# Returns: integer numOwnedCharacterSlots

SetOverrideMusicMode

(OverrideMusicMode overrideMusicMode)

GetOverrideMusicMode

()

# Returns: OverrideMusicMode overrideMusicMode

AddPendingNarrationText

(string text)

AddPartialPendingNarrationText

(string text)

FinalizePartialPendingNarrationText

(integer pauseBetweenTextMs)

RequestReadPendingNarrationTextToClient

(ScreenReaderNarrationType narrationType)

RequestReadTextChatToClient

(string text)

ClearNarrationQueue

(ScreenReaderNarrationType narrationType)

ClearAllNarrationQueues

()

ClearActiveNarration

()

SetTextChatNarrationQueueEnabled

(bool enabled)

SetCenterScreenAnnounceNarrationQueueEnabled

(bool enabled)

ToggleShowIngameGui

()

GetNumPlayerStatuses

()

# Returns: integer numStatuses

GetCriticalStrikeChance

(number statValue)

# Returns: number chance

DoesGameHaveFocus

()

# Returns: bool hasFocus

IsPlayerActivated

()

# Returns: bool activated

GetSecondsPlayed

()

# Returns: integer secondsPlayed

GetLatency

()

# Returns: integer latencyMS

PlaceInTradeWindow

protected (luaindex:nilable tradeIndex)

PlaceInUnitFrame

protected (string target)

ConvertMouseButtonToKeyCode

(MouseButtonIndex mouseButton)

# Returns: KeyCode key

ResetAllBindsToDefault

()

ResetKeyboardBindsToDefault

()

ResetGamepadBindsToDefault

()

ClearBindsForUnknownActions

()

ResetGamepadDeadzonesToDefault

()

DoesUnitExist

(string unitTag)

# Returns: bool exists

GetRawUnitName

(string unitTag)

# Returns: string rawName

GetUnitDisplayName

(string unitTag)

# Returns: string displayName

GetUnitGender

(string unitTag)

# Returns: Gender gender

GetUnitNameHighlightedByReticle

()

# Returns: string name

GetUnitClass

(string unitTag)

# Returns: string className

GetUnitClassId

(string unitTag)

# Returns: integer classId

GetUnitChampionPoints

(string unitTag)

# Returns: integer championPoints

GetUnitEffectiveChampionPoints

(string unitTag)

# Returns: integer championPoints

CanUnitGainChampionPoints

(string unitTag)

# Returns: bool canGainChampionPoints

GetUnitEffectiveLevel

(string unitTag)

# Returns: integer level

GetUnitZone

(string unitTag)

# Returns: string zoneName

GetUnitWorldPosition

(string unitTag)

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

GetUnitRawWorldPosition

(string unitTag)

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

IsUnitWorldMapPositionBreadcrumbed

(string unitTag)

# Returns: bool isBreadcrumb

GetUnitXP

(string unitTag)

# Returns: integer exp

GetUnitXPMax

(string unitTag)

# Returns: integer maxExp

IsUnitChampion

(string unitTag)

# Returns: bool isChampion

IsUnitUsingVeteranDifficulty

(string unitTag)

# Returns: bool isVeteranDifficulty

GetPlayerCurseType

()

# Returns: CurseType curseType

GetPlayerChampionXP

()

# Returns: integer championExp

GetPlayerChampionPointsEarned

()

# Returns: integer points

IsUnitBattleLeveled

(string unitTag)

# Returns: bool isBattleLeveled

IsUnitChampionBattleLeveled

(string unitTag)

# Returns: bool isChampBattleLeveled

GetUnitBattleLevel

(string unitTag)

# Returns: integer battleLevel

GetUnitChampionBattleLevel

(string unitTag)

# Returns: integer champBattleLevel

GetUnitDrownTime

(string unitTag)

# Returns: number startTime, number endTime

GetUnitEquipmentBonusRatingRelativeToLevel

(string unitTag, number rawEquipmentBonusRating)

# Returns: number relativeEquipmentBonusRating

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

IsGroupMemberInSameWorldAsPlayer

(string unitTag)

# Returns: bool isInSameWorld

IsGroupMemberInSameInstanceAsPlayer

(string unitTag)

# Returns: bool isInSameInstance

IsGroupMemberInSameLayerAsPlayer

(string unitTag)

# Returns: bool isInSameLayer

IsUnitSoloOrGroupLeader

(string unitTag)

# Returns: bool isSoloOrGroupLeader

GetGroupLeaderUnitTag

()

# Returns: string leaderUnitTag

IsUnitFriend

(string unitTag)

# Returns: bool isOnFriendList

IsUnitIgnored

(string unitTag)

# Returns: bool isIgnored

IsUnitPlayer

(string unitTag)

# Returns: bool isPlayer

IsUnitPvPFlagged

(string unitTag)

# Returns: bool isPvPFlagged

IsUnitAttackable

(string unitTag)

# Returns: bool attackable

IsUnitJusticeGuard

(string unitTag)

# Returns: bool isJusticeGuard

IsUnitInvulnerableGuard

(string unitTag)

# Returns: bool isInvulnerableGuard

IsUnitLivestock

(string unitTag)

# Returns: bool isLivestock

GetUnitAlliance

(string unitTag)

# Returns: integer alliance

AreUnitsCurrentlyAllied

(string unitTag1, string unitTag2)

# Returns: bool allied

GetUnitBattlegroundTeam

(string unitTag)

# Returns: BattlegroundTeam battlegroundTeam

GetUnitAdventureZoneFaction

(string unitTag)

# Returns: AdventureZoneFaction adventureZoneFaction

GetUnitRace

(string unitTag)

# Returns: string race

GetUnitRaceId

(string unitTag)

# Returns: integer raceId

IsUnitFriendlyFollower

(string unitTag)

# Returns: bool isFollowing

GetUnitReaction

(string unitTag)

# Returns: UnitReactionType unitReaction

GetUnitAvARankPoints

(string unitTag)

# Returns: integer AvARankPoints

GetUnitAvARank

(string unitTag)

# Returns: integer rank, integer subRank

GetLargeAvARankIcon

(integer rank)

# Returns: textureName largeRankIcon

GetAvARankProgress

(integer currentRankPoints)

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

GetNumPointsNeededForAvARank

(integer rank)

# Returns: integer numPointsRequired

GetUnitReactionColor

(string unitTag)

# Returns: number red, number green, number blue

GetUnitReactionColorType

(string unitTag)

# Returns: UnitReactionColor reactionColorType

IsUnitInCombat

(string unitTag)

# Returns: bool isInCombat

IsUnitActivelyEngaged

(string unitTag)

# Returns: bool isActivelyEngaged

IsUnitDead

(string unitTag)

# Returns: bool isDead

IsUnitReincarnating

(string unitTag)

# Returns: bool isReincarnating

IsUnitDeadOrReincarnating

(string unitTag)

# Returns: bool isDead

IsUnitSwimming

(string unitTag)

# Returns: bool isSwimming

IsUnitFalling

(string unitTag)

# Returns: bool isFalling

IsUnitInAir

(string unitTag)

# Returns: bool isInAir

IsUnitResurrectableByPlayer

(string unitTag)

# Returns: bool isResurrectable

IsUnitBeingResurrected

(string unitTag)

# Returns: bool isBeingResurrected

DoesUnitHaveResurrectPending

(string unitTag)

# Returns: bool hasResurrectPending

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

IsUnitInDungeon

(string unitTag)

# Returns: bool isInDungeon

IsUnitGuildKiosk

(string unitTag)

# Returns: bool isGuildKiosk

GetUnitGuildKioskOwner

(string unitTag)

# Returns: integer ownerGuildId

GetUnitCaption

(string unitTag)

# Returns: string caption

GetUnitSilhouetteTexture

(string unitTag)

# Returns: string icon

GetRaceAndGenderSilhouetteTexture

(integer raceDefId, Gender gender)

# Returns: string icon

GetUnitPowerInfo

(string unitTag, luaindex poolIndex)

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

GetUnitPower

(string unitTag, CombatMechanicFlags powerType)

# Returns: integer current, integer max, integer effectiveMax

GetUnitBankAccessBag

(string unitTag)

# Returns: Bag:nilable bankBag

GetUnitTargetMarkerType

(string unitTag)

# Returns: TargetMarkerType targetMarkerType

GetCurrentCharacterId

()

# Returns: string id

GetPlayerStat

(DerivedStats derivedStat, StatBonusOption statBonusOption)

# Returns: integer value

GetAllUnitAttributeVisualizerEffectInfo

(string unitTag)

# Uses variable returns...
# Returns: UnitAttributeVisual unitAttributeVisual, DerivedStats statType, Attributes attributeType, CombatMechanicFlags powerType, number value, number maxValue

GetUnitAttributeVisualizerEffectInfo

(string unitTag, UnitAttributeVisual unitAttributeVisual, DerivedStats statType, Attributes attributeType, CombatMechanicFlags powerType)

# Returns: number:nilable value, number:nilable maxValue, integer:nilable sequenceId

GetUnitDifficulty

(string unitTag)

# Returns: UIMonsterDifficulty difficult

GetUnitTitle

(string unitTag)

# Returns: string title

CancelCast

()

# Returns: bool cancelled

IsTargetSameAsLastValidTarget

()

# Returns: bool same

TogglePlayerWield

()

IsPlayerMoving

()

# Returns: bool moving

IsPlayerGroundTargeting

()

# Returns: bool isGroundTargeting

IsPlayerEmoteOverridden

(integer emoteId)

# Returns: bool isOverridden

GetGroundTargetingError

()

# Returns: integer:nilable error

GetPlayerCameraHeading

()

# Returns: number heading

GetPlayerWorldPositionInHouse

()

# Returns: integer worldX, integer worldY, integer worldZ, number rotationRadians

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

GetNumBuffs

(string unitTag)

# Returns: integer numBuffs

GetUnitActiveMundusStoneBuffIndices

(string unitTag)

# Uses variable returns...
# Returns: luaindex mundusStoneBuffIndex

GroupInvite

(string unitTag)

GroupKick

(string unitTag)

GroupPromote

(string unitTag)

CancelBuff

(integer buffIndex)

GetWeaponSwapUnlockedLevel

()

# Returns: integer level

GetSlotAbilityCost

(luaindex actionSlotIndex, CombatMechanicFlags mechanicType, HotBarCategory:nilable hotbarCategory)

# Returns: integer abilityCost

GetSlotTexture

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: string texture, string weapontexture, string activationAnimation

GetSlotName

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: string name

GetSlotItemDisplayQuality

(luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: ItemDisplayQuality:nilable displayQuality

GetSlotCooldownInfo

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: integer remain, integer duration, bool global, ActionBarSlotType globalSlotType

IsSlotUsed

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool used

IsSlotUsable

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool useable

OnSlotDownAndUp

private (luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

OnSlotDown

private (luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

OnSlotUp

private (luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

OnSpecialMoveKeyPressed

private (SpecialMove moveIndex)

OnSpecialMoveKeyDown

private (SpecialMove moveIndex)

OnSpecialMoveKeyUp

private (SpecialMove moveIndex)

GetSlotItemCount

(luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: integer:nilable count

GetSlotItemSound

(luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: integer itemSoundCategory

IsSlotItemConsumable

(luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: bool consumable

DoesInventoryContainEmptySoulGem

()

# Returns: bool hasEmptyGem

IsSlotSoulTrap

(luaindex actionSlotIndex)

# Returns: bool isSoulTrap

GetNumAbilities

()

# Returns: integer num

GetAbilityInfoByIndex

(luaindex abilityIndex)

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

IsValidAbilityForSlot

(luaindex abilityIndex, luaindex actionSlotIndex)

# Returns: bool isValid

IsValidCraftedAbilityForSlot

(integer craftedAbilityId, luaindex actionSlotIndex)

# Returns: bool isValid

IsValidItemForSlot

(Bag bagId, integer bagSlotIndex, luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: bool isValid

IsValidItemForSlotByItemId

(integer itemId, luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: bool valid

IsValidCollectibleForSlot

(integer collectibleId, luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: bool valid

IsValidQuestItemForSlot

(integer questItemId, luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: bool valid

IsValidEmoteForSlot

(integer emoteId, luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: bool valid

IsValidQuickChatForSlot

(integer quickChatId, luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: bool valid

CompleteQuest

()

AbandonQuest

(luaindex journalQuestIndex)

GetIsQuestSharable

(luaindex journalQuestIndex)

# Returns: bool isSharable

ShareQuest

(luaindex journalQuestIndex)

GetJournalQuestStepInfo

(luaindex journalQuestIndex, luaindex stepIndex)

# Returns: string journalText, QuestStepVisibility:nilable visibility, QuestStepComparisonType comparisonType, string trackerOverrideText, integer numConditions

GetJournalQuestLocationInfo

(luaindex journalQuestIndex)

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

GetJournalQuestEnding

(luaindex journalQuestIndex)

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

GetJournalQuestNumConditions

(luaindex journalQuestIndex, luaindex stepIndex)

# Returns: integer conditionCount

RequestJournalQuestConditionAssistance

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

# Returns: integer:nilable taskId

GetNearestQuestCondition

(integer considerType)

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

GetJournalQuestTimerInfo

(luaindex journalQuestIndex)

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

GetJournalQuestTimerCaption

(luaindex journalQuestIndex)

# Returns: string caption

GetJournalQuestNumSteps

(luaindex journalQuestIndex)

# Returns: integer numSteps

GetQuestToolCount

(luaindex journalQuestIndex)

# Returns: integer toolCount

SendChatMessage

private (string message, ChannelType channelId, string target)

MoveForwardStart

private ()

MoveForwardStop

private ()

MoveBackwardStart

private ()

MoveBackwardStop

private ()

StopAllMovement

()

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

()

CameraZoomOut

()

ToggleAutoRun

private ()

RollDodgeStart

private ()

RollDodgeStop

private ()

PrepareAttack

private ()

PerformAttack

private ()

StartBlock

private ()

StopBlock

private ()

ToggleGameCameraPadlockTarget

private ()

PerformInterrupt

private ()

StartCommandPet

private ()

StopCommandPet

private ()

GameCameraGamepadZoomDown

private ()

GameCameraGamepadZoomUp

private ()

EndInteraction

(integer interactionType)

GetChatterGreeting

()

# Returns: string optionString

GetChatterData

()

# Returns: string text, integer numOptions, bool atGreeting

GetMaxBags

()

# Returns: integer maxBags

GetItemInstanceId

(Bag bagId, integer slotIndex)

# Returns: integer:nilable id

GetItemTotalCount

(Bag bagId, integer slotIndex)

# Returns: integer count

IsItemConsumable

(Bag bagId, integer slotIndex)

# Returns: bool consumable

GetQuestToolLink

(luaindex aQuestIndex, luaindex aToolIndex, LinkStyle linkStyle)

# Returns: string link

GetQuestItemLink

(luaindex aQuestIndex, luaindex aStepIndex, luaindex aConditionIndex, LinkStyle linkStyle)

# Returns: string link

GetQuestItemNameFromLink

(string link)

# Returns: string name

GetItemName

(Bag bagId, integer slotIndex)

# Returns: string name

IsItemUsable

(Bag bagId, integer slotIndex)

# Returns: bool usable, bool usableOnlyFromActionSlot

GetSlotStackSize

(Bag bagId, integer slotIndex)

# Returns: integer stack, integer maxStack

GetEquippedItemInfo

(EquipSlot equipSlot)

# Returns: string icon, bool slotHasItem, integer sellPrice, bool isHeldSlot, bool isHeldNow, bool locked

GetHeldSlots

()

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

IsEquipable

(Bag bagId, integer slotIndex)

# Returns: bool isEquipable, integer resultErrorCodeIfFailed

GetItemLinkInfo

(string itemLink)

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

IsBankUpgradeAvailable

()

# Returns: bool isAvailable

GetFirstFreeValidSlotForItem

(Bag bagId, integer slotIndex, HotBarCategory hotbarCategory)

# Returns: luaindex:nilable freeSlot

GetFirstFreeValidSlotForSimpleAction

(ActionBarSlotType actionType, integer actionId, HotBarCategory:nilable hotbarCategory)

# Returns: luaindex:nilable emptyActionSlotIndex

FindActionSlotMatchingItem

(Bag bagId, integer slotIndex, HotBarCategory hotbarCategory)

# Returns: luaindex:nilable currentSlot

FindActionSlotMatchingSimpleAction

(ActionBarSlotType actionType, integer actionId, HotBarCategory:nilable hotbarCategory)

# Returns: luaindex:nilable currentActionSlotIndex

GetItemSoundCategoryFromLink

(string link)

# Returns: integer itemSoundCategory

GetSelectedGuildBankId

()

# Returns: integer:nilable guildId

GetMapPlayerPosition

(string unitTag)

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

GetMapPing

(string unitTag)

# Returns: number normalizedX, number normalizedY

GetMapRallyPoint

()

# Returns: number normalizedX, number normalizedY

GetMapPlayerWaypoint

()

# Returns: number normalizedX, number normalizedY

GetNumKeepTravelNetworkNodes

(BattlegroundQueryContextType bgContext)

# Returns: integer numNodes

GetNumKeepTravelNetworkLinks

(BattlegroundQueryContextType bgContext)

# Returns: integer numLinks

GetKeepTravelNetworkNodeInfo

(luaindex nodeIndex, BattlegroundQueryContextType bgContext)

# Returns: integer keepId, bool accessible, number normalizedX, number normalizedY

GetKeepTravelNetworkNodeKeepId

(luaindex nodeIndex, BattlegroundQueryContextType bgContext)

# Returns: integer keepId

GetKeepTravelNetworkNodePosition

(luaindex nodeIndex, BattlegroundQueryContextType bgContext)

# Returns: number normalizedX, number normalizedY

GetKeepTravelNetworkLinkInfo

(luaindex linkIndex, BattlegroundQueryContextType bgContext)

# Returns: integer linkType, integer linkOwner, integer restricedToAlliance, number startX, number startY, number endX, number endY

GetKeepTravelNetworkLinkEndpoints

(luaindex linkIndex, BattlegroundQueryContextType bgContext)

# Returns: luaindex keepAIndex, luaindex keepBIndex

GetKeepAccessible

(integer keepId, BattlegroundQueryContextType bgContext)

# Returns: bool accessible

GetKeepHasResourcesForTravel

(integer keepId, BattlegroundQueryContextType bgContext)

# Returns: bool hasResources

GetKeepFastTravelInteraction

()

# Returns: integer:nilable startKeepId

GetNumLootItems

()

# Returns: integer count

GetNumKeepResourceTypes

()

# Returns: integer numTypes

GetNumKeepUpgradePaths

()

# Returns: integer numPaths

GetNumUpgradesForKeepAtResourceLevel

(integer keepId, BattlegroundQueryContextType battlegroundContext, KeepResourceType resourceType, integer level)

# Returns: integer numUpgrades

GetKeepUpgradeDetails

(integer keepId, BattlegroundQueryContextType battlegroundContext, KeepResourceType resourceType, integer level, luaindex index)

# Returns: string upgradeName, string upgradeDetails, textureName upgradeIcon, bool active

GetKeepUpgradeLineFromResourceType

(KeepResourceType resourceType)

# Returns: KeepUpgradeLine upgradeLine

GetKeepUpgradeLineFromUpgradePath

(KeepUpgradePath upgradePath)

# Returns: KeepUpgradeLine upgradeLine

GetNumUpgradesForKeepAtPathLevel

(integer keepId, BattlegroundQueryContextType battlegroundContext, KeepUpgradePath upgradePath, integer level)

# Returns: integer numUpgrades

GetKeepUpgradePathDetails

(integer keepId, BattlegroundQueryContextType battlegroundContext, KeepUpgradePath upgradePath, integer level, luaindex index)

# Returns: string upgradeName, string upgradeDetails, textureName icon, bool active

CanRespawnAtKeep

(integer keepId)

# Returns: bool canRespawn

GetIsTracked

(TrackedDataType trackType, integer param1, integer param2)

# Returns: bool tracked

GetTrackingLevel

(TrackedDataType trackType, integer param1, integer param2)

# Returns: TrackingLevel trackingLevel

SetTracked

(TrackedDataType trackType, bool tracked, integer param1, integer param2)

# Returns: bool success

CanTrack

(TrackedDataType trackType, integer param1, integer param2)

# Returns: bool canTrack

GetTrackedByIndex

(luaindex index)

# Returns: TrackedDataType trackType, integer param1, integer param2

GetTrackedIsAssisted

(TrackedDataType trackType, integer param1, integer param2)

# Returns: bool assisted

SetTrackedIsAssisted

(TrackedDataType trackType, bool assisted, integer param1, integer param2)

AddMapPin

(MapDisplayPinType pinType, integer param1, integer param2, integer param3)

SetMapPinAssisted

(MapDisplayPinType pinType, bool assisted, integer param1, integer param2, integer param3)

SetMapPinContinuousPositionUpdate

(MapDisplayPinType pinType, bool continuousUpdate, integer param1, integer param2, integer param3)

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

IsPlayerEscortingRam

()

# Returns: bool isPlayerEscorting

GetNumPlayersEscortingRam

()

# Returns: integer numPlayersEscorting

GetMinMaxRamEscorts

()

# Returns: integer minEscorts, integer maxEscorts

FormatAchievementLinkTimestamp

(string timestamp)

# Returns: string date, string time

GetNumStats

()

# Returns: integer numStats

PlayerHasAttributeUpgrades

()

# Returns: bool hasLevelUpgrades

ChooseAbilityProgressionMorph

(luaindex progressionIndex, integer morph)

GetAbilityProgressionInfo

(luaindex progressionIndex)

# Returns: string name, integer morph, integer rank

GetAbilityProgressionXPInfo

(luaindex progressionIndex)

# Returns: integer lastRankXp, integer nextRankXP, integer currentXP, bool atMorph

GetAbilityProgressionAbilityInfo

(luaindex progressionIndex, integer morph, integer rank)

# Returns: string name, string texture, luaindex abilityIndex

GetAbilityProgressionRankFromAbilityId

(integer abilityId)

# Returns: integer:nilable rank

GetAbilityProgressionXPInfoFromAbilityId

(integer abilityId)

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

GetAttributeDerivedStatPerPointValue

(integer attribute, integer stat)

# Returns: number amountPerPoint

GetActiveCombatTipInfo

(integer activeCombatTipId)

# Returns: string name, string tipText, string iconPath

IsInteractionCameraActive

()

# Returns: bool isActive

IsSpectatorCameraActive

()

# Returns: bool isActive

GameCameraInteractStart

private ()

IsReticleHidden

()

# Returns: bool isHidden

IsGameCameraUnitHighlightedAttackable

()

# Returns: bool attackable

GameCameraMouseFreeLookStart

private ()

GameCameraMouseFreeLookStop

private ()

CycleGameCameraPreferredEnemyTarget

private ()

IsGameCameraPreferredTargetValid

()

# Returns: bool valid

ClearGameCameraPreferredTarget

private ()

GetGameCameraInteractableActionInfo

()

# Returns: string:nilable action, string:nilable name, bool interactBlocked, bool isOwned, integer additionalInfo, integer:nilable contextualInfo, string:nilable contextualLink, bool isCriminalInteract

GetNameOfGameCameraQuestToolTarget

()

# Returns: string name

ToggleGameCameraFirstPerson

()

IsGameCameraSiegeControlled

()

# Returns: bool valid

ReleaseGameCameraSiegeControlled

private ()

SetSpectatorCameraEnabled

private (bool enable)

GetSpectatableUnitName

(luaindex index)

# Returns: string name

GetNumSpectatableUnits

()

# Returns: integer numUnits

SetSpectatorCameraTargetIndex

(luaindex index)

GetSpectatorCameraTargetIndex

()

# Returns: luaindex index

SpectatorCameraTargetNext

()

SpectatorCameraTargetPrev

()

GetNumPendingFeedback

()

# Returns: integer pendingFeedback

GetFeedbackIdByIndex

(luaindex feedbackIndex)

# Returns: integer:nilable feedbackId

GetFeedbackType

(integer feedbackId)

# Returns: integer feedbackType

RemovePendingFeedback

(integer feedbackId)

IsFeedbackGatheringEnabled

()

# Returns: bool enabled

GetAllyUnitBlockState

(string unitTag)

# Returns: BlockState state

Quit

()

ConfirmLogout

(bool quitGame, LogoutType option, LogoutResult initialResult)

CancelLogout

()

GetIsNewCharacter

()

# Returns: bool isNewCharacter

GetUniqueNameForCharacter

(string characterName)

# Returns: string uniqueName

GetWorldName

()

# Returns: string worldName

IsSettingTemplate

()

# Returns: bool isSettingTemplate

IsNewCharacterNotificationSuppressionActive

()

# Returns: bool isSuppressionActive

GetTrialChatRestriction

(ChannelType channel, string target)

# Returns: TrialAccountRestrictionType restrictionType

GetTrialChatIsRestrictedAndWarn

(ChannelType channel, string target)

# Returns: bool handled

GetPlayerStatus

()

# Returns: PlayerStatus status

SelectPlayerStatus

(PlayerStatus status)

CanChangeBattleLevelPreference

()

# Returns: bool canChangeBattleLevelPreference

GetCursorBagId

()

# Returns: Bag:nilable originatingBagId

GetCursorSlotIndex

()

# Returns: integer:nilable slotIndex

GetCursorCollectibleId

()

# Returns: integer:nilable collectibleId

GetCursorAbilityId

()

# Returns: integer:nilable abilityId

GetCursorCraftedAbilityId

()

# Returns: integer:nilable craftedAbilityId

GetCursorChampionSkillId

()

# Returns: integer:nilable championSkillId

GetCursorEmoteId

()

# Returns: integer:nilable emoteId

GetCursorQuickChatId

()

# Returns: integer:nilable quickChatId

GetCursorQuestItemId

()

# Returns: integer:nilable questItemId

GetCursorCraftedAbilityScriptId

()

# Returns: integer:nilable scriptId

GetCursorVengeancePerkData

()

# Returns: luaindex:nilable vengeancePerkIndex, VengeancePerkSlotFlags:nilable vengeancePerkSlotFlag

PlaceInActionBar

protected (luaindex actionSlot, HotBarCategory:nilable hotbarCategory)

PlaceInInventory

protected (Bag bagId, integer slotIndex)

RequestMoveItem

protected (Bag sourceBag, integer sourceSlot, Bag destBag, integer destSlot, integer stackCount)

PlaceInEquipSlot

protected (integer slot)

PlaceInStoreWindow

protected ()

PlaceInTransfer

protected ()

PlaceInWorldLeftClick

protected ()

PlaceInAttachmentSlot

protected (luaindex attachmentSlot)

PickupAction

protected (luaindex actionSlot, HotBarCategory:nilable hotbarCategory)

PickupAbility

protected (luaindex abilityIndex)

PickupAbilityById

protected (integer abilityId)

PickupCompanionAbilityById

protected (integer abilityId)

PickupAbilityBySkillLine

protected (SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

PickupChampionSkillById

protected (integer championSkillId)

PickupInventoryItem

protected (Bag bagId, integer slotIndex, integer count)

PickupEquippedItem

protected (integer slotIndex, Bag bagId)

PickupTradeItem

protected (luaindex tradeIndex)

PickupQuestTool

protected (luaindex journalQuestIndex, luaindex toolIndex)

PickupQuestItem

protected (luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

PickupStoreItem

protected (luaindex entryIndex)

PickupStoreBuybackItem

protected (luaindex entryIndex)

PickupCollectible

protected (integer collectibleId)

PickupEmoteById

protected (integer emoteId)

PickupQuickChatById

protected (integer quickChatId)

PickupCraftedAbility

protected (integer craftedAbilityId)

PickupCraftedAbilityScript

protected (integer craftedAbilityScriptId)

PickupVengeancePerk

protected (luaindex vengeancePerkIndex, VengeancePerkSlotFlags vengeancePerkSlotFlag)

RespondToDestroyRequest

private (bool destroyItem)

PlaceInTradingHouse

protected ()

InitiateConfirmUseInventoryItem

protected (Bag bag, integer slotIndex)

RespondToConfirmUseInventoryItemRequest

private (bool useItem)

GetNumActionLayers

()

# Returns: integer actionLayers

GetActionLayerInfo

(luaindex layerIndex)

# Returns: string layerName, integer numLayerCategories

GetActionLayerCategoryInfo

(luaindex layerIndex, luaindex categoryIndex)

# Returns: string categoryName, integer numActions

GetActionInfo

(luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex)

# Returns: string actionName, bool isRebindable, bool isHidden

GetActionBindingInfo

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

# Returns: KeyCode keyCode, KeyCode mod1, KeyCode mod2, KeyCode mod3, KeyCode mod4

GetActionDefaultBindingInfo

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

# Returns: KeyCode keyCode, KeyCode mod1, KeyCode mod2, KeyCode mod3, KeyCode mod4

GetHighestPriorityActionBindingInfoFromName

(string actionName, bool preferGamepad)

# Returns: KeyCode keyCode, KeyCode mod1, KeyCode mod2, KeyCode mod3, KeyCode mod4

GetHighestPriorityActionBindingInfoFromNameAndInputDevice

(string actionName, PreferredInputDeviceType preferredInputDeviceType)

# Returns: KeyCode keyCode, KeyCode mod1, KeyCode mod2, KeyCode mod3, KeyCode mod4

GetMaxBindingsPerAction

()

# Returns: integer maxNumBindings

CreateDefaultActionBind

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

BindKeyToAction

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

UnbindKeyFromAction

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

UnbindAllKeysFromAction

protected (luaindex layerIndex, luaindex categoryIndex, luaindex actionIndex)

GetActionIndicesFromName

(string actionName)

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

GetBindingIndicesFromKeys

(luaindex layerIndex, KeyCode keyCode, KeyCode mod1, KeyCode mod2, KeyCode mod3, KeyCode mod4)

# Returns: luaindex:nilable categoryIndex, luaindex:nilable actionIndex, luaindex:nilable bindingIndex

GetActionNameFromKey

(string layerName, KeyCode keyCode)

# Returns: string actionName

IsCurrentBindingDefault

(string actionName, luaindex bindingIndex)

# Returns: bool isDefault

PushActionLayerByName

(string layerName)

InsertActionLayerByName

(string layerName, luaindex activeLayerIndex)

InsertNamedActionLayerAbove

(string layerName, string existingLayerName)

RemoveActionLayerByName

(string layerName)

IsActionLayerActiveByName

(string layerName)

# Returns: bool active

PopActionLayer

()

GetNumActiveActionLayers

()

# Returns: integer numActiveActionLayers

GetActiveActionLayerIndex

(luaindex activeActionLayerIndex)

# Returns: luaindex:nilable layerIndex

GetActionLayerNameByIndex

(luaindex layerIndex)

# Returns: string layerName

IsActionLayerTopLayerByName

(string layerName)

# Returns: bool isTopLayer

GetNumCharacters

()

# Returns: integer numCharacters

GetCharacterInfo

(luaindex index)

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

GetNumAttributes

()

# Returns: integer numAttributes

GetNumAdvancedStatCategories

()

# Returns: integer numCategories

GetAdvancedStatsCategoryId

(luaindex categoryIndex)

# Returns: integer categoryId

GetAdvancedStatCategoryInfo

(integer categoryId)

# Returns: string displayName, integer numStats

GetAdvancedStatInfo

(integer categoryId, luaindex statIndex)

# Returns: AdvancedStatDisplayType statType, string displayName, string description, string flatDescription, string percentDescription

GetAdvancedStatValue

(AdvancedStatDisplayType statType)

# Returns: AdvancedStatDisplayFormat displayFormat, integer:nilable flatValue, number:nilable percentValue

IsPlayerTryingToMove

()

# Returns: bool tryingToMove

GetCon

(integer otherLevel, integer:nilable playerLevel)

# Returns: DifficultyCon con

IsPlayerInWerewolfForm

()

# Returns: bool isInWerewolfForm

IsPlayerStunned

()

# Returns: bool isStunned

ArePlayerWeaponsSheathed

()

# Returns: bool weaponsAreSheathed

GetCurrentSynergyInfo

()

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

GetNumberOfAvailableSynergies

()

# Returns: integer numAvailable

GetSynergyInfoAtIndex

(luaindex synergyIndex)

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

CanUseSynergyAtIndex

(luaindex synergyIndex)

# Returns: bool canBeUsed

SetSynergyPriorityOverride

(integer synergyAbilityId, integer priority)

GetSynergyPriorityOverride

(integer synergyAbilityId)

# Returns: integer priority

ClearSynergyPriorityOverride

(integer synergyAbilityId)

ClearAllSynergyPriorityOverrides

()

HasSynergyEffects

()

# Returns: bool hasSynergy

GetGroupInviteInfo

()

# Returns: string characterName, integer millisecondsSinceRequest, string displayName

AcceptGroupInvite

()

DeclineGroupInvite

()

HasPendingGroupElectionVote

()

# Returns: bool hasPendingVote

CastGroupVote

(GroupVoteChoice vote)

RegisterForGroupAddOnDataBroadcastAuthKey

(string addOnName)

# Returns: integer:nilable authKey, string registeredAddOnName

BroadcastAddOnDataToGroup

(integer authKey, integer data)

# Returns: GroupAddOnDataBroadcastResult result

GetGroupAddOnDataBroadcastCooldownRemainingMS

()

# Returns: integer cooldownRemainingMS

GroupLeave

()

GroupInviteByName

(string characterOrDisplayName)

GroupKickByName

(string characterOrDisplayName)

GroupDisband

()

IsPlayerInGroup

(string characterOrDisplayName)

# Returns: bool inGroup

IsCharacterInGroup

(string characterName)

# Returns: bool inGroup

GetGroupSize

()

# Returns: integer groupSize

GetNumCompanionsInGroup

()

# Returns: integer numCompanions

JumpToGroupLeader

()

JumpToGroupMember

(string characterOrDisplayName)

CanJumpToGroupMember

(string unitTag)

# Returns: bool canJump, JumpToPlayerResult result

SetVeteranDifficulty

(bool isVeteranDifficulty)

GetLocalPlayerGroupUnitTag

()

# Returns: string:nilable unitTag

GetGroupUnitTagByIndex

(luaindex sortIndex)

# Returns: string:nilable unitTag

GetGroupIndexByUnitTag

(string unitTag)

# Returns: luaindex sortIndex

IsGroupCompanionUnitTag

(string unitTag)

# Returns: bool isGroupCompanionUnitTag

GetCompanionUnitTagByGroupUnitTag

(string groupUnitTag)

# Returns: string:nilable companionUnitTag

GetGroupUnitTagByCompanionUnitTag

(string companionUnitTag)

# Returns: string:nilable groupUnitTag

GetInstanceKickTime

()

# Returns: integer:nilable remainingTimeMs, integer:nilable totalTimeMs

GetInstanceKickReason

()

# Returns: ForcedZoneExitCause reason

IsGroupMemberInRemoteRegion

(string unitTag)

# Returns: bool inRemoteRegion

IsAnyGroupMemberInDungeon

()

# Returns: bool isAnyGroupMemberInDungeon

IsGroupCrossAlliance

()

# Returns: bool isGroupCrossAlliance

IsInLFGGroup

()

# Returns: bool isInLFGGroup

IsCurrentLFGActivityComplete

()

# Returns: bool isComplete

GetGroupMemberSelectedRole

(string unitTag)

# Returns: LFGRole role

IsGroupUsingVeteranDifficulty

()

# Returns: bool isVeteran

IsGroupModificationAvailable

()

# Returns: bool isAvailable

DoesGroupModificationRequireVote

()

# Returns: bool doesRequireVote

CanPlayerChangeGroupDifficulty

()

# Returns: bool canChange, GroupDifficultyChangeReason reason

GetGroupElectionInfo

()

# Returns: GroupElectionType electionType, integer timeRemainingSeconds, string electionDescriptor, string:nilable targetUnitTag

GetGroupElectionVoteByUnitTag

(string unitTag)

# Returns: GroupVoteChoice choice

GetGroupElectionUnreadyUnitTags

()

# Uses variable returns...
# Returns: string unreadyPlayers

BeginGroupElection

(GroupElectionType electionType, string electionDescriptor, string targetUnitTag, GroupElectionFlags flags)

# Returns: bool sentSuccessfully

GetExpectedGroupElectionResult

(GroupElectionType electionType, string targetUnitTag)

# Returns: GroupElectionFailure failureReason

AssignTargetMarkerToReticleTarget

(TargetMarkerType targetMarkerType)

GetRaidReviveCountersRemaining

()

# Returns: integer:nilable currentCounter

GetCurrentRaidScore

()

# Returns: integer score

GetCurrentRaidDeaths

()

# Returns: integer:nilable deaths

GetCurrentRaidStartingReviveCounters

()

# Returns: integer:nilable startingReviveCounters

GetCurrentRaidLifeScoreBonus

()

# Returns: integer:nilable currentLifeScoreBonus

GetRaidBonusMultiplier

()

# Returns: integer currentLifeScoreBonus

IsRaidInProgress

()

# Returns: bool inProgress

HasRaidEnded

()

# Returns: bool ended

WasRaidSuccessful

()

# Returns: bool:nilable successful

IsPlayerInRaid

()

# Returns: bool inRaid

IsPlayerInReviveCounterRaid

()

# Returns: bool isInReviveCounterRaid

IsPlayerInRaidStagingArea

()

# Returns: bool isInRaidStagingArea

GetRaidName

(integer raidId)

# Returns: string name

GetCurrentParticipatingRaidId

()

# Returns: integer currentRaidId

GetRaidTargetTime

()

# Returns: integer raidTargetTime

GetRaidDuration

()

# Returns: integer raidTime

QueryRaidLeaderboardData

(RaidCategory raidCategory, integer raidId)

# Returns: LeaderboardDataReadyState readyState

GetNumRaidLeaderboards

(RaidCategory raidCategory)

# Returns: integer count, bool hasWeekly

GetRaidOfTheWeekLeaderboardInfo

(RaidCategory raidCategory)

# Returns: string name, integer raidId

GetRaidLeaderboardName

(integer raidId)

# Returns: string name

GetRaidLeaderboardUISortIndex

(RaidCategory raidCategory, integer raidId)

# Returns: luaindex uiSortIndex

GetRaidOfTheWeekLeaderboardLocalPlayerInfo

(RaidCategory raidCategory)

# Returns: integer rank, integer bestScore

GetRaidLeaderboardLocalPlayerInfo

(integer raidId)

# Returns: integer rank, integer bestScore

GetNumTrialOfTheWeekLeaderboardEntries

()

# Returns: integer count

GetNumTrialLeaderboardEntries

(integer raidId)

# Returns: integer count

GetNumChallengeOfTheWeekLeaderboardEntries

()

# Returns: integer count

GetNumChallengeLeaderboardEntries

(integer raidId)

# Returns: integer count

GetTrialOfTheWeekLeaderboardEntryInfo

(luaindex entryIndex)

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

GetTrialLeaderboardEntryInfo

(integer raidId, luaindex entryIndex)

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

GetChallengeOfTheWeekLeaderboardEntryInfo

(luaindex entryIndex)

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

GetChallengeLeaderboardEntryInfo

(integer raidId, luaindex entryIndex)

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

GetRaidOfTheWeekTimes

()

# Returns: integer secondsUntilEnd, integer secondsUntilNextStart

GetPlayerRaidOfTheWeekParticipationInfo

(RaidCategory raidCategory)

# Returns: bool isParticipating, bool isCredited

GetPlayerRaidParticipationInfo

(integer raidId)

# Returns: bool isParticipating, bool isCredited

GetPlayerRaidOfTheWeekProgressInfo

(RaidCategory raidCategory)

# Returns: bool inProgress, bool complete

GetPlayerRaidProgressInfo

(integer raidId)

# Returns: bool inProgress, bool complete

GetNextRaidLeaderboardId

(RaidCategory raidCategory, integer:nilable lastRaidId)

# Returns: integer:nilable nextRaidId

GetNextTributeLeaderboardType

(TributeLeaderboardType:nilable lastTributeLeaderboardType)

# Returns: TributeLeaderboardType:nilable nextTributeLeaderboardType

GetTributeLeaderboardLocalPlayerInfo

(TributeLeaderboardType tributeLeaderboardType)

# Returns: integer currentRank, integer currentScore

QueryTributeLeaderboardData

(TributeLeaderboardType tributeLeaderboardType)

# Returns: LeaderboardDataReadyState readyState

GetNumTributeLeaderboardEntries

(TributeLeaderboardType tributeLeaderboardType)

# Returns: integer numLeaderboardEntries

GetTributeLeaderboardEntryInfo

(TributeLeaderboardType tributeLeaderboardType, luaindex entryIndex)

# Returns: integer rank, string displayName, string characterName, integer score

GetTributeLeaderboardsSchedule

()

# Returns: integer secondsUntilEnd, integer secondsUntilNextStart

RequestTributeLeaderboardRank

()

# Returns: LeaderboardDataReadyState readyState

HasPlayerConfirmedEndlessDungeonCompanionSummoning

()

# Returns: bool confirmed

SetPlayerConfirmedEndlessDungeonCompanionSummoning

(bool confirmed)

GetNumEndlessDungeonLifetimeVerseAndVisionStackCounts

()

# Returns: integer totalVerseStacks, integer totalNonAvatarVisionStacks, integer totalAvatarVisionStacks

GetNumEndlessDungeonActiveVerses

()

# Returns: integer numActiveVerses

GetEndlessDungeonActiveVerseAbility

(luaindex index)

# Returns: integer abilityId

GetNextEndlessDungeonLifetimeVerseAbilityAndStackCount

(integer:nilable lastAbilityId)

# Returns: integer:nilable nextAbilityId, integer:nilable nextStackCount

GetNextEndlessDungeonVisionAbilityAndStackCount

(integer:nilable lastAbilityId)

# Returns: integer:nilable nextAbilityId, integer:nilable nextStackCount

GetNumStacksForEndlessDungeonBuff

(integer buffAbilityId, bool includeLifetimeStacks)

# Returns: integer stackCount

GetEndlessDungeonBuffSelectorBucketTypeChoice

(EndlessDungeonBuffBucketType bucketType)

# Returns: integer abilityId

CanRerollCurrentBuffSelectorOptions

()

# Returns: bool canRerollBuffs

GetEndlessDungeonBuffSelectorRerollCost

()

# Returns: integer rerollCost

GetEndlessDungeonCounterValue

(EndlessDungeonCounterType counterType)

# Returns: integer value

GetEndlessDungeonScore

()

# Returns: integer score

GetEndlessDungeonStartTimeMilliseconds

()

# Returns: integer53 startTimeMilliseconds

GetEndlessDungeonFinalRunTimeMilliseconds

()

# Returns: integer53 finalRunTimeMilliseconds

IsInstanceEndlessDungeon

()

# Returns: bool isEndlessDungeon

IsEndlessDungeonStarted

()

# Returns: bool isEndlessDungeonStarted

GetEndlessDungeonGroupType

()

# Returns: EndlessDungeonGroupType endlessDungeonGroupType

IsEndlessDungeonCompleted

()

# Returns: bool isEndlessDungeonCompleted

QueryEndlessDungeonLeaderboardData

(EndlessDungeonGroupType endlessDungeonGroupType, integer endlessDungeonId)

# Returns: LeaderboardDataReadyState readyState

GetEndlessDungeonOfTheWeekLeaderboardLocalPlayerInfo

(EndlessDungeonGroupType endlessDungeonGroupType)

# Returns: integer rank, integer bestScore

GetEndlessDungeonLeaderboardLocalPlayerInfo

(EndlessDungeonGroupType endlessDungeonGroupType, integer endlessDungeonId)

# Returns: integer rank, integer bestScore

GetPlayerEndlessDungeonOfTheWeekParticipationInfo

(EndlessDungeonGroupType endlessDungeonGroupType)

# Returns: bool isParticipating, bool isCredited

GetPlayerEndlessDungeonParticipationInfo

(EndlessDungeonGroupType endlessDungeonGroupType, integer endlessDungeonId)

# Returns: bool isParticipating, bool isCredited

GetPlayerEndlessDungeonOfTheWeekProgressInfo

(EndlessDungeonGroupType endlessDungeonGroupType)

# Returns: bool inProgress, bool complete

GetPlayerEndlessDungeonProgressInfo

(EndlessDungeonGroupType endlessDungeonGroupType, integer endlessDungeonId)

# Returns: bool inProgress, bool complete

GetNumEndlessDungeonOfTheWeekDuoLeaderboardEntries

()

# Returns: integer count

GetNumEndlessDungeonDuoLeaderboardEntries

(integer endlessDungeonId)

# Returns: integer count

GetNumEndlessDungeonOfTheWeekSoloLeaderboardEntries

()

# Returns: integer count

GetNumEndlessDungeonSoloLeaderboardEntries

(integer endlessDungeonId)

# Returns: integer count

GetEndlessDungeonOfTheWeekDuoLeaderboardEntryInfo

(luaindex entryIndex)

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

GetEndlessDungeonDuoLeaderboardEntryInfo

(integer endlessDungeonId, luaindex entryIndex)

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

GetEndlessDungeonOfTheWeekSoloLeaderboardEntryInfo

(luaindex entryIndex)

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

GetEndlessDungeonSoloLeaderboardEntryInfo

(integer endlessDungeonId, luaindex entryIndex)

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

GetEndlessDungeonOfTheWeekTimes

()

# Returns: integer secondsUntilEnd, integer secondsUntilNextStart

JumpToFriend

(string displayName)

JumpToHouse

(string displayName)

JumpToSpecificHouse

(string displayName, integer houseId, bool fromHouseTours)

GetNextLeaderboardScoreNotificationId

(integer:nilable lastId)

# Returns: integer:nilable nextId

GetLeaderboardScoreNotificationInfo

(integer notificationId)

# Returns: LeaderboardScoreNotificationType contentType, integer contentId, integer contentContextualInfo, integer score, integer millisecondsSinceRequest, integer numMembers

GetLeaderboardScoreNotificationMemberInfo

(integer notificationId, luaindex memberIndex)

# Returns: string displayName, string characterName, bool isFriend, bool isGuildMember, bool isPlayer

RemoveLeaderboardScoreNotification

(integer notificationId)

InviteToTributeByDisplayName

(string displayName)

IsCommunicationRestricted

()

# Returns: bool isCommunicationRestricted

CanCommunicateWith

(string characterOrDisplayName, id64 consoleId)

# Returns: bool isCommunicationPermitted

IsActiveAbilityHotBarCategory

(HotBarCategory hotbarCategory)

# Returns: bool isActiveAbilityCategory

IsActionSlotRestricted

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool locked

IsActionBarRespeccable

()

# Returns: bool isRespeccable

GetActionBarLockedReason

()

# Returns: ActionBarLockedReason actionBarLockedReason

ClearSlot

protected (luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

SelectSlotAbility

protected (luaindex abilityIndex, luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

SelectSlotItem

protected (Bag bagId, integer bagSlotIndex, luaindex actionSlotIndex, HotBarCategory hotbarCategory)

SelectSlotSimpleAction

protected (ActionBarSlotType actionType, integer actionId, luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

SelectLastSlottedItem

protected (luaindex actionSlotIndex, HotBarCategory hotbarCategory)

ClearLastSlottedItem

()

GetLastSlottedItemLink

()

# Returns: string itemLink

GetSlotItemLink

(luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: string itemLink

GetSlotBoundId

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: integer actionId

GetSlotType

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: ActionBarSlotType actionType

GetCurrentQuickslot

()

# Returns: luaindex actionSlotIndex

SetCurrentQuickslot

(luaindex actionSlotIndex)

GetActiveHotbarCategory

()

# Returns: HotBarCategory hotbarCategory

GetActionSlotEffectDuration

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: integer durationMilliseconds

GetActionSlotEffectTimeRemaining

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: integer timeRemainingMilliseconds

GetActionSlotEffectStackCount

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: integer stackCount

CanAbilityBeUsedFromHotbar

(integer abilityId, HotBarCategory hotbarCategory)

# Returns: bool canBeUsed

GetEffectiveAbilityIdForAbilityOnHotbar

(integer abilityId, HotBarCategory:nilable hotbarCategory)

# Returns: integer effectiveAbilityId

GetEffectiveAbilityIdForAbilityOnHotbarForArmoryBuild

(integer abilityId, luaindex buildIndex, HotBarCategory:nilable hotbarCategory)

# Returns: integer effectiveAbilityId

GetSkillProgressionIdForHotbarSlotOverrideRule

(luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: integer progressionId

GetWeaponPairFromHotbarCategory

(HotBarCategory hotbarCategory)

# Returns: ActiveWeaponPair weaponPair

IsSlotToggled

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool toggledOn

ActionSlotHasCostFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasRequirementFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasWeaponSlotFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasTargetFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasRangeFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasLeapKeepTargetFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasSubzoneFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasStatusEffectFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasFallingFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasSwimmingFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasMountedFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasReincarnatingFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasActivationHighlight

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

ActionSlotHasNonCostStateFailure

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool status

GetAssignableAbilityBarStartAndEndSlots

()

# Returns: luaindex startActionSlotIndex, luaindex endActionSlotIndex

GetAssignableChampionBarStartAndEndSlots

()

# Returns: luaindex startActionSlotIndex, luaindex endActionSlotIndex

GetRequiredChampionDisciplineIdForSlot

(luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: integer requiredDisciplineId

IsActionSlotLocked

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool isLocked

IsActionSlotMutable

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool isMutable

ActionSlotHasEffectiveSlotAbilityData

(luaindex actionSlotIndex, HotBarCategory:nilable hotbarCategory)

# Returns: bool hasEffectiveSlotAbilityData

GetActionSlotUnlockText

(luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: string slotUnlockText

HasMountSkin

()

# Returns: bool result

GetMountSkinId

()

# Returns: integer skinId

GetRidingStats

()

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

GetMaxRidingTraining

(RidingTrainType trainTypeIndex)

# Returns: integer maxValue

GetTimeUntilCanBeTrained

()

# Returns: integer timeMs, integer totalDurationMs

GetTrainingCost

()

# Returns: integer cost

GetNumUpgradesPerStablemasterTraining

()

# Returns: integer numUpgrades

TrainRiding

(RidingTrainType trainTypeIndex)

IsMounted

()

# Returns: bool mounted

IsGroupMountPassenger

()

# Returns: bool isPassenger

IsGroupMountPassengerForTarget

(string characterOrDisplayName)

# Returns: bool isPassenger

ToggleMount

private ()

UseMountAsPassenger

(string characterOrDisplayName)

GetTargetMountedStateInfo

(string characterOrDisplayName)

# Returns: MountedState mountedState, bool isRidingGroupMount, bool hasFreePassengerSlot

GetAbilityIdByIndex

(luaindex abilityIndex)

# Returns: integer abilityId

GetAbilityLink

(integer abilityId, LinkStyle linkStyle)

# Returns: string link

DoesAbilityExist

(integer abilityId)

# Returns: bool exists

IsAbilityPermanent

(integer abilityId)

# Returns: bool isPermanent

GetAbilityEffectDescription

(integer effectSlotId)

# Returns: string description

GetAbilityUpgradeLines

(integer abilityId)

# Uses variable returns...
# Returns: string label, string oldValue, string newValue

GetAbilityNewEffectLines

(integer abilityId)

# Uses variable returns...
# Returns: string newEffect

GetAbilityBuffType

(integer abilityId, string casterUnitTag)

# Returns: BuffType buffType

ShouldAbilityShowAsUsableWithDuration

(integer abilityId)

# Returns: bool showAsUsable

IsBlockActive

()

# Returns: bool active

StartSoulGemResurrection

private ()

CancelSoulGemResurrection

private ()

OnWeaponSwap

private ()

OnWeaponSwapToSet1

private ()

OnWeaponSwapToSet2

private ()

ActivateSynergy

private ()

ActivateSynergyAtIndex

private (luaindex synergyIndex)

# Returns: ClientUseAbilityResult castResult

GetOfferedQuestInfo

()

# Returns: string dialogue, string response

GetOfferedQuestShareInfo

(integer questId)

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

GetOfferedQuestShareIds

()

# Uses variable returns...
# Returns: integer questId

AcceptOfferedQuest

()

AcceptSharedQuest

(integer questId)

DeclineSharedQuest

(integer questId)

GetNumJournalQuests

()

# Returns: integer numQuests

IsValidQuestIndex

(luaindex journalQuestIndex)

# Returns: bool isValid

GetJournalQuestType

(luaindex journalQuestIndex)

# Returns: QuestType type

GetJournalQuestRepeatType

(luaindex journalQuestIndex)

# Returns: QuestRepeatableType repeatType

GetJournalQuestZoneDisplayType

(luaindex journalQuestIndex)

# Returns: ZoneDisplayType zoneDisplayType

CanAbandonJournalQuest

(luaindex journalQuestIndex)

# Returns: bool canAbandon

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

GetJournalQuestId

(luaindex journalQuestIndex)

# Returns: integer questId

GetJournalQuestIsComplete

(luaindex journalQuestIndex)

# Returns: bool completed

GetJournalQuestName

(luaindex journalQuestIndex)

# Returns: string questName

GetJournalQuestLevel

(luaindex journalQuestIndex)

# Returns: integer level

GetJournalQuestConditionType

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex, TrackingLevel trackingLevel)

# Returns: integer pinType

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

DoesItemFulfillJournalQuestCondition

(Bag bagId, integer slotIndex, luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

# Returns: bool fulfillsCondition

DoesItemLinkFulfillJournalQuestCondition

(string link, luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex, bool:nilable isSelfCrafted)

# Returns: bool fulfillsCondition

GetQuestToolCooldownInfo

(luaindex journalQuestIndex, luaindex toolIndex)

# Returns: integer remain, integer duration

GetQuestItemCooldownInfo

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

# Returns: integer remain, integer duration

UseQuestItem

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

UseQuestTool

(luaindex journalQuestIndex, luaindex toolIndex)

CanUseQuestItem

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

# Returns: bool canUse

CanUseQuestTool

(luaindex journalQuestIndex, luaindex toolIndex)

# Returns: bool canUse

CanQuickslotQuestItemById

(integer questItemId)

# Returns: bool canQuickslot

IsJournalQuestInCurrentMapZone

(luaindex questIndex)

# Returns: bool isInCurrentZone

IsJournalQuestStepEnding

(luaindex journalQuestIndex, luaindex stepIndex)

# Returns: bool isEnding

DoesJournalQuestConditionHavePosition

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

# Returns: bool hasPosition

SetMapToQuestCondition

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

# Returns: SetMapResultCode setMapResult

SetMapToQuestStepEnding

(luaindex journalQuestIndex, luaindex stepIndex)

# Returns: SetMapResultCode setMapResult

SetMapToQuestZone

(luaindex questIndex)

# Returns: SetMapResultCode setMapResult

GetJournalQuestNumRewards

(luaindex journalQuestIndex)

# Returns: integer count

GetQuestRewardItemLink

(luaindex rewardIndex, LinkStyle linkStyle)

# Returns: string link

GetNextCompletedQuestId

(integer:nilable lastQuestId)

# Returns: integer:nilable nextQuestId

GetCompletedQuestInfo

(integer questId)

# Returns: string name, QuestType questType

GetCompletedQuestLocationInfo

(integer questId)

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

GetJournalQuestRewardInfo

(luaindex journalQuestIndex, luaindex rewardIndex)

# Returns: RewardType type, string name, integer amount, textureName iconFile, bool meetsUsageRequirement, ItemDisplayQuality itemDisplayQuality, RewardItemType:nilable itemType

GetJournalQuestRewardItemId

(luaindex journalQuestIndex, luaindex rewardIndex)

# Returns: integer rewardItemDefId

GetJournalQuestRewardCollectibleId

(luaindex journalQuestIndex, luaindex rewardIndex)

# Returns: integer rewardCollectibleDefId

GetJournalQuestRewardTributeCardUpgradeInfo

(luaindex journalQuestIndex, luaindex rewardIndex)

# Returns: integer patronDefId, luaindex cardIndex

GetJournalQuestRewardSkillLine

(luaindex journalQuestIndex, luaindex rewardIndex)

# Returns: SkillType skillType, luaindex skillLineIndex

GetJournalQuestRewardActiveSpectacleEventId

(luaindex journalQuestIndex, luaindex rewardIndex)

# Returns: integer activeSpectacleEventId

GetJournalQuestStartingZone

(luaindex journalQuestIndex)

# Returns: luaindex zoneIndex

GetQuestToolInfo

(luaindex journalQuestIndex, luaindex toolIndex)

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

GetQuestItemInfo

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

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

GetQuestToolQuestItemId

(luaindex journalQuestIndex, luaindex toolIndex)

# Returns: integer questItemId

GetQuestConditionQuestItemId

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

# Returns: integer questItemId

GetQuestItemName

(integer questItemId)

# Returns: string itemName

GetQuestItemTooltipText

(integer questItemId)

# Returns: string tooltipText

GetQuestItemIcon

(integer questItemId)

# Returns: textureName iconFilename

CancelRequestJournalQuestConditionAssistance

(integer taskId)

GetJournalQuestZoneStoryZoneId

(luaindex journalQuestIndex)

# Returns: integer zoneId

HasQuest

(integer questId)

# Returns: bool hasQuest

HasCompletedQuest

(integer questId)

# Returns: bool hasCompleted

GetQuestType

(integer questId)

# Returns: QuestType questType

GetQuestRepeatableType

(integer questId)

# Returns: QuestRepeatableType repeatType

GetQuestConditionItemInfo

(luaindex journalQuestIndex, luaindex stepIndex, luaindex conditionIndex)

# Returns: integer itemId, integer materialItemId, TradeskillType craftingType, ItemQuality itemQuality

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

GetDynamicChatChannelName

(integer channelId)

# Returns: string name

GetChatChannelId

(string name)

# Returns: ChannelType channelId

CanWriteGuildChannel

(integer channelId)

# Returns: bool canWrite

GetNumChatContainers

()

# Returns: integer numContainers

GetNumChatContainerTabs

(luaindex chatContainerIndex)

# Returns: integer numContainerTabs

GetChatContainerTabInfo

(luaindex chatContainerIndex, luaindex tabIndex)

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

GetNumChatCategories

()

# Returns: integer numCategories

IsChatContainerTabCategoryEnabled

(luaindex chatContainerIndex, luaindex tabIndex, ChatChannelCategories chatCategory)

# Returns: bool enabled

SetChatContainerTabCategoryEnabled

(luaindex chatContainerIndex, luaindex tabIndex, ChatChannelCategories chatCategory, bool enabled)

SetChatContainerTabInfo

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

ResetChatContainerTabToDefault

(luaindex chatContainerIndex, luaindex tabIndex)

GetChatContainerColors

(luaindex chatContainerIndex)

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

SetChatContainerColors

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

ResetChatToDefaults

()

ResetChatContainerColorsToDefault

(luaindex chatContainerIndex)

AddChatContainer

()

RemoveChatContainer

(luaindex chatContainerIndex)

AddChatContainerTab

(luaindex chatContainerIndex, string name, bool isCombatLog)

RemoveChatContainerTab

(luaindex chatContainerIndex, luaindex tabIndex)

TransferChatContainerTab

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

GetChatFontSize

()

# Returns: integer fontSize

SetChatFontSize

(integer fontSize)

GetGamepadChatFontSize

()

# Returns: integer gamepadFontSize

SetGamepadChatFontSize

(integer gamepadFontSize)

ResetChatFontSizeToDefault

()

GetChatCategoryColor

(ChatChannelCategories category)

# Returns: number red, number green, number blue

SetChatCategoryColor

(ChatChannelCategories category, number red, number green, number blue)

ResetChatCategoryColorToDefault

(ChatChannelCategories category)

GetChannelCategoryFromChannel

(ChannelType channel)

# Returns: ChatChannelCategories category

IsChatBubbleCategoryEnabled

(ChatChannelCategories category)

# Returns: bool enabled

SetChatBubbleCategoryEnabled

(ChatChannelCategories category, bool enabled)

IsChatSystemAvailableForCurrentPlatform

()

# Returns: bool enabled

IsChannelCategoryCommunicationRestricted

(ChatChannelCategories channelCategory)

# Returns: bool isChannelRestricted

RandomDiceRoll

private (integer maxValue, integer numRolls, integer modifier)

# Returns: RandomRollResult result

RandomRangeRoll

private (integer minValue, integer maxValue)

# Returns: RandomRollResult result

SetSessionIgnore

(string userName, bool isIgnoredThisSession)

ClearSessionIgnores

()

SetChatLogEnabled

(bool isEnabled)

IsChatLogEnabled

()

# Returns: bool isEnabled

ReplyToPendingInteraction

(bool isConfirmed)

IsUnderArrest

()

# Returns: bool beingArrested

IsGameCameraClickableFixture

()

# Returns: bool isClickableFixture

IsGameCameraClickableFixtureActive

()

# Returns: bool isClickableFixtureActive

GetGameCameraInteractableUnitAudioInfo

()

# Returns: integer audioModelType, integer audioModelMaterial, integer audioModelSize

IsGameCameraInteractableUnitMonster

()

# Returns: bool isUnitMonster

GetGameCameraInteractableInfo

()

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

GetGameCameraPickpocketingBonusInfo

()

# Returns: bool inBonus, bool isHostile, integer percentChance, PickpocketDifficultyType difficulty, bool isEmpty, ProspectivePickpocketResult prospectiveResult, string monsterSocialClassString, MonsterSocialClass monsterSocialClass

GetChatterOption

(luaindex optionIndex)

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

GetChatterOptionWaypoints

(luaindex optionIndex)

# Uses variable returns...
# Returns: integer waypointId

SelectChatterOption

(luaindex optionIndex)

IsInteractionPending

()

# Returns: bool isPending

EndPendingInteraction

()

GetChatterOptionCount

()

# Returns: integer optionCount

ResetChatter

()

GetChatterFarewell

()

# Returns: string backToTOCString, string farewellString, bool isImportant

IsInteracting

()

# Returns: bool isInteracting

IsPlayerInteractingWithObject

()

# Returns: bool areThey

IsInteractingWithMyAssistant

()

# Returns: bool isAssistant

IsInteractingWithMyCompanion

()

# Returns: bool interactingWithCompanion

IsPendingInteractionConfirmationValid

()

# Returns: bool isValid

ChooseEndlessDungeonBuff

(EndlessDungeonBuffBucketType bucketType)

RerollEndlessDungeonBuffSelection

private ()

IsInteractVOPlaying

()

# Returns: bool isPlaying

ReplayLastInteractVO

()

CanReplayLastInteractVO

()

# Returns: bool canReplay

CheckInventorySpaceAndWarn

(integer numItems)

# Returns: bool haveSpace

CheckInventorySpaceSilently

(integer numItems)

# Returns: bool haveSpace

HasItemToImproveForWrit

(integer itemId, integer materialItemId, ItemTraitType itemTraitType, integer itemStyleId, ItemQuality targetFunctionalQuality)

# Returns: bool hasItem

GetItemTraitInformation

(Bag bagId, integer slotIndex)

# Returns: ItemTraitInformation itemTraitInformation

GetItemTraitInformationFromItemLink

(string itemLink)

# Returns: ItemTraitInformation itemTraitInformation

BindItem

(Bag bagId, integer slotIndex)

GetWornItemInfo

(Bag wornBagId, EquipSlot equipSlot)

# Returns: bool slotHasItem, textureName icon, bool isHeldSlot, bool isHeldNow, bool isLocked

RequestEquipItem

(Bag bagId, integer slotIndex, Bag wornBagId, EquipSlot equipSlot)

RequestUnequipItem

(Bag wornBagId, EquipSlot equipSlot)

GetItemGlyphMinLevels

(Bag bagId, integer slotIndex)

# Returns: integer:nilable minLevel, integer:nilable minChampionPoints

GetItemSetSuppressionInfo

(integer itemSetId)

# Returns: ItemBonusSuppressionType suppressionType, integer refId

GetItemTraitSuppressionInfo

(ItemTraitType itemTraitType)

# Returns: ItemBonusSuppressionType suppressionType, integer refId

GetItemEnchantSuppressionInfo

()

# Returns: ItemBonusSuppressionType suppressionType, integer refId

GetItemPoisonSuppressionInfo

()

# Returns: ItemBonusSuppressionType suppressionType, integer refId

GetItemBonusSuppressionName

(ItemBonusSuppressionType suppressionType, integer refId)

# Returns: string text

GetNumAvailableMundusStoneSlots

()

# Returns: integer numMundusStoneSlots

PlayItemSound

(ItemUISoundCategory itemSoundCategory, ItemUISoundAction itemSoundAction)

PlayLootSound

(integer audioModelType, bool closeLootWindow)

SetTamrielTomesNormalizedConfirmationAmount

(number aNormalizedConfirmationAmount)

WhatIsVisualSlotShowing

(VisualSlot visualSlot, GameplayActorCategory actorCategory)

# Returns: VisualLayer highestPriorityVisualLayerThatIsShowing

GetHiddenByStringForVisualLayer

(VisualLayer visualLayer)

# Returns: string hiddenByString

WouldEquipmentBeHidden

(EquipSlot equipSlot, GameplayActorCategory actorCategory)

# Returns: bool isHidden, VisualLayer highestPriorityVisualLayerThatIsShowing

IsEquipSlotVisualCategoryHidden

(EquipSlotVisualCategory equipSlotVisualCategory, GameplayActorCategory actorCategory)

# Returns: bool isHidden

WouldCollectibleBeHidden

(integer collectibleId, GameplayActorCategory actorCategory)

# Returns: bool isHidden, VisualLayer highestPriorityVisualLayerThatIsShowing

WouldOutfitBeHidden

(luaindex outfitIndex, GameplayActorCategory actorCategory)

# Returns: bool isHidden, VisualLayer highestPriorityVisualLayerThatIsShowing

DoesCollectibleHaveVisibleAppearance

(integer collectibleId)

# Returns: bool hasVisibleAppearance

GetKioskBidWindowSecondsRemaining

()

# Returns: integer secondsRemaining

GetKioskGuildInfo

(integer guildId)

# Returns: integer:nilable bankedMoney, integer:nilable existingBidAmount, integer:nilable numTotalBids, GuildKioskGuildInfoResult queryResult

GetMaxKioskBidsPerGuild

()

# Returns: integer maxBidsPerGuild

GetKioskPurchaseCost

()

# Returns: integer cost

GuildKioskBid

(integer guildId, integer bidAmount)

GuildKioskPurchase

(integer guildId)

RequestGuildKioskActiveBids

(integer guildId)

# Returns: SocialActionResult result

GetNumGuildKioskActiveBids

(integer guildId)

# Returns: integer numBids

GetGuildKioskActiveBidInfo

(integer guildId, luaindex index)

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

GetNumTradingHouseGuilds

()

# Returns: integer numGuilds

GetTradingHouseGuildDetails

(luaindex index)

# Returns: integer guildId, string guildName, Alliance guildAlliance

GetCurrentTradingHouseGuildDetails

()

# Returns: integer guildId, string guildName, Alliance guildAlliance

CanBuyFromTradingHouse

(integer guildId)

# Returns: bool canBuy

CanSellOnTradingHouse

(integer guildId)

# Returns: bool canSell

GetSelectedTradingHouseGuildId

()

# Returns: integer:nilable guildId

SelectTradingHouseGuildId

(integer guildId)

# Returns: bool success

GetTradingHouseListingCounts

()

# Returns: integer currentListingCount, integer maxListingCount

GetTradingHousePostPriceInfo

(integer desiredPostPrice)

# Returns: integer listingFee, integer tradingHouseCut, integer expectedProfit

GetTradingHouseListingPercentage

()

# Returns: number listingPercentage

GetTradingHouseCutPercentage

()

# Returns: number cutPercentage

SetPendingItemPost

(Bag bag, integer slot, integer quantity)

GetPendingItemPost

()

# Returns: Bag bag, integer slot, integer quantity

RequestPostItemOnTradingHouse

(Bag bag, integer slot, integer quantity, integer postingPrice)

SetPendingItemPurchase

(luaindex index)

SetPendingItemPurchaseByItemUniqueId

(id64 itemUniqueId, integer purchasePrice)

ClearPendingItemPurchase

()

ConfirmPendingItemPurchase

()

ClearAllTradingHouseSearchTerms

()

SetTradingHouseFilter

(TradingHouseFilterType filterType, integer:nilable values)

# Returns: bool success

SetTradingHouseFilterRange

(TradingHouseFilterType filterType, integer:nilable minValue, integer:nilable maxValue)

# Returns: bool success

GetMaxTradingHouseFilterExactTerms

(TradingHouseFilterType filterType)

# Returns: integer maxReturns

ExecuteTradingHouseSearch

(integer page, TradingHouseSortField sortField, bool sortAscending, bool useLastExecutedSearchFilters)

GetTradingHouseSearchResultsInfo

()

# Returns: integer numItemsOnPage, integer currentPage, bool hasMorePages

GetTradingHouseSearchResultItemInfo

(luaindex index)

# Returns: textureName icon, string itemName, ItemDisplayQuality displayQuality, integer stackCount, string sellerName, integer timeRemaining, integer purchasePrice, CurrencyType currencyType, id64 itemUniqueId, number purchasePricePerUnit

GetTradingHouseSearchResultItemLink

(luaindex index, LinkStyle linkStyle)

# Returns: string link

AreAllTradingHouseSearchResultsPurchased

()

# Returns: bool allResultsPurchased

HasTradingHouseListings

()

# Returns: bool hasListing

RequestTradingHouseListings

()

GetNumTradingHouseListings

()

# Returns: integer numListings

CancelTradingHouseListing

(luaindex index)

CancelTradingHouseListingByItemUniqueId

(id64 itemUniqueId)

GetTradingHouseListingItemInfo

(luaindex index)

# Returns: textureName icon, string itemName, ItemDisplayQuality displayQuality, integer stackCount, string sellerName, integer timeRemaining, integer salePrice, CurrencyType currencyType, id64 itemUniqueId, number salePricePerUnit

GetTradingHouseListingItemLink

(luaindex index, LinkStyle linkStyle)

# Returns: string link

GetEnchantmentSearchCategories

(ItemType itemType)

# Uses variable returns...
# Returns: integer category

GetTradingHouseCooldownRemaining

()

# Returns: integer cooldownMilliseconds

MatchTradingHouseItemNames

(string searchText)

# Returns: integer:nilable taskId

CancelMatchTradingHouseItemNames

(integer taskId)

GetMatchTradingHouseItemNamesResult

(integer taskId, luaindex resultIndex)

# Returns: string itemName, integer itemNameHash

GetNumMatchTradingHouseItemNamesResults

(integer taskId)

# Returns: integer:nilable numResults

GetMinLettersInTradingHouseItemNameForCurrentLanguage

()

# Returns: integer minLetters

GetNumZones

()

# Returns: integer numZones

SetMapToPlayerLocation

()

# Returns: SetMapResultCode setMapResult

DoesCurrentMapMatchMapForPlayerLocation

()

# Returns: bool matches

DoesCurrentMapShowPlayerWorld

()

# Returns: bool isInMap

SetMapToMapListIndex

(luaindex index)

# Returns: SetMapResultCode setMapResult

SetMapToMapId

(integer mapId)

# Returns: SetMapResultCode setMapResult

SetMapToAutoMapNavigationTargetPosition

()

# Returns: SetMapResultCode setMapResult

GetCurrentMapIndex

()

# Returns: luaindex:nilable index

GetCurrentMapId

()

# Returns: integer mapId

GetMapIndexByZoneId

(integer zoneId)

# Returns: luaindex:nilable index

GetMapIdByZoneId

(integer zoneId)

# Returns: integer mapId

GetMapIdByIndex

(luaindex mapIndex)

# Returns: integer mapId

GetMapIndexById

(integer mapId)

# Returns: luaindex:nilable index

GetCyrodiilMapIndex

()

# Returns: luaindex:nilable index

GetImperialCityMapIndex

()

# Returns: luaindex:nilable index

GetCurrentMapZoneIndex

()

# Returns: luaindex zoneIndex

GetZoneNameByIndex

(luaindex zoneIndex)

# Returns: string zoneName

GetMapNameByIndex

(luaindex mapIndex)

# Returns: string mapName

GetMapNameById

(integer mapId)

# Returns: string mapName

GetNumMaps

()

# Returns: integer numMaps

MapZoomOut

()

# Returns: SetMapResultCode setMapResult

WouldProcessMapClick

(number normalizedClickX, number normalizedClickY)

# Returns: bool wouldProcess, luaindex:nilable resultingMapIndex

ProcessMapClick

(number normalizedClickX, number normalizedClickY)

# Returns: SetMapResultCode setMapResult

GetZoneIndexByMapId

(integer mapId)

# Returns: luaindex:nilable zoneIndex

GetMapInfoByIndex

(luaindex index)

# Returns: string name, UIMapType mapType, MapContentType mapContentType, luaindex zoneIndex, string description

GetMapInfoById

(integer mapId)

# Returns: string name, UIMapType mapType, MapContentType mapContentType, luaindex zoneIndex, string description

GetUniversallyNormalizedMapInfo

(integer mapId)

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

GetZoneDescription

(luaindex zoneIndex)

# Returns: string description

GetZoneDescriptionById

(integer zoneId)

# Returns: string description

GetMapParentCategories

(luaindex index)

# Uses variable returns...
# Returns: string categoryName, luaindex categoryIndex

GetMapNumTiles

()

# Returns: integer numHorizontalTiles, integer numVerticalTiles

GetMapTileTexture

(luaindex tileIndex)

# Returns: string tileFilename

GetMapNumTilesForMapId

(integer mapId)

# Returns: integer numHorizontalTiles, integer numVerticalTiles

GetMapTileTextureForMapId

(integer mapId, luaindex tileIndex)

# Returns: string tileFilename

GetMapName

()

# Returns: string mapName

GetMapType

()

# Returns: UIMapType mapType

GetMapContentType

()

# Returns: MapContentType mapContentType

GetMapCustomMaxZoom

()

# Returns: number:nilable customMaxZoom

GetMapFilterType

()

# Returns: MapFilterType mapFilterType

GetNumMapLocations

()

# Returns: integer numMapLocations

IsMapLocationVisible

(luaindex locationIndex)

# Returns: bool isVisible

GetMapLocationIcon

(luaindex locationIndex)

# Returns: string icon, number normalizedX, number normalizedZ

GetNumMapLocationTooltipLines

(luaindex locationIndex)

# Returns: integer numLines

IsMapLocationTooltipLineVisible

(luaindex locationIndex, luaindex tooltipLineIndex)

# Returns: bool isVisible

GetMapLocationTooltipLineInfo

(luaindex locationIndex, luaindex tooltipLineIndex)

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

GetMapLocationTooltipHeader

(luaindex locationIndex)

# Returns: string header

GetMapMouseoverInfo

(number normalizedMouseX, number normalizedMouseY)

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

GetNumMapBlobs

()

# Returns: integer numBlobs

GetMapBlobNameInfo

(luaindex blobIndex)

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

GetNumMapKeySections

()

# Returns: integer numSections

GetMapKeySectionName

(luaindex sectionIndex)

# Returns: string sectionName

GetNumMapKeySectionSymbols

(luaindex sectionIndex)

# Returns: integer numSymbols

GetMapKeySectionSymbolInfo

(luaindex sectionIndex, luaindex symbolIndex)

# Returns: string name, textureName icon, string tooltip

GetMapFloorInfo

()

# Returns: luaindex currentFloor, integer numFloors

SetMapFloor

(luaindex desiredFloorIndex)

# Returns: SetMapResultCode setMapResult

ShouldMapShowPriorityFastTravelOnly

()

# Returns: bool showPriorityFastTravelOnly

ClearAutoMapNavigationTarget

()

HasAutoMapNavigationTarget

()

# Returns: bool hasAutoMapNavigationTarget

GetAutoMapNavigationNormalizedPositionForCurrentMap

()

# Returns: number normalizedX, number normalizedY

GetAutoMapNavigationCommonZoomOutMapIndex

()

# Returns: luaindex:nilable commonMapIndex

GetNormalizedWorldPosition

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

# Returns: number normalizedX, number normalizedY

GetRawNormalizedWorldPosition

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

# Returns: number normalizedX, number normalizedY

OnMapUpdateComplete

()

PingMap

(MapDisplayPinType pingType, MapDisplayType mapDisplayType, number normalizedX, number normalizedZ, object mapDisplay)

SetPlayerWaypointByWorldLocation

(integer worldX, integer worldY, integer worldZ)

# Returns: bool success

RemovePlayerWaypoint

()

RemoveRallyPoint

()

GenerateUnitNameTooltipLine

(string unitTag)

# Returns: string text, InterfaceColorType interfaceColorType, integer color

GenerateQuestEndingTooltipLine

(luaindex questIndex)

# Returns: string text, InterfaceColorType interfaceColorType, integer color

GenerateQuestNameTooltipLine

(luaindex questIndex)

# Returns: string text, InterfaceColorType interfaceColorType, integer color

GenerateQuestConditionTooltipLine

(luaindex questIndex, luaindex stepIndex, luaindex conditionIndex, bool useShortDescription)

# Returns: string text, InterfaceColorType interfaceColorType, integer color

GenerateMapPingTooltipLine

(MapDisplayPinType mapPingType, string unitTag)

# Returns: string text, InterfaceColorType interfaceColorType, integer color

GenerateAvAObjectiveConditionTooltipLine

(BattlegroundQueryContextType bgQueryType, integer keepId, integer objectiveId, ObjectivePinTier objectivePinTier)

# Returns: string text, InterfaceColorType interfaceColorType, integer color

GenerateMasterWritBaseText

(string itemLink)

# Returns: string description

GenerateMasterWritRewardText

(string itemLink)

# Returns: string description

GetNumPOIs

(luaindex zoneIndex)

# Returns: integer numPOIs

GetPOIInfo

(luaindex zoneIndex, luaindex poiIndex)

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

GetPOIType

(luaindex zoneIndex, luaindex poiIndex)

# Returns: PointOfInterestType poiType

GetPOIMapInfo

(luaindex zoneIndex, luaindex poiIndex)

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

GetPOIPinIcon

(integer poiId, bool checkNearby)

# Returns: textureName icon, MapDisplayPinType poiPinType

GetPOIIndices

(integer poiId)

# Returns: luaindex zoneIndex, luaindex poiIndex

GetCurrentSubZonePOIIndices

()

# Returns: luaindex:nilable zoneIndex, luaindex:nilable poiIndex

IsInCyrodiil

()

# Returns: bool isInCyrodiil

IsInImperialCity

()

# Returns: bool isInImperialCity

IsInAvAZone

()

# Returns: bool isInAvAZone

IsInOutlawZone

()

# Returns: bool isInOutlawZone

IsInJusticeEnabledZone

()

# Returns: bool isInJusticeZone

CanLeaveCurrentLocationViaTeleport

()

# Returns: bool canLeaveCurrentLocationViaTeleport

DoesCurrentZoneAllowScalingByLevel

()

# Returns: bool allowsScaling

DoesCurrentZoneHaveTelvarStoneBehavior

()

# Returns: bool telvarBehaviorEnabled

DoesCurrentZoneAllowBattleLevelScaling

()

# Returns: bool allowsBattleLevelScaling

GetCurrentZoneLevelScalingConstraints

()

# Returns: ScaleLevelConstraintType scaleLevelContraintType, integer minScaleLevel, integer maxScaleLevel

GetCollectibleIdForZone

(luaindex zoneIndex)

# Returns: integer collectibleId

GetPOIZoneCompletionType

(luaindex zoneIndex, luaindex poiIndex)

# Returns: ZoneCompletionType zoneCompletionType

GetPOISkyshardId

(luaindex zoneIndex, luaindex poiIndex)

# Returns: integer skyshardId

GetPOIInstanceType

(luaindex zoneIndex, luaindex poiIndex)

# Returns: InstanceType instanceType

GetPOIMapFilterOverride

(luaindex zoneIndex, luaindex poiIndex)

# Returns: MapFilter mapFilterOverride

GetCadwellProgressionLevel

()

# Returns: CadwellProgressionLevel cadwellProgressionLevel

GetNumZonesForCadwellProgressionLevel

(CadwellProgressionLevel cadwellProgressionLevel)

# Returns: integer numZones

GetCadwellZoneInfo

(CadwellProgressionLevel cadwellProgressionLevel, luaindex zoneIndex)

# Returns: string zoneName, string zoneDescription, luaindex zoneOrder

GetNumPOIsForCadwellProgressionLevelAndZone

(CadwellProgressionLevel cadwellProgressionLevel, luaindex zoneIndex)

# Returns: integer numPOIs

GetCadwellZonePOIInfo

(CadwellProgressionLevel cadwellProgressionLevel, luaindex zoneIndex, luaindex poiIndex)

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

GetPlayerActiveSubzoneName

()

# Returns: string subzoneName

GetPlayerActiveZoneName

()

# Returns: string zoneName

GetPlayerLocationName

()

# Returns: string mapName

IsPlayerInAvAWorld

()

# Returns: bool isInAvAWorld

IsActiveWorldBattleground

()

# Returns: bool isInBattleground

IsActiveWorldGroupOwnable

()

# Returns: bool isWorldGroupOwnable

IsActiveWorldStarterWorld

()

# Returns: bool isStarterWorld

GuiRender3DPositionToWorldPosition

(number renderX, number renderY, number renderZ)

# Returns: integer worldX, integer worldY, integer worldZ

WorldPositionToGuiRender3DPosition

(integer worldX, integer worldY, integer worldZ)

# Returns: number renderX, number renderY, number renderZ

ExitInstanceImmediately

()

CanExitInstanceImmediately

()

# Returns: bool canExitInstanceImmediately

CanJumpToPlayerInZone

(integer zoneId)

# Returns: bool canJump, JumpToPlayerResult result

GetHistoricalKeepTravelNetworkLinkInfo

(luaindex linkIndex, BattlegroundQueryContextType bgContext, number historyPercent)

# Returns: integer linkType, integer linkOwner, integer restricedToAlliance, number startX, number startY, number endX, number endY

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, bool isShownInCurrentMap, bool linkedCollectibleIsLocked

GetFastTravelNodePOIIndicies

(luaindex nodeIndex)

# Returns: luaindex zoneIndex, luaindex poiIndex

GetFastTravelNodeOutboundOnlyInfo

(luaindex nodeIndex)

# Returns: bool isOutboundOnly, integer errorStringId

GetFastTravelNodeDrawLevelOffset

(luaindex nodeIndex)

# Returns: integer drawLevelOffset

GetFastTravelNodeLinkedCollectibleId

(luaindex nodeIndex)

# Returns: integer collectibleId

GetFastTravelNodeHouseId

(luaindex nodeIndex)

# Returns: integer houseId

GetFastTravelNodeMapPriority

(luaindex nodeIndex)

# Returns: integer:nilable mapPriority

GetFastTravelNodeZoneDisplayType

(luaindex nodeIndex)

# Returns: ZoneDisplayType zoneDisplayType

IsFastTravelNodeAutoDiscovered

(luaindex nodeIndex)

# Returns: bool isAutoDiscovered

HasCompletedFastTravelNodePOI

(luaindex nodeIndex)

# Returns: bool hasCompletedPOI

FastTravelToNode

(luaindex nodeIndex)

GetRecallCost

(luaindex nodeIndex)

# Returns: integer cost

GetRecallCurrency

(luaindex nodeIndex)

# Returns: CurrencyType currency

GetRecallCooldown

()

# Returns: integer remain, integer duration

GetNumObjectives

()

# Returns: integer num

GetObjectiveIdsForIndex

(luaindex index)

# Returns: integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext

DoesObjectiveExist

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool exists

GetObjectiveType

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: ObjectiveType objectiveType

GetObjectiveControlState

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: ObjectiveControlState controlState

GetLastObjectiveControlEvent

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: ObjectiveControlEvent controlEvent

GetObjectiveInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: string objectiveName, ObjectiveType objectiveType, ObjectiveControlState objectiveState

GetObjectivePinInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: MapDisplayPinType pinType, number currentNormalizedX, number currentNormalizedY, bool continuousUpdate

GetObjectiveSpawnPinInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: MapDisplayPinType pinType, number spawnNormalizedX, number spawnNormalizedY

GetObjectiveAuraPinInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: MapDisplayPinType pinType, number red, number green, number blue

GetObjectiveReturnPinInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: MapDisplayPinType pinType, number returnNormalizedX, number returnNormalizedY, bool continuousUpdate

GetObjectiveDesignation

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: ObjectiveDesignation designation

IsBattlegroundObjective

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool isInBattleground

IsCarryableObjectiveCarriedByLocalPlayer

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool isCarried

IsCaptureAreaObjectiveCaptured

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool isCaptured

GetCaptureAreaObjectiveOwner

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: Alliance ownerAlliance

GetCaptureAreaObjectiveLastInfluenceState

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: Alliance alliance, bool wereInfluenceSourcesInRangeOfCaptureArea

GetCarryableObjectiveHoldingAllianceInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: Alliance holdingAlliance, Alliance lastHoldingAlliance

GetCarryableObjectiveHoldingCharacterInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: string rawCharacterName, string displayName, integer classId

GetCarryableObjectiveLastHoldingCharacterInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: string rawCharacterName, string displayName, integer classId

GetCaptureFlagObjectiveOriginalOwningAlliance

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: Alliance originalOwningAlliance

GetArtifactScrollObjectiveOriginalOwningAlliance

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: Alliance originalOwningAlliance

GetKeepThatHasCapturedThisArtifactScrollObjective

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer capturedAtKeepId

GetArtifactReturnObjectiveOwner

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: Alliance ownerAlliance

GetReturnObjectiveOwner

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: Alliance ownerAlliance

GetAvAArtifactScore

(integer campaignId, Alliance alliance, ObjectiveType artifactType)

# Returns: bool allOwnHeld, integer enemyHeld

GetNumArtifactScoreBonuses

(Alliance alliance, ObjectiveType artifactType)

# Returns: integer numBonuses

GetArtifactScoreBonusAbilityId

(Alliance alliance, ObjectiveType artifactType, luaindex index)

# Returns: integer abilityId

IsObjectiveObjectVisible

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool isVisible

IsObjectiveEnabled

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool isEnabled

GetObjectiveVirtualId

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer virtualId

GetKeepArtifactObjectiveId

(integer keepId)

# Returns: integer objectiveId

GetHistoricalAvAObjectivePinInfo

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext, number historyPercent)

# Returns: MapDisplayPinType pinType, number currentNormalizedX, number currentNormalizedY, bool continuousUpdate

DoesObjectivePassCompassVisibilitySubzoneCheck

(integer keepId, integer objectiveId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool doesPassVisiblityCheck

GetBattlegroundGameType

(integer battlegroundId, luaindex:nilable roundIndex)

# Returns: BattlegroundGameType gameType

GetCurrentBattlegroundGameType

(luaindex:nilable roundIndex)

# Returns: BattlegroundGameType gameType

GetScoreToWinBattlegroundRound

(integer battlegroundId, luaindex:nilable roundIndex)

# Returns: integer result

GetScoreToWinCurrentBattlegroundRound

(luaindex:nilable roundIndex)

# Returns: integer result

GetBattlegroundRoundNearingVictoryPercent

(integer battlegroundId, luaindex:nilable roundIndex)

# Returns: number nearingVictoryPercent

GetCurrentBattlegroundRoundNearingVictoryPercent

(luaindex:nilable roundIndex)

# Returns: number nearingVictoryPercent

GetBattlegroundRoundMaxActiveSequencedObjectives

(integer battlegroundId, luaindex:nilable roundIndex)

# Returns: integer maxActiveSequencedObjectives

GetCurrentBattlegroundRoundMaxActiveSequencedObjectives

(luaindex:nilable roundIndex)

# Returns: integer maxActiveSequencedObjectives

GetCurrentBattlegroundId

()

# Returns: integer battlegroundId

LeaveBattleground

()

GetCurrentBattlegroundShutdownTimer

()

# Returns: integer:nilable timeLeftMS

GetCurrentBattlegroundRoundIndex

()

# Returns: luaindex:nilable currentRound

GetLocalPlayerBattlegroundLivesRemaining

()

# Returns: integer numLives

HasTeamWonBattlegroundEarly

()

# Returns: bool isWonEarly

DidLocalPlayerJoinBattlegroundInProgress

()

# Returns: bool joinedInProgress

DidCurrentBattlegroundRequestLFM

()

# Returns: bool lfmRequested

DoesCurrentBattlegroundImpactMMR

()

# Returns: bool impactsMMR

GetCurrentBattlegroundMMRReductionBonusTypes

()

# Returns: BattlegroundMMRBonusType bonusTypes

GetCurrentBattlegroundMMRLossReductionBonus

()

# Returns: number bonusReductionPercent

GetBattlegroundName

(integer battlegroundId)

# Returns: string name

GetBattlegroundDescription

(integer battlegroundId)

# Returns: string description

GetBattlegroundNumRounds

(integer battlegroundId)

# Returns: integer numRounds

DoesBattlegroundHaveRounds

(integer battlegroundId)

# Returns: bool hasRounds

GetBattlegroundNumTeams

(integer battlegroundId)

# Returns: integer numTeams

GetBattlegroundTeamByIndex

(integer battlegroundId, luaindex teamIndex)

# Returns: BattlegroundTeam:nilable battlegroundTeam

DoesBattlegroundHaveTeam

(integer battlegroundId, BattlegroundTeam battlegroundTeam)

# Returns: bool hasTeam

DoesBattlegroundHaveLimitedPlayerLives

(integer battlegroundId)

# Returns: bool hasLimitedLives

GetBattlegroundMaxPlayerLives

(integer battlegroundId)

# Returns: integer maxPlayerLives

GetBattlegroundTeamSize

(integer battlegroundId)

# Returns: integer teamSize

GetBattlegroundInfoTexture

(integer battlegroundId)

# Returns: textureName path

GetBattlegroundNumUsedMedals

(integer battlegroundId)

# Returns: integer numMedals

GetBattlegroundMedalIdByIndex

(integer battlegroundId, luaindex medalIndex)

# Returns: integer medalId

GetMedalInfo

(integer medalId)

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

GetMedalName

(integer medalId)

# Returns: string name

GetMedalScoreReward

(integer medalId)

# Returns: integer scoreReward

QueryBattlegroundLeaderboardData

(BattlegroundLeaderboardType battlegroundType)

# Returns: LeaderboardDataReadyState readyState

GetNextBattlegroundLeaderboardType

(BattlegroundLeaderboardType:nilable lastBattlegroundLeaderboardType)

# Returns: BattlegroundLeaderboardType:nilable nextBattlegroundLeaderboardType

ShouldShowLeaderboardForBattlegroundLeaderboardType

(BattlegroundLeaderboardType battlegroundLeaderboardType)

# Returns: bool shouldShow

GetNumBattlegroundLeaderboardEntries

(BattlegroundLeaderboardType battlegroundLeaderboardType)

# Returns: integer numLeaderboardEntries

GetBattlegroundLeaderboardEntryInfo

(BattlegroundLeaderboardType battlegroundLeaderboardType, luaindex entryIndex)

# Returns: integer rank, string displayName, string characterName, integer score

GetBattlegroundLeaderboardLocalPlayerInfo

(BattlegroundLeaderboardType lastBattlegroundLeaderboardType)

# Returns: integer currentRank, integer currentScore

GetBattlegroundLeaderboardsSchedule

(BattlegroundLeaderboardType leaderboardType)

# Returns: integer secondsUntilEnd, integer secondsUntilNextStart

GetNumScoreboardEntries

(luaindex:nilable roundIndex)

# Returns: integer numItems

GetScoreboardEntryInfo

(luaindex entryIndex, luaindex:nilable roundIndex)

# Returns: string characterName, string displayName, BattlegroundTeam team, bool isLocalPlayer

GetScoreboardEntryBattlegroundTeam

(luaindex entryIndex, luaindex:nilable roundIndex)

# Returns: BattlegroundTeam team

GetScoreboardEntryClassId

(luaindex entryIndex, luaindex:nilable roundIndex)

# Returns: integer classId

GetScoreboardEntryScoreByType

(luaindex entryIndex, ScoreTrackerEntryType scoreType, luaindex:nilable roundIndex)

# Returns: integer score

GetNextScoreboardEntryMedalId

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

# Returns: integer:nilable nextMedalId

GetScoreboardEntryNumEarnedMedalsById

(luaindex entryIndex, integer medalId, luaindex:nilable roundIndex)

# Returns: integer count

GetScoreboardEntryNumLivesRemaining

(luaindex entryIndex, luaindex:nilable roundIndex)

# Returns: integer numLivesRemaining

GetBattlegroundCumulativeScoreForScoreboardEntryByType

(luaindex entryIndex, ScoreTrackerEntryType scoreType, luaindex:nilable roundIndex)

# Returns: integer score

GenerateCumulativeMedalInfoForScoreboardEntry

(luaindex entryIndex, luaindex:nilable roundIndex)

GetNextBattlegroundCumulativeMedalId

(integer:nilable lastMedalId)

# Returns: integer:nilable nextMedalId

GetBattlegroundCumulativeNumEarnedMedalsById

(integer medalId)

# Returns: integer count

GetCurrentBattlegroundRoundResult

(luaindex:nilable roundIndex)

# Returns: BattlegroundRoundResult:nilable roundResult

GetCurrentBattlegroundScore

(luaindex roundIndex, BattlegroundTeam team)

# Returns: integer score

GetCurrentBattlegroundRoundsWonByTeam

(BattlegroundTeam battlegroundTeam)

# Returns: integer numWins

DidCurrentBattlegroundTeamWinOrTieRound

(BattlegroundTeam battlegroundTeam, luaindex:nilable roundIndex)

# Returns: bool wonOrTied

GetBattlegroundResultForTeam

(BattlegroundTeam battlegroundTeam)

# Returns: BattlegroundResult result

GetCurrentBattlegroundState

()

# Returns: BattlegroundState result

IsCurrentBattlegroundStateTimed

()

# Returns: bool isTimed

GetCurrentBattlegroundStateTimeRemaining

()

# Returns: integer timeRemaining

GetScoreboardLocalPlayerEntryIndex

(luaindex:nilable roundIndex)

# Returns: luaindex playerIndex

GetCampaignAllianceScore

(integer campaignId, Alliance 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: Alliance alliance

GetSecondsUntilCampaignUnderdogReevaluation

(integer campaignId)

# Returns: integer seconds

GetPendingAssignedCampaign

()

# Returns: integer campaignId

IsInCampaign

()

# Returns: bool inCampaign

DoesCampaignHaveEmperor

(integer campaignId)

# Returns: bool hasEmperor

GetCampaignEmperorInfo

(integer campaignId)

# Returns: Alliance emperorAlliance, string emperorCharacterName, string emperorDisplayName

GetCampaignEmperorReignDuration

(integer campaignId)

# Returns: integer durationInSeconds

GetCampaignAbdicationStatus

(integer campaignId)

# Returns: Alliance abdicatedAlliance, string abdicatedCharacterName, string abdicatedDisplayName

GetEmperorAllianceBonusAbilityId

(integer rankIndex)

# Returns: integer abilityId

GetCampaignReassignCooldown

()

# Returns: integer cooldownSeconds

GetCampaignReassignInitialCooldown

()

# Returns: integer cooldownSeconds

GetCampaignReassignCost

(CampaignReassignmentRequestType reassignType)

# Returns: integer cost

GetCurrentCampaignId

()

# Returns: integer currentCampaignId

GetAssignedCampaignId

()

# Returns: integer assignedCampaignId

GetNumFreeAnytimeCampaignReassigns

()

# Returns: integer reassignCount

GetNumFreeEndCampaignReassigns

()

# Returns: integer reassignCount

AssignCampaignToPlayer

(integer campaignId, CampaignReassignmentRequestType reassignOnEnd)

GetCampaignUnassignCooldown

()

# Returns: integer cooldownSeconds

GetCampaignUnassignInitialCooldown

()

# Returns: integer cooldownSeconds

GetCampaignUnassignCost

(CampaignUnassignRequestType campaignUnassignType)

# Returns: integer cost

GetNumFreeAnytimeCampaignUnassigns

()

# Returns: integer unassignCount

UnassignCampaignForPlayer

(CampaignUnassignRequestType campaignUnassignType)

QueryCampaignSelectionData

()

GetCampaignSequenceId

(integer campaignId)

# Returns: integer sequenceId

QueryCampaignLeaderboardData

(Alliance alliance)

# Returns: LeaderboardDataReadyState readyState

GetLeaderboardCampaignSequenceId

(integer campaignId)

# Returns: integer campaignSequenceId

GetCampaignLeaderboardMaxRank

(integer campaignId)

# Returns: integer maxRank

GetNumCampaignLeaderboardEntries

(integer campaignId)

# Returns: integer entryCount

GetNumCampaignAllianceLeaderboardEntries

(integer campaignId, Alliance alliance)

# Returns: integer entryCount

GetCampaignLeaderboardEntryInfo

(integer campaignId, luaindex entryIndex)

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

GetCampaignAllianceLeaderboardEntryInfo

(integer campaignId, Alliance alliance, luaindex entryIndex)

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

GetPlayerCampaignRewardTierInfo

(integer campaignId)

# Returns: integer earnedTier, integer nextTierProgress, integer nextTierTotal

GetNumSelectionCampaigns

()

# Returns: integer campaignCount

GetSelectionCampaignAllianceScore

(luaindex campaignIndex, integer alliance)

# Returns: integer score

GetSelectionCampaignId

(luaindex campaignIndex)

# Returns: integer campaignId

GetSelectionCampaignTimes

(luaindex campaignIndex)

# Returns: integer secondsUntilCampaignStart, integer secondsUntilCampaignEnd

GetSelectionCampaignUnderdogLeaderAlliance

(luaindex campaignIndex)

# Returns: Alliance alliance

GetNumSelectionCampaignFriends

(luaindex campaignIndex)

# Returns: integer numFriends

GetNumSelectionCampaignGuildMembers

(luaindex campaignIndex)

# Returns: integer numGuilds

GetNumSelectionCampaignGroupMembers

(luaindex campaignIndex)

# Returns: integer numGroupmates

GetSelectionCampaignPopulationData

(luaindex campaignIndex, Alliance alliance)

# Returns: CampaignPopulationType currentPopulationEstimate

GetSelectionCampaignQueueWaitTime

(luaindex campaignIndex)

# Returns: integer queueWaitTimeSeconds

GetSelectionCampaignCurrentAllianceLock

(luaindex campaignIndex)

# Returns: Alliance lockedToAlliance

GetSelectionCampaignAllianceLockReason

(luaindex campaignIndex)

# Returns: CampaignAllianceLockReason allianceLockReason

GetSelectionCampaignAllianceLockConflictingCharacterName

(luaindex campaignIndex)

# Returns: string:nilable conflictingCharacterName

DoesPlayerMeetCampaignRequirements

(integer campaignId)

# Returns: bool meetsJoiningRequirements

GetCampaignRulesetId

(integer campaignId)

# Returns: integer rulesetId

GetCampaignRulesetName

(integer rulesetId)

# Returns: string name

GetCampaignRulesetType

(integer rulesetId)

# Returns: CampaignRulesetType rulesetType

GetCampaignRulesetDescription

(integer rulesetId)

# Returns: string description

GetCurrentCampaignLoyaltyStreak

()

# Returns: integer currentLoyaltyStreak

GetCampaignRulesetNumImperialKeeps

(integer rulesetId, Alliance alliance)

# Returns: integer numKeeps

GetCampaignRulesetImperialKeepId

(integer rulesetId, Alliance alliance, luaindex index)

# Returns: integer keepId

GetCampaignRulsetMinEmperorAlliancePoints

(integer rulesetId, Alliance alliance)

# Returns: integer minPoints

GetCampaignRulesetDurationInSeconds

(integer rulesetId)

# Returns: integer duration

DoesCurrentCampaignRulesetAllowChampionPoints

()

# Returns: bool allowsChampionPoints

RegisterForAssignedCampaignData

()

UnregisterForAssignedCampaignData

()

ResetCampaignHistoryWindow

(BattlegroundQueryContextType battlegroundContext, number currentHistoryPercent)

# Returns: bool requiresRebuild

GetCampaignHistoryWindow

(BattlegroundQueryContextType battlegroundContext)

# Returns: integer windowStartSecsAgo, integer windowEndSecsAgo

DoesHistoryRequireMapRebuild

(BattlegroundQueryContextType battlegroundContext, number oldHistoryPercent, number newHistoryPercent)

# Returns: bool needsRebuild

IsUnderpopBonusEnabled

(integer campaignId, Alliance alliance)

# Returns: bool isBonusEnabled

IsLocalBattlegroundContext

(integer battlegroundContext)

# Returns: bool isLocal

IsAssignedBattlegroundContext

(integer battlegroundContext)

# Returns: bool isAssigned

DoBattlegroundContextsIntersect

(integer context1, integer context2)

# Returns: bool intersects

GetNumKillLocations

()

# Returns: integer numLocations

GetNumKillLocationAllianceKills

(luaindex index, Alliance alliance)

# Returns: integer numKills

GetKillLocationPinInfo

(luaindex index)

# Returns: integer pinType, number normalizedX, number normalizedY

GetCampaignHoldings

(integer campaignId, CampaignHoldingType holdingType, Alliance alliance, Alliance targetAlliance)

# Returns: integer holdingsControlled

GetTotalCampaignHoldings

(integer campaignId, CampaignHoldingType holdingType, Alliance alliance)

# Returns: integer holdingsControlled

GetCampaignAlliancePotentialScore

(integer campaignId, Alliance alliance)

# Returns: integer potentialScore

GetCampaignHoldingScoreValues

(integer campaignId)

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

GetCampaignName

(integer campaignId)

# Returns: string campaignName

CanCampaignBeAllianceLocked

(integer campaignId)

# Returns: bool canCampaignBeAllianceLocked

IsImperialCityCampaign

(integer campaignId)

# Returns: bool isImperialCityCampaign

GetNumCampaignRulesetTypes

()

# Returns: integer numRulesetTypes

GetMinLevelForCampaignTutorial

()

# Returns: integer minLevelForCampaignTutorial

HasAllianceLockPendingNotification

()

# Returns: bool hasNotification

GetAllianceLockPendingNotificationInfo

()

# Returns: integer:nilable campaignId, Alliance:nilable alliance, integer:nilable timeLeftS

MarkAllianceLockPendingNotificationSeen

()

DoesTelVarAmountPreventQueuingForCampaign

(integer campaignId)

# Returns: bool isPreventedFromQueuing

GetExpectedGroupQueueResult

()

# Returns: QueueForCampaignResponseType queueForCampaignResult

QueueForCampaign

(integer campaignId, bool queueAsGroup)

CanLeaveCampaignQueue

(integer campaignId, bool queueAsGroup)

# Returns: LeaveCampaignQueueResponseType result

LeaveCampaignQueue

(integer campaignId, bool queueAsGroup)

GetNumCampaignQueueEntries

()

# Returns: integer entryCount

IsQueuedForCampaign

(integer campaignId, bool queueAsGroup)

# Returns: bool isQueued

GetCampaignQueueEntry

(luaindex entryIndex)

# Returns: integer campaignId, bool queueAsGroup

GetSecondsInCampaignQueue

(integer campaignId, bool queueAsGroup)

# Returns: integer timeInQueueInSeconds

GetCampaignQueuePosition

(integer campaignId, bool queueAsGroup)

# Returns: integer queuePosition

GetCampaignQueueRemainingConfirmationSeconds

(integer campaignId, bool queueAsGroup)

# Returns: integer confirmationTimeRemainingInSeconds

GetCampaignQueueState

(integer campaignId, bool queueAsGroup)

# Returns: CampaignQueueRequestStateType currentState

ConfirmCampaignEntry

(integer campaignId, bool queueAsGroup, bool accept)

GetCampaignQueueConfirmationDuration

()

# Returns: integer numSeconds

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

GetStoreCollectibleInfo

(luaindex entryIndex)

# Returns: integer collectibleId, bool owned

GetStoreEntryHouseTemplateId

(luaindex entryIndex)

# Returns: integer houseTemplateId

GetStoreEntryQuestItemId

(luaindex entryIndex)

# Returns: integer questItemId

GetStoreEntryAntiquityId

(luaindex entryIndex)

# Returns: integer antiquityId

GetNumStoreItems

()

# Returns: integer numItems

GetNumBuybackItems

()

# Returns: integer numBuybackItems

GetStoreCurrencyTypes

()

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

GetStoreUsedCurrencyTypes

()

# Uses variable returns...
# Returns: CurrencyType currencyType

GetStoreItemLink

(luaindex entryIndex, LinkStyle linkStyle)

# Returns: string link

GetStoreEntryTypeInfo

(luaindex entryIndex)

# Uses variable returns...
# Returns: ItemFilterType itemFilterType

GetStoreEntryStatValue

(luaindex entryIndex)

# Returns: integer statValue

GetStoreDefaultSortField

()

# Returns: StoreDefaultSortField defaultSortField

GetStoreEntryMaxBuyable

(luaindex entryIndex)

# Returns: integer quantity

GetBuybackItemInfo

(luaindex entryIndex)

# Returns: textureName icon, string name, integer stack, integer price, ItemQuality functionalQuality, bool meetsRequirementsToEquip, ItemDisplayQuality displayQuality

GetBuybackItemLink

(luaindex entryIndex, LinkStyle linkStyle)

# Returns: string link

BuyStoreItem

(luaindex entryIndex, integer quantity)

BuybackItem

(luaindex entryIndex)

SellInventoryItem

(Bag bagId, integer slotIndex, integer quantity)

SellAllJunk

()

CloseStore

()

RepairAll

()

RepairItem

(Bag bagId, integer slotIndex)

LaunderItem

(Bag bagId, integer slotIndex, integer quantity)

IsStoreEmpty

()

# Returns: bool isEmpty

CanStoreRepair

()

# Returns: bool canRepair

LootAll

(bool ignoreStolenItems)

GetLootItemLink

(integer lootId, LinkStyle linkStyle)

# Returns: string link

GetLootItemType

(integer lootId)

# Returns: LootItemType itemType

LootItemById

(integer lootId)

LootCurrency

(CurrencyType type)

LootMoney

()

EndLooting

()

IsLooting

()

# Returns: bool isLooting

GetLootTargetInfo

()

# Returns: string name, InteractTargetType targetType, string actionName, bool isOwned

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

GetLootCurrency

(CurrencyType type)

# Returns: integer unownedCurrency, integer ownedCurrency

GetLootMoney

()

# Returns: integer unownedMoney, integer ownedMoney

GetLootQuestItemId

(integer lootId)

# Returns: integer questItemId

GetLootAntiquityLeadId

(integer lootId)

# Returns: integer antiquityId

GetLootTributeCardUpgradeInfo

(integer lootId)

# Returns: integer tributePatronDefId, luaindex tributeCardIndex

GetKeepType

(integer keepId)

# Returns: KeepType keepType

GetNumKeeps

()

# Returns: integer numKeeps

GetAvAKeepScore

(integer campaignId, integer alliance)

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

GetAvAKeepsHeld

(integer campaignId, integer alliance)

# Returns: integer keepsHeld

GetNumKeepScoreBonuses

()

# Returns: integer numBonuses

GetKeepScoreBonusAbilityId

(luaindex index)

# Returns: integer abilityId

GetEdgeKeepBonusAbilityId

(luaindex index)

# Returns: integer abilityId

GetKeepPinInfo

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer pinType, number normalizedX, number normalizedY

GetKeepName

(integer keepId)

# Returns: string keepName

GetKeepAlliance

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer alliance

GetResourceKeepForKeep

(integer parentKeepId, KeepResourceType resourceType)

# Returns: integer keepId

GetKeepResourceLevel

(integer keepId, BattlegroundQueryContextType battlegroundContext, KeepResourceType resourceType)

# Returns: integer resourceLevel

GetKeepResourceType

(integer keepId)

# Returns: KeepResourceType resourceType

GetKeepResourceInfo

(integer keepId, BattlegroundQueryContextType battlegroundContext, KeepResourceType resourceType, integer level)

# Returns: integer currentAmount, integer amountForNextLevel, integer upkeepPerMinute

GetKeepUpgradeInfo

(integer keepId, BattlegroundQueryContextType battlegroundContext, KeepUpgradePath upgradePath, integer level)

# Returns: integer currentAmount, integer amountForNextLevel, integer upkeepPerMinute

GetKeepProductionLevel

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer productionLevel

GetKeepDefensiveLevel

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer defensiveLevel

GetSecondsUntilKeepClaimAvailable

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer secondsUntilAvailable

GetGuildClaimInteractionKeepId

()

# Returns: integer keepId

GetGuildReleaseInteractionKeepId

()

# Returns: integer keepId

CancelKeepGuildClaimInteraction

()

CancelKeepGuildReleaseInteraction

()

GetHistoricalKeepUnderAttack

(integer keepId, BattlegroundQueryContextType battlegroundContext, number historyPercent)

# Returns: bool underAttack

GetHistoricalKeepPinInfo

(integer keepId, BattlegroundQueryContextType battlegroundContext, number historyPercent)

# Returns: integer pinType, number normalizedX, number normalizedY

GetHistoricalKeepAlliance

(integer keepId, BattlegroundQueryContextType battlegroundContext, number historyPercent)

# Returns: integer alliance

GetInteractionKeepId

()

# Returns: integer keepId

GetKeepUnderAttack

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool underAttack

IsKeepPassable

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool isPassable

GetKeepDirectionalAccess

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: KeepPieceDirectionalAccess directionalAccess

GetKeepUpgradeRate

(integer keepId, BattlegroundQueryContextType battlegroundContext, KeepUpgradeLine upgradeLine)

# Returns: integer rate

GetClaimedKeepGuildName

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: string guildName

GetMaxKeepSieges

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer maxSiege

GetMaxKeepNPCs

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer maxNPC

GetNumFriendlyKeepNPCs

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer numFriendlyNPC

GetNumSieges

(integer keepId, BattlegroundQueryContextType battlegroundContext, integer alliance)

# Returns: integer numSieges

GetKeepKeysByIndex

(luaindex index)

# Returns: integer keepId, integer battlegroundContext

IsKeepTypeClaimable

(KeepType keepType)

# Returns: bool isClaimable

IsKeepTypeCapturable

(KeepType keepType)

# Returns: bool isCapturable

DoesKeepTypeHaveSiegeLimit

(KeepType keepType)

# Returns: bool hasSiegeLimit

IsKeepTypePassable

(KeepType keepType)

# Returns: bool isPassable

GetDistrictOwnershipTelVarBonusPercent

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer districtOwnershipTelVarBonusPercent

GetKeepCaptureBonusPercent

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: integer keepCaptureBonusPercent

DoesKeepPassCompassVisibilitySubzoneCheck

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool doesPassVisibilityCheck

GetKeepRecallAvailable

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool canRecall

CanUseKeepRecallStone

()

# Returns: KeepRecallStoneUseResult useResult

GetKeepMaxUpgradeLevel

(integer keepId)

# Returns: integer maxLevel

GetNumEdgeKeepBonuses

()

# Returns: integer numBonuses

IsKeepTravelBlockedByDaedricArtifact

(integer keepId)

# Returns: bool isKeepTravelBlockedByDaedricArtifact

CanKeepBeFastTravelledTo

(integer keepId, BattlegroundQueryContextType battlegroundContext)

# Returns: bool canKeepBeFastTravelledTo

GetNumTitles

()

# Returns: integer titleCount

GetTitle

(luaindex titleIndex)

# Returns: string titleString

GetCurrentTitleIndex

()

# Returns: luaindex:nilable titleIndex

SelectTitle

(luaindex:nilable titleIndex)

AcceptResurrect

()

DeclineResurrect

()

IsResurrectPending

()

# Returns: bool resurrectPending

GetPendingResurrectInfo

()

# Returns: string casterName, integer timeLeft, string casterDisplayName

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

DidDeathCauseDurabilityDamage

()

# Returns: bool causedDurabilityDamage

Revive

()

Release

()

JoinRespawnQueue

()

IsQueuedForCyclicRespawn

()

# Returns: bool queuedForRespawn

RespawnAtKeep

(integer keepId)

IsDuelingDeath

()

# Returns: bool duelingDeath

GetIsInDisableSelfResurrectInPlaceSubzone

()

# Returns: bool isInDisabledSelfResurrectInPlaceSubzone

RespawnAtForwardCamp

(luaindex index)

GetNumForwardCamps

(BattlegroundQueryContextType battlegroundContext)

# Returns: integer num

GetForwardCampPinInfo

(BattlegroundQueryContextType battlegroundContext, luaindex index)

# Returns: integer pinType, number normalizedX, number normalizedY, number normalizedRadius, bool useable

GetNextForwardCampRespawnTime

()

# Returns: integer nextForwardCampRespawnTime

GetDuelInfo

()

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

ChallengeTargetToDuel

(string characterOrDisplayName)

AcceptDuel

()

DeclineDuel

()

IsNearDuelBoundary

()

# Returns: bool isNearBoundary

TradeInvite

(string target)

TradeInviteByName

(string playerName)

TradeInviteAccept

()

TradeInviteDecline

()

GetTradeInviteInfo

()

# Returns: string characterName, integer millisecondsSinceRequest, string displayName

TradeSetMoney

(integer amount)

TradeInviteCancel

()

TradeCancel

()

TradeAccept

()

TradeEdit

()

TradeAddItem

(Bag bagId, integer slotIndex, luaindex:nilable tradeIndex)

TradeRemoveItem

(luaindex tradeIndex)

GetTradeItemInfo

(TradeParticipant who, luaindex tradeIndex)

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

IsTradeItemBoPAndTradeable

(TradeParticipant who, luaindex tradeIndex)

# Returns: bool isBoPAndTradeable

GetTradeItemBoPTimeRemainingSeconds

(TradeParticipant who, luaindex tradeIndex)

# Returns: integer timeRemainingS

GetTradeItemBoPTradeableDisplayNamesString

(TradeParticipant who, luaindex tradeIndex)

# Returns: string namesString

GetTradeItemBagAndSlot

(TradeParticipant who, luaindex tradeIndex)

# Returns: Bag:nilable bagId, integer:nilable slotIndex

GetTradeItemLink

(TradeParticipant who, luaindex tradeIndex, LinkStyle linkStyle)

# Returns: string link

GetTradeMoneyOffer

(TradeParticipant who)

# Returns: integer moneyOffer

GetIsTrackedForContentId

(TrackedDataType trackType, integer contentId)

# Returns: bool tracked

GetNumTracked

()

# Returns: integer numTracked

IsTrackingDataAvailable

()

# Returns: bool isAvailable

RemoveMapPin

(MapDisplayPinType pinType, integer param1, integer param2, integer param3)

AddMapQuestPins

(luaindex journalQuestIndex, TrackingLevel trackingLevel)

RemoveMapQuestPins

(luaindex journalQuestIndex)

AddMapZoneStoryPins

()

RemoveMapZoneStoryPins

()

AddMapAntiquityDigSitePins

()

RemoveMapAntiquityDigSitePins

()

StartMapPinAnimation

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

# Returns: bool played

StopMapPinAnimation

(MapDisplayPinType pinType, integer param1, integer param2, integer param3)

IsPlayerInsidePinArea

(MapDisplayPinType pinType, integer param1, integer param2, integer param3)

# Returns: bool isPlayerInside

RemoveMapPinsByType

(MapDisplayPinType pinType)

RemoveMapPinsInRange

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

AssistedQuestPinForTracked

(MapDisplayPinType trackedPinType)

# Returns: MapDisplayPinType assistedPinType

TrackedQuestPinForAssisted

(MapDisplayPinType assistedPinType)

# Returns: MapDisplayPinType trackedPinType

GetQuestPinTypeForTrackingLevel

(MapDisplayPinType pinType, TrackingLevel trackingLevel)

# Returns: MapDisplayPinType pinTypeForTrackingLevel

SetPinTint

(MapDisplayPinType pinType, number red, number green, number blue, integer param1, integer param2, integer param3)

SetMapQuestPinsTrackingLevel

(luaindex journalQuestIndex, TrackingLevel trackingLevel)

AreSkillsInitialized

()

# Returns: bool areInitialized

GetAvailableSkillPoints

()

# Returns: integer numPoints

GetNumSkyShards

()

# Returns: integer numShards

GetNumSkillTypes

()

# Returns: integer numSkillTypes

GetNumSkillLines

(SkillType skillType)

# Returns: integer numSkillLines

GetSkillLineId

(SkillType skillType, luaindex skillLineIndex)

# Returns: integer skillLineId

GetSkillLineUnlockTextById

(integer skillLineId)

# Returns: string unlockText

GetSkillLineDynamicInfo

(SkillType skillType, luaindex skillLineIndex)

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

GetSkillLineXPInfo

(SkillType skillType, luaindex skillLineIndex)

# Returns: integer lastRankXP, integer nextRankXP, integer currentXP

GetSkillLineRankXPExtents

(SkillType skillType, luaindex skillLineIndex, luaindex rank)

# Returns: integer:nilable startXP, integer:nilable nextRankStartXP

GetSkillLineOrderingIndex

(SkillType skillType, luaindex skillLineIndex)

# Returns: luaindex orderingIndex

GetSkillLinePointCostMultiplier

(SkillType skillType, luaindex skillLineIndex)

# Returns: integer multiplier

GetNumSkillAbilities

(SkillType skillType, luaindex skillLineIndex)

# Returns: integer numAbilities

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

GetSkillLineProgressionAbilityRank

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

# Returns: integer rank

GetUpgradeSkillHighestRankAvailableAtSkillLineRank

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex, luaindex skillLineRank)

# Returns: integer:nilable availableSkillRank

GetSkillAbilityId

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex, bool showUpgrade)

# Returns: integer abilityId

GetNumPassiveSkillRanks

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: integer numRanks

GetProgressionSkillProgressionIndex

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: luaindex:nilable progressionIndex

GetProgressionSkillProgressionId

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: integer progressionId

GetProgressionSkillProgressionName

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: string progressionName

GetProgressionSkillMorphSlotAbilityId

(integer progressionId, MorphSlot morphSlot)

# Returns: integer abilityId

GetProgressionSkillMorphSlotChainedAbilityIds

(integer progressionId, MorphSlot morphSlot)

# Uses variable returns...
# Returns: integer abilityId

GetProgressionSkillMorphSlotRankXPExtents

(integer progressionId, MorphSlot morphSlot, integer rank)

# Returns: integer startXP, integer endXP

GetCraftedAbilitySkillCraftedAbilityId

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: integer craftedAbilityId

GetSpecificSkillAbilityInfo

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

# Returns: integer abilityId, luaindex skillLineRankNeeded, integer characterLevelNeeded

GetSpecificSkillAbilityKeysByAbilityId

(integer abilityId)

# Returns: SkillType skillType, luaindex skillLineIndex, luaindex skillIndex, integer morphChoice, integer rank

GetSkillAbilityUpgradeInfo

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: integer:nilable currentUpgradeLevel, integer:nilable maxUpgradeLevel

GetSkillAbilityNextUpgradeInfo

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: string name, textureName texture, luaindex:nilable earnedRank

IsSkillAbilityPassive

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: bool isPassive

IsCraftedAbilitySkill

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: bool isCraftedAbility

IsSkillAbilityUltimate

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: bool isUltimate

IsSkillAbilityAutoGrant

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: bool isAutoGrant

GetSkillAbilityLineRankNeededToUnlock

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: luaindex lineRankNeededToUnlock

GetSkillAbilityCharacterLevelNeededToUnlock

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: integer levelNeededToUnlock

IsSkillAbilityPurchased

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: bool isPurchased

SetAdviseSkillLine

(SkillType skillType, luaindex skillLineIndex, bool advise)

GetSkillAbilityIndicesFromProgressionIndex

(luaindex progressionIndex)

# Returns: SkillType skillType, luaindex skillLineIndex, luaindex skillIndex

GetSkillAbilityIndicesFromCraftedAbilityId

(integer craftedAbilityId)

# Returns: SkillType skillType, luaindex skillLineIndex, luaindex skillIndex

GetSkillLineIndicesFromSkillId

(integer skillId)

# Returns: SkillType skillType, luaindex skillLineIndex

GetSkillLineIndicesFromSkillLineId

(integer skillLineId)

# Returns: SkillType skillType, luaindex skillLineIndex

GetSkillLineGameplayActorCategory

(integer skillLineId)

# Returns: GameplayActorCategory gameplayActorCategory

IsWerewolfSkillLineById

(integer skillLineId)

# Returns: bool isWerewolfSkillLine

IsPlayerClassSkillLineById

(integer skillLineId)

# Returns: bool isPlayerClassSkillLine

GetSkillLineAnnouncementIconById

(integer skillLineId)

# Returns: textureName announcementIcon

GetSkillLineCraftingGrowthTypeById

(integer skillLineId)

# Returns: TradeskillType craftingSkillType

GetSkillLineMasteryCollectibleId

(integer skillLineId)

# Returns: integer collectibleId

GetSkillsAdvisorSuggestionLimit

()

# Returns: integer suggestionLimit

GetSubclassingAchievementId

()

# Returns: integer achievementId

GetSubclassingQuestId

()

# Returns: integer questId

BestowSubclassingQuest

()

GetSubclassingAccessLevel

()

# Returns: SubclassingAccessLevel accessLevel

HasAccessToSubclassing

()

# Returns: bool hasAccess

GetFirstFreeValidSlotForSkillAbility

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: luaindex:nilable freeSlotIndex

GetAssignedSlotFromSkillAbility

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex)

# Returns: luaindex:nilable actionSlotIndex

SlotSkillAbilityInSlot

(SkillType skillType, luaindex skillLineIndex, luaindex skillIndex, luaindex actionSlotIndex)

GetSkillRespecCost

(SkillPointAllocationMode allocationMode)

# Returns: integer cost

GetPendingSkillRespecScrollItemLink

()

# Returns: string itemLink

PrepareSkillPointAllocationRequest

(SkillPointAllocationMode allocationMode, RespecPaymentType respecPaymentType)

AddTrainingToAllocationRequest

(integer skillLineIdsToTrain)

DeactivateSkillLinesInAllocationRequest

(integer skillLineIdsToDeactivate)

ActivateSkillLinesInAllocationRequest

(integer skillLineIdsToDeactivate)

AddActiveChangeToAllocationRequest

(integer skillLineId, integer progressionId, MorphSlot morphSlot, bool isPurchased)

AddPassiveChangeToAllocationRequest

(integer skillLineId, integer abilityId, bool isRemoval)

AddHotbarSlotChangeToAllocationRequest

(luaindex actionSlotIndex, HotBarCategory hotbarCategory, ActionBarSlotType actionType, integer actionId)

SendSkillPointAllocationRequest

()

CancelSkillPointAllocationRequest

()

GetSkillRespecCastTimeRemainingMs

()

# Returns: integer timeRemainingMs

GetClassAccessCollectibleId

(integer classId)

# Returns: integer collectibleId

GetNumSkillLinesForClass

(integer classId)

# Returns: integer numSkillLines

GetSkillLineIdForClass

(integer classId, luaindex classSkillLineIndex)

# Returns: integer skillLineId

GetSkillLineClassId

(SkillType skillType, luaindex skillLineIndex)

# Returns: integer classId

StartSkillRespecFromUI

()

AreCompanionSkillsInitialized

()

# Returns: bool initialized

GetCompanionSkillLineNameById

(integer skillLineId)

# Returns: string name

GetNumCompanionSkillLines

(SkillType skillType)

# Returns: integer numSkillLines

GetCompanionSkillLineId

(SkillType skillType, luaindex skillLineIndex)

# Returns: integer skillLineId

GetCompanionSkillLineDynamicInfo

(integer skillLineId)

# Returns: luaindex rank, bool active, bool discovered

GetCompanionSkillLineXPInfo

(integer skillLineId)

# Returns: integer lastRankXP, integer nextRankXP, integer currentXP

GetNumAbilitiesInCompanionSkillLine

(integer skillLineId)

# Returns: integer numAbilities

GetCompanionAbilityId

(integer skillLineId, luaindex abilityIndex)

# Returns: integer abilityId

IsCompanionAbilityUnlocked

(integer abilityId)

# Returns: bool isUnlocked

GetCompanionAbilityRankRequired

(integer abilityId)

# Returns: luaindex rankRequired

GetSkillBuildTutorialLevel

()

# Returns: integer level

GetNumAvailableSkillBuilds

()

# Returns: integer numSkillBuilds

GetSkillBuildInfo

(integer skillBuildId)

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

GetNumSkillBuildAbilities

(integer skillBuildId)

# Returns: integer numSkillBuilds

GetSkillBuildEntryInfo

(integer skillBuildId, luaindex skillBuildAbilityIndex)

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

GetAvailableSkillBuildIdByIndex

(luaindex skillBuildIndex)

# Returns: integer skillBuildId

SelectSkillBuild

(integer skillBuildId, bool isAdvancedMode)

GetSkillBuildId

()

# Returns: integer skillBuildId

IsSkillBuildAdvancedMode

()

# Returns: bool isSkillBuildAdvancedMode

GetDefaultSkillBuildId

()

# Returns: integer skillBuildId

SetHealthWarningStage

(HealthWarningStage stage)

FlashHealthWarningStage

(HealthWarningStage stage, integer flashTimeMs)

ClearHealthWarnings

()

SetFlashWaitTime

(integer waitTimeMs)

IsLocalMailboxFull

(MailCategory category)

# Returns: bool isFull

GetNumMailItemsByCategory

(MailCategory category)

# Returns: integer numMail

GetMailIdByIndex

(MailCategory category, luaindex index)

# Returns: id64 mailId

GetNumMailItems

()

# Returns: integer numMail

GetNextMailId

(id64:nilable lastMailId)

# Returns: id64:nilable nextMailId

GetMailItemInfo

(id64 mailId)

# Returns: string senderDisplayName, string senderCharacterName, string subject, textureName icon, bool unread, bool fromSystem, bool fromCustomerService, bool returned, integer numAttachments, integer attachedMoney, integer codAmount, integer:nilable expiresInDays, integer secsSinceReceived, MailCategory category

GetMailSender

(id64 mailId)

# Returns: string senderDisplayName, string senderCharacterName

GetMailFlags

(id64 mailId)

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

SendMail

(string to, string subject, string body)

GetQueuedMailPostage

()

# Returns: integer postage

ClearQueuedMail

()

CloseMailbox

()

RequestReadMail

(id64 mailId)

# Returns: RequestReadMailResult result

DeleteMail

(id64 mailId)

IsMailReturnable

(id64 mailId)

# Returns: bool isReturnable

ReturnMail

(id64 mailId)

ReadMail

(id64 mailId)

# Returns: string body

HasUnreadMail

()

# Returns: bool unread

HasUnreceivedMail

()

# Returns: bool unreceived

GetNumUnreadMail

()

# Returns: integer numUnread

CanQueueItemAttachment

(Bag bagId, integer slotIndex, luaindex attachmentSlot)

# Returns: bool canAttach

RemoveQueuedItemAttachment

(luaindex attachmentSlot)

QueueMoneyAttachment

(integer amount)

GetQueuedMoneyAttachment

()

# Returns: integer amount

QueueCOD

(integer amount)

GetQueuedCOD

()

# Returns: integer amount

GetMailQueuedAttachmentLink

(luaindex attachmentSlot, LinkStyle linkStyle)

# Returns: string link

GetQueuedItemAttachmentInfo

(luaindex attachmentSlot)

# Returns: Bag bagId, integer slotIndex, textureName icon, integer stack

GetAttachedItemLink

(id64 mailId, luaindex attachIndex, LinkStyle linkStyle)

# Returns: string link

GetAttachedItemInfo

(id64 mailId, luaindex attachIndex)

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

TakeMailAttachedItems

(id64 mailId)

TakeMailAttachedMoney

(id64 mailId)

TakeMailAttachments

(id64 mailId, bool deleteOnClaim)

TakeAllMailAttachmentsInCategory

(MailCategory category, bool deleteOnClaim)

CanTryTakeAllMailAttachmentsInCategory

(MailCategory category, bool deleteOnClaim)

# Returns: bool canTakeAttachments

RequestOpenMailbox

()

IsReadMailInfoReady

(id64 mailId)

# Returns: bool isReady

QueueItemAttachment

(Bag bagId, integer slotIndex, luaindex attachmentSlot)

# Returns: integer itemAttachmentResult

GetNumAchievementCategories

()

# Returns: integer numCategories

GetAchievementCategoryInfo

(luaindex topLevelIndex)

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

GetAchievementSubCategoryInfo

(luaindex topLevelIndex, luaindex subCategoryIndex)

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

GetAchievementCategoryKeyboardIcons

(luaindex categoryIndex)

# Returns: textureName normalIcon, textureName pressedIcon, textureName mouseoverIcon

GetAchievementCategoryGamepadIcon

(luaindex categoryIndex)

# Returns: textureName gamepadIcon

GetEarnedAchievementPoints

()

# Returns: integer points

GetTotalAchievementPoints

()

# Returns: integer points

GetAchievementId

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

# Returns: integer achievementId

GetAchievementProgress

(integer achievementId)

# Returns: id64 progress

GetAchievementTimestamp

(integer achievementId)

# Returns: integer53 timestamp

GetAchievementNumRewards

(integer achievementId)

# Returns: integer numRewards

GetAchievementItemLink

(integer achievementId, LinkStyle linkStyle)

# Returns: string link

GetRecentlyCompletedAchievements

(integer numAchievementsToGet)

# Uses variable returns...
# Returns: integer achievementId

GetCategoryInfoFromAchievementId

(integer achievementId)

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

GetFirstAchievementInLine

(integer achievementId)

# Returns: integer firstAchievementId

GetNextAchievementInLine

(integer achievementId)

# Returns: integer nextAchievementId

GetPreviousAchievementInLine

(integer achievementId)

# Returns: integer previousAchievementId

GetAchievementLink

(integer achievementId, LinkStyle linkStyle)

# Returns: string link

GetAchievementIdFromLink

(string link)

# Returns: integer achievementId

GetAchievementNameFromLink

(string link)

# Returns: string name

GetAchievementProgressFromLinkData

(integer achievementId, string progress)

# Uses variable returns...
# Returns: integer numCompleted

GetAchievementRewardPoints

(integer achievementId)

# Returns: integer points

StartAchievementSearch

(string searchString, bool forceRefresh)

GetNumAchievementsSearchResults

()

# Returns: integer numSearchResults

GetAchievementsSearchResult

(luaindex searchResultIndex)

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

GetSkyshardAchievementZoneId

(integer achievementId)

# Returns: integer zoneId

GetAchievementLinkedBookCollectionId

(integer achievementId)

# Returns: integer bookCollectionId

GetNumExperiencePointsInLevel

(integer level)

# Returns: integer:nilable numXP

GetNumExperiencePointsInCompanionLevel

(integer level)

# Returns: integer:nilable numXP

GetActiveCompanionLevelForExperiencePoints

(integer numXP, integer:nilable startingLevel)

# Returns: integer level

GetEnlightenedMultiplier

()

# Returns: number multiplier

GetEnlightenedPool

()

# Returns: integer poolAmount

IsEnlightenedAvailableForAccount

()

# Returns: bool availableForAccount

IsEnlightenedAvailableForCharacter

()

# Returns: bool availableForCharacter

GetNumChampionXPInChampionPoint

(integer championPointsEarned)

# Returns: integer:nilable maxExp

GetMaxSpendableChampionPointsInAttribute

()

# Returns: integer maxSpendableChampionPointsInAttribute

GetMaxLevel

()

# Returns: integer maxLevel

GetChampionPointsPlayerProgressionCap

()

# Returns: integer maxRank

GetAbilityProgressionAbilityId

(luaindex progressionIndex, integer morph, integer rank)

# Returns: integer abilityId

GetProgressionSkillMorphSlotCurrentXP

(integer progressionId, MorphSlot morphSlot)

# Returns: integer currentXP

GetProgressionSkillCurrentMorphSlot

(integer progressionId)

# Returns: MorphSlot morphSlot

ChooseSkillProgressionMorphSlot

(integer progressionId, MorphSlot morphSlot)

GetNumProgressionSkillAbilityFxOverrides

(integer progressionId)

# Returns: integer numAbilityFxOverrides

GetProgressionSkillAbilityFxOverrideCollectibleIdByIndex

(integer progressionId, luaindex index)

# Returns: integer collectibleId

GetActiveProgressionSkillAbilityFxOverrideCollectibleId

(integer progressionId)

# Returns: integer collectibleId

GetAbilityFxOverrideProgressionId

(integer abilityFxOverrideId)

# Returns: integer progressionId

PurchaseAttributes

(integer health, integer magicka, integer stamina)

SendAttributePointAllocationRequest

(RespecPaymentType respecPaymentType, integer healthDelta, integer magickaDelta, integer staminaDelta)

CancelAttributePointAllocationRequest

()

GetAttributeRespecCastTimeRemainingMs

()

# Returns: integer timeRemainingMs

GetAttributeSpentPoints

(integer attributeType)

# Returns: integer points

GetAttributeUnspentPoints

()

# Returns: integer points

GetPendingAttributeRespecScrollItemLink

()

# Returns: string itemLink

GetAttributeRespecGoldCost

()

# Returns: integer cost

StartAttributeRespecFromUI

()

GetNumScriptedEventInvites

()

# Returns: integer eventCount

GetScriptedEventInviteIdFromIndex

(luaindex eventIndex)

# Returns: integer eventId

GetScriptedEventInviteInfo

(integer eventId)

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

GetScriptedEventInviteTimeRemainingMS

(integer eventId)

# Returns: integer timeRemainingMS

AcceptWorldEventInvite

(integer eventId)

DeclineWorldEventInvite

(integer eventId)

RemoveScriptedEventInviteForQuest

(string questName)

GetNumLoreCategories

()

# Returns: integer numTopCategories

GetLoreCategoryInfo

(luaindex categoryIndex)

# Returns: string name, integer numCollections, integer categoryId

GetLoreCollectionInfo

(luaindex categoryIndex, luaindex collectionIndex)

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

GetLoreBookInfo

(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)

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

GetBookMediumInfo

(integer mediumId)

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

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

ReadLoreBook

(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex)

# Returns: string body, integer mediumId, bool showTitle

GetLoreBookLink

(luaindex categoryIndex, luaindex collectionIndex, luaindex bookIndex, LinkStyle linkStyle)

# Returns: string link

GetLoreBookTitleFromLink

(string link)

# Returns: string title

GetLoreBookCategoryIndexFromCategoryId

(integer categoryId)

# Returns: luaindex:nilable categoryIndex

GetLoreBookCollectionIndicesFromCollectionId

(integer collectionId)

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

GetLoreBookIndicesFromBookId

(integer bookId)

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

GetLoreBookCollectionLinkedAchievement

(luaindex categoryIndex, luaindex collectionIndex)

# Returns: integer achievementId

GetLoreBookOverrideImageFromBookId

(integer bookId)

# Returns: textureName:nilable overrideImage, AnchorPosition:nilable overrideImageTitlePosition

GetNumUnlockedHirelingCorrespondence

(HirelingType hirelingType)

# Returns: integer current, integer max

GetHirelingCorrespondenceInfoByIndex

(HirelingType hirelingType, luaindex index)

# Returns: string sender, string subject, string message, textureName icon

GetGameCameraNonInteractableName

()

# Returns: string:nilable name

GetGameCameraTargetHoverTutorial

()

# Returns: TutorialTrigger tutorialType

GetPledgeOfMaraOfferInfo

()

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

SendPledgeOfMaraResponse

(PledgeOfMaraResponse response)

GetRingOfMaraExperienceBonus

()

# Returns: number bonusPercentage

ReportFeedback

(CustomerServiceSubmitFeedbackImpacts impact, CustomerServiceSubmitFeedbackCategories category, CustomerServiceSubmitFeedbackSubcategories subcategory, string details, string description, bool takeScreenshot)

GetHelpCategoryInfo

(luaindex helpCategoryIndex)

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

GetNumHelpCategories

()

# Returns: integer numHelpCategories

GetNumHelpEntriesWithinCategory

(luaindex helpCategoryIndex)

# Returns: integer numHelpEntries

GetHelpInfo

(luaindex helpCategoryIndex, luaindex helpIndex)

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

GetHelpId

(luaindex helpCategoryIndex, luaindex helpIndex)

# Returns: integer:nilable helpId

GetUISystemAssociatedWithHelpEntry

(luaindex helpCategoryIndex, luaindex helpIndex)

# Returns: UISystem uiSystem

GetHelpSearchResults

()

# Uses variable returns...
# Returns: luaindex helpCategoryIndex, luaindex helpIndex

GetHelpIndicesFromHelpLink

(string helpLink)

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

SubmitCustomerServiceTicket

()

# Returns: bool success

ResetCustomerServiceTicket

(bool retainTargetInfo)

SetCustomerServiceTicketBody

(string body)

SetCustomerServiceTicketCategory

(integer category)

SetCustomerServiceTicketIncludeScreenshot

(bool includeScreenshot)

SetCustomerServiceTicketPlayerTarget

(string displayName)

SetCustomerServiceTicketItemTargetByLink

(string itemLink)

SetCustomerServiceTicketItemTarget

(string itemName, integer itemId)

SetCustomerServiceTicketQuestTarget

(string questName)

SetCustomerServiceTicketGroupListingTarget

(luaindex groupListingIndex)

SetCustomerServiceTicketAppliedGroupListingTarget

()

SetCustomerServiceTicketHouseListingTarget

(HouseTourListingType listingType, luaindex listingIndex)

SetCustomerServiceTicketHouseListingCurrentHouseTarget

()

StartHelpSearch

(string searchString)

GetHelpOverviewIntroParagraph

()

# Returns: string paragraph

GetNumHelpOverviewQuestionAnswers

()

# Returns: integer length

GetHelpOverviewQuestionAnswerPair

(luaindex index)

# Returns: string question, string answer

GetZoneStoriesHelpIndices

()

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetMundusStoneHelpIndices

()

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetSubclassingHelpIndices

()

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

IsKeyboardHelpOption

(HelpShowOptions showOption)

# Returns: bool isKeyboardOption

IsGamepadHelpOption

(HelpShowOptions showOption)

# Returns: bool isGamepadOption

IsSubmitFeedbackSupported

()

# Returns: bool isSupported

GetHelpLink

(luaindex helpCategoryIndex, luaindex helpIndex, LinkStyle linkStyle)

# Returns: string link

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

GetLockpickingDefaultGamepadVibration

()

# Returns: number defaultVibration

DoesPlayerHaveLockpickingCompanionBonus

()

# Returns: bool playerHasCompanionBonus

GetLockpickingCompanionBonusName

()

# Returns: string lockpickingCompanionBonusName

GetLockpickingCompanionBonusTimeMS

()

# Returns: integer lockpickingCompanionBonusTime

GetCraftingInteractionMode

()

# Returns: CraftingInteractionMode currentCraftingInteractionMode

GetCraftingInteractionType

()

# Returns: TradeskillType currentCraftingInteractionType

IsAwaitingCraftingProcessResponse

()

# Returns: bool isCrafting

GetLastCraftingResultTotalInspiration

()

# Returns: integer totalInspiration

GetNumLastCraftingResultLearnedTranslations

()

# Returns: integer numLearnedTranslations

GetLastCraftingResultLearnedTranslationInfo

(luaindex resultIndex)

# Returns: string translationName, string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, EquipType equipType, integer itemStyleId, ItemDisplayQuality displayQuality

GetNumLastCraftingResultLearnedTraits

()

# Returns: integer numLearnedTraits

GetLastCraftingResultLearnedTraitInfo

(luaindex resultIndex)

# Returns: string traitName, string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, EquipType equipType, integer itemStyleId, ItemDisplayQuality displayQuality

GetNumLastCraftingResultItemsAndPenalty

()

# Returns: integer numItems, bool penaltyApplied

GetNumLastCraftingResultCurrencies

()

# Returns: integer numCurrencies

GetLastCraftingResultCurrencyInfo

(luaindex resultIndex)

# Returns: CurrencyType currencyType, integer currencyAmount

GetLastCraftingResultItemInfo

(luaindex resultIndex)

# Returns: string name, textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, EquipType equipType, ItemType itemType, integer itemStyleId, ItemDisplayQuality displayQuality, ItemUISoundCategory soundCategory, integer itemInstanceId

GetLastCraftingResultItemLink

(luaindex resultIndex, LinkStyle linkStyle)

# Returns: string link

GetLastCraftingResultAbilityId

()

# Returns: integer abilityId

GetTradeskillLevelPassiveAbilityId

(TradeskillType tradeskillType)

# Returns: integer levelPassiveAbilityId

GetTradeskillRecipeCraftingSystem

(TradeskillType tradeskillType)

# Returns: RecipeCraftingSystem recipeCraftingSystem

QueueCraftingErrorAfterResultReceived

(TradeskillResult craftingResult)

PrepareDeconstructMessage

()

AddItemToDeconstructMessage

(Bag bagId, integer slotIndex, integer quantity)

# Returns: bool wasItemAdded

SendDeconstructMessage

()

# Returns: bool wasMessageSent

PrepareConsumeAttunableStationsMessage

()

AddItemToConsumeAttunableStationsMessage

(Bag bagId, integer slotIndex)

# Returns: bool wasItemAdded

SendConsumeAttunableStationsMessage

()

# Returns: bool wasMessageSent

GetNonCombatBonusLevelTypeForTradeskillType

(TradeskillType tradeskillType)

# Returns: NonCombatBonusType nonCombatBonusType

GetTradeskillTypeForNonCombatBonusLevelType

(NonCombatBonusType nonCombatBonusType)

# Returns: TradeskillType tradeskillType

GetCostToCraftAlchemyItem

(Bag solventBagId, integer solventSlotIndex, integer numIterations)

# Returns: integer cost

GetMaxIterationsPossibleForAlchemyItem

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

# Returns: integer numIterations, TradeskillResult limitReason

CraftAlchemyItem

GetAlchemyResultingItemInfo

# Returns: string name, textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, EquipType equipType, integer itemStyleId, ItemDisplayQuality displayQuality, ProspectiveAlchemyResult prospectiveAlchemyResult

GetAlchemyResultingItemLink

# Returns: string link, ProspectiveAlchemyResult prospectiveAlchemyResult

GetAlchemyResultInspiration

# Returns: integer inspiration

GetAlchemyResultQuantity

(Bag solventBagId, integer solventSlotIndex, integer numIterations)

# Returns: integer resultQuantity

GetAlchemyItemTraits

(Bag reagentBagId, integer reagentSlotIndex)

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

IsAlchemyItemTraitKnown

(Bag reagentBagId, integer reagentSlotIndex, luaindex traitIndex)

# Returns: bool isKnown

DoesAlchemyItemHaveKnownTrait

(Bag reagentBagId, integer reagentSlotIndex, integer traitId)

# Returns: bool isKnown

DoesAlchemyItemHaveKnownEncodedTrait

(Bag reagentBagId, integer reagentSlotIndex, integer encodedTraits)

# Returns: bool isKnown

GetTraitIdFromBasePotion

(integer itemId)

# Returns: integer traitId

IsAlchemySolvent

(ItemType itemType)

# Returns: bool isAlchemySolvent

IsAlchemySolventForItemAndMaterialId

(Bag solventBagId, integer solventSlotIndex, integer targetItemId, integer targetMaterialItemId)

# Returns: bool isCorrectSolvent

GetAlchemyResultingItemIdIfKnown

# Returns: integer:nilable resultingItemId

GetNumRecipeLists

()

# Returns: integer numRecipeLists

GetRecipeListInfo

(luaindex recipeListIndex)

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

GetMaxRecipeIngredients

()

# Returns: integer maxIngredients

GetRecipeInfo

(luaindex recipeListIndex, luaindex recipeIndex)

# Returns: bool known, string name, integer numIngredients, integer provisionerLevelReq, integer qualityReq, ProvisionerSpecialIngredientType specialIngredientType, TradeskillType requiredCraftingStationType, integer resultItemId

GetNextKnownRecipeForCraftingStation

(luaindex recipeListIndex, TradeskillType requiredCraftingStationType, luaindex:nilable lastRecipeIndex)

# Returns: luaindex:nilable nextRecipeIndex

GetRecipeIngredientRequiredQuantity

(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex)

# Returns: integer requiredQuantity

GetRecipeIngredientItemInfo

(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex)

# Returns: string name, textureName icon, integer requiredQuantity, integer sellPrice, ItemDisplayQuality displayQuality

GetRecipeIngredientItemLink

(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex, LinkStyle linkStyle)

# Returns: string link

GetNumRecipeTradeskillRequirements

(luaindex recipeListIndex, luaindex recipeIndex)

# Returns: integer numTradeskillRequirements

GetRecipeTradeskillRequirement

(luaindex recipeListIndex, luaindex recipeIndex, luaindex tradeskillIndex)

# Returns: TradeskillType tradeskill, integer levelRequirement

GetRecipeResultItemInfo

(luaindex recipeListIndex, luaindex recipeIndex)

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

GetRecipeResultItemLink

(luaindex recipeListIndex, luaindex recipeIndex, LinkStyle linkStyle)

# Returns: string link

GetRecipeResultQuantity

(luaindex recipeListIndex, luaindex recipeIndex, integer numIterations)

# Returns: integer quantity

GetMaxIterationsPossibleForRecipe

(luaindex recipeListIndex, luaindex recipeIndex)

# Returns: integer maxIterations, TradeskillResult limitReason

GetCostToCraftProvisionerItem

(luaindex recipeListIndex, luaindex recipeIndex, integer numIterations)

# Returns: integer cost

CraftProvisionerItem

(luaindex recipeListIndex, luaindex recipeIndex, integer numIterations)

GetCurrentRecipeIngredientCount

(luaindex recipeListIndex, luaindex recipeIndex, luaindex ingredientIndex)

# Returns: integer count

GetNumUpdatedRecipes

()

# Returns: integer numRecipes

GetUpdatedRecipeIndices

(luaindex index)

# Returns: luaindex recipeListIndex, luaindex recipeIndex

GetRecipeInfoFromItemId

(integer itemId)

# Returns: TradeskillType:nilable craftingStationType, luaindex:nilable recipeListIndex, luaindex:nilable recipeIndex

GetCostToCraftEnchantingItem

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

# Returns: integer cost

GetMaxIterationsPossibleForEnchantingItem

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

# Returns: integer numIterations, TradeskillResult limitReason

CraftEnchantingItem

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

GetEnchantingResultingItemLink

# Returns: string link

AreAllEnchantingRunesKnown

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

# Returns: bool isKnown

IsRuneKnown

(integer itemId)

# Returns: bool isKnown

GetRunestoneTranslatedName

(Bag bagId, integer slotIndex)

# Returns: string:nilable name

GetRunestoneSoundInfo

(Bag bagId, integer slotIndex)

# Returns: string soundName, integer soundLength

GetEnchantedItemResultingItemLink

(Bag itemBagId, integer itemSlotIndex, Bag enchantmentBagId, integer enchantmentSlotIndex, LinkStyle linkStyle)

# Returns: string link

GetEnchantSearchCategoryType

(integer enchantId)

# Returns: EnchantmentSearchCategoryType searchCategory

GetEnchantProcAbilityId

(integer enchantId)

# Returns: integer abilityId

GetRunesForItemIdIfKnown

(integer itemId, integer materialItemId, ItemQuality itemQuality)

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

DoesPlayerHaveRunesForEnchanting

(integer aspectItemId, integer essenceItemId, integer potencyItemId)

# Returns: bool hasRunes

RequestScribe

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

SetCraftedAbilityScriptSelectionOverride

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

GetCraftedAbilityScriptSelectionOverride

()

# Returns: integer craftedAbilityId, integer primaryScriptId, integer secondaryScriptId, integer tertiaryScriptId

IsCraftedAbilityScriptCompatibleWithSelections

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

# Returns: bool isCompatible

ResetCraftedAbilityScriptSelectionOverride

()

IsScribingEnabled

()

# Returns: bool isScribingEnabled

GetCraftedAbilityLink

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

# Returns: string link

GetNumCraftedAbilities

()

# Returns: integer numCraftedAbilities

GetCraftedAbilityIdAtIndex

(luaindex index)

# Returns: integer craftedAbilityId

GetScribingInkItemLink

(LinkStyle linkStyle)

# Returns: string link

GetCostToScribeScripts

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

# Returns: integer cost

IsScribableScriptCombinationForCraftedAbility

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

# Returns: bool isScribableCombination

IsCraftedAbilityScribed

(integer craftedAbilityId)

# Returns: bool isScribed

IsCraftedAbilityScriptUnlocked

(integer craftedAbilityScriptId)

# Returns: bool isUnlocked

GetAbilityIdForCraftedAbilityId

(integer craftedAbilityId)

# Returns: integer abilityId

GetSkillTypeForCraftedAbilityId

(integer craftedAbilityId)

# Returns: SkillType skillType

IsCraftedAbilityScriptActive

(integer craftedAbilityId, integer craftedAbilityScriptId)

# Returns: bool isActive

GetCraftedAbilityActiveScriptIds

(integer craftedAbilityId)

# Returns: integer primaryScriptId, integer secondaryScriptId, integer tertiaryScriptId

IsCraftedAbilityUnlocked

(integer craftedAbilityId)

# Returns: bool isUnlocked

IsCraftedAbilityDisabled

(integer craftedAbilityId)

# Returns: bool isDisabled

IsCraftedAbilityScriptDisabled

(integer craftedAbilityScriptId)

# Returns: bool isDisabled

GetNumScriptsInSlotForCraftedAbility

(integer craftedAbilityId, ScribingSlot slotType)

# Returns: integer numScripts

GetScriptIdAtSlotIndexForCraftedAbility

(integer craftedAbilityId, ScribingSlot slotType, luaindex index)

# Returns: integer scriptDefId

GetCraftedAbilityScriptDisplayName

(integer craftedAbilityScriptId)

# Returns: string displayName

GetCraftedAbilityScriptDescription

(integer craftedAbilityId, integer craftedAbilityScriptId)

# Returns: string description

GetCraftedAbilityScriptGeneralDescription

(integer craftedAbilityScriptId)

# Returns: string description

GetCraftedAbilityScriptIcon

(integer craftedAbilityScriptId)

# Returns: textureName icon

GetCraftedAbilityScriptAcquireHint

(integer craftedAbilityScriptId)

# Returns: string acquireHint

GetCraftedAbilityScriptScribingSlot

(integer craftedAbilityScriptId)

# Returns: ScribingSlot slot

GetCraftedAbilityDisplayName

(integer craftedAbilityId)

# Returns: string displayName

GetCraftedAbilityDescription

(integer craftedAbilityId)

# Returns: string description

GetCraftedAbilityIcon

(integer craftedAbilityId)

# Returns: textureName icon

GetCraftedAbilityAcquireHint

(integer craftedAbilityId)

# Returns: string acquireHint

GetCraftedAbilityRepresentativeAbilityId

(integer craftedAbilityId, string casterUnitTag)

# Returns: integer abilityId

GetCraftedAbilityIdsFromLink

(string link)

# Returns: integer craftedAbilityId, integer primaryScriptId, integer secondaryScriptId, integer tertiaryScriptId

IsSmithingCraftingType

(TradeskillType tradeskillType)

# Returns: bool isSmithingType

DoesSmithingTypeIgnoreStyleItems

(TradeskillType tradeskillType)

# Returns: bool ignoresStyleItems

GetCostToCraftSmithingItem

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

# Returns: integer cost

GetMaxIterationsPossibleForSmithingItem

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

# Returns: integer numIterations, TradeskillResult limitReason

CraftSmithingItem

GetSmithingPatternResultLink

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

# Returns: string link

CanSmithingWeaponPatternsBeCraftedHere

()

# Returns: bool canBeCrafted

CanSmithingApparelPatternsBeCraftedHere

()

# Returns: bool canBeCrafted

CanSmithingJewelryPatternsBeCraftedHere

()

# Returns: bool canBeCrafted

CanSmithingSetPatternsBeCraftedHere

()

# Returns: bool canBeCrafted

CanSpecificSmithingItemSetPatternBeCraftedHere

(integer itemSetId)

# Returns: bool canBeCrafted

GetNumSmithingPatterns

()

# Returns: integer smithingPatterns

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

GetSmithingPatternInfoForItemId

(integer itemId, integer materialItemId, TradeskillType craftingSkillType)

# Returns: luaindex:nilable patternIndex, luaindex:nilable materialIndex

GetSmithingPatternInfoForItemSet

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

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

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

GetSmithingPatternMaterialItemLink

(luaindex patternIndex, luaindex materialIndex, LinkStyle linkStyle)

# Returns: string link

GetSmithingPatternArmorType

(luaindex patternIndex)

# Returns: ArmorType armorType

GetCurrentSmithingMaterialItemCount

(luaindex patternIndex, luaindex materialIndex)

# Returns: integer count

GetHighestItemStyleId

()

# Returns: integer highestItemStyleDefId

GetItemStyleInfo

(integer itemStyleId)

# Returns: bool alwaysHideIfLocked

GetItemStyleMaterialLink

(integer itemStyleId, LinkStyle linkStyle)

# Returns: string link

GetCurrentSmithingStyleItemCount

(integer itemStyleId)

# Returns: integer count

IsSmithingStyleKnown

(integer itemStyleId, luaindex patternIndex)

# Returns: bool known

GetFirstKnownItemStyleId

(luaindex patternIndex)

# Returns: integer:nilable itemStyleId

CanSmithingStyleBeUsedOnPattern

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

# Returns: bool canBeUsed, integer levelRequirement, integer championPointsRequirement

GetNumSmithingTraitItems

()

# Returns: integer numTraitItems

GetSmithingTraitItemInfo

(luaindex traitItemIndex)

# Returns: ItemTraitType:nilable traitType, string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, integer itemStyleId, ItemDisplayQuality displayQuality

GetSmithingTraitItemLink

(luaindex traitItemIndex, LinkStyle linkStyle)

# Returns: string link

GetCurrentSmithingTraitItemCount

(luaindex traitItemIndex)

# Returns: integer count

IsSmithingTraitItemValidForPattern

(luaindex patternIndex, luaindex traitItemIndex)

# Returns: bool valid

IsSmithingTraitKnownForPattern

(luaindex patternIndex, ItemTraitType traitType)

# Returns: bool known

IsTraitKnownForItem

(integer itemId, ItemTraitType traitType)

# Returns: bool isKnown

GetNumSmithingResearchLines

(TradeskillType craftingSkillType)

# Returns: integer numLines

GetMaxSimultaneousSmithingResearch

(TradeskillType craftingSkillType)

# Returns: integer maxSimultaneousResearch

GetSmithingResearchLineInfo

(TradeskillType craftingSkillType, luaindex researchLineIndex)

# Returns: string name, textureName icon, integer numTraits, integer timeRequiredForNextResearchSecs

GetSmithingResearchLineTraitInfo

(TradeskillType craftingSkillType, luaindex researchLineIndex, luaindex traitIndex)

# Returns: ItemTraitType traitType, string traitDescription, bool known

GetSmithingResearchLineTraitDescriptions

(TradeskillType craftingSkillType, luaindex researchLineIndex, luaindex traitIndex)

# Returns: string traitDescription, string traitResearchSourceDescription, string traitMaterialSourceDescription

GetSmithingResearchLineTraitTimes

(TradeskillType craftingSkillType, luaindex researchLineIndex, luaindex traitIndex)

# Returns: integer:nilable duration, integer:nilable timeRemainingSecs

CanItemBeSmithingTraitResearched

(Bag bagId, integer slotIndex, TradeskillType craftingSkillType, luaindex researchLineIndex, luaindex traitIndex)

# Returns: bool canBeResearched

CanItemLinkBeTraitResearched

(string itemLink)

# Returns: bool canBeResearched

ResearchSmithingTrait

(Bag bagId, integer slotIndex)

CancelSmithingTraitResearch

(TradeskillType tradeskillType, luaindex researchLineIndex, luaindex traitIndex)

CanItemBeRefined

(Bag bagId, integer slotIndex, TradeskillType craftingSkillType)

# Returns: bool canItemBeRefined

CanItemBeDeconstructed

(Bag bagId, integer slotIndex, TradeskillType:nilable craftingSkillType)

# Returns: bool canItemBeDeconstructed

GetRequiredSmithingRefinementStackSize

()

# Returns: integer requiredStackSize

GetSmithingRefinementMinRawMaterial

()

# Returns: integer minRawMaterial

GetSmithingRefinementMaxRawMaterial

()

# Returns: integer maxRawMaterial

CanItemBeSmithingImproved

(Bag bagId, integer slotIndex, TradeskillType craftingSkillType)

# Returns: bool canBeImproved

GetSmithingImprovementChance

(Bag itemToImproveBagId, integer itemToImproveSlotIndex, integer numBoostersToUse, TradeskillType craftingSkillType)

# Returns: number chance

GetNumSmithingImprovementItems

()

# Returns: integer numImprovementItems

GetSmithingImprovementItemInfo

(TradeskillType craftingSkillType, luaindex improvementItemIndex)

# Returns: string itemName, textureName icon, integer currentStack, integer sellPrice, bool meetsUsageRequirement, EquipType equipType, integer itemStyleId, ItemQuality functionalQuality, ItemDisplayQuality displayQuality

GetSmithingImprovementItemLink

(TradeskillType craftingSkillType, luaindex improvementItemIndex, LinkStyle linkStyle)

# Returns: string link

GetSmithingGuaranteedImprovementItemAmount

(TradeskillType craftingSkillType, luaindex improvementItemIndex)

# Returns: integer numImprovementItemsRequired

GetSmithingImprovedItemInfo

(Bag itemToImproveBagId, integer itemToImproveSlotIndex, TradeskillType craftingSkillType)

# Returns: string itemName, textureName icon, integer sellPrice, bool meetsUsageRequirement, EquipType equipType, integer itemStyleId, ItemQuality functionalQuality, ItemDisplayQuality displayQuality

GetSmithingImprovedItemLink

(Bag itemToImproveBagId, integer itemToImproveSlotIndex, TradeskillType craftingSkillType, LinkStyle linkStyle)

# Returns: string link

ImproveSmithingItem

(Bag itemToImproveBagId, integer itemToImproveSlotIndex, integer numBoostersToUse)

GetImperialStyleId

()

# Returns: integer imperialStyleId

GetMoragTongStyleId

()

# Returns: integer moragTongStyleId

GetNumValidItemStyles

()

# Returns: integer numValidItemStyles

GetValidItemStyleId

(luaindex index)

# Returns: integer validItemStyle

GetSmithingRefinedItemId

(Bag bagId, integer slotIndex)

# Returns: integer:nilable refinedItemId

DoesItemMatchSmithingMaterialTraitAndStyle

(Bag bagId, integer slotIndex, integer materialItemId, ItemTraitType itemTraitType, integer itemStyleId)

# Returns: bool isMatchingItem

GetNumConsolidatedSmithingSets

()

# Returns: integer numSets

GetNumUnlockedConsolidatedSmithingSets

()

# Returns: integer numUnlocked

IsConsolidatedSmithingSetIndexUnlocked

(luaindex setIndex)

# Returns: bool isUnlocked

IsConsolidatedSmithingItemSetIdUnlocked

(integer itemSetId)

# Returns: bool isUnlocked

GetConsolidatedSmithingItemSetIdByIndex

(luaindex setIndex)

# Returns: integer itemSetId

SetActiveConsolidatedSmithingSetByIndex

(luaindex:nilable setIndex)

GetActiveConsolidatedSmithingItemSetId

()

# Returns: integer itemSetId

CanItemBeConsumedByConsolidatedStation

(Bag bagId, integer slotIndex)

# Returns: bool canBeConsumed

GetSmithingStationItemSetIdFromItem

(Bag bagId, integer slotIndex)

# Returns: integer itemSetId

GetNextDirtyUnlockedConsolidatedSmithingItemSetId

(integer:nilable lastItemSetId)

# Returns: integer:nilable nextItemSetId

StartConsolidatedSmithingItemSetSearch

(string searchString)

GetNumConsolidatedSmithingItemSetSearchResults

()

# Returns: integer numSearchResults

GetConsolidatedSmithingItemSetSearchResult

(luaindex index)

# Returns: integer itemSetId

GetNonCombatBonus

(NonCombatBonusType nonCombatBonus)

# Returns: integer bonusValue

GetCurrencyBonusPercentage

(CurrencyType currencyType)

# Returns: integer bonusPercentage

GetActivityInfo

(integer activityId)

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

GetActivityName

(integer activityId)

# Returns: string name

GetActivityType

(integer activityId)

# Returns: LFGActivity activity

GetActivityKeyboardDescriptionTextures

(integer activityId)

# Returns: textureName descriptionTextureSmallKeyboard, textureName descriptionTextureLargeKeyboard

GetActivityGamepadDescriptionTexture

(integer activityId)

# Returns: textureName descriptionTextureGamepad

GetActivityGroupType

(integer activityId)

# Returns: LFGGroupType groupTypeAllowed

GetActivityBattlegroundId

(integer activityId)

# Returns: integer battlegroundId

ShouldActivityForceFullPanelKeyboard

(integer activityId)

# Returns: bool forceFullPanelKeyboard

GetNumActivitySetActivities

(integer activitySetId)

# Returns: integer count

GetActivitySetActivityIdByIndex

(integer activitySetId, luaindex index)

# Returns: integer activityId

GetActivitySetInfo

(integer activitySetId)

# Returns: string name, string description, integer sortOrder

GetActivitySetIcon

(integer activitySetId)

# Returns: textureName icon

GetActivitySetKeyboardDescriptionTextures

(integer activitySetId)

# Returns: textureName descriptionTextureSmallKeyboard, textureName descriptionTextureLargeKeyboard

GetActivitySetGamepadDescriptionTexture

(integer activitySetId)

# Returns: textureName descriptionTextureGamepad

ShouldActivitySetForceFullPanelKeyboard

(integer activitySetId)

# Returns: bool forceFullPanelKeyboard

DoesActivitySetHaveRewardData

(integer activitySetId)

# Returns: bool hasRewardData

DoesActivitySetHaveMMR

(integer activitySetId)

# Returns: bool hasMMR

GetActivityZoneId

(integer activityId)

# Returns: integer zoneId

GetNumActivitiesByType

(LFGActivity activity)

# Returns: integer count

GetActivityIdByTypeAndIndex

(LFGActivity activity, luaindex index)

# Returns: integer activityId

GetActivityTypeAndIndex

(integer activityId)

# Returns: LFGActivity activity, luaindex index

DoesPlayerMeetActivityLevelRequirements

(integer activityId)

# Returns: bool meetsLevelRequirements

DoesGroupMeetActivityLevelRequirements

(integer activityId)

# Returns: bool meetsLevelRequirements

IsActivityAvailableFromPlayerLocation

(integer activityId)

# Returns: bool isActivityAvailableFromPlayerLocation

DoesActivitySetHaveAvailablityRequirementList

(integer activitySetId)

# Returns: bool hasAvailablityReq

DoesActivitySetPassAvailablityRequirementList

(integer activitySetId)

# Returns: bool passesAvailablityReq, integer errorStringId

UpdateSelectedLFGRole

(LFGRole role)

GetSelectedLFGRole

()

# Returns: LFGRole role

CanUpdateSelectedLFGRole

()

# Returns: bool canUpdateSelectedLFGRole

IsActivityEligibleForDailyReward

(LFGActivity activity)

# Returns: bool isEligible

GetLFGCooldownTimeRemainingSeconds

(LFGCooldownType cooldownType)

# Returns: integer timeRemainingSeconds

AddActivityFinderSetSearchEntry

(integer activitySetId)

AddActivityFinderSpecificSearchEntry

(integer activityId)

ClearActivityFinderSearch

()

StartActivityFinderSearch

()

# Returns: ActivityQueueResult result

CanSendLFMRequest

()

# Returns: bool canSendLFMRequest

SendLFMRequest

()

GetNumActivityRequests

()

# Returns: integer numRequests

GetActivityRequestIds

(luaindex requestIndex)

# Returns: integer activityId, integer activitySetId

CancelGroupSearches

()

GetActivityFinderStatus

()

# Returns: ActivityFinderStatus status

IsCurrentlySearchingForGroup

()

# Returns: bool isSearching

GetRequiredActivityCollectibleId

(integer activityId)

# Returns: integer collectibleId

GetLFGSearchTimes

()

# Returns: integer startTimeMs, integer estimatedCompletionTimeMs

HasActivityFindReplacementNotification

()

# Returns: bool hasfindReplacementNotification

GetActivityFindReplacementNotificationInfo

()

# Returns: integer:nilable activityId

AcceptActivityFindReplacementNotification

()

DeclineActivityFindReplacementNotification

()

GetGroupSizeFromLFGGroupType

(LFGGroupType groupType)

# Returns: integer size

GetPlayerMMRByType

(LFGActivity activity)

# Returns: integer mmrRating

GetNumActivitySetsByType

(LFGActivity activity)

# Returns: integer count

GetActivitySetIdByTypeAndIndex

(LFGActivity activity, luaindex index)

# Returns: integer activitySetId

GetActivityTypeGatingQuest

(LFGActivity activity)

# Returns: integer questId

BestowActivityTypeGatingQuest

(LFGActivity activity)

IsLFGActivitySetDisabled

(integer activitySetId)

# Returns: bool disabled

IsLFGActivityDisabled

(integer activityId)

# Returns: bool disabled

IsLFGAccountDisabled

()

# Returns: bool disabled

HasLFGReadyCheckNotification

()

# Returns: bool hasReadyCheckNotification

HasAcceptedLFGReadyCheck

()

# Returns: bool hasAcceptedReadyCheck

GetLFGReadyCheckNotificationInfo

()

# Returns: LFGActivity activityType, LFGRole playerRole, integer timeRemainingSeconds

GetLFGReadyCheckActivityType

()

# Returns: LFGActivity activityType

AcceptLFGReadyCheckNotification

()

DeclineLFGReadyCheckNotification

()

GetLFGReadyCheckCounts

()

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

GetActivityAverageRoleTime

(integer activityId, LFGRole role)

# Returns: bool hasData, integer timeSeconds

GetCurrentLFGActivityId

()

# Returns: integer activityId

GetNumFishingLures

()

# Returns: integer numLures

GetFishingLureInfo

(luaindex lureIndex)

# Returns: string name, textureName icon, integer stack, integer sellPrice, ItemQuality quality

SetFishingLure

(luaindex lureIndex)

GetFishingLure

()

# Returns: luaindex:nilable lureIndex

GetNumViewableTreasureMaps

()

# Returns: integer numViewableMaps

GetTreasureMapInfo

(luaindex treasureMapIndex)

# Returns: string name, textureName imagePath

SetFloatingMarkerInfo

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

SetFloatingMarkerGlobalAlpha

(number alpha)

GetAgentChatRequestInfo

()

# Returns: bool isChatRequested, integer millisecondsSinceRequest

IsAgentChatActive

()

# Returns: bool isActive

AcceptAgentChat

()

DeclineAgentChat

()

GetNumKillingAttacks

()

# Returns: integer numKillingAttacks

GetKillingAttackInfo

(luaindex index)

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

DoesKillingAttackHaveAttacker

(luaindex index)

# Returns: bool hasAttacker

GetKillingAttackerInfo

(luaindex index)

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

GetKillingAttackerBattlegroundTeam

(luaindex index)

# Returns: BattlegroundTeam battlegroundTeam

GetNumDeathRecapHints

()

# Returns: integer numHints

GetDeathRecapHintInfo

(luaindex index)

# Returns: string text, DeathRecapHintImportance importance

GetNumTelvarStonesLost

()

# Returns: integer telvarStonesLost

IsRestyleSlotTypeDyeable

(RestyleMode restyleMode, integer restyleSlotType)

# Returns: bool isDyeable

GetOutfitName

(GameplayActorCategory actorCategory, luaindex outfitIndex)

# Returns: string name

GetOutfitSlotInfo

(GameplayActorCategory actorCategory, luaindex outfitIndex, OutfitSlot outfitSlot)

# Returns: integer collectibleId, luaindex:nilable itemMaterialIndex, integer primaryDyeId, integer secondaryDyeId, integer accentDyeId

EquipOutfit

(GameplayActorCategory actorCategory, luaindex outfitIndex)

UnequipOutfit

(GameplayActorCategory actorCategory)

GetEquippedOutfitIndex

(GameplayActorCategory actorCategory)

# Returns: luaindex:nilable outfitIndex

GetOutfitStyleFreeConversionCollectibleId

(integer outfitStyleId)

# Returns: integer:nilable freeConversionCollectibleId

IsOutfitStyleWeapon

(integer outfitStyleId)

# Returns: bool isWeapon

IsOutfitStyleArmor

(integer outfitStyleId)

# Returns: bool isArmor

GetOutfitStyleWeaponModelType

(integer outfitStyleId)

# Returns: WeaponModelType weaponModelType

GetOutfitStyleVisualArmorType

(integer outfitStyleId)

# Returns: VisualArmorType visualArmorType

GetOutfitChangeFlatCost

()

# Returns: integer flatCostStyleStones

SendOutfitChangeRequest

(bool useFlatCurrency, GameplayActorCategory actorCategory, luaindex outfitIndex, OutfitSlot outfitSlot, integer collectibleId, luaindex itemMaterialIndex, integer primaryDyeId, integer secondaryDyeId, integer accentDyeId)

GetOutfitSlotDataCollectibleCategoryId

(OutfitSlot outfitSlot)

# Returns: integer collectibleCategoryId

GetOutfitSlotDataHiddenOutfitStyleCollectibleId

(OutfitSlot outfitSlot)

# Returns: integer collectibleId

IsValidOutfitName

(string outfitName)

# Uses variable returns...
# Returns: NamingError violationCode

RenameOutfit

(GameplayActorCategory actorCategory, luaindex outfitIndex, string name)

GetApplyCostForIndividualOutfitSlot

(GameplayActorCategory actorCategory, luaindex outfitIndex, OutfitSlot outfitSlot, integer collectibleId, integer changedDyeCount)

# Returns: integer applyCostGold

GetTotalApplyCostForOutfitSlots

(GameplayActorCategory actorCategory, luaindex outfitIndex, OutfitSlot outfitSlot, integer collectibleId, integer changedDyeCount)

# Returns: integer totalCostGold

GetOutfitSlotsForCurrentlyHeldWeapons

(GameplayActorCategory actorCategory)

# Returns: OutfitSlot:nilable mainHandOutfitSlot, OutfitSlot:nilable offHandOutfitSlot

GetOutfitSlotsForEquippedWeapons

(GameplayActorCategory actorCategory)

# Returns: OutfitSlot:nilable mainHandOutfitSlot, OutfitSlot:nilable offHandOutfitSlot, OutfitSlot:nilable backupMainHandOutfitSlot, OutfitSlot:nilable backupOffHandOutfitSlot

AreDyeChannelsDyeableForOutfitSlotData

(GameplayActorCategory actorCategory, OutfitSlot outfitSlot, integer collectibleId)

# Returns: bool primary, bool secondary, bool accent

IsJusticeEnabled

()

# Returns: bool isJusticeEnabled

IsJusticeEnabledForZone

(luaindex aZoneIndex)

# Returns: bool isBountyEnabled

IsKillOnSight

()

# Returns: bool isKillOnSight

GetInfamy

()

# Returns: integer infamy

GetBounty

()

# Returns: integer bounty

GetPlayerInfamyData

()

# Returns: integer heat, integer bounty

GetReducedBountyPayoffAmount

()

# Returns: integer payoffAmount

GetFullBountyPayoffAmount

()

# Returns: integer payoffAmount

GetBountyDecayInfo

()

# Returns: integer amountPerInterval, integer intervalDurationS, integer progressThroughIntervalS

GetHeatDecayInfo

()

# Returns: integer amountPerInterval, integer intervalDurationS, integer progressThroughIntervalS

GetSecondsUntilBountyDecaysToZero

()

# Returns: integer secondsUntilBountyDecaysToZero

GetSecondsUntilHeatDecaysToZero

()

# Returns: integer secondsUntilBountyDecaysToZero

GetInfamyLevel

(integer infamyAmount)

# Returns: InfamyThresholdsType infamyLevel

GetInfamyMeterSize

()

# Returns: integer meterSize

GetFenceSellTransactionInfo

()

# Returns: integer totalSells, integer sellsUsed, integer resetTimeSeconds

GetFenceLaunderTransactionInfo

()

# Returns: integer totalLaunders, integer laundersUsed, integer resetTimeSeconds

GetTotalFenceHagglingBonus

()

# Returns: integer bonus

GetSecondsUntilArrestTimeout

()

# Returns: integer secondsUntilArrestTimeout

IsTrespassing

()

# Returns: bool isTrespassing

GetTimeToClemencyResetInSeconds

()

# Returns: integer timeRemaining

GetTimeToShadowyConnectionsResetInSeconds

()

# Returns: integer timeRemaining

IsStuckFixPending

()

# Returns: bool isStuckFixPending

CanUseStuck

(bool warn)

# Returns: bool canUseStuck

GetTimeUntilStuckAvailable

()

# Returns: integer millisecondsUntilAvailable

GetStuckCooldown

()

# Returns: integer cooldownRemainingSecs

SendPlayerStuck

private ()

ApplyPendingHeraldryChanges

()

IsPlayerAllowedToEditHeraldry

(integer guildIndex)

# Returns: bool allowed

IsCurrentlyCustomizingHeraldry

()

# Returns: bool currentlyCustomizing

GetHeraldryCustomizationCosts

()

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

IsCreatingHeraldryForFirstTime

()

# Returns: bool creatingForFirstTime

HasPendingHeraldryChanges

()

# Returns: bool hasPendingChanges

GetPendingHeraldryCost

()

# Returns: integer pendingCost

RevertToSavedHeraldry

(bool hasActiveAppearance)

SetPendingHeraldryIndices

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

GetPendingHeraldryIndices

()

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

GetNumHeraldryColors

()

# Returns: integer numColors

GetHeraldryColorInfo

(luaindex colorIndex)

# Returns: string colorName, DyeHueCategory hueCategory, number r, number g, number b, integer sortKey

GetNumHeraldryBackgroundCategories

()

# Returns: integer numCategories

GetHeraldryBackgroundCategoryInfo

(luaindex categoryIndex)

# Returns: string categoryName, textureName icon

GetHeraldryGuildFinderBackgroundCategoryIcon

(luaindex categoryIndex)

# Returns: textureName icon

GetNumHeraldryBackgroundStyles

(luaindex categoryIndex)

# Returns: integer numStyles

GetHeraldryBackgroundStyleInfo

(luaindex categoryIndex, luaindex styleIndex)

# Returns: string styleName, textureName icon

GetHeraldryGuildFinderBackgroundStyleIcon

(luaindex categoryIndex, luaindex styleIndex)

# Returns: textureName icon

GetNumHeraldryCrestCategories

()

# Returns: integer numCategories

GetHeraldryCrestCategoryInfo

(luaindex categoryIndex)

# Returns: string categoryName, textureName icon

GetNumHeraldryCrestStyles

(luaindex categoryIndex)

# Returns: integer numStyles

GetHeraldryCrestStyleInfo

(luaindex categoryIndex, luaindex styleIndex)

# Returns: string styleName, textureName icon

GetHeraldryGuildFinderCrestStyleIcon

(luaindex categoryIndex, luaindex styleIndex)

# Returns: textureName icon

StartHeraldryCustomization

(integer guildIndex)

EndHeraldryCustomization

()

GetHeraldryGuildBankedMoney

()

# Returns: integer:nilable money

GetGamepadTemplate

()

# Returns: GamepadTemplate gamepadTemplate

GetNumSavedKeybindings

()

# Returns: integer numSavedBindings

GetMaxNumSavedKeybindings

()

# Returns: integer maxNumSavedBindings

SendAllCachedSettingMessages

()

GetVibrationInfoFromTrigger

(GamepadVibrationTrigger triggerType)

# Returns: integer durationMS, number coarseMotor, number fineMotor, number leftTriggerMotor, number rightTriggerMotor, bool foundInfo, string debugSourceInfo

CanChampionSkillTypeBeSlotted

(ChampionSkillType championSkillType)

# Returns: bool isSlottable

GetNumChampionDisciplines

()

# Returns: integer numDisciplines

GetChampionDisciplineName

(integer disciplineId)

# Returns: string name

GetChampionDisciplineType

(integer disciplineId)

# Returns: ChampionDisciplineType disciplineType

GetChampionDisciplineZoomedOutBackground

(integer disciplineId)

# Returns: textureName texture

GetChampionDisciplineZoomedInBackground

(integer disciplineId)

# Returns: textureName texture

GetChampionDisciplineSelectedZoomedOutOverlay

(integer disciplineId)

# Returns: textureName texture

GetNumChampionDisciplineSkills

(luaindex disciplineIndex)

# Returns: integer numSkills

GetChampionSkillPosition

(integer championSkillId)

# Returns: number normalizedX, number normalizedY

GetChampionClusterRootOffset

(integer championSkillId)

# Returns: number normalizedOffsetX, number normalizedOffsetY

GetChampionSkillName

(integer championSkillId)

# Returns: string skillName

GetMaxPossiblePointsInChampionSkill

()

# Returns: integer maxPossiblePoints

GetNumPointsSpentOnChampionSkill

(integer championSkillId)

# Returns: integer numSpentPoints

GetNumSpentChampionPoints

(integer disciplineId)

# Returns: integer numSpentPoints

GetNumUnspentChampionPoints

(integer disciplineId)

# Returns: integer numUnspentPoints

GetChampionSkillDescription

(integer championSkillId, integer numPendingPoints)

# Returns: string description

GetChampionSkillCurrentBonusText

(integer championSkillId, integer numPendingPoints)

# Returns: string currentBonus

GetChampionAbilityId

(integer championSkillId)

# Returns: integer abilityId

GetChampionRespecCost

()

# Returns: integer cost

GetChampionPointPoolForRank

(integer rank)

# Returns: ChampionDisciplineType disciplineType

IsChampionSystemUnlocked

()

# Returns: bool unlocked

GetChampionSkillLinkIds

(integer championSkillId)

# Uses variable returns...
# Returns: integer linkedSkillId

GetChampionSkillId

(luaindex disciplineIndex, luaindex championSkillIndex)

# Returns: integer championSkillId

IsChampionSkillRootNode

(integer championSkillId)

# Returns: bool isRoot

GetNumChampionNodesToPreallocate

()

# Returns: integer numNodes

GetNumChampionLinksToPreallocate

()

# Returns: integer numLinks

DoesChampionSkillHaveJumpPoints

(integer championSkillId)

# Returns: bool hasJumpPoints

GetChampionSkillJumpPoints

(integer championSkillId)

# Uses variable returns...
# Returns: integer jumpPoint

GetChampionSkillMaxPoints

(integer championSkillId)

# Returns: integer maxPoints

WouldChampionSkillNodeBeUnlocked

(integer championSkillId, integer pendingPoints)

# Returns: bool unlocked

GetChampionSkillType

(integer championSkillId)

# Returns: ChampionSkillType championSkillType

IsChampionSkillClusterRoot

(integer championSkillId)

# Returns: bool isRoot

GetChampionClusterName

(integer rootChampionSkillId)

# Returns: string clusterName

GetChampionClusterBackgroundTexture

(integer rootChampionSkillId)

# Returns: textureName texture

GetChampionClusterSkillIds

(integer rootChampionSkillId)

# Uses variable returns...
# Returns: integer championSkillIds

PrepareChampionPurchaseRequest

(bool respecNeeded)

AddSkillToChampionPurchaseRequest

(integer championSkillId, integer newPendingPoints)

AddHotbarSlotToChampionPurchaseRequest

(luaindex slotIndex, integer championSkillId)

GetChampionPurchaseAvailability

()

# Returns: ChampionPurchaseResult result

GetExpectedResultForChampionPurchaseRequest

()

# Returns: ChampionPurchaseResult result

SendChampionPurchaseRequest

()

GetChampionDisciplineId

(luaindex disciplineIndex)

# Returns: integer disciplineId

GetNumDefaultQuickChats

()

# Returns: integer numQuickChats

GetDefaultQuickChatName

(luaindex index)

# Returns: string name

GetDefaultQuickChatMessage

(luaindex index)

# Returns: string message

PlayDefaultQuickChat

private (luaindex index)

ZoUTF8StringLength

(string string)

# Returns: integer length

SetSCTAnimationOffsetX

(object timeline, number offsetX)

SetSCTAnimationOffsetY

(object timeline, number offsetY)

ResetSCTDataToDefaults

()

GetSCTKeyboardFont

()

# Returns: string fontName, FontStyle fontStyle

SetSCTKeyboardFont

(string fontName, FontStyle fontStyle)

GetSCTGamepadFont

()

# Returns: string fontName, FontStyle fontStyle

SetSCTGamepadFont

(string fontName, FontStyle fontStyle)

GetSCTEventVisualInfoId

(SCTEventType eventType)

# Returns: integer SCTEventVisualInfoId

SetSCTEventVisualInfo

(SCTEventType eventType, integer SCTEventVisualInfoId)

GetNumSCTSlots

()

# Returns: integer numSlots

CreateNewSCTSlot

()

# Returns: luaindex slotIndex

GetSCTSlotPosition

(luaindex slotIndex)

# Returns: SCTUnitAnchorType SCTAnchorType, AnchorPosition anchorPoint, number UIOffsetX, number UIOffsetY, number cameraOffsetRight, number cameraOffsetUp

SetSCTSlotPosition

(luaindex slotIndex, SCTUnitAnchorType SCTAnchorType, AnchorPosition anchorPoint, number UIOffsetX, number UIOffsetY, number cameraOffsetRight, number cameraOffsetUp)

GetSCTSlotZoomedInPosition

(luaindex slotIndex)

# Returns: number zoomedInCameraDistanceThreshold, number zoomedInUIOffsetX, number zoomedInUIOffsetY

SetSCTSlotZoomedInPosition

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

GetSCTSlotClamping

(luaindex slotIndex)

# Returns: number topEdgeUIOffsetBuffer, number bottomEdgeUIOffsetBuffer

SetSCTSlotClamping

(luaindex slotIndex, number topEdgeUIOffsetBuffer, number bottomEdgeUIOffsetBuffer)

GetSCTSlotAnimationTimeline

(luaindex slotIndex)

# Returns: string animationTimelineName

SetSCTSlotAnimationTimeline

(luaindex slotIndex, string animationTimelineName)

GetSCTSlotAnimationMinimumSpacing

(luaindex slotIndex)

# Returns: integer minSpacingMS

SetSCTSlotAnimationMinimumSpacing

(luaindex slotIndex, integer minSpacingMS)

IsSCTSlotEventTypeShown

(luaindex slotIndex, SCTEventType eventType)

# Returns: bool isShown

SetSCTSlotEventTypeShown

(luaindex slotIndex, SCTEventType eventType, bool isShown)

DoesSCTSlotAllowTargetType

(luaindex slotIndex, SCTUnitType targetType)

# Returns: bool allowed

AddSCTSlotAllowedTargetType

(luaindex slotIndex, SCTUnitType targetType)

ClearSCTSlotAllowedTargetTypes

(luaindex slotIndex)

DoesSCTSlotExcludeTargetType

(luaindex slotIndex, SCTUnitType targetType)

# Returns: bool allowed

AddSCTSlotExcludedTargetType

(luaindex slotIndex, SCTUnitType targetType)

ClearSCTSlotExcludedTargetTypes

(luaindex slotIndex)

DoesSCTSlotAllowSourceType

(luaindex slotIndex, SCTUnitType targetType)

# Returns: bool allowed

AddSCTSlotAllowedSourceType

(luaindex slotIndex, SCTUnitType sourceType)

ClearSCTSlotAllowedSourceTypes

(luaindex slotIndex)

DoesSCTSlotExcludeSourceType

(luaindex slotIndex, SCTUnitType targetType)

# Returns: bool allowed

AddSCTSlotExcludedSourceType

(luaindex slotIndex, SCTUnitType sourceType)

ClearSCTSlotExcludedSourceTypes

(luaindex slotIndex)

GetSCTSlotTargetReputationTypes

(luaindex slotIndex)

# Returns: bool showForFriendly, bool showForNeutral, bool showForEnemy

SetSCTSlotTargetReputationTypes

(luaindex slotIndex, bool showForFriendly, bool showForNeutral, bool showForEnemy)

GetSCTSlotSourceReputationTypes

(luaindex slotIndex)

# Returns: bool showForFriendly, bool showForNeutral, bool showForEnemy

SetSCTSlotSourceReputationTypes

(luaindex slotIndex, bool showForFriendly, bool showForNeutral, bool showForEnemy)

GetSCTSlotEventControlScales

(luaindex slotIndex)

# Returns: number defaultScale, number critScale

SetSCTSlotEventControlScales

(luaindex slotIndex, number defaultScale, number critScale)

GetSCTSlotKeyboardCloudId

(luaindex slotIndex)

# Returns: integer SCTCloudId

SetSCTSlotKeyboardCloud

(luaindex slotIndex, integer SCTCloudId)

GetSCTSlotGamepadCloudId

(luaindex slotIndex)

# Returns: integer SCTCloudId

SetSCTSlotGamepadCloud

(luaindex slotIndex, integer SCTCloudId)

CreateNewSCTEventVisualInfo

()

# Returns: integer SCTEventVisualInfoId

GetSCTSlotEventVisualInfo

(luaindex slotIndex, SCTEventType eventType)

# Returns: integer SCTEventVisualInfoId

SetSCTSlotEventVisualInfo

(luaindex slotIndex, SCTEventType eventType, integer SCTEventVisualInfoId)

GetSCTEventVisualInfoTextFormat

(integer SCTEventVisualInfoId, SCTEventTextType textType)

# Returns: string format, bool enabled

SetSCTEventVisualInfoTextFormat

(integer SCTEventVisualInfoId, SCTEventTextType textType, string format)

GetSCTEventVisualInfoTextFontSizes

(integer SCTEventVisualInfoId, SCTEventTextType textType)

# Returns: integer keyboardFontSize, integer gamepadFontSize, bool enabled

SetSCTEventVisualInfoTextFontSizes

(integer SCTEventVisualInfoId, SCTEventTextType textType, integer keyboardFontSize, integer gamepadFontSize)

GetSCTEventVisualInfoTextColor

(integer SCTEventVisualInfoId, SCTEventTextType textType)

# Returns: number r, number g, number b, bool enabled

SetSCTEventVisualInfoTextColor

(integer SCTEventVisualInfoId, SCTEventTextType textType, number r, number g, number b)

GetSCTEventVisualInfoHideWhenValueIsZero

(integer SCTEventVisualInfoId)

# Returns: bool hideWhenValueIsZero, bool enabled

SetSCTEventVisualInfoHideWhenValueIsZero

(integer SCTEventVisualInfoId, bool hideWhenValueIsZero)

CreateNewSCTCloud

()

# Returns: integer SCTCloudId

GetNumSCTCloudOffsets

(integer SCTCloudId)

GetSCTCloudOffset

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

AddSCTCloudOffset

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

ClearSCTCloudOffsets

(integer SCTCloudId)

GetSCTCloudAnimationOverlapPercent

(integer SCTCloudId)

# Returns: number animationOverlapPercent

SetSCTCloudAnimationOverlapPercent

(integer SCTCloudId, number animationOverlapPercent)

ShowMarketProduct

(integer marketProductId, MarketOpenOperation source)

ShowMarketAndSearch

(string marketProductSearchString, MarketOpenOperation source)

RequestPurchaseMarketProduct

(integer marketProductId, luaindex presentationIndex, bool isGift)

ShowEsoPlusPage

(MarketOpenOperation source)

RequestShowMarketChapterUpgrade

(MarketOpenOperation source, integer chapterUpgradeId)

GetNumMarketProductUnlockNotifications

()

# Returns: integer numNotifications

GetMarketProductUnlockNotificationProductId

(luaindex notificationIndex)

# Returns: integer marketProductId

ClearMarketProductUnlockNotifications

()

HasExpiringMarketCurrencyNotification

()

# Returns: bool hasNotification

ClearExpiringMarketCurrencyNotification

()

HasShownReturningPlayerAnnouncement

()

# Returns: bool hasShownAnnouncement

FlagReturningPlayerAnnouncementSeen

()

StartWorldParticleEffect

private (integer particleEffectId)

StopWorldParticleEffect

private (integer particleEffectId)

SetWorldParticleEffectPosition

private (integer particleEffectId, number worldX, number worldY, number worldZ)

SetWorldParticleEffectOrientation

private (integer particleEffectId, number pitchRadians, number yawRadians, number rollRadians)

SetWorldParticleEffectScale

private (integer particleEffectId, number scale)

DeleteWorldParticleEffect

private (integer particleEffectId)

StartWorldEffectOnPlayer

private (UIWorldEffect UIWorldEffect)

GetCurrentZoneDungeonDifficulty

()

# Returns: DungeonDifficulty isVeteranDifficulty

CopyHousePermissions

(integer sourceHouseId, integer destinationHouseId)

GetNumHousingPermissions

(integer houseId, HousePermissionUserGroup permissionCategory)

# Returns: integer numPermissions

DoesHousingUserGroupHaveAccess

(integer houseId, HousePermissionUserGroup permissionCategory, luaindex index)

# Returns: bool hasAccess

IsHousingPermissionEnabled

(integer houseId, HousePermissionUserGroup permissionCategory, luaindex index, HousePermissionSetting setting)

# Returns: bool isPermissionEnabled

IsHousingPermissionMarkedForDelete

(integer houseId, HousePermissionUserGroup permissionCategory, luaindex index)

# Returns: bool isMarkedForDelete

GetHousingUserGroupDisplayName

(integer houseId, HousePermissionUserGroup permissionCategory, luaindex index)

# Returns: string displayName

SetHousingPermissionPreset

(integer houseId, HousePermissionUserGroup permissionCategory, luaindex index, HousePermissionPresetSetting preset, bool setForAllHouses)

RemoveHousingPermission

(integer houseId, HousePermissionUserGroup permissionCategory, luaindex index, bool removeFromAllHouses)

AddHousingPermission

(integer houseId, HousePermissionUserGroup permissionCategory, bool grantAccess, HousePermissionPresetSetting preset, bool addToAllHouses, string targetName)

GetHousingPermissionPresetType

(integer houseId, HousePermissionUserGroup permissionCategory, luaindex index)

# Returns: HousePermissionPresetSetting preset

SetHousingPrimaryHouse

(integer houseId)

GetHousingPrimaryHouse

()

# Returns: integer houseId

GetCurrentZoneHouseId

()

# Returns: integer houseId

GetCurrentHousePopulationCap

()

# Returns: integer popCap

GetNumFurnitureCategories

()

# Returns: integer numCategories

GetFurnitureCategoryId

(luaindex categoryIndex)

# Returns: integer categoryId

GetNumFurnitureSubcategories

(luaindex categoryIndex)

# Returns: integer numSubcategories

GetFurnitureSubcategoryId

(luaindex categoryIndex, luaindex subcategoryIndex)

# Returns: integer subcategoryId

GetFurnitureCategoryInfo

(integer furnitureCategoryId)

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

GetFurnitureCategoryKeyboardIcons

(integer furnitureCategoryId)

# Returns: textureName normalIcon, textureName pressedIcon, textureName mouseoverIcon

GetFurnitureCategoryGamepadIcon

(integer furnitureCategoryId)

# Returns: textureName gamepadIcon

GetHouseZoneId

(integer houseId)

# Returns: integer zoneId

GetHousePreviewBackgroundImage

(integer houseId)

# Returns: textureName previewBackgroundFileIndex

IsPrimaryHouse

(integer houseId)

# Returns: bool isPrimaryHouse

GetHouseFurnitureCount

(integer houseId)

# Returns: integer:nilable furnitureCount

DoesFurnitureThemeShowInBrowser

(FurnitureThemeType furnitureTheme)

# Returns: bool showInBrowser

AreHousingPermissionsChangesPending

()

# Returns: bool changesPending

GetHousingStarterQuestId

()

# Returns: integer questId

RequestBestowHousingStarterQuest

()

GetHouseToursStatus

()

# Returns: HouseToursStatus status

IsHouseToursListingOnCooldown

()

# Returns: bool isOnCooldown

IsHouseToursSearchOnCooldown

()

# Returns: bool isOnCooldown

RequestHouseToursSearch

(HouseTourListingType listingType)

# Returns: integer:nilable searchId

SetHouseToursCategoryTypeFilter

(HouseTourListingType listingType, HouseCategoryType houseCategoryType)

# Returns: bool success

SetHouseToursDisplayNameFilter

(HouseTourListingType listingType, string ownerDisplayName)

# Returns: bool success

SetHouseToursHouseIdFilter

(HouseTourListingType listingType, integer houseId)

# Returns: bool success

SetHouseToursTagFilter

(HouseTourListingType listingType, HouseTourListingTag tag)

# Returns: bool success

GetNumHouseToursSearchListings

(HouseTourListingType listingType)

# Returns: integer numSearchListings

GetNumHouseToursUnfilteredListings

(HouseTourListingType listingType)

# Returns: integer numUnfilteredListings

GetHouseToursListingCollectibleIdByIndex

(HouseTourListingType listingType, luaindex listingIndex)

# Returns: integer collectibleId

GetHouseToursListingHouseIdByIndex

(HouseTourListingType listingType, luaindex listingIndex)

# Returns: integer houseId

GetHouseToursListingNicknameByIndex

(HouseTourListingType listingType, luaindex listingIndex)

# Returns: string nickname

GetHouseToursListingOwnerDisplayNameByIndex

(HouseTourListingType listingType, luaindex listingIndex)

# Returns: string displayName

GetHouseToursListingFurnitureCountByIndex

(HouseTourListingType listingType, luaindex listingIndex)

# Returns: integer:nilable furnitureCount

GetHouseToursListingTagsByIndex

(HouseTourListingType listingType, luaindex listingIndex)

# Uses variable returns...
# Returns: HouseTourListingTag tag

IsHouseToursListingFavoriteByIndex

(HouseTourListingType listingType, luaindex listingIndex)

# Returns: bool isFavorite

IsHouseToursListingListedByIndex

(HouseTourListingType listingType, luaindex listingIndex)

# Returns: bool isListed

GetNumHouseToursTopRecommendedHouseNotifications

()

# Returns: integer numNotifications

GetHouseToursTopRecommendedHouseNotification

(luaindex notificationIndex)

# Returns: integer houseId

GetHouseToursRecommendationsTimeRemainingS

()

# Returns: integer timeRemainingS

RequestCreateHouseToursListing

(integer houseId, HouseTourListingTag tag)

RequestUpdateHouseToursListing

(integer houseId, HouseTourListingTag tag)

RequestDeleteHouseToursListing

(integer houseId)

IsHouseListed

(integer houseId)

# Returns: bool isListed

GetNumHouseToursPlayerListingRecommendations

(integer houseId)

# Returns: integer recommendationCount

GetHouseToursPlayerListingTagsByHouseId

(integer houseId)

# Uses variable returns...
# Returns: HouseTourListingTag tag

CanFavoriteHouses

()

# Returns: bool canFavorite

GetNumFavoriteHouses

()

# Returns: integer numFavorites

RequestRecommendCurrentHouse

()

RequestUpdateCurrentHouseFavoriteStatus

(HouseTourFavoriteOperationType operationType)

RequestUpdateHouseToursListingFavoriteStatusByIndex

(HouseTourListingType listingType, luaindex listingIndex, HouseTourFavoriteOperationType operationType)

IsCurrentHouseListed

()

# Returns: bool isListed

IsCurrentHouseFavorite

()

# Returns: bool isFavorited

IsCurrentHouseRecommended

()

# Returns: bool isRecommended

GetCurrentHouseTourListingCollectibleId

()

# Returns: integer collectibleId

GetCurrentHouseTourListingHouseId

()

# Returns: integer houseId

GetCurrentHouseTourListingFurnitureCount

()

# Returns: integer:nilable numFurnishings

GetCurrentHouseTourListingNickname

()

# Returns: string nickname

GetCurrentHouseTourListingOwnerDisplayName

()

# Returns: string ownerDisplayName

GetCurrentHouseTourListingTags

()

# Uses variable returns...
# Returns: HouseTourListingTag tag

CanRecommendHouses

()

# Returns: bool canRecommendedHouses

GetNumHousesRecommendedByLocalPlayer

()

# Returns: integer numRecommendations

IsHouseDefaultAccessSettingValidForHouseToursListing

(HousePermissionDefaultAccessSetting housePermissionDefaultAccessSetting)

# Returns: bool isValid

HousingEditorIsPreviewInspectionEnabled

()

# Returns: bool enabled

HousingEditorSetPreviewInspectionEnabled

(bool enabled)

HousingEditorTogglePreviewInspectionEnabled

()

HousingEditorTogglePlacementType

()

HousingEditorSetPlacementType

(HousingEditorPlacementType placementType)

HousingEditorGetPlacementType

()

# Returns: HousingEditorPlacementType placementType

HousingEditorTogglePrecisionPlacementMode

()

HousingEditorSetPrecisionPlacementMode

(HousingEditorPrecisionPlacementMode placementMode)

HousingEditorGetPrecisionPlacementMode

()

# Returns: HousingEditorPrecisionPlacementMode precisionPlacementMode

HousingEditorSetPrecisionMoveUnits

(integer aMovementCentimeters)

HousingEditorGetPrecisionMoveUnits

()

# Returns: integer aMovementCentimeters

HousingEditorSetPrecisionRotateUnits

(number aRotationRadians)

HousingEditorGetPrecisionRotateUnits

()

# Returns: number aRotationRadians

HousingEditorToggleSurfaceDragMode

()

HousingEditorIsSurfaceDragModeEnabled

()

# Returns: bool enabled

HousingEditorRequestResetEngagedTargetDummies

()

# Returns: HousingRequestResult result

HousingEditorRequestKickOccupant

(luaindex occupantIndex)

# Returns: HousingRequestResult result

HousingEditorGetRetrieveToBag

()

# Returns: Bag bagId

HousingEditorSetRetrieveToBag

(Bag bagId)

HousingEditorRequestSelectedPlacement

()

# Returns: HousingRequestResult result

HousingEditorRequestItemPlacement

(Bag bagId, integer slotIndex, integer worldX, integer worldY, integer worldZ, number pitchRadians, number yawRadians, number rollRadians)

# Returns: HousingRequestResult result

HousingEditorRequestCollectiblePlacement

(integer collectibleId, integer worldX, integer worldY, integer worldZ, number pitchRadians, number yawRadians, number rollRadians)

# Returns: HousingRequestResult result

HousingEditorRequestChangePositionAndOrientation

(id64 furnitureId, integer worldX, integer worldY, integer worldZ, number pitchRadians, number yawRadians, number rollRadians)

# Returns: HousingRequestResult result

HousingEditorRequestChangePosition

(id64 furnitureId, integer worldX, integer worldY, integer worldZ)

# Returns: HousingRequestResult result

HousingEditorRequestChangeOrientation

(id64 furnitureId, number pitchRadians, number yawRadians, number rollRadians)

# Returns: HousingRequestResult result

HousingEditorRequestChangeState

(id64 furnitureId, integer:nilable objectStateIndex)

# Returns: HousingRequestResult result

HousingEditorGetFurnitureWorldPosition

(id64 furnitureId)

# Returns: integer worldX, integer worldY, integer worldZ

HousingEditorGetFurnitureWorldBounds

(id64 furnitureId)

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

HousingEditorGetFurnitureLocalBounds

(id64 furnitureId)

# Returns: number minLocalX, number minLocalY, number minLocalZ, number maxLocalX, number maxLocalY, number maxLocalZ

HousingEditorGetFurnitureOrientation

(id64 furnitureId)

# Returns: number pitchRadians, number yawRadians, number rollRadians

HousingEditorGetFurnitureWorldCenter

(id64 furnitureId)

# Returns: number centerX, number centerY, number centerZ

HousingEditorGetFurnitureWorldOffset

(id64 furnitureId)

# Returns: number offsetX, number offsetY, number offsetZ

HousingEditorGetSelectedObjectWorldPosition

()

# Returns: integer worldX, integer worldY, integer worldZ

HousingEditorGetSelectedObjectOrientation

()

# Returns: number pitchRadians, number yawRadians, number rollRadians

HousingEditorGetSelectedObjectWorldCenter

()

# Returns: number centerX, number centerY, number centerZ

HousingEditorGetSelectedOrTargetObjectDistanceM

()

# Returns: number worldDistanceM

HousingEditorRequestRemoveSelectedFurniture

()

# Returns: HousingRequestResult result

HousingEditorRequestRemoveFurniture

(id64 furnitureId)

# Returns: HousingRequestResult result

HousingEditorGetSelectedFurnitureId

()

# Returns: id64:nilable furnitureId

HousingEditorIsSelectingHousingObject

()

# Returns: bool isSelectingAnyObject

HousingEditorGetSelectedFurnitureStackCount

()

# Returns: integer stackCount

HousingEditorSelectFurnitureById

(id64 furnitureId)

# Returns: HousingRequestResult result

HousingEditorMoveSelectedObject

(AxisTypes aAxis, number aMovementForce)

HousingEditorRotateSelectedObject

(AxisTypes aAxis, number aRotationForce)

HousingEditorAdjustPrecisionEditingPosition

(integer aWorldX, integer aWorldY, integer aWorldZ)

HousingEditorAdjustSelectedObjectRotation

(number aPitchRadians, number aYawRadians, number aRollRadians)

HousingEditorCalculateRotationAboutAxis

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

# Returns: number pitchRadians, number yawRadians, number rollRadians

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

HousingEditorStraightenSelectedObject

()

HousingEditorPushSelectedObject

(number aPushDistance)

HousingEditorAlignFurnitureToSurface

()

# Returns: HousingRequestResult result

HousingEditorAlignSelectedObjectToSurface

()

# Returns: HousingRequestResult result

IsTargetCyclingSupportedInCurrentHousingEditorMode

()

# Returns: bool targetCyclingSupported

HousingEditorGetNumCyclableTargets

()

# Returns: integer numTargets

HousingEditorCycleTarget

()

# Returns: HousingRequestResult result

HousingEditorCreateItemFurnitureForPlacement

(Bag bagId, integer slotIndex)

# Returns: bool success

HousingEditorCreateCollectibleFurnitureForPlacement

(integer collectibleId)

# Returns: bool success

HousingEditorCreateFurnitureForPlacementFromMarketProduct

(integer marketProductId)

# Returns: bool success

HousingEditorGetSelectedFurnitureYAxisRotationOffset

()

# Returns: number yAxisRotationOffsetRadians

HousingEditorEndCurrentPreview

()

HousingEditorGetTargetInfo

()

# Returns: id64 furnitureId, luaindex:nilable pathIndex

HousingEditorSelectTargettedFurniture

()

# Returns: HousingRequestResult result

HousingEditorCanSelectTargettedFurniture

()

# Returns: bool hasTarget

HousingEditorRequestModeChange

(HousingEditorMode mode)

# Returns: HousingRequestResult result

GetHousingEditorMode

()

# Returns: HousingEditorMode mode

IsInHousingEditorPlacementMode

()

# Returns: bool isPlacementMode

GetHousingVisitorRole

()

# Returns: HousingVisitorRole role

GetNextPlacedHousingFurnitureId

(id64:nilable lastFurnitureId)

# Returns: id64:nilable nextFurnitureId

GetPlacedHousingFurnitureInfo

(id64 furnitureId)

# Returns: string itemName, textureName icon, integer furnitureDataId

GetPlacedHousingFurnitureNumObjectStates

(id64 furnitureId)

# Returns: integer numStates

GetPlacedHousingFurnitureCurrentObjectStateIndex

(id64 furnitureId)

# Returns: integer currentObjectStateIndex

GetPlacedHousingFurnitureDisplayQuality

(id64 furnitureId)

# Returns: ItemDisplayQuality displayQuality

GetPlacedFurnitureParent

(id64 furnitureId)

# Returns: id64:nilable parentFurnitureId

GetPlacedFurnitureChildren

(id64 furnitureId)

# Uses variable returns...
# Returns: id64 childFurnitureId

HousingEditorCanPlaceCollectible

(integer collectibleId)

# Returns: bool success

HousingEditorCanFurnitureBePathed

(id64 furnitureId)

# Returns: bool canBePathed

HousingEditorCanCollectibleBePathed

(integer collectibleId)

# Returns: bool canBePathed

HousingEditorJumpToSafeLocation

()

GetHousingEditorConstants

()

# Returns: number pushSpeedPerSecond, number rotationStepSizeRadians, integer numTicksPerSecondForRotationChange

GetCurrentHousePreviewTemplateId

()

# Returns: integer houseTemplateId

GetCurrentHouseOwner

()

# Returns: string displayName

HousingEditorPreviewTemplate

(integer houseTemplateId)

RequestOpenHouseStore

()

GetHouseFurnishingPlacementLimit

(integer houseId, HousingFurnishingLimitType limitType)

# Returns: integer furnishingPlacementLimit

GetNumHouseFurnishingsPlaced

(HousingFurnishingLimitType limitType)

# Returns: integer numFurnishingsPlaced

IsOwnerOfCurrentHouse

()

# Returns: bool isOwner

HasAnyEditingPermissionsForCurrentHouse

()

# Returns: bool canEdit

HasPermissionSettingForCurrentHouse

(HousePermissionSetting setting)

# Returns: bool hasSetting

GetPlacedFurnitureLink

(id64 placedFurnitureId, LinkStyle linkStyle)

# Returns: string itemLink, string collectibleLink

GetCurrentHousePopulation

()

# Returns: integer population

GetHouseOccupantName

(luaindex index)

# Returns: string displayName, string characterName

UndoLastHousingEditorCommand

()

RedoLastHousingEditorCommand

()

CanUndoLastHousingEditorCommand

()

# Returns: bool canUndo

CanRedoLastHousingEditorCommand

()

# Returns: bool canRedo

GetNumHousingEditorHistoryCommands

()

# Returns: integer numCommands

GetCurrentHousingEditorHistoryCommandIndex

()

# Returns: integer index

GetHousingEditorHistoryCommandInfo

(integer index)

# Returns: HousingEditorCommandType commandType, string itemName, textureName icon

SetHousingEditorTrackedFurnitureId

(id64 placedFurnitureId)

SetHousingEditorTrackedPathNode

(id64 placedFurnitureId, luaindex pathIndex)

ResetHousingEditorTrackedFurnitureOrNode

()

HousingEditorRequestSetFurnitureParent

(id64 childFurnitureId, id64 parentFurnitureId)

# Returns: HousingRequestResult result

HousingEditorRequestClearFurnitureParent

(id64 furnitureId)

# Returns: HousingRequestResult result

HousingEditorBeginLinkingTargettedFurniture

()

# Returns: HousingRequestResult result

HousingEditorGetLinkRelationshipFromSelectedChildToPendingFurniture

()

# Returns: HousingPendingLinkRelationship result

HousingEditorGetPendingBadLinkResult

()

# Returns: HousingRequestResult result

HousingEditorPerformPendingLinkOperation

()

# Returns: HousingRequestResult result

HousingEditorCanRemoveParentFromPendingFurniture

()

# Returns: HousingRequestResult result

HousingEditorRemoveParentFromPendingFurniture

()

# Returns: HousingRequestResult result

HousingEditorCanRemoveAllChildrenFromPendingFurniture

()

# Returns: HousingRequestResult result

HousingEditorRemoveAllChildrenFromPendingFurniture

()

# Returns: HousingRequestResult result

HousingEditorGetPathNodeWorldPosition

(id64 furnitureId, luaindex index)

# Returns: integer worldX, integer worldY, integer worldZ

HousingEditorGetPathNodeOrientation

(id64 furnitureId, luaindex index)

# Returns: number pitchRadians, number yawRadians, number rollRadians

HousingEditorRequestChangeFurniturePathData

(id64 furnitureId, FurniturePathState newState, PathFollowType newFollowType, bool newConformToGround)

# Returns: HousingRequestResult result

HousingEditorRequestInsertPathNode

(id64 furnitureId, luaindex index, integer worldX, integer worldY, integer worldZ, number headingRadians, HousingPathMovementSpeed speed, integer reachDestinationDelayTime)

# Returns: HousingRequestResult result

HousingEditorRequestModifyPathNode

# Returns: HousingRequestResult result

HousingEditorRequestRemovePathNode

(id64 furnitureId, luaindex index)

# Returns: HousingRequestResult result

HousingEditorRequestReplacePathCollectible

(id64 furnitureId, integer collectiblieId)

# Returns: HousingRequestResult result

HousingEditorRequestSetStartingNodeIndex

(id64 furnitureId, luaindex startingIndex)

# Returns: HousingRequestResult result

GetNextPathedHousingFurnitureId

(id64:nilable lastFurnitureId)

# Returns: id64:nilable nextFurnitureId

HousingEditorSelectPathNodeByIndex

(id64 furnitureId, luaindex index)

# Returns: HousingRequestResult result

HousingEditorSelectTargetUnderReticle

()

# Returns: HousingRequestResult result

HousingEditorEditTargettedFurniturePath

()

# Returns: HousingRequestResult result

HousingEditorSelectTargettedPathNode

()

# Returns: HousingRequestResult result

HousingEditorBeginPlaceNewPathNode

(luaindex index)

# Returns: HousingRequestResult result

HousingEditorRequestPlaceSelectedPathNode

()

# Returns: HousingRequestResult result

HousingEditorRequestRemoveSelectedPathNode

()

# Returns: HousingRequestResult result

HousingEditorReleaseSelectedPathNode

()

# Returns: HousingRequestResult result

HousingEditorRotatePathNode

(number rotationForce)

# Returns: HousingRequestResult result

HousingEditorRequestRestartAllFurniturePaths

()

# Returns: HousingRequestResult result

HousingEditorHasSelectablePathNode

()

# Returns: bool hasTarget

HousingEditorIsPlacingNewNode

()

# Returns: bool placingNewNode

HousingEditorToggleSelectedFurniturePathState

()

# Returns: HousingRequestResult result

HousingEditorToggleSelectedFurniturePathConformToGround

()

# Returns: HousingRequestResult result

HousingEditorSetSelectedFurniturePathFollowType

(PathFollowType newPathType)

# Returns: HousingRequestResult result

HousingEditorToggleSelectedPathNodeSpeed

()

# Returns: HousingRequestResult result

HousingEditorToggleSelectedPathNodeDelayTime

()

# Returns: HousingRequestResult result

HousingEditorAlignSelectedPathNodeToSurface

()

# Returns: HousingRequestResult result

HousingEditorGetSelectedPathNodeFurnitureId

()

# Returns: id64 furnitureId

HousingEditorGetSelectedPathNodeIndex

()

# Returns: luaindex pathIndex

HousingEditorGetSelectedPathNodeSpeed

()

# Returns: HousingPathMovementSpeed movementSpeed

HousingEditorGetSelectedPathNodeDelayTime

()

# Returns: integer timeMS

HousingEditorGetSelectedFurniturePathState

()

# Returns: FurniturePathState pathState

HousingEditorGetSelectedFurniturePathConformToGround

()

# Returns: bool conformToGround

HousingEditorGetSelectedFurniturePathFollowType

()

# Returns: PathFollowType followType

HousingEditorPathNodeSpeed

(id64 furnitureId, luaindex index)

# Returns: HousingPathMovementSpeed movementSpeed

HousingEditorPathNodeDelayTime

(id64 furnitureId, luaindex index)

# Returns: integer timeMS

HousingEditorGetFurniturePathState

(id64 furnitureId)

# Returns: FurniturePathState pathState

HousingEditorGetFurniturePathFollowType

(id64 furnitureId)

# Returns: PathFollowType followType

HousingEditorGetPathNodeDelayTimeFromValue

(HousingPathDelayTime pathDelayTime)

# Returns: integer timeMS

HousingEditorGetPathNodeValueFromDelayTime

(integer timeMS)

# Returns: HousingPathDelayTime pathDelayTime

HousingEditorGetNumPathNodesInSelectedFurniture

()

# Returns: integer numPathNodes

HousingEditorGetNumPathNodesForFurniture

(id64 furnitureId)

# Returns: integer numNodes

HousingEditorGetStartingNodeIndexForPath

(id64 furnitureId)

# Returns: luaindex nodeIndex

HousingEditorIsLocalPlayerInPairedFurnitureInteraction

()

# Returns: bool isInteracting

HousingEditorEndLocalPlayerPairedFurnitureInteraction

()

CanHousingEditorPlacementPreviewMarketProduct

(integer marketProductId)

# Returns: bool canPreview

HousingEditorClearPreviewMarketProductTransform

private ()

HousingEditorEndMarketProductPlacementPreview

private ()

IsHousingEditorPreviewingMarketProductPlacement

()

# Returns: bool isPreviewingMarketProductPlacement

HousingEditorRequestMarketProductPlacementPreview

private (integer marketProductId)

# Returns: HousingRequestResult result

HousingEditorSavePreviewMarketProductTransform

private ()

GetItemUniqueIdFromFurnitureId

(id64 furnitureId)

# Returns: id64 itemUniqueId

GetFurnitureIdFromItemUniqueId

(id64 itemUniqueId)

# Returns: id64 furnitureId

GetFurnitureIdFromCollectibleId

(integer collectibleId)

# Returns: id64 furnitureId

GetCollectibleIdFromFurnitureId

(id64 furnitureId)

# Returns: integer collectibleId

SetNameplateKeyboardFont

(string fontName, FontStyle fontStyle)

GetNameplateKeyboardFont

()

# Returns: string fontName, FontStyle fontStyle

SetNameplateGamepadFont

(string fontName, FontStyle fontStyle)

GetNameplateGamepadFont

()

# Returns: string fontName, FontStyle fontStyle

RequestOpenUnsafeURL

(string URL)

GetNextActiveArtificialEffectId

(integer:nilable lastActiveEffectId)

# Returns: integer:nilable nextActiveEffectId

GetArtificialEffectInfo

(integer artificialEffectId)

# Returns: string displayName, textureName icon, BuffEffectType effectType, integer sortOrder, number timeStartedS, number timeEndingS

GetArtificialEffectTooltipText

(integer artificialEffectId)

# Returns: string tooltipText

IsCutsceneActive

()

# Returns: bool isCutsceneActive

GetActiveCutsceneVideoPath

()

# Returns: string videoPath

GetActiveCutsceneVideoDataId

()

# Returns: integer videoDataId

RequestEndCutscene

()

HasEsoPlusFreeTrialNotification

()

# Returns: bool hasFreeTrialNotification

ClearEsoPlusFreeTrialNotification

()

CanItemBeRetraited

(Bag bagId, integer slotIndex)

# Returns: bool canBeRetraited

RequestItemTraitChange

(Bag bagId, integer slotIndex, ItemTraitType itemTrait)

GetItemRetraitCost

()

# Returns: integer retraitCost, CurrencyType currencyType, CurrencyLocation currencyLocation

GetResultingItemLinkAfterRetrait

(Bag bagId, integer slotIndex, ItemTraitType pendingTrait, LinkStyle linkStyle)

# Returns: string link

IsItemTraitKnownForRetraitResult

(Bag bagId, integer slotIndex, ItemTraitType pendingTrait)

# Returns: bool isKnown

GetRearchLineInfoFromRetraitItem

(Bag bagId, integer slotIndex)

# Returns: TradeskillType craftingType, string researchLineName

GetItemTraitTypeCategory

(ItemTraitType itemTraitType)

# Returns: ItemTraitTypeCategory itemTraitTypeCategory

StartDyesSearch

(string searchString)

GetNumDyesSearchResults

()

# Returns: integer numSearchResults

GetDyesSearchResult

(luaindex searchResultIndex)

# Returns: luaindex dyeIndex

ClaimPendingLevelUpReward

()

MakeLevelUpRewardChoice

(integer sourceRwardId, integer choiceRewardId)

IsLevelUpRewardChoiceSelected

(integer sourceRewardId, integer choiceRewardId)

# Returns: bool isSelectedChoice

DoAllValidLevelUpRewardChoicesHaveSelections

()

# Returns: bool allSelectionsMade

GetPendingLevelUpRewardLevel

()

# Returns: integer:nilable level

HasPendingLevelUpReward

()

# Returns: bool hasPendingReward

GetHighestClaimedLevelUpReward

()

# Returns: integer highestClaimedLevel

GetUpcomingLevelUpRewardLevel

()

# Returns: integer:nilable level

HasUpcomingLevelUpReward

()

# Returns: bool hasNextReward

GetNextLevelUpRewardMilestoneLevel

()

# Returns: integer:nilable milestoneLevel

IsLevelUpRewardMilestoneForLevel

(integer level)

# Returns: bool isRewardMilestone

GetNumInventorySlotsNeededForLevelUpReward

(integer level)

# Returns: integer numInventorySlotsNeeded

GetLevelUpBackground

(integer level)

# Returns: textureName background

GetKeyboardLevelUpTipOverview

(integer level)

# Returns: string tipOverview

GetKeyboardLevelUpTipDescription

(integer level)

# Returns: string tipOverview

GetGamepadLevelUpTipOverview

(integer level)

# Returns: string tipOverview

GetGamepadLevelUpTipDescription

(integer level)

# Returns: string tipOverview

GetNumLevelUpTextureLayerRevealAnimations

(integer level)

# Returns: integer numAnimations

GetLevelUpTextureLayerRevealAnimation

(integer level, luaindex index)

# Returns: integer animationId

GetLevelUpTextureLayerRevealAnimationsMinDuration

(integer level)

# Returns: integer minDurationMS

GetLevelUpHelpIndicesForLevel

(integer level)

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetNumAdditionalLevelUpUnlocks

(integer level)

# Returns: integer numAdditionalUnlocks

GetAdditionalLevelUpUnlockDisplayName

(integer level, luaindex unlockIndex)

# Returns: string displayName

GetAdditionalLevelUpUnlockDescription

(integer level, luaindex unlockIndex)

# Returns: string description

GetAdditionalLevelUpUnlockKeyboardIcon

(integer level, luaindex unlockIndex)

# Returns: textureName keyboardIcon

GetAdditionalLevelUpUnlockGamepadIcon

(integer level, luaindex unlockIndex)

# Returns: textureName gamepadIcon

IsLevelUpRewardValidForPlayer

(integer rewardId)

# Returns: bool isValid

GetNumLevelUpGuiParticleEffects

(integer level)

# Returns: integer numEffects

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

GetAttributePointsAwardedForLevel

(integer level)

# Returns: integer numAttributePoints

GetSkillPointsAwardedForLevel

(integer level)

# Returns: integer numSkillPoints

GetNumRewardsForLevel

(integer level)

# Returns: integer numRewards

GetRewardInfoForLevel

(integer level, luaindex index)

# Returns: integer rewardId, integer quantity

GetTextureLayerRevealAnimationTexture

(integer animationId)

# Returns: textureName texture

GetTextureLayerRevealAnimationBlendMode

(integer animationId)

# Returns: TextureBlendMode blendMode

GetTextureLayerRevealAnimationWindowDimensions

(integer animationId)

# Returns: number normalizedWidth, number normalizedHeight

GetTextureLayerRevealAnimationWindowEndPoints

(integer animationId)

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

GetTextureLayerRevealAnimationWindowMovementDuration

(integer animationId)

# Returns: integer durationMS

GetTextureLayerRevealAnimationWindowMovementOffset

(integer animationId)

# Returns: integer offsetMS

GetTextureLayerRevealAnimationWindowFadeGradientInfo

(integer animationId, luaindex index)

# Returns: number x, number y, number normalizedDistance

GetNextGiftId

(id64:nilable lastGiftId)

# Returns: id64:nilable nextGiftId

GetGiftInfo

(id64 giftId)

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

ViewGifts

(id64 giftIds)

TakeGift

(id64 giftId, string note)

ReturnGift

(id64 giftId, string note)

RequestResendGift

(id64 giftId)

DeleteGift

(id64 giftId)

PlayGiftClaimFanfare

()

PlayGiftThankedFanfare

()

SetEncounterLogEnabled

(bool isEnabled)

IsEncounterLogEnabled

()

# Returns: bool isEnabled

SetEncounterLogVerboseFormat

(bool verbose)

IsEncounterLogVerboseFormat

()

# Returns: bool isVerbose

SetEncounterLogAbilityInfoInline

(bool isInline)

IsEncounterLogAbilityInfoInline

()

# Returns: bool isInline

GetEncounterLogVersion

()

# Returns: integer version

GetNextZoneStoryZoneId

(integer:nilable lastZoneId)

# Returns: integer:nilable nextZoneId

GetNumZoneActivitiesForZoneCompletionType

(integer zoneId, ZoneCompletionType zoneCompletionType)

# Returns: integer numActivities

GetNumUnblockedZoneStoryActivitiesForZoneCompletionType

(integer zoneId, ZoneCompletionType zoneCompletionType)

# Returns: integer numUnblockedActivities, integer blockingBranchErrorStringId

DoesZoneCompletionTypeInZoneHaveBranchesWithDifferentLengths

(integer zoneId, ZoneCompletionType zoneCompletionType)

# Returns: bool hasBranchesWithDifferentLengths

GetZoneActivityIdForZoneCompletionType

(integer zoneId, ZoneCompletionType zoneCompletionType, luaindex activitiyIndex)

# Returns: integer activityId

GetNumCompletedZoneActivitiesForZoneCompletionType

(integer zoneId, ZoneCompletionType zoneCompletionType)

# Returns: integer numCompletedActivities

GetNumAssociatedAchievementsForZoneCompletionType

(integer zoneId, ZoneCompletionType zoneCompletionType)

# Returns: integer numAssociatedAchievements

GetAssociatedAchievementIdForZoneCompletionType

(integer zoneId, ZoneCompletionType zoneCompletionType, luaindex associatedAchievementIndex)

# Returns: integer associatedAchievementId

IsZoneStoryActivityComplete

(integer zoneId, ZoneCompletionType zoneCompletionType, luaindex activityIndex)

# Returns: bool isActivityComplete

GetZoneStoryActivityNameByActivityIndex

(integer zoneId, ZoneCompletionType zoneCompletionType, luaindex activityIndex)

# Returns: string name

GetZoneStoryActivityNameByActivityId

(integer zoneId, ZoneCompletionType zoneCompletionType, integer activityId)

# Returns: string name

GetZoneStoryShortDescriptionByActivityId

(integer zoneId, ZoneCompletionType zoneCompletionType, integer activityId)

# Returns: string description

GetNormalizedPositionForZoneStoryActivityId

(integer zoneId, ZoneCompletionType zoneCompletionType, integer activityId)

# Returns: number normalizedX, number normalizedZ, number normalizedRadius, bool isInCurrentMap

GetZoneStoryGamepadBackground

(integer zoneId)

# Returns: textureName backgroundFile

CanZoneStoryContinueTrackingActivities

(integer zoneId)

# Returns: bool canContinueTracking

CanZoneStoryContinueTrackingActivitiesForCompletionType

(integer zoneId, ZoneCompletionType zoneCompletionType)

# Returns: bool canContinueTracking

TrackNextActivityForZoneStory

(integer zoneId, ZoneCompletionType:nilable zoneCompletionType, bool setAutoMapNavigationTarget)

# Returns: bool foundActivityToTrack

IsZoneStoryStarted

(integer zoneId)

# Returns: bool isStarted

IsJournalQuestIndexInTrackedZoneStory

(luaindex journalQuestIndex)

# Returns: bool isInTrackedZoneStory

ClearTrackedZoneStory

()

SetTrackedZoneStoryAssisted

(bool isAssisted)

GetGuildPersonalityAttribute

(integer guildId)

# Returns: GuildPersonalityAttributeValue personality

GetGuildLanguageAttribute

(integer guildId)

# Returns: GuildLanguageAttributeValue language

DoesGuildHaveActivityAttribute

(integer guildId, GuildActivityAttributeValue activity)

# Returns: bool hasActivity

DoesGuildHaveRoleAttribute

(integer guildId, LFGRole role)

# Returns: bool hasRole

GetGuildNameAttribute

(integer guildId)

# Returns: string guildName

GetGuildRecruitmentMessageAttribute

(integer guildId)

# Returns: string recruitmentMessage

GetGuildHeaderMessageAttribute

(integer guildId)

# Returns: string headerMessage

GetGuildAllianceAttribute

(integer guildId)

# Returns: Alliance guildAlliance

GetGuildPrimaryFocusAttribute

(integer guildId)

# Returns: GuildFocusAttributeValue primaryFocus

GetGuildSecondaryFocusAttribute

(integer guildId)

# Returns: GuildFocusAttributeValue secondaryFocus

GetGuildSizeAttribute

(integer guildId)

# Returns: integer guildSize

GetGuildSizeAttributeRangeValues

(GuildSizeAttributeValue size)

# Returns: integer minSize, integer maxSize

GetGuildMinimumCPAttribute

(integer guildId)

# Returns: integer minimumCP

GetGuildKioskAttribute

(integer guildId)

# Returns: string:nilable ownedKioskName

GetGuildHeraldryAttribute

(integer guildId)

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

GetGuildFoundedDateAttribute

(integer guildId)

# Returns: string foundedDate

GetGuildLocalStartTimeAttribute

(integer guildId)

# Returns: integer localStartTimeHour

GetGuildLocalEndTimeAttribute

(integer guildId)

# Returns: integer localEndTimeHour

GetGuildRecruitmentStatusAttribute

(integer guildId)

# Returns: GuildRecruitmentStatusAttributeValue recruitmentStatus

DoesGuildDataHaveInitializedAttributes

(integer guildId, GuildMetaDataAttribute attribute)

# Returns: bool hasAllData

RequestGuildFinderAttributesForGuild

(integer guildId)

# Returns: bool requested

GetNextWorldEventInstanceId

(integer:nilable lastWorldEventInstanceId)

# Returns: integer:nilable nextWorldEventInstanceId

GetWorldEventId

(integer worldEventInstanceId)

# Returns: integer worldEventId

GetWorldEventType

(integer worldEventId)

# Returns: WorldEventType worldEventType

GetWorldEventLocationContext

(integer worldEventInstanceId)

# Returns: WorldEventLocationContext locationContext

GetNumWorldEventInstanceUnits

(integer worldEventInstanceId)

# Returns: integer numUnits

GetWorldEventInstanceUnitTag

(integer worldEventInstanceId, luaindex unitIndex)

# Returns: string unitTag

GetWorldEventInstanceUnitPinType

(integer worldEventInstanceId, string unitTag)

# Returns: MapDisplayPinType pinType

GetWorldEventInstanceUnitPinIcon

(integer worldEventInstanceId, string unitTag, bool ignoreAnimatedIcon)

# Returns: textureName mapIcon

GetIsWorldEventInstanceUnitPinIconAnimated

(integer worldEventInstanceId, string unitTag)

# Returns: bool isAnimated

GetWorldEventPOIInfo

(integer worldEventInstanceId)

# Returns: luaindex zoneIndex, luaindex poiIndex

GetPOIWorldEventInstanceId

(luaindex zoneIndex, luaindex poiIndex)

# Returns: integer worldEventInstanceId

GetWorldEventNumSteps

(integer worldEventId)

# Returns: integer numSteps

GetParticipatingWorldEventStep

()

# Returns: integer worldEventInstanceId, luaindex stepIndex

GetWorldEventCurrentStepExpireTimeS

(integer worldEventInstanceId)

# Returns: integer53 endTimeS

GetWorldEventCurrentStepProgress

(integer worldEventInstanceId)

# Returns: integer currentProgress, integer maxProgress

GetWorldEventStepName

(integer worldEventInstanceId, luaindex stepIndex)

# Returns: string name

GetWorldEventStepDescription

(integer worldEventInstanceId, luaindex stepIndex)

# Returns: string description

GuildFinderRequestSearch

()

# Returns: integer:nilable searchId

GuildFinderIsSearchOnCooldown

()

# Returns: bool isOnCooldown

GuildFinderGetNumSearchResults

()

# Returns: integer numResults

GuildFinderGetSearchResultGuildId

(luaindex index)

# Returns: integer guildId

SetGuildFinderFocusSearchFilter

(GuildFocusAttributeValue focus)

SetGuildFinderHasTradersSearchFilter

(bool hasTrader)

SetGuildFinderActivityFilterValue

(GuildActivityAttributeValue activity, bool hasActivity)

SetGuildFinderPersonalityFilterValue

(GuildPersonalityAttributeValue personality, bool hasPersonality)

SetGuildFinderAllianceFilterValue

(Alliance alliance, bool hasAlliance)

SetGuildFinderLanguageFilterValue

(GuildLanguageAttributeValue language, bool hasLanguage)

SetGuildFinderSizeFilterValue

(GuildSizeAttributeValue size, bool hasSize)

SetGuildFinderRoleFilterValue

(LFGRole role, bool hasRole)

SetGuildFinderChampionPointsFilterValues

(integer minChampionPoints, integer maxChampionPoints)

SetGuildFinderPlayTimeFilters

(integer startTime, integer endTime)

RequestGuildFinderAccountApplications

()

# Returns: bool requested

GetGuildFinderNumAccountApplications

()

# Returns: integer numApplications

GetGuildFinderAccountApplicationDuration

(luaindex index)

# Returns: integer timeRemainingS

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

GetGuildFinderNumGuildApplications

(integer guildId)

# Returns: integer numApplications

GetGuildFinderGuildApplicationDuration

(integer guildId, luaindex index)

# Returns: integer timeRemainingS

GetGuildFinderGuildApplicationInfoAt

(integer guildId, luaindex index)

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

AcceptGuildApplication

(integer guildId, luaindex index)

# Returns: GuildProcessApplicationResponse acceptedResult

DeclineGuildApplication

(integer guildId, luaindex index, string declineMessage, bool blacklistApplicant, string blacklistMessage)

# Returns: GuildProcessApplicationResponse declinedResult, GuildBlacklistResponse blacklistResult

SubmitGuildFinderApplication

(integer guildId, string applicationMessage)

# Returns: GuildApplicationResponse applicationResult

RescindGuildFinderApplication

(luaindex index)

# Returns: bool rescinded

GetNumPlayerApplicationNotifications

()

# Returns: integer numApplications

GetPlayerApplicationNotificationInfo

(luaindex index)

# Returns: string declineReason, string guildName, Alliance alliance, GuildApplicationStatus applicationStatus

ClearPlayerApplicationNotification

(luaindex index)

GetDefaultsForGuildLanguageAttributeFilter

()

# Uses variable returns...
# Returns: GuildLanguageAttributeValue language

GetLocalPlayerDaedricArtifactId

()

# Returns: integer:nilable daedricArtifactId

GetDaedricArtifactDisplayName

(integer daedricArtifactId)

# Returns: string artifactDisplayName

GetDaedricArtifactVisualType

(integer daedricArtifactId)

# Returns: DaedricArtifactVisualType artifactVisualType

ClearGuildHistoryCache

(integer guildId, GuildHistoryEventCategory:nilable category, integer keepResultsFromLastNumSeconds)

# Returns: bool success

GetNumGuildHistoryEvents

(integer guildId, GuildHistoryEventCategory category)

# Returns: integer numEvents

GetGuildHistoryEventIndicesForTimeRange

(integer guildId, GuildHistoryEventCategory category, integer53 newestTimeS, integer53 oldestTimeS)

# Returns: luaindex:nilable newestEventIndex, luaindex:nilable oldestEventIndex

GetOldestGuildHistoryEventIndexForUpToDateEventsWithoutGaps

(integer guildId, GuildHistoryEventCategory category)

# Returns: luaindex:nilable oldestEventIndex

GetNewestAndOldestRedactedGuildHistoryEventIds

(integer guildId, GuildHistoryEventCategory category)

# Returns: integer53:nilable newestRedactedEventId, integer53:nilable oldestRedactedEventId

DoesGuildHistoryEventCategoryHaveUpToDateEvents

(integer guildId, GuildHistoryEventCategory category)

# Returns: bool hasUpToDateEvents

GetNumGuildHistoryEventRanges

(integer guildId, GuildHistoryEventCategory category)

# Returns: integer numGuildHistoryEventRanges

GetGuildHistoryEventRangeInfo

(integer guildId, GuildHistoryEventCategory category, luaindex rangeIndex)

# Returns: integer53 newestTimeS, integer53 oldestTimeS, integer53 newestEventId, integer53 oldestEventId

GetGuildHistoryEventRangeIndexForEventId

(integer guildId, GuildHistoryEventCategory category, integer53 eventId)

# Returns: luaindex:nilable rangeIndex

GetGuildHistoryEventCategoryAndIndex

(integer guildId, integer53 eventId)

# Returns: GuildHistoryEventCategory:nilable category, luaindex:nilable eventIndex

GetGuildHistoryEventIndex

(integer guildId, GuildHistoryEventCategory category, integer53 eventId)

# Returns: luaindex:nilable eventIndex

GetGuildHistoryEventId

(integer guildId, GuildHistoryEventCategory category, luaindex eventIndex)

# Returns: integer53 eventId

GetGuildHistoryEventTimestamp

(integer guildId, GuildHistoryEventCategory category, luaindex eventIndex)

# Returns: integer53 timestamp

IsGuildHistoryEventRedacted

(integer guildId, GuildHistoryEventCategory category, luaindex eventIndex)

# Returns: bool isRedacted

GetGuildHistoryEventBasicInfo

(integer guildId, GuildHistoryEventCategory category, luaindex eventIndex)

# Returns: integer53 eventId, integer53 timestamp, bool isRedacted, integer eventType

GetGuildHistoryRosterEventInfo

(integer guildId, luaindex eventIndex)

# Returns: integer53 eventId, integer53 timestampS, bool isRedacted, GuildHistoryRosterEvent eventType, string actingDisplayName, string targetDisplayName, integer:nilable rankId

GetGuildHistoryBankedItemEventInfo

(integer guildId, luaindex eventIndex)

# Returns: integer53 eventId, integer53 timestampS, bool isRedacted, GuildHistoryBankedItemEvent eventType, string displayName, string itemLink, integer quantity

GetGuildHistoryBankedCurrencyEventInfo

(integer guildId, luaindex eventIndex)

# Returns: integer53 eventId, integer53 timestampS, bool isRedacted, GuildHistoryBankedCurrencyEvent eventType, string displayName, CurrencyType currencyType, integer amount, string kioskName

GetGuildHistoryTraderEventInfo

(integer guildId, luaindex eventIndex)

# Returns: integer53 eventId, integer53 timestampS, bool isRedacted, GuildHistoryTraderEvent eventType, string sellerDisplayName, string buyerDisplayName, string itemLink, integer quantity, integer price, integer tax

GetGuildHistoryMilestoneEventInfo

(integer guildId, luaindex eventIndex)

# Returns: integer53 eventId, integer53 timestampS, bool isRedacted, GuildHistoryMilestoneEvent eventType

GetGuildHistoryActivityEventInfo

(integer guildId, luaindex eventIndex)

# Returns: integer53 eventId, integer53 timestampS, bool isRedacted, GuildHistoryActivityEvent eventType, string displayName

GetGuildHistoryAvAActivityEventInfo

(integer guildId, luaindex eventIndex)

# Returns: integer53 eventId, integer53 timestampS, bool isRedacted, GuildHistoryAvAActivityEvent eventType, string displayName, integer keepId, integer campaignId

GetGuildHistoryCacheDefaultMaxNumDays

(GuildHistoryEventCategory category)

# Returns: integer numDays

GetGuildHistoryRequestMinCooldownMs

()

# Returns: integer minCooldownMs

CreateGuildHistoryRequest

(integer guildId, GuildHistoryEventCategory category, integer53 newestTimeS, integer53 oldestTimeS)

# Returns: integer requestId

TryCleanExistingGuildHistoryRequestParameters

(integer guildId, GuildHistoryEventCategory category, integer53 newestTimeS, integer53 oldestTimeS)

# Returns: integer requestId

GetGuildHistoryRequestFlags

(integer requestId)

# Returns: GuildHistoryRequestFlags flags

IsGuildHistoryRequestComplete

(integer requestId)

# Returns: bool isComplete

IsGuildHistoryRequestTargetingEvents

(integer requestId)

# Returns: bool isTargetingEvents

DoesGuildHistoryHaveOutstandingRequest

()

# Returns: bool hasOutstandingRequest

RequestMoreGuildHistoryEvents

(integer requestId, bool queueRequestIfOnCooldown, integer53:nilable targetNewestEventId, integer53:nilable targetOldestEventId)

# Returns: GuildHistoryDataReadyState readyState

DestroyGuildHistoryRequest

(integer requestId)

# Returns: bool successfullyDestroyed

DumpGuildHistoryChunkInformation

(integer:nilable guildId)

GetNumInProgressAntiquities

()

# Returns: integer numInProgressAntiquities

GetNumDigSitesForInProgressAntiquity

(luaindex inProgressAntiquityIndex)

# Returns: integer numDigSitesForInProgressAntiquity

GetInProgressAntiquityDigSiteId

(luaindex inProgressAntiquityIndex, luaindex digSiteIndex)

# Returns: integer digSiteId

GetInProgressAntiquityId

(luaindex inProgressAntiquityIndex)

# Returns: integer antiquityId

GetDigSiteNormalizedCenterPosition

(integer digSiteId)

# Returns: number normalizedX, number normalizedZ, bool isShownInCurrentMap

GetDigSiteNormalizedBorderPoints

(integer digSiteId)

# Uses variable returns...
# Returns: number normalizedX, number normalizedZ

GetInProgressAntiquitiesForDigSite

(integer digSiteId)

# Uses variable returns...
# Returns: integer antiquityId

SetMapToDigSitePosition

(integer digSiteId)

# Returns: SetMapResultCode setMapResult

GetAntiquityDiggingSkillLineId

()

# Returns: integer diggingSkillLineId

GetAntiquityScryingSkillLineId

()

# Returns: integer scryingSkillLineId

GetAntiquityScryingToolCollectibleId

()

# Returns: integer collectibleId

GetHighestScryableDifficulty

()

# Returns: AntiquityDifficulty highestScryableDifficulty

GetScryingPassiveSkillIndex

(ScryingPassiveSkill scryingPassiveSkill)

# Returns: luaindex scryingPassiveSkillIndex

AreAntiquitySkillLinesDiscovered

()

# Returns: bool isUnlocked

RequestAbandonAntiquity

(integer antiquityId)

# Returns: AntiquityAbandonResult abandonResult

MeetsAntiquitySkillRequirementsForScrying

(integer antiquityId)

# Returns: bool meetsSkillRequirements

MeetsAntiquityRequirementsForScrying

(integer antiquityId, integer:nilable zoneId)

# Returns: AntiquityScryingResult scryingResult

CanScryForAntiquity

(integer antiquityId)

# Returns: AntiquityScryingResult scryingResult

GetTotalNumGoalsForAntiquity

(integer antiquityId)

# Returns: integer numGoals

GetNumGoalsAchievedForAntiquity

(integer antiquityId)

# Returns: integer numAchievedGoals

GetAntiquityLeadTimeRemainingSeconds

(integer antiquityId)

# Returns: integer leadTimeRemainingSeconds

IsAntiquityRepeatable

(integer antiquityId)

# Returns: bool allowsRepeats

DoesAntiquityPassVisibilityRequirements

(integer antiquityId)

# Returns: bool isVisible, integer errorStringId

GetAntiquityCategoryId

(integer antiquityId)

# Returns: integer categoryId

GetAntiquityDifficulty

(integer antiquityId)

# Returns: AntiquityDifficulty difficulty

GetNextAntiquityId

(integer:nilable lastAntiquityId)

# Returns: integer:nilable nextAntiquityId

GetNumAntiquityDigSites

(integer antiquityId)

# Returns: integer numDigSites

GetAntiquityZoneId

(integer antiquityId)

# Returns: integer zoneId

GetAntiquityCategoryGamepadIcon

(integer antiquityCategoryId)

# Returns: textureName gamepadIcon

GetAntiquityCategoryKeyboardIcons

(integer antiquityCategoryId)

# Returns: textureName unpressedButtonIcon, textureName pressedButtonIcon, textureName mouseoverButtonIcon

GetAntiquityCategoryName

(integer antiquityCategoryId)

# Returns: string name

GetAntiquityCategoryOrder

(integer antiquityCategoryId)

# Returns: integer order

GetAntiquityCategoryParentId

(integer antiquityCategoryId)

# Returns: integer setId

GetAntiquitySetRewardId

(integer antiquitySetId)

# Returns: integer rewardId

StartAntiquitySearch

(string searchString)

GetNumAntiquitySearchResults

()

# Returns: integer numSearchResults

GetAntiquitySearchResult

(luaindex aIndex)

# Returns: integer aAntiquityId

GetTrackedAntiquityId

()

# Returns: integer antiquityId

SetTrackedAntiquityId

(integer antiquityId)

IsDigSiteAssociatedWithTrackedAntiquity

(integer digSiteId)

# Returns: bool isAssociated

ScryForAntiquity

(integer antiquityId)

IsScryingInProgress

()

# Returns: bool isInProgress

RequestScryingExit

()

RequestAntiquityDiggingExit

()

RequestItemReconstruction

(integer itemDefId, ItemTraitType itemTrait, ItemQuality itemQuality, CurrencyType currencyType)

GetNextItemSetCollectionId

(integer:nilable lastItemSetId)

# Returns: integer:nilable nextItemSetId

GetItemSetCollectionSlotsInMask

(ItemSetCollectionSlot_id64 slotMask)

# Uses variable returns...
# Returns: ItemSetCollectionSlot_id64 slot

DoesItemSetCollectionsHaveAnyNewPieces

()

# Returns: bool hasNewPieces

GetItemSetCollectionCategoryId

(integer itemSetId)

# Returns: integer categoryId

GetItemSetName

(integer itemSetId)

# Returns: string name

GetItemSetType

(integer itemSetId)

# Returns: ItemSetType type

GetItemSetUnperfectedSetId

(integer itemSetId)

# Returns: integer unperfectedSetId

GetNumItemSetCollectionPieces

(integer itemSetId)

# Returns: integer numPieces

GetItemSetCollectionPieceInfo

(integer itemSetId, luaindex index)

# Returns: integer pieceId, ItemSetCollectionSlot_id64 slot

GetNumItemSetCollectionSlotsUnlocked

(integer itemSetId)

# Returns: integer numSlotsUnlocked

IsItemSetCollectionSlotUnlocked

(integer itemSetId, ItemSetCollectionSlot_id64 slot)

# Returns: bool isUnlocked

ItemSetCollectionHasNewPieces

(integer itemSetId)

# Returns: bool hasNewPieces

IsItemSetCollectionSlotNew

(integer itemSetId, ItemSetCollectionSlot_id64 slot)

# Returns: bool isNew

ClearItemSetCollectionSlotNew

(integer itemSetId, ItemSetCollectionSlot_id64 slot, bool sendUpdate)

GetNumItemReconstructionCurrencyOptions

()

# Returns: integer numCurrencyOptions

GetItemReconstructionCurrencyOptionType

(luaindex currencyOptionIndex)

# Returns: CurrencyType currencyType

GetItemReconstructionCurrencyOptionCost

(integer itemSetId, CurrencyType currencyType)

# Returns: integer:nilable cost

GetItemSetCollectionCategoryName

(integer categoryId)

# Returns: string name

GetItemSetCollectionCategoryGamepadIcon

(integer categoryId)

# Returns: textureName gamepadIcon

GetItemSetCollectionCategoryKeyboardIcons

(integer categoryId)

# Returns: textureName unpressedButtonIcon, textureName pressedButtonIcon, textureName mouseoverButtonIcon

GetItemSetCollectionCategoryOrder

(integer categoryId)

# Returns: integer order

GetItemSetCollectionCategoryParentId

(integer categoryId)

# Returns: integer parentCategoryId

GetItemSetCollectionPieceItemLink

(integer pieceId, LinkStyle linkStyle, ItemTraitType traitType, ItemQuality:nilable upgradeItemFunctionalQuality)

# Returns: string itemLink

GetEquipmentFilterTypeForItemSetCollectionSlot

(ItemSetCollectionSlot_id64 slot)

# Returns: EquipmentFilterType equipmentFilterType

GetCollectibleCategoryNameByCategoryId

(integer categoryId)

# Returns: string categoryName

GetHotbarForCollectibleCategoryId

(integer categoryId)

# Returns: HotBarCategory:nilable hotbarCategory

GetNumSubcategoriesInCollectibleCategory

(luaindex topLevelIndex)

# Returns: integer numSubcategories

GetNumCollectiblesInCollectibleCategory

(luaindex topLevelIndex, luaindex:nilable subCategoryIndex)

# Returns: integer numCollectibles

SetRandomMountType

(RandomMountType randomMountType, GameplayActorCategory actorCategory)

GetRandomMountType

(GameplayActorCategory actorCategory)

# Returns: RandomMountType randomMountType

HasActiveCompanion

()

# Returns: bool hasActiveCompanion

HasPendingCompanion

()

# Returns: bool hasPendingCompanion

HasBlockedCompanion

()

# Returns: bool hasBlockedCompanion

HasSuppressedCompanion

()

# Returns: bool hasSuppressedCompanion

GetActiveCompanionDefId

()

# Returns: integer activeCompanionDefId

GetPendingCompanionDefId

()

# Returns: integer pendingCompanionId

GetCompanionCollectibleId

(integer companionId)

# Returns: integer collectibleId

GetCompanionName

(integer companionId)

# Returns: string name

GetCompanionPassivePerkAbilityId

(integer companionId)

# Returns: integer abilityId

GetActiveCompanionLevelInfo

()

# Returns: integer level, integer currentExperience

GetMaximumRapport

()

# Returns: integer maxRapport

GetMinimumRapport

()

# Returns: integer minRapport

GetActiveCompanionRapportLevel

()

# Returns: CompanionRapportLevel rapportLevel

GetActiveCompanionRapport

()

# Returns: integer rapport

GetActiveCompanionRapportLevelDescription

(CompanionRapportLevel rapportLevel)

# Returns: string rapportLevelDescription

GetCompanionNumSlotsUnlockedForLevel

(integer companionLevel)

# Returns: integer numSlots

GetCompanionRace

(integer companionId)

# Returns: integer aRaceDefId

GetCompanionGender

(integer companionId)

# Returns: Gender gender

IsTimedActivitySystemAvailable

()

# Returns: bool available

GetNumTimedActivities

()

# Returns: integer numTimedActivities

GetTimedActivityId

(luaindex index)

# Returns: integer timedActivityId

GetTimedActivityEncodedId

(luaindex index)

# Returns: id64 encodedId

GetTimedActivityName

(luaindex index)

# Returns: string activityName

GetTimedActivityDescription

(luaindex index)

# Returns: string activityDescription

GetTimedActivityType

(luaindex index)

# Returns: TimedActivityType activityType

GetTimedActivityDifficulty

(luaindex index)

# Returns: TimedActivityDifficulty difficulty

GetNumTimedActivityRewards

(luaindex index)

# Returns: integer numRewards

GetTimedActivityRewardInfo

(luaindex index, luaindex rewardIndex)

# Returns: integer rewardId, integer quantity

GetTimedActivityCurrencyRewardInfo

(luaindex index)

# Returns: CurrencyType currencyType, integer quantity

GetTimedActivityProgress

(luaindex index)

# Returns: integer progress

GetTimedActivityMaxProgress

(luaindex index)

# Returns: integer maxProgress

GetTimedActivityEndTimeS

(luaindex index)

# Returns: integer53 endTimeS

GetTimedActivityNumTimesClaimed

(luaindex index)

# Returns: integer numTimesClaimed

GetTimedActivityTotalNumTimesClaimable

(luaindex index)

# Returns: integer totalNumTimesClaimable

ClaimTimedActivityReward

(luaindex index)

RerollTimedActivity

(luaindex index)

# Returns: TamrielTomeChallengeRerollResult result

GetTrackedTimedActivityInfo

()

# Returns: luaindex:nilable index, id64 timedActivityEncodedId

TrackTimedActivity

(luaindex index)

ClearTrackedTimedActivity

()

GetTimedActivityTypeResetTimeS

(TimedActivityType activityType)

# Returns: integer53 resetTimeS

GetTomePointGainBonusPercentage

()

# Returns: integer bonusPercentage

GetTimedActivityRequiredCollectible

(integer timedActivityId)

# Returns: integer requiredCollectible

GetLocalTimeOfDay

()

# Returns: integer hours, integer minutes, integer seconds

GetGlobalTimeOfDay

()

# Returns: integer hours, integer minutes, integer seconds

GetNumSkyshardsInZone

(integer zoneId)

# Returns: integer numSkyshards

GetZoneSkyshardId

(integer zoneId, luaindex skyshardIndex)

# Returns: integer skyshardId

GetNormalizedPositionForSkyshardId

(integer skyshardId)

# Returns: number normalizedX, number normalizedZ, bool isInCurrentMap

GetSkyshardDiscoveryDistanceM

()

# Returns: integer discoveryDistanceM

GetSkyshardHint

(integer skyshardId)

# Returns: string skyshardHint

GetSkyshardDiscoveryStatus

(integer skyshardId)

# Returns: SkyshardDiscoveryStatus skyshardDiscoveryStatus

GetArmoryBuildName

(luaindex buildIndex)

# Returns: string buildName

GetArmoryBuildIconIndex

(luaindex buildIndex)

# Returns: luaindex buildIconIndex

GetArmoryBuildAttributeSpentPoints

(luaindex buildIndex, Attributes attributeType)

# Returns: integer spentPoints

GetArmoryBuildChampionSpentPointsByDiscipline

(luaindex buildIndex, integer disciplineId)

# Returns: integer spentPoints

GetArmoryBuildSkillsTotalSpentPoints

(luaindex buildIndex)

# Returns: integer spentPoints

GetArmoryBuildSlotBoundId

(luaindex buildIndex, luaindex actionSlotIndex, HotBarCategory hotbarCategory)

# Returns: integer actionId

GetArmoryBuildEquippedOutfitIndex

(luaindex buildIndex)

# Returns: luaindex:nilable outfitIndex

GetArmoryBuildCurseType

(luaindex buildIndex)

# Returns: CurseType curseType

GetArmoryBuildEquipSlotInfo

(luaindex buildIndex, EquipSlot equipSlot)

# Returns: ArmoryBuildEquipSlotState equipSlotState, Bag bagId, integer slotIndex

SaveArmoryBuild

(luaindex buildIndex)

RestoreArmoryBuild

(luaindex buildIndex)

IsValidArmoryBuildName

(string buildName)

# Uses variable returns...
# Returns: NamingError violationCode

SetArmoryBuildIconIndex

(luaindex buildIndex, luaindex iconIndex)

SetArmoryBuildName

(luaindex buildIndex, string buildName)

IsItemInArmory

(Bag bagId, integer slotIndex)

# Returns: bool isInAnyBuild

GetItemArmoryBuildList

(Bag bagId, integer slotIndex)

# Uses variable returns...
# Returns: string buildList

GetArmoryBuildPrimaryMundusStone

(luaindex buildIndex)

# Returns: MundusStone mundusStone

GetArmoryBuildSecondaryMundusStone

(luaindex buildIndex)

# Returns: MundusStone mundusStone

GetArmoryOperationsCooldownDurationMs

()

# Returns: integer durationMs

GetArmoryOperationsCooldownRemaining

()

# Returns: integer remainingTime

GetTributeInviteInfo

()

# Returns: TributeInviteState tributeInviteState, string partnerCharacterName, string partnerDisplayName, TributePlayerType targetType, integer timeRemainingMS

ChallengeTargetToTribute

(string characterOrDisplayName)

AcceptTribute

()

DeclineTribute

()

GetTributeRequiredCollectibleId

()

# Returns: integer requiredCollectibleId

GetTributeRequiredQuestId

()

# Returns: integer requiredQuestId

RequestTributeExit

(bool isInterceptingCloseAction)

GetDraftedPatronId

(TributePatronDraftId patronDraftId)

# Returns: integer patronDefId

IsGroupFinderCategoryAvailable

(GroupFinderCategory category)

# Returns: bool isAvailable

RequestSetGroupFinderExpectingUpdates

(bool isExpectingUpdates)

RequestGroupFinderSearch

()

# Returns: integer:nilable searchId

RequestApplyToGroupListing

(luaindex listingIndex, string optionalMessage, integer:nilable inviteCode)

# Returns: GroupFinderActionResult result

RequestCreateGroupListing

()

RequestEditGroupListing

()

RequestRemoveGroupListing

()

RequestResolveGroupListingApplication

(ResolveGroupListingApplicationRequest requestType, id64:nilable applicantCharId)

GetGroupFinderStatusReason

()

# Returns: GroupFinderActionResult statusReason

ResetGroupFinderFilterOptionsToDefault

()

ResetGroupFinderFilterAndDraftDifficultyToDefault

()

CancelGroupFinderFilterOptionsChanges

()

UpdateGroupFinderFilterOptions

(bool resetDifficulty)

SetGroupFinderGroupFilterSearchString

(string searchString)

GetGroupFinderGroupFilterSearchString

()

# Returns: string searchString

SetGroupFinderFilterCategory

(GroupFinderCategory category, bool isCancelable)

GetGroupFinderFilterCategory

()

# Returns: GroupFinderCategory category

SetGroupFinderFilterPrimaryOptionByIndex

(luaindex index, bool setSelection)

GetGroupFinderFilterNumPrimaryOptions

()

# Returns: integer numOptions

GetGroupFinderFilterPrimaryOptionByIndex

(luaindex index)

# Returns: string name, bool setState

SetGroupFinderFilterSecondaryOptionByIndex

(luaindex index, bool setState)

GetGroupFinderFilterNumSecondaryOptions

()

# Returns: integer numOptions

GetGroupFinderFilterSecondaryOptionByIndex

(luaindex index)

# Returns: string name, bool setState

SetGroupFinderFilterGroupSizeFlags

(GroupFinderGroupSize groupSizes)

GetGroupFinderFilterGroupSizes

()

# Returns: GroupFinderGroupSize groupSizes

GetGroupFinderFilterGroupSizeIterationEnd

()

# Returns: GroupFinderGroupSize groupSize

SetGroupFinderFilterPlaystyleFlags

(GroupFinderPlaystyle playstyles)

GetGroupFinderFilterPlaystyles

()

# Returns: GroupFinderPlaystyle playstyle

SetGroupFinderFilterRequiresChampion

(bool setState)

DoesGroupFinderFilterRequireChampion

()

# Returns: bool setState

SetGroupFinderFilterRequiresVOIP

(bool setState)

DoesGroupFinderFilterRequireVOIP

()

# Returns: bool setState

SetGroupFinderFilterRequiresInviteCode

(bool setState)

DoesGroupFinderFilterRequireInviteCode

()

# Returns: bool setState

SetGroupFinderFilterAutoAcceptRequests

(bool setState)

DoesGroupFinderFilterAutoAcceptRequests

()

# Returns: bool setState

SetGroupFinderFilterEnforceRoles

(bool setState)

DoesGroupFinderFilterRequireEnforceRoles

()

# Returns: bool setState

SetGroupFinderFilterChampionPoints

(integer championPoints)

GetGroupFinderFilterChampionPoints

()

# Returns: integer championPoints

HasGroupFinderFilterChanged

()

# Returns: bool hasChanged

IsGroupFinderFilterDefault

()

# Returns: bool isDefault

GetGroupFinderSearchNumListings

()

# Returns: integer numListings

GetGroupFinderSearchListingCategoryByIndex

(luaindex index)

# Returns: GroupFinderCategory category

GetGroupFinderSearchListingOptionsSelectionTextByIndex

(luaindex index)

# Returns: string primaryOption, string secondaryOption

GetGroupFinderSearchListingGroupSizeByIndex

(luaindex index)

# Returns: GroupFinderGroupSize groupSize

GetGroupFinderSearchListingTitleByIndex

(luaindex index)

# Returns: string title

GetGroupFinderSearchListingDescriptionByIndex

(luaindex index)

# Returns: string description

GetGroupFinderSearchListingLeaderDisplayNameByIndex

(luaindex index)

# Returns: string displayName

GetGroupFinderSearchListingLeaderCharacterNameByIndex

(luaindex index)

# Returns: string characterName

GetGroupFinderSearchListingPlaystyleByIndex

(luaindex index)

# Returns: GroupFinderPlaystyle playstyle

DoesGroupFinderSearchListingRequireChampion

(luaindex index)

# Returns: bool requiresChampion

DoesGroupFinderSearchListingRequireVOIP

(luaindex index)

# Returns: bool requiresVOIP

DoesGroupFinderSearchListingRequireInviteCode

(luaindex index)

# Returns: bool requiresInviteCode

DoesGroupFinderSearchListingAutoAcceptRequests

(luaindex index)

# Returns: bool autoAcceptsRequests

DoesGroupFinderSearchListingEnforceRoles

(luaindex index)

# Returns: bool enforcesRoles

GetGroupFinderSearchListingChampionPointsByIndex

(luaindex index)

# Returns: integer championPoints

GetGroupFinderSearchListingNumRolesByIndex

(luaindex index)

# Returns: integer numRoles

GetGroupFinderSearchListingRoleStatusCount

(luaindex index, LFGRole role)

# Returns: integer desiredCount, integer attainedCount

GetGroupFinderSearchListingJoinabilityResult

(luaindex index)

# Returns: GroupFinderActionResult joinabilityResult

IsGroupFinderSearchListingActiveApplication

(luaindex index)

# Returns: bool isAppliedTo

IsGroupFinderSearchOnCooldown

()

# Returns: bool isSearchOnCooldown

GetGroupFinderSearchListingFirstLockingCollectibleId

(luaindex index)

# Returns: integer collectibleId

UpdateGroupFinderUserTypeGroupListingOptions

(GroupFinderGroupListingUserType userType)

SetGroupFinderUserTypeGroupListingCategory

(GroupFinderGroupListingUserType userType, GroupFinderCategory category)

GetGroupFinderUserTypeGroupListingCategory

(GroupFinderGroupListingUserType userType)

# Returns: GroupFinderCategory category

SetGroupFinderUserTypeGroupListingPrimaryOption

(GroupFinderGroupListingUserType userType, luaindex index)

GetGroupFinderUserTypeGroupListingNumPrimaryOptions

(GroupFinderGroupListingUserType userType)

# Returns: integer numOptions

GetGroupFinderUserTypeGroupListingPrimaryOptionByIndex

(GroupFinderGroupListingUserType userType, luaindex index)

# Returns: string name, bool setState

SetGroupFinderUserTypeGroupListingSecondaryOptionDefault

(GroupFinderGroupListingUserType userType)

SetGroupFinderUserTypeGroupListingSecondaryOption

(GroupFinderGroupListingUserType userType, luaindex index)

GetGroupFinderUserTypeGroupListingNumSecondaryOptions

(GroupFinderGroupListingUserType userType)

# Returns: integer numOptions

GetGroupFinderUserTypeGroupListingSecondaryOptionByIndex

(GroupFinderGroupListingUserType userType, luaindex index)

# Returns: string name, bool setState

GetGroupFinderUserTypeGroupListingOptionsSelectionText

(GroupFinderGroupListingUserType userType)

# Returns: string primaryOptionText, string secondaryOptionText

SetGroupFinderUserTypeGroupListingTitle

(GroupFinderGroupListingUserType userType, string name)

GetGroupFinderUserTypeGroupListingTitle

(GroupFinderGroupListingUserType userType)

# Returns: string title

SetGroupFinderUserTypeGroupListingDescription

(GroupFinderGroupListingUserType userType, string name)

GetGroupFinderUserTypeGroupListingDescription

(GroupFinderGroupListingUserType userType)

# Returns: string description

GetGroupFinderUserTypeGroupListingLeaderDisplayName

(GroupFinderGroupListingUserType userType)

# Returns: string displayName

GetGroupFinderUserTypeGroupListingLeaderCharacterName

(GroupFinderGroupListingUserType userType)

# Returns: string characterName

SetGroupFinderUserTypeGroupListingGroupSize

(GroupFinderGroupListingUserType userType, GroupFinderGroupSize groupSize)

GetGroupFinderUserTypeGroupListingGroupSize

(GroupFinderGroupListingUserType userType)

# Returns: GroupFinderGroupSize groupSize

GetGroupFinderUserTypeGroupSizeIterationBegin

(GroupFinderGroupListingUserType userType)

# Returns: GroupFinderGroupSize groupSize

GetGroupFinderUserTypeGroupSizeIterationEnd

(GroupFinderGroupListingUserType userType)

# Returns: GroupFinderGroupSize groupSize

GetGroupFinderUserTypeGroupListingNumRoles

(GroupFinderGroupListingUserType userType)

# Returns: integer numRoles

SetGroupFinderUserTypeGroupListingPlaystyle

(GroupFinderGroupListingUserType userType, GroupFinderPlaystyle playstyle)

GetGroupFinderUserTypeGroupListingPlaystyle

(GroupFinderGroupListingUserType userType)

# Returns: GroupFinderPlaystyle playstyle

SetGroupFinderUserTypeGroupListingRequiresChampion

(GroupFinderGroupListingUserType userType, bool requiresChampion)

DoesGroupFinderUserTypeGroupListingRequireChampion

(GroupFinderGroupListingUserType userType)

# Returns: bool requiresChampion

SetGroupFinderUserTypeGroupListingRequiresVOIP

(GroupFinderGroupListingUserType userType, bool setState)

DoesGroupFinderUserTypeGroupListingRequireVOIP

(GroupFinderGroupListingUserType userType)

# Returns: bool setState

SetGroupFinderUserTypeGroupListingRequiresInviteCode

(GroupFinderGroupListingUserType userType, bool requiresInviteCode)

DoesGroupFinderUserTypeGroupListingRequireInviteCode

(GroupFinderGroupListingUserType userType)

# Returns: bool requiresInviteCode

SetGroupFinderUserTypeGroupListingAutoAcceptRequests

(GroupFinderGroupListingUserType userType, bool autoAcceptRequests)

DoesGroupFinderUserTypeGroupListingAutoAcceptRequests

(GroupFinderGroupListingUserType userType)

# Returns: bool autoAcceptRequests

SetGroupFinderUserTypeGroupListingEnforceRoles

(GroupFinderGroupListingUserType userType, bool enforceRoles)

DoesGroupFinderUserTypeGroupListingEnforceRoles

(GroupFinderGroupListingUserType userType)

# Returns: bool enforceRoles

DoesGroupFinderUserTypeGroupListingRequireDLC

(GroupFinderGroupListingUserType userType)

# Returns: bool requiresDLC

SetGroupFinderUserTypeGroupListingChampionPoints

(GroupFinderGroupListingUserType userType, integer championPoints)

GetGroupFinderCreateGroupListingChampionPoints

(GroupFinderGroupListingUserType userType)

# Returns: integer championPoints

SetGroupFinderUserTypeGroupListingInviteCode

(GroupFinderGroupListingUserType userType, integer inviteCode)

GetGroupFinderUserTypeGroupListingInviteCode

(GroupFinderGroupListingUserType userType)

# Returns: integer inviteCode

GroupFinderUserTypeGroupListingClearDesiredRoles

(GroupFinderGroupListingUserType userType)

SetGroupFinderUserTypeGroupListingRoleCount

(GroupFinderGroupListingUserType userType, LFGRole role, integer count)

GetGroupFinderUserTypeGroupListingDesiredRoleCount

(GroupFinderGroupListingUserType userType, LFGRole role)

# Returns: integer count

GetGroupFinderUserTypeGroupListingAttainedRoleCount

(GroupFinderGroupListingUserType userType, LFGRole role)

# Returns: integer count

DoesGroupFinderUserTypeGroupListingDesiredRolesMatchAttainedRoles

(GroupFinderGroupListingUserType userType)

# Returns: bool desiredRolesMatchAttainedRoles

GetCurrentGroupFinderUserType

()

# Returns: GroupFinderGroupListingUserType userType

HasGroupListingForUserType

(GroupFinderGroupListingUserType userType)

# Returns: bool wasGroupListingCreated

HasUserTypeGroupListingChanged

(GroupFinderGroupListingUserType userType)

# Returns: bool hasChanged

CancelEditGroupListing

()

GetNextGroupListingApplicationCharacterId

(id64:nilable lastApplicantCharId)

# Returns: id64:nilable nextApplicantCharId

GetGroupListingApplicationInfoByCharacterId

(id64 applicantCharId)

# Returns: string displayName, string characterName, integer classId, integer level, integer championPoints, LFGRole role

GetGroupListingApplicationTimeRemainingSecondsByCharacterId

(id64 applicantCharId)

# Returns: integer timeRemainingSeconds

GetGroupListingApplicationNoteByCharacterId

(id64 applicantCharId)

# Returns: string note

IsGroupListingApplicationPendingByCharacterId

(id64 applicantCharId)

# Returns: bool isPending

HasPendingAcceptedGroupFinderApplication

()

# Returns: bool hasPendingapplication

IsValidGroupFinderListingTitle

(string title)

# Uses variable returns...
# Returns: NamingError violationCode

IsGroupFinderRoleChangeRequested

()

# Returns: bool isRoleChangeRequested

GetNumPromotionalEventCampaignActivities

(id64 campaignKey)

# Returns: integer numActivities

GetNumPromotionalEventCampaignMilestoneRewards

(id64 campaignKey)

# Returns: integer numMilestoneRewards

GetPromotionalEventCampaignProgress

(id64 campaignKey)

# Returns: integer numActivitiesCompleted, PromotionalEventRewardFlags capstoneRewardFlags

TryClaimPromotionalEventCapstoneReward

(id64 campaignKey, integer:nilable choiceId)

GetPromotionalEventCampaignActivityInfo

(id64 campaignKey, luaindex activityIndex)

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

GetPromotionalEventCampaignActivityDescription

(id64 campaignKey, luaindex activityIndex)

# Returns: string description

GetPromotionalEventCampaignActivityProgress

(id64 campaignKey, luaindex activityIndex)

# Returns: integer progress, PromotionalEventRewardFlags rewardFlags

TryClaimPromotionalEventActivityReward

(id64 campaignKey, luaindex activityIndex, integer:nilable choiceId)

GetPromotionalEventCampaignMilestoneInfo

(id64 campaignKey, luaindex milestoneIndex)

# Returns: integer completionThreshold, integer rewardId, integer rewardQuantity

GetPromotionalEventCampaignMilestoneRewardFlags

(id64 campaignKey, luaindex milestoneIndex)

# Returns: PromotionalEventRewardFlags rewardFlags

TryClaimPromotionalEventMilestoneReward

(id64 campaignKey, luaindex milestoneIndex, integer:nilable choiceId)

IsAnyPromotionalEventCampaignRewardClaimable

(id64 campaignKey)

# Returns: bool isAnyClaimable

TryClaimAllAvailablePromotionalEventCampaignRewards

(id64 campaignKey)

GetRecentlyClaimedPromotionalEventRewards

(id64 campaignKey)

# Uses variable returns...
# Returns: PromotionalEventCampaignComponentType type, luaindex index

TryAutoTrackNextPromotionalEventCampaign

()

# Returns: id64 campaignKeyAutoTracked

TryAutoTrackNextPromotionalEventActivity

()

# Returns: id64 campaignKeyAutoTracked

GetTrackedPromotionalEventActivityInfo

()

# Returns: id64 campaignKey, luaindex activityIndex

TrackPromotionalEventActivity

(id64 campaignKey, luaindex activityIndex)

ClearTrackedPromotionalEventActivity

()

GetReturningPlayerIntroGameplayData

()

# Returns: id64:nilable campaignKey, PromotionalEventCampaignComponentType:nilable componentType, luaindex:nilable index

GetReturningPlayerCampaignDisplayName

()

# Returns: string displayName

GetReturningPlayerIntroGameplayDisplayName

()

# Returns: string displayName

GetReturningPlayerIntroGameplayDescription

()

# Returns: string description

GetNumReturningPlayerPrimaryRewards

()

# Returns: integer numRewards

GetReturningPlayerPrimaryRewardData

(luaindex rewardIndex)

# Returns: id64 campaignKey, PromotionalEventCampaignComponentType componentType, luaindex index

IsInReturningPlayerIntroWorld

()

# Returns: bool isInReturningPlayerIntroWorld

GetExpectedJumpToReturningPlayerIntroGameplayResult

()

# Returns: ReturningPlayerInstanceJumpResult expectedResult

RequestJumpToReturningPlayerIntroGameplay

private ()

ShouldShowReturningPlayerLeaveIntroPrompt

()

# Returns: bool shouldShow

MarkReturningPlayerLeaveIntroPromptShown

()

HasReceivedPromotionalEventUpdate

()

# Returns: bool hasReceivedUpdate

HandleReturningPlayerUISystemShown

(UISystem uiSystem)

CanAcceptActiveSpectacleEventQuest

(integer activeSpectacleEventId)

# Returns: bool canAcceptQuest

GetNumActiveSpectacleEvents

()

# Returns: integer numActiveSpectacleEvents

GetActiveSpectacleEventId

(luaindex activeSpectacleEventIndex)

# Returns: integer spectacleEventDefId

GetActiveSpectacleEventDisplayName

(integer activeSpectacleEventId)

# Returns: string displayName

GetActiveSpectacleEventPhaseInfo

(integer activeSpectacleEventId)

# Returns: luaindex currentPhase, integer numPhases

GetActiveSpectacleEventPhaseDisplayName

(integer activeSpectacleEventId)

# Returns: string displayName

GetActiveSpectacleEventPhaseDescription

(integer activeSpectacleEventId)

# Returns: string description

GetActiveSpectacleEventPhaseStartedNotificationMessage

(integer activeSpectacleEventId)

# Returns: string phaseStartedNotificationMessage

GetActiveSpectacleEventPhaseCompleteNotificationMessage

(integer activeSpectacleEventId)

# Returns: string phaseCompleteNotificationMessage

GetSpectacleEventPhaseStartedAnnouncementInfo

(integer activeSpectacleEventId, integer activeSpectacleEventPhaseId)

# Returns: string broadcastMessage, string soundId

GetSpectacleEventPhaseCompleteAnnouncementInfo

(integer activeSpectacleEventId, integer activeSpectacleEventPhaseId)

# Returns: string broadcastMessage, string soundId

GetActiveSpectacleEventPhaseProgressPercentage

(integer activeSpectacleEventId)

# Returns: number progressPercentage

IsCurrentActiveSpectacleEventPhaseComplete

(integer activeSpectacleEventId)

# Returns: bool isCurrentPhaseComplete

GetSecondsRemainingUntilNextActiveSpectacleEventPhase

(integer activeSpectacleEventId)

# Returns: number secondsRemaining

GetActiveSpectacleEventQuestIndex

(integer activeSpectacleEventId)

# Returns: luaindex:nilable questIndex

RequestBestowActiveSpectacleEventQuest

(integer activeSpectacleEventId)

GetActiveSpectacleEventIdsForZoneIndex

(luaindex zoneIndex)

# Uses variable returns...
# Returns: integer activeSpectacleEventId

GetActiveSpectacleEventIdsForPOI

(luaindex zoneIndex, luaindex poiIndex)

# Uses variable returns...
# Returns: integer activeSpectacleEventId

GetActiveSpectacleEventIdsForWhichPOIIsPrimary

(luaindex zoneIndex, luaindex poiIndex)

# Uses variable returns...
# Returns: integer primaryActiveSpectacleEventId

IsActiveSpectacleEventPhaseTransitionEnabled

(integer activeSpectacleEventId)

# Returns: bool phaseTransitionEnabled

GetActiveSpectacleEventLootIconGamepad

(integer activeSpectacleEventId)

# Returns: textureName lootIcon

GetActiveSpectacleEventLootIconKeyboard

(integer activeSpectacleEventId)

# Returns: textureName lootIcon

GetActiveSpectacleEventActivityFinderBackgroundGamepad

(integer activeSpectacleEventId)

# Returns: textureName backgroundTexture

GetActiveSpectacleEventActivityFinderBackgroundKeyboard

(integer activeSpectacleEventId)

# Returns: textureName backgroundTexture

GetActiveSpectacleEventNumFeaturedAchievements

(integer activeSpectacleEventId)

# Returns: integer numFeaturedAchievements

GetActiveSpectacleEventFeaturedAchievementsId

(integer activeSpectacleEventId, luaindex achievementIndex)

# Returns: integer achievementId

IsCharmAbility

(integer abilityId)

# Returns: bool isCharmAbility

RequestSetLoadoutRoleByIndex

(luaindex index)

# Returns: VengeanceActionResult result

CanLoadoutRoleBeEquippedByIndex

(luaindex index)

# Returns: VengeanceActionResult result

GetNumberOfVengeanceRolesAvailableToPlayer

()

# Returns: integer result

GetVengeanceRoleNameAtIndex

(luaindex index)

# Returns: string roleName

GetVengeanceRoleIconAtIndex

(luaindex:nilable roleIndex)

# Returns: textureName icon

IsLoadoutRoleEquippedAtIndex

(luaindex index)

# Returns: bool isEquipped

GetRemainingCooldownForRoleSwapMs

()

# Returns: integer cooldownRemaining

GetNumberOfImportantDerivedStatDisplaysForRoleAtIndex

(luaindex index)

# Returns: integer result

GetImportantDerivedStatDisplayInfoForRoleAtIndex

(luaindex roleIndex, luaindex statIndex)

# Returns: DerivedStats derivedStat, integer oldValue, integer newValue, DerivedStatDisplayType displayType

GetNumberOfImportantMiscStatDisplaysForRoleAtIndex

(luaindex index)

# Returns: integer result

GetImportantMiscStatDisplayInfoForRoleAtIndex

(luaindex roleIndex, luaindex statIndex)

# Returns: VengeanceMiscStat miscStat, number oldValue, number newValue, DerivedStatDisplayType displayType

GetAbilityIdForHotbarSlotAtIndex

(luaindex roleIndex, HotBarCategory hotbar, luaindex slot)

# Returns: integer abilityId

GetDerivedStatValueForRoleAtIndex

(DerivedStats derivedStat, luaindex roleIndex)

# Returns: integer statValue

GetNumberOfPerksAvailableToLoadoutRoleDef

(luaindex:nilable roleIndex)

# Returns: integer numPerks

GetNumberOfPerksAvailableToLoadoutRoleDefInSlot

(VengeancePerkSlotFlags aSlotFlag, luaindex:nilable roleIndex)

# Returns: integer numPerks

CanPerkBeSlottedInSlotForRole

(luaindex slotIndex, VengeancePerkSlotFlags aSlotFlag, luaindex:nilable roleIndex)

# Returns: VengeanceActionResult result

RequestSetPerkSelectionForRoleByIndex

(luaindex redPerkIndex, luaindex yellowPerkIndex, luaindex bluePerkIndex, luaindex:nilable roleIndex)

# Returns: VengeanceActionResult result

GetVengeancePerkNameAtIndex

(luaindex perkIndex, luaindex:nilable roleIndex)

# Returns: string perkName

GetVengeancePerkTooltipTextAtIndex

(luaindex perkIndex, luaindex:nilable roleIndex)

# Returns: string tooltipText

GetActiveLoadoutRoleIndex

()

# Returns: luaindex roleIndex

GetIndexOfPerkInSlotForRole

(VengeancePerkSlotFlags slotFlag, luaindex:nilable roleIndex)

# Returns: luaindex globalPerkIndex

GetSlotIndexOfPerkInSlotForRole

(VengeancePerkSlotFlags slotFlag, luaindex:nilable roleIndex)

# Returns: luaindex perkSlotIndex

GetNumberOfSlotFlagsForPerkAtIndex

(luaindex globalPerkIndex, luaindex:nilable roleIndex)

# Returns: integer numSlotFlags

GetSlotFlagForSlotAtIndex

(luaindex globalPerkIndex, luaindex slotFlagIndex, luaindex:nilable roleIndex)

# Returns: VengeancePerkSlotFlags slotFlag

GetPerkIndexForSlotAtSlotIndex

(VengeancePerkSlotFlags slotFlag, luaindex slotIndex, luaindex:nilable roleIndex)

# Returns: luaindex globalPerkIndex

GetVengeancePerkIconAtIndex

(luaindex perkIndex, luaindex:nilable roleIndex)

# Returns: textureName icon

IsVengeancePerkDisabled

(integer perkDefId)

# Returns: bool isDisabled

IsVengeancePerkAtIndexDisabled

(luaindex globalPerkIndex, luaindex:nilable roleIndex)

# Returns: bool isDisabled

IsVengeancePerkAtSlotIndexDisabled

(VengeancePerkSlotFlags slotFlag, luaindex slotIndex, luaindex:nilable roleIndex)

# Returns: bool isDisabled

IsVengeancePerkUnlockedForSlot

(integer perkDefId, VengeancePerkSlotFlags slotFlag, luaindex:nilable roleIndex)

# Returns: bool isUnlocked

GetVengeancePerkIcon

(integer defId)

# Returns: textureName icon

GetVengeanceRoleIcon

(integer defId)

# Returns: textureName icon

IsReferenceTrackActive

(RewardTrackType rewardTrackType, integer referenceTrackId)

# Returns: bool isActive

GetReferenceTrackIdFromIndex

(RewardTrackType rewardTrackType, luaindex referenceTrackIndex)

# Returns: integer referenceTrackId

GetReferenceTrackIndex

(RewardTrackType rewardTrackType, integer referenceTrackId)

# Returns: luaindex:nilable referenceTrackIndex

GetRewardTrackIdFromReferenceTrackId

(RewardTrackType rewardTrackType, integer referenceTrackId)

# Returns: integer rewardTrackId

GetNumReferenceTracksForType

(RewardTrackType rewardTrackType)

# Returns: integer numReferenceTracksForType

GetInfoForRewardTrack

(RewardTrackType rewardTrackType, luaindex referenceTrackIndex)

# Returns: integer trackId, luaindex currentTier, integer progressToNextTier, integer endTime

GetRewardTrackRewardClaimedState

(RewardTrackType rewardTrackType, luaindex referenceTrackIndex, luaindex tier, RewardTrackComponent rewardTrackComponent, luaindex rewardIndex)

# Returns: bool isClaimed, bool isFallback, bool isInfinitelyRepeatableReward

GetRewardTrackInfinitelyRepeatableRewardClaimedState

(RewardTrackType rewardTrackType, luaindex referenceTrackIndex, RewardTrackComponent rewardTrackComponent)

# Returns: integer:nilable numTimesAlreadyClaimed, integer:nilable numTimesStillClaimable

ClaimRewardTrackReward

(RewardTrackType rewardTrackType, luaindex referenceTrackIndex, luaindex tier, RewardTrackComponent rewardTrackComponent, luaindex rewardIndex)

HasAccessToRewardTrackComponent

(RewardTrackType rewardTrackType, luaindex referenceTrackIndex, RewardTrackComponent rewardTrackComponent)

# Returns: bool hasAccess

HasTamrielTomeProductType

(integer tomeId, TamrielTomeProductType productType)

# Returns: bool hasLevel

TryPurchaseTamrielTomePremiumPlus

(integer tomeId)

TryRedeemCachesForTomePoints

(integer numToRedeem)

GetRewardTrackDisplayName

(integer rewardTrackId)

# Returns: string displayName

GetRewardTrackBackgroundFileIndex

(integer rewardTrackId)

# Returns: textureName fileIndex

GetNumBaseTiersForRewardTrack

(integer rewardTrackId)

# Returns: integer numTiers

GetNumBonusTiersForRewardTrack

(integer rewardTrackId)

# Returns: integer numTiers

GetTotalNumTiersForRewardTrack

(integer rewardTrackId)

# Returns: integer numTiers

GetNumRewardsAtRewardTrackTier

(integer rewardTrackId, luaindex tierIndex, RewardTrackComponent rewardTrackComponent)

# Returns: integer numRewards

GetTotalProgressAtRewardTrackTier

(integer rewardTrackId, luaindex tierIndex)

# Returns: integer totalProgress

GetTamrielTomeIntroBackgroundFileIndex

(integer tamrielTomeId)

# Returns: textureName introFileIndex

GetTamrielTomePremiumUpgradeBackgroundFileIndex

(integer tamrielTomeId)

# Returns: textureName premiumUpgradeBackgroundFileIndex

GetNumTamrielTomeHighlights

(integer tamrielTomeId)

# Returns: integer numHighlights

GetTamrielTomeHighlightInfo

(integer tamrielTomeId, luaindex highlightIndex)

# Returns: string title, string text

GetNumTamrielTomeFeaturedRewards

(integer tamrielTomeId)

# Returns: integer numFeaturedRewards

GetTamrielTomeFeaturedRewardInfo

(integer tamrielTomeId, luaindex featuredRewardIndex)

# Returns: luaindex tier, RewardTrackComponent rewardTrackComponent, luaindex rewardIndex

GetTamrielTomePremiumPlusBonusRewardInfo

(integer tamrielTomeId)

# Returns: integer rewardId, integer rewardQuantity

GetTamrielTomePremiumPlusRewardDescription

(integer tamrielTomeId)

# Returns: string description

GetCurrencyCostToUpgradeTamrielTome

()

# Returns: integer currencyCost

GetTamrielTomesRewardInfo

(integer rewardTrackId, luaindex tierIndex, RewardTrackComponent rewardTrackComponent, luaindex rewardIndex)

# Returns: integer rewardId, integer overrideAmount, integer cost, ItemDisplayQuality displayQuality, bool hideQuality

GetCostToProgressToNextTier

(integer rewardTrackId, luaindex tierIndex)

# Returns: integer costToProgress

HasInfinitelyRepeatableTierForRewardTrack

(integer rewardTrackId)

# Returns: bool hasInfinitelyRepeatableTier

GetInfinitelyRepeatableTierForRewardTrack

(integer rewardTrackId)

# Returns: luaindex infinitelyRepeatableTier

GetHighestTierPossibleForRewardTrack

(integer rewardTrackId)

# Returns: integer numTiers

GetRewardTrackSettings

()

# Returns: bool isSystemEnabled

IsDirectPurchaseEnabled

()

# Returns: bool isEnabled

IsAdventureZoneActive

()

# Returns: bool isAdventureZoneActive

GetAdventureZoneDisplayName

()

# Returns: string zoneName

IsInAdventureZone

()

# Returns: bool isInAdventureZone

GetAdventureZonePlayerReputation

()

# Returns: integer playerReputation

GetAdventureZoneFactionReputation

(AdventureZoneFaction faction)

# Returns: integer factionReputation

GetAdventureZoneEventDisplayName

(luaindex locationIndex)

# Returns: string displayName

GetAdventureZoneEventLocationName

(luaindex locationIndex)

# Returns: string locationName

GetAdventureZoneEventLocationBackgroundFileIndex

(luaindex locationIndex)

# Returns: textureName fileIndex

GetAdventureZoneEventLocationState

(luaindex locationIndex)

# Returns: AdventureZoneWorldEventLocationState locationState

GetAdventureZoneEventLocationStartTimestampMs

(luaindex locationIndex)

# Returns: integer53 startTimestamp

ShowAdventureZoneEventLocationOnMap

(luaindex locationIndex)

HasAdventureZoneKeyFragment

(AdventureZoneBoss boss)

# Returns: bool hasKeyFragment

GetAdventureZoneBossState

(AdventureZoneBoss boss)

# Returns: AdventureZoneBossState bossState

GetAdventureZoneBossName

(AdventureZoneBoss boss)

# Returns: string bossName

GetAdventureZoneBossDescription

(AdventureZoneBoss boss)

# Returns: string bossDescription

GetAdventureZoneBossIconFileIndex

(AdventureZoneBoss boss)

# Returns: textureName fileIndex

GetAdventureZoneBossKeyIconFileIndex

(AdventureZoneBoss boss)

# Returns: textureName fileIndex

GetAdventureZoneBossKeyFragmentIconFileIndex

(AdventureZoneBoss boss)

# Returns: textureName fileIndex

GetAdventureZoneBossAchievementInfo

(AdventureZoneBoss boss)

# Returns: integer achievementId, luaindex achievementCriterionIndex

ShowAdventureZoneBossOnMap

(AdventureZoneBoss boss)

IsGameCameraActive

()

# Returns: bool isActive

IsProgrammableCameraActive

()

# Returns: bool isActive

IsGameCameraUIModeActive

()

# Returns: bool active

GetUnitLevel

(string unitTag)

# Returns: integer level

GetUnitName

(string unitTag)

# Returns: string name

GetUnitZoneIndex

(string unitTag)

# Returns: luaindex:nilable zoneIndex

IsLockedWeaponSlot

(EquipSlot equipSlot)

# Returns: bool locked

GetLinkType

(string itemLink)

# Returns: LinkType linkType

ExecuteChatCommand

(string text)

GetNumCharacterSlotsPerUpgrade

()

# Returns: integer numSlots

GetCurrentCharacterSlotsUpgrade

()

# Returns: integer currentCharacterSlotsUpgrade

GetMaxCharacterSlotsUpgrade

()

# Returns: integer maxCharacterSlotsUpgrade

Logout

()

Disconnect

private ()

HasClaimedAccountReward

(integer rewardDefId)

# Returns: bool hasClaimedAccountReward

SetFullscreenEffect

(FullscreenEffectType effectType, number param1, number param2, bool immediateUpdate)

IsBankOpen

()

# Returns: bool isBankOpen

GetBankingBag

()

# Returns: Bag bagId

DoesBankHoldCurrency

(Bag bagId)

# Returns: bool doesBankHoldCurrency

IsGuildBankOpen

()

# Returns: bool isGuildBankOpen

GetCurrencyAmount

(CurrencyType currencyType, CurrencyLocation currencyLocation)

# Returns: integer amount

GetPlayerStoredCurrencyAmount

(CurrencyType currencyType)

# Returns: integer amount

GetMaxPossibleCurrency

(CurrencyType currencyType, CurrencyLocation currencyLocation)

# Returns: integer max

GetMaxCurrencyTransfer

(CurrencyType currencyType, CurrencyLocation fromLocation, CurrencyLocation toLocation)

# Returns: integer maxTransfer

TransferCurrency

(CurrencyType currencyType, integer amount, CurrencyLocation fromLocation, CurrencyLocation toLocation)

GetTelvarStonePercentLossOnPvpDeath

()

# Returns: number percentLoss

GetTelvarStonePercentLossOnNonPvpDeath

()

# Returns: number percentLoss

DoesCurrencyAmountMeetConfirmationThreshold

(CurrencyType currencyType, integer currencyQuantity)

# Returns: bool showConfirmation

UseItem

protected (Bag bagId, integer slotIndex)

CanInteractWithItem

(Bag bagId, integer slotIndex)

# Returns: bool canInteract

DestroyItem

(Bag bagId, integer slotIndex)

GetNextBankUpgradePrice

()

# Returns: integer cost

GetNextBackpackUpgradePrice

()

# Returns: integer cost

BuyBankSpace

()

BuyBagSpace

()

BuyBagSpaceFromInventory

()

DisplayBankUpgrade

()

GetBagUseableSize

(Bag bagId)

# Returns: integer bagSlots

GetBagSize

(Bag bagId)

# Returns: integer bagSlots

IsArmorEffectivenessReduced

(Bag bagId, integer slotIndex)

# Returns: bool effectivenessReduced

GetNumBagUsedSlots

(Bag bagId)

# Returns: integer usedSlots

GetNumBagFreeSlots

(Bag bagId)

# Returns: integer freeSlots

FindFirstEmptySlotInBag

(Bag bagId)

# Returns: integer:nilable slotIndex

GetItemFilterTypeInfo

(Bag bagId, integer slotIndex)

# Uses variable returns...
# Returns: ItemFilterType itemFilterType

GetItemLinkFilterTypeInfo

(string itemLink)

# Uses variable returns...
# Returns: ItemFilterType itemFilterType

GetItemCooldownInfo

(Bag bagId, integer slotIndex)

# Returns: integer remain, integer duration

GetItemStatValue

(Bag bagId, integer slotIndex)

# Returns: integer statValue

GetItemSoundCategory

(Bag bagId, integer slotIndex)

# Returns: integer itemSoundCategory

IsItemBound

(Bag bagId, integer slotIndex)

# Returns: bool isBound

IsItemReconstructed

(Bag bagId, integer slotIndex)

# Returns: bool isReconstructed

IsItemEnchantable

(Bag bagId, integer slotIndex)

# Returns: bool enchantable

IsItemEnchantment

(Bag bagId, integer slotIndex)

# Returns: bool enchantment

CanItemTakeEnchantment

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

# Returns: bool canEnchant

EnchantItem

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

CanConvertItemStyle

(Bag itemToBagId, integer itemToSlotIndex, integer newStyle)

# Returns: bool canConvert

IsItemChargeable

(Bag bagId, integer slotIndex)

# Returns: bool rechargeable

GetAmountSoulGemWouldChargeItem

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

# Returns: integer chargeAmount

ChargeItemWithSoulGem

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

IsItemSoulGem

(SoulGemType soulGemType, Bag bagId, integer slotIndex)

# Returns: bool isSoulGem

GetChargeInfoForItem

(Bag bagId, integer slotIndex)

# Returns: integer charges, integer maxCharges

DoesItemHaveDurability

(Bag bagId, integer slotIndex)

# Returns: bool hasDurability

GetItemCondition

(Bag bagId, integer slotIndex)

# Returns: integer condition

GetItemRepairCost

(Bag bagId, integer slotIndex)

# Returns: integer repairCost

GetRepairAllCost

()

# Returns: integer repairCost

GetItemLaunderPrice

(Bag bagId, integer slotIndex)

# Returns: integer launderCost

IsItemRepairKit

(Bag bagId, integer slotIndex)

# Returns: bool isRepairKit

IsItemNonCrownRepairKit

(Bag bagId, integer slotIndex)

# Returns: bool isNonCrownRepairKit

IsItemNonGroupRepairKit

(Bag bagId, integer slotIndex)

# Returns: bool isNonGroupRepairKit

GetRepairKitTier

(Bag bagId, integer slotIndex)

# Returns: integer tier

GetAmountRepairKitWouldRepairItem

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

# Returns: integer amountRepaired

RepairItemWithRepairKit

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

GetActiveWeaponPairInfo

()

# Returns: ActiveWeaponPair activeWeaponPair, bool locked

GetHeldWeaponPair

()

# Returns: ActiveWeaponPair heldWeaponPair

GetItemLevel

(Bag bagId, integer slotIndex)

# Returns: integer level

GetItemRequiredLevel

(Bag bagId, integer slotIndex)

# Returns: integer requiredLevel

GetItemRequiredChampionPoints

(Bag bagId, integer slotIndex)

# Returns: integer requiredChampionPoints

GetItemTrait

(Bag bagId, integer slotIndex)

# Returns: ItemTraitType trait

GetItemTraitCategory

(Bag bagId, integer slotIndex)

# Returns: ItemTraitTypeCategory itemTraitTypeCategory

GetItemLinkTraitCategory

(string itemLink)

# Returns: ItemTraitTypeCategory itemTraitTypeCategory

GetItemLinkTraitType

(string itemLink)

# Returns: ItemTraitType itemTraitType

GetItemCreatorName

(Bag bagId, integer slotIndex)

# Returns: string creatorName

GetItemInfo

(Bag bagId, integer slotIndex)

# Returns: textureName icon, integer stack, integer sellPrice, bool meetsUsageRequirement, bool locked, EquipType equipType, integer itemStyleId, ItemQuality functionalQuality, ItemDisplayQuality displayQuality

GetItemId

(Bag bagId, integer slotIndex)

# Returns: integer itemId

GetItemActorCategory

(Bag bagId, integer slotIndex)

# Returns: GameplayActorCategory actorCategory

GetItemSellValueWithBonuses

(Bag bagId, integer slotIndex)

# Returns: integer sellPrice

GetItemCraftingInfo

(Bag bagId, integer slotIndex)

# Returns: TradeskillType usedInCraftingType, ItemType itemType, integer:nilable extraInfo1, integer:nilable extraInfo2, integer:nilable extraInfo3

GetItemType

(Bag bagId, integer slotIndex)

# Returns: ItemType itemType, SpecializedItemType specializedItemType

GetItemUseType

(Bag bagId, integer slotIndex)

# Returns: ItemUseType itemUseType

GetItemArmorType

(Bag bagId, integer slotIndex)

# Returns: ArmorType armorType

GetItemWeaponType

(Bag bagId, integer slotIndex)

# Returns: WeaponType weaponType

GetItemEquipmentFilterType

(Bag bagId, integer slotIndex)

# Returns: EquipmentFilterType equipmentFilterType

GetItemUniqueId

(Bag bagId, integer slotIndex)

# Returns: id64:nilable id

GetItemFunctionalQuality

(Bag bagId, integer slotIndex)

# Returns: ItemQuality functionalQuality

GetItemDisplayQuality

(Bag bagId, integer slotIndex)

# Returns: ItemDisplayQuality displayQuality

GetItemEquipType

(Bag bagId, integer slotIndex)

# Returns: EquipType equipType

GetSoulGemItemInfo

(Bag bagId, integer slotIndex)

# Returns: integer tier, SoulGemType soulGemType

GetSoulGemInfo

(SoulGemType soulGemType, integer targetLevel, bool onlyInInventory)

# Returns: string name, textureName icon, integer stackCount, ItemQuality quality

GetNextGuildBankSlotId

(integer:nilable lastSlotId)

# Returns: integer:nilable nextSlotId

IsItemSellableOnTradingHouse

(Bag bagId, integer slotIndex)

# Returns: bool canBeSold

GetNextFurnitureVaultSlotId

(integer:nilable lastSlotId)

# Returns: integer:nilable nextSlotId

GetNextVirtualBagSlotId

(integer:nilable lastSlotId)

# Returns: integer:nilable nextSlotId

CanItemBeVirtual

(Bag bagId, integer slotIndex)

# Returns: bool canBeVirtualItem

IsItemPlaceableFurniture

(Bag bagId, integer slotIndex)

# Returns: bool isPlaceable

GetItemFurnitureDataId

(Bag bagId, integer slotIndex)

# Returns: integer furnitureDataId

IsDisplayNameInItemBoPAccountTable

(Bag bagId, integer slotIndex, string displayName)

# Returns: bool isInTable

IsItemBoPAndTradeable

(Bag bagId, integer slotIndex)

# Returns: bool isBoPAndTradeable

GetItemBoPTimeRemainingSeconds

(Bag bagId, integer slotIndex)

# Returns: integer timeRemainingS

GetItemBoPTradeableDisplayNamesString

(Bag bagId, integer slotIndex)

# Returns: string namesString

GetItemBoPTradeableNumEligibleNames

(Bag bagId, integer slotIndex)

# Returns: integer numNames

GetItemBoPTradeableEligibleNameByIndex

(Bag bagId, integer slotIndex, luaindex nameIndex)

# Returns: string name

HasCraftBagAccess

()

# Returns: bool hasAccess

SelectGuildBank

(integer guildId)

TransferToGuildBank

(Bag sourceBagId, integer sourceSlotIndex)

TransferFromGuildBank

(integer slotId)

HasAnyJunk

(Bag bagId, bool excludeStolenItems)

# Returns: bool hasJunk

DestroyAllJunk

()

CanAnyItemsBeStoredInCraftBag

(Bag bagId)

# Returns: bool canBeStoredInCraftBag

StowAllVirtualItems

()

StowAllFurnitureItems

()

CanStowFurnitureItem

(Bag bagId, integer slotIndex)

# Returns: bool canBeStowed

DoesBagHaveSpaceFor

(Bag destinationBagId, Bag sourceBagId, integer sourceSlotIndex)

# Returns: bool hasSpace

DoesBagHaveSpaceForItemLink

(Bag destinationBagId, string itemLink)

# Returns: bool hasSpace

CanItemBePlayerLocked

(Bag bagId, integer slotIndex)

# Returns: bool canBePlayerLocked

IsItemPlayerLocked

(Bag bagId, integer slotIndex)

# Returns: bool playerLocked

SetItemIsPlayerLocked

(Bag bagId, integer slotIndex, bool playerLocked)

IsItemLockedSetPiece

(Bag bagId, integer slotIndex)

# Returns: bool isLockedSetPiece

CanItemBeUsedToLearn

(Bag bagId, integer slotIndex)

# Returns: bool canBeUsedToLearn

CanItemBeMarkedAsJunk

(Bag bagId, integer slotIndex)

# Returns: bool canBeMarkedAsJunk

IsItemJunk

(Bag bagId, integer slotIndex)

# Returns: bool junk

SetItemIsJunk

(Bag bagId, integer slotIndex, bool junk)

IsItemDyeable

(Bag bagId, integer slotIndex)

# Returns: bool dyeable

AreItemDyeChannelsDyeable

(Bag bagId, integer slotIndex)

# Returns: bool primary, bool secondary, bool accent

IsItemVisuallyDisabledInVengeance

(Bag bagId, integer slotIndex)

# Returns: bool isDisabled

HasItemInSlot

(Bag bagId, integer slotIndex)

# Returns: bool hasItemInSlot

GetItemLink

(Bag bagId, integer slotIndex, LinkStyle linkStyle)

# Returns: string link

GetItemLinkName

(string itemLink)

# Returns: string itemName

GetItemLinkItemId

(string itemLink)

# Returns: integer itemId

GetItemLinkItemSetCollectionSlot

(string itemLink)

# Returns: id64 slot

GetItemLinkIcon

(string itemLink)

# Returns: textureName itemIcon

GetItemLinkItemType

(string itemLink)

# Returns: ItemType itemType, SpecializedItemType specializedItemType

GetItemLinkItemUseType

(string itemLink)

# Returns: ItemUseType onUseType

GetItemLinkItemUseReferenceId

(string itemLink)

# Returns: integer onUseReferenceId

GetItemLinkArmorType

(string itemLink)

# Returns: ArmorType armorType

GetItemLinkWeaponType

(string itemLink)

# Returns: WeaponType weaponType

GetItemLinkWeaponPower

(string itemLink)

# Returns: integer weaponPower

GetItemLinkArmorRating

(string itemLink, bool considerCondition)

# Returns: integer armorRating

GetItemLinkRequiredLevel

(string itemLink)

# Returns: integer requiredLevel

GetItemLinkRequiredChampionPoints

(string itemLink)

# Returns: integer requiredChampionPoints

GetItemLinkValue

(string itemLink, bool considerCondition)

# Returns: integer value

GetItemLinkCondition

(string itemLink)

# Returns: integer conditionPercent

DoesItemLinkHaveArmorDecay

(string itemLink)

# Returns: bool hasArmorDecay

GetItemLinkMaxEnchantCharges

(string itemLink)

# Returns: integer maxCharges

GetItemLinkNumEnchantCharges

(string itemLink)

# Returns: integer numCharges

DoesItemLinkHaveEnchantCharges

(string itemLink)

# Returns: bool hasCharges

GetItemLinkEnchantInfo

(string itemLink)

# Returns: bool hasCharges, string enchantHeader, string enchantDescription

GetItemLinkDefaultEnchantId

(string itemLink)

# Returns: integer enchantId

GetItemLinkAppliedEnchantId

(string itemLink)

# Returns: integer enchantId

GetItemLinkFinalEnchantId

(string itemLink)

# Returns: integer enchantId

IsItemAffectedByPairedPoison

(EquipSlot equipSlot)

# Returns: bool hasPairedPoison

GetItemPairedPoisonInfo

(EquipSlot equipSlot)

# Returns: bool hasPoison, integer poisonCount, string poisonHeader, string poisonItemLink

GetItemLinkOnUseAbilityId

(string itemLink)

# Returns: integer abilityId

GetItemLinkOnUseAbilityInfo

(string itemLink)

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

GetItemLinkTraitOnUseAbilityInfo

(string itemLink, luaindex index)

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

GetItemLinkTraitInfo

(string itemLink)

# Returns: ItemTraitType traitType, string traitDescription

GetItemLinkSetInfo

(string itemLink, bool equipped)

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

GetItemLinkSetBonusInfo

(string itemLink, bool equipped, 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

GetItemSetBonusInfo

(integer itemSetId, luaindex index)

# Returns: integer numRequired, string bonusDescription, bool isPerfectedBonus

GetItemSetClassRestrictions

(integer itemSetId)

# Returns: bool hasRestrictions, bool passesRestrictions, string allowedNamesString

IsItemLinkSetCollectionPiece

(string itemLink)

# Returns: bool isSetCollectionPiece

GetItemLinkNumContainerSetIds

(string itemLink)

# Returns: integer numSetIds

GetItemLinkContainerSetInfo

(string itemLink, luaindex containerSetIndex)

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

GetItemLinkContainerSetBonusInfo

(string itemLink, luaindex containerSetIndex, luaindex bonusIndex)

# Returns: integer numRequired, string bonusDescription, bool isPerfectedBonus

GetItemLinkFlavorText

(string itemLink)

# Returns: string flavorText

IsItemLinkCrafted

(string itemLink)

# Returns: bool isCrafted

IsItemLinkVendorTrash

(string itemLink)

# Returns: bool isVendorTrash

GetItemLinkSiegeMaxHP

(string itemLink)

# Returns: integer maxHP

GetItemLinkFunctionalQuality

(string itemLink)

# Returns: ItemQuality functionalQuality

GetItemLinkDisplayQuality

(string itemLink)

# Returns: ItemDisplayQuality displayQuality

GetItemLinkSiegeType

(string itemLink)

# Returns: SiegeType siegeType

IsItemLinkUnique

(string itemLink)

# Returns: bool isUnique

IsItemLinkUniqueEquipped

(string itemLink)

# Returns: bool isUniqueEquipped

GetItemLinkEquipType

(string itemLink)

# Returns: EquipType equipType

IsItemLinkConsumable

(string itemLink)

# Returns: bool isConsumable

GetItemLinkCraftingSkillType

(string itemLink)

# Returns: TradeskillType tradeskillType

IsItemLinkEnchantingRune

(string itemLink)

# Returns: bool isEnchantingRune

GetItemLinkEnchantingRuneName

(string itemLink)

# Returns: bool:nilable known, string:nilable name

GetItemLinkEnchantingRuneClassification

(string itemLink)

# Returns: EnchantingRuneClassification runeClassification

GetItemLinkRequiredCraftingSkillRank

(string itemLink)

# Returns: integer requiredRank

IsItemLinkBound

(string itemLink)

# Returns: bool isBound

GetItemLinkBindType

(string itemLink)

# Returns: BindType bindType

GetItemLinkGlyphMinLevels

(string itemLink)

# Returns: integer:nilable minLevel, integer:nilable minChampionPoints

ConvertItemGlyphTierRangeToRequiredLevelRange

(bool isChampionRank, integer:nilable minTierLevel, integer:nilable maxTierLevel)

# Returns: integer minRequiredLevel, integer maxRequiredLevel

IsItemLinkPlaceableFurniture

(string itemLink)

# Returns: bool isPlaceableFurniture

GetItemLinkFurnishingLimitType

(string itemLink)

# Returns: HousingFurnishingLimitType furnishingLimitType

IsItemLinkConsolidatedSmithingStation

(string itemLink)

# Returns: bool isConsolidatedSmithingStation

GetItemLinkNumConsolidatedSmithingStationUnlockedSets

(string itemLink)

# Returns: integer numUnlockedSets

IsItemLinkBook

(string itemLink)

# Returns: bool isBook

GetItemLinkBookTitle

(string itemLink)

# Returns: string:nilable bookTitle

IsItemLinkBookKnown

(string itemLink)

# Returns: bool isKnown

IsItemLinkBookPartOfCollection

(string itemLink)

# Returns: bool isPartOfCollection

DoesItemLinkStartQuest

(string itemLink)

# Returns: bool startsQuest

DoesItemLinkFinishQuest

(string itemLink)

# Returns: bool finishesQuest

IsItemLinkRecipeKnown

(string itemLink)

# Returns: bool isRecipeKnown

GetItemLinkRecipeResultItemLink

(string itemLink, LinkStyle linkStyle)

# Returns: string link

GetItemLinkRecipeNumIngredients

(string itemLink)

# Returns: integer numIngredients

GetItemLinkRecipeIngredientInfo

(string itemLink, luaindex index)

# Returns: string ingredientName, integer amountInInventoryAndBank, integer amountRequired

GetItemLinkRecipeIngredientItemLink

(string itemLink, luaindex index, LinkStyle linkStyle)

# Returns: string link

GetItemLinkRecipeNumTradeskillRequirements

(string itemLink)

# Returns: integer numTradeskillRequirements

GetItemLinkRecipeTradeskillRequirement

(string itemLink, luaindex tradeskillIndex)

# Returns: TradeskillType tradeskill, integer requiredLevel

GetItemLinkRecipeQualityRequirement

(string itemLink)

# Returns: integer qualityRequirement

GetItemLinkRecipeCraftingSkillType

(string itemLink)

# Returns: TradeskillType craftingSkillType

GetItemLinkReagentTraitInfo

(string itemLink, luaindex index)

# Returns: bool:nilable known, string:nilable name

GetItemLinkItemStyle

(string itemLink)

# Returns: integer style

GetItemLinkShowItemStyleInTooltip

(string itemLink)

# Returns: bool showInTooltip

GetItemLinkRefinedMaterialItemLink

(string itemLink, LinkStyle linkStyle)

# Returns: string refinedItemLink

GetItemLinkMaterialLevelDescription

(string itemLink)

# Returns: string levelsDescription

IsItemLinkOnlyUsableFromQuickslot

(string itemLink)

# Returns: bool onlyUsableFromQuickslot

IsItemLinkReconstructed

(string itemLink)

# Returns: bool isReconstructed

IsItemLinkStolen

(string itemLink)

# Returns: bool itemStolen

IsItemLinkLockedSetPiece

(string itemLink)

# Returns: bool isLockedSetPiece

CanItemLinkBeUsedToLearn

(string itemLink)

# Returns: bool canBeUsedToLearn

IsItemLinkForcedNotDeconstructable

(string itemLink)

# Returns: bool itemNotDeconstructable

IsItemLinkContainer

(string itemLink)

# Returns: bool itemIsContainer

IsItemLinkStackable

(string itemLink)

# Returns: bool itemStackable

GetItemLinkStacks

(string itemLink)

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

GetItemLinkInventoryCount

(string itemLink, InventoryCountBagOption countType)

# Returns: integer inventoryCount

CanItemLinkBeVirtual

(string itemLink)

# Returns: bool canBeVirtual

GetItemLinkDyeIds

(string itemLink)

# Returns: integer primaryDefId, integer secondaryDefId, integer accentDefId

GetItemLinkDyeStampId

(string itemLink)

# Returns: integer dyeStampId

GetItemLinkFurnitureDataId

(string itemLink)

# Returns: integer furnitureDataId

GetItemLinkGrantedRecipeIndices

(string itemLink)

# Returns: luaindex:nilable recipeListIndex, luaindex:nilable recipeIndex

IsItemLinkFurnitureRecipe

(string itemLink)

# Returns: bool isFurnitureRecipe

GetItemLinkOutfitStyleId

(string itemLink)

# Returns: integer outfitStyleId

GetItemLinkTooltipRequiresCollectibleId

(string itemLink)

# Returns: integer collectibleId

GetItemLinkActorCategory

(string itemLink)

# Returns: GameplayActorCategory actorCategory

ShouldHideTooltipRequiredLevel

(string itemLink)

# Returns: bool shouldHideLevel

GetItemCombinationId

(Bag bagId, integer slotIndex)

# Returns: integer combinationId

GetItemLinkCombinationId

(string itemLink)

# Returns: integer combinationId

GetItemLinkCombinationDescription

(string itemLink)

# Returns: string combinationDescription

GetItemLinkTradingHouseItemSearchName

(string itemLink)

# Returns: string itemName

GetItemLinkContainerCollectibleId

(string itemLink)

# Returns: integer containerCollectibleId

GetMaxTraits

()

# Returns: integer maxTraits

IsItemStolen

(Bag bagId, integer slotIndex)

# Returns: bool itemStolen

AreAnyItemsStolen

(Bag bagId)

# Returns: bool anyItemsStolen

HasPoisonInBag

(Bag bagId)

# Returns: bool hasPoison

HasFishInBag

(Bag bagId)

# Returns: bool hasFish

GetTelvarStoneMultiplierThresholdIndex

()

# Returns: luaindex:nilable thresholdIndex

GetTelvarStoneThresholdAmount

(luaindex:nilable thresholdIndex)

# Returns: integer minimumAmount

GetTelvarStoneMultiplier

(luaindex:nilable thresholdIndex)

# Returns: number telvarStoneMultiplier

IsMaxTelvarStoneMultiplierThreshold

(luaindex:nilable thresholdIndex)

# Returns: bool isAtMaxThreshold

StackBag

(Bag bagId)

CompareBagItemToCurrentlyEquipped

(Bag bagId, integer slotIndex, EquipSlot equipSlot)

# Uses variable returns...
# Returns: DerivedStats derivedStat, integer statDelta

CompareItemLinkToCurrentlyEquipped

(string itemLink, EquipSlot equipSlot)

# Uses variable returns...
# Returns: DerivedStats derivedStat, integer statDelta

GetItemLinkNumItemTags

(string itemLink)

# Returns: integer numItemTags

GetItemLinkItemTagInfo

(string itemLink, luaindex itemTagIndex)

# Returns: string itemTagDescription, ItemTagCategory itemTagCategory

IsItemLinkVisuallyDisabledInVengeance

(string itemLink)

# Returns: bool isDisabled

IsItemLinkUsableOutsideVengeance

(string itemLink)

# Returns: bool canUseOutsideVengeance

HasCraftBagAutoTransferNotification

()

# Returns: bool hasTransferNotification

ClearCraftBagAutoTransferNotification

()

IsActiveCombatRelatedEquipmentSlot

(EquipSlot equipSlot)

# Returns: bool isActiveCombatRelatedEquipSlot

GetEquipmentBonusRating

(Bag bagId, EquipSlot equipSlot)

# Returns: number equipmentBonusRating

GetEquipmentBonusThreshold

(integer unitLevel, integer unitChampionPoints, integer index)

# Returns: number thresholdValue

GetNumCrownGemsFromItemManualGemification

(Bag bagId, integer slotIndex)

# Returns: integer itemsRequired, integer gemsAwarded

IsItemFromCrownStore

(Bag bagId, integer slotIndex)

# Returns: bool isFromCrownStore

IsItemFromCrownCrate

(Bag bagId, integer slotIndex)

# Returns: bool isFromCrownCrate

IsItemLinkFromCrownStore

(string itemLink)

# Returns: bool isFromCrownStore

IsItemLinkFromCrownCrate

(string itemLink)

# Returns: bool isFromCrownCrate

GetItemBindType

(Bag bagId, integer slotIndex)

# Returns: BindType bindType

IsHouseBankBag

(Bag bagId)

# Returns: bool isHouseBankBag

IsFurnitureVault

(Bag bagId)

# Returns: bool isFurnitureVault

GetCurrentBankUpgrade

()

# Returns: integer currentBankUpgrade

GetMaxBankUpgrade

()

# Returns: integer maxBankUpgrade

GetNumBankSlotsPerUpgrade

()

# Returns: integer numSlots

GetCurrentBackpackUpgrade

()

# Returns: integer currentBackpackUpgrade

GetMaxBackpackUpgrade

()

# Returns: integer maxBackpackUpgrade

GetNumBackpackSlotsPerUpgrade

()

# Returns: integer numSlots

IsItemPrioritySell

(Bag bagId, integer slotIndex)

# Returns: bool isPrioritySell

IsItemLinkPrioritySell

(string itemLink)

# Returns: bool isPrioritySell

GetItemSellInformation

(Bag bagId, integer slotIndex)

# Returns: ItemSellInformation sellInformation

GetItemLinkSellInformation

(string itemLink)

# Returns: ItemSellInformation sellInformation

GetItemLinkComparisonEquipSlots

(string itemLink)

# Returns: EquipSlot equipSlot1, EquipSlot equipSlot2

GetItemComparisonEquipSlots

(Bag bagId, integer slotIndex)

# Returns: EquipSlot equipSlot1, EquipSlot equipSlot2

GetItemLinkEquippedComparisonEquipSlots

(string itemLink)

# Returns: EquipSlot equipSlot1, EquipSlot equipSlot2

GetItemEquippedComparisonEquipSlots

(Bag bagId, integer slotIndex)

# Returns: EquipSlot equipSlot1, EquipSlot equipSlot2

GetWornBagForGameplayActorCategory

(GameplayActorCategory actorCategory)

# Returns: Bag bagId

CheckPlayerCanPerformCombinationAndWarn

(integer combinationId)

# Returns: bool canPerformCombination

GetCombinationNumUnlockedCollectibles

(integer combinationId)

# Returns: integer numUnlockedCollectibles

GetCombinationUnlockedCollectibleId

(integer combinationId, luaindex unlockedCollectibleIndex)

# Returns: integer unlockedCollectibleId

GetCombinationNumCollectibleComponents

(integer combinationId)

# Returns: integer numCollectibleComponents

GetCombinationCollectibleComponentId

(integer combinationId, luaindex componentIndex)

# Returns: integer collectibleId

GetCombinationNumNonFragmentCollectibleComponents

(integer combinationId)

# Returns: integer numNonFragmentCollectibleComponents

GetCombinationNonFragmentComponentCollectibleIds

(integer combinationId)

# Uses variable returns...
# Returns: integer nonFragmentCollectibleId

GetCombinationDescription

(integer combinationId)

# Returns: string combinationDescription

IsCurrencyValid

(CurrencyType currencyType)

# Returns: bool isValidCurrency

CanCurrencyBeStoredInLocation

(CurrencyType currencyType, CurrencyLocation currencyLocation)

# Returns: bool canBeStored

GetCurrencyPlayerStoredLocation

(CurrencyType currencyType)

# Returns: CurrencyLocation currencyLocation

GetCurrencyTypeFromRewardType

(RewardType rewardType)

# Returns: CurrencyType currencyType

GetCurrencyName

(CurrencyType currencyType, bool isSingular, bool isLower)

# Returns: string name

GetCurrencyDescription

(CurrencyType currencyType)

# Returns: string description

GetCurrencyKeyboardColor

(CurrencyType currencyType)

# Returns: number red, number green, number blue

GetCurrencyKeyboardIcon

(CurrencyType currencyType)

# Returns: textureName iconPath, integer percentOfLineSize

GetCurrencyLootKeyboardIcon

(CurrencyType currencyType)

# Returns: textureName iconPath

GetCurrencyGamepadColor

(CurrencyType currencyType)

# Returns: number red, number green, number blue

GetCurrencyGamepadIcon

(CurrencyType currencyType)

# Returns: textureName iconPath, integer percentOfLineSize

GetCurrencyLootGamepadIcon

(CurrencyType currencyType)

# Returns: textureName iconPath

IsCurrencyDefaultNameLowercase

(CurrencyType currencyType)

# Returns: bool defaultIsLowercase

ShouldShowCurrencyInLootHistory

(CurrencyType currencyType)

# Returns: bool shouldShowInLootHistory

ShouldShowCurrencyInCurrencyPanel

(CurrencyType currencyType)

# Returns: bool shouldShowInCurrencyPanel

IsCurrencyCapped

(CurrencyType currencyType, CurrencyLocation currencyLocation)

# Returns: bool isCapped

GetCurrencyAcquiredUISound

(CurrencyType currencyType)

# Returns: string soundId

GetCurrencyTransactUISound

(CurrencyType currencyType)

# Returns: string soundId

GetTamrielTomeCurrencyPerBooster

()

# Returns: integer currencyAmount

GetNumTutorials

()

# Returns: integer numTutorials

GetTutorialType

(luaindex tutorialIndex)

# Returns: TutorialType:nilable tutorialType

GetTutorialTrigger

(luaindex tutorialIndex)

# Returns: TutorialTrigger:nilable tutorialTrigger

GetTutorialInfo

(luaindex tutorialIndex)

# Returns: string title, string description, integer displayPriority

GetTutorialDisplayPriority

(luaindex tutorialIndex)

# Returns: integer displayPriority

GetTutorialLinkedHelpInfo

(luaindex tutorialIndex)

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

RemoveTutorial

(TutorialTrigger tutorialTrigger)

IsTutorialActionRequired

(luaindex tutorialIndex)

# Returns: bool isActionRequired

SetTutorialSeen

(luaindex tutorialIndex)

TriggerTutorial

(TutorialTrigger tutorialTrigger)

# Returns: bool success

TriggerTutorialWithPosition

(TutorialTrigger tutorialTrigger, AnchorPosition anchor, number offsetX, number offsetY)

# Returns: bool success

TriggerTutorialWithParam

(TutorialTrigger tutorialTrigger, integer param)

# Returns: bool success

GetTutorialId

(TutorialTrigger tutorialTrigger, integer:nilable param)

# Returns: integer tutorialId

GetTutorialIndex

(TutorialTrigger tutorialTrigger)

# Returns: luaindex tutorialIndex

HasSeenTutorial

(integer tutorialId)

# Returns: bool seen

CanTutorialBeSeen

(integer tutorialId)

# Returns: bool canBeSeen

ResetAllTutorials

()

ClearActiveActionRequiredTutorial

()

IsCollectibleBlacklisted

(integer collectibleId)

# Returns: bool isBlacklisted

GetNumCollectibleCategories

()

# Returns: integer numCategories

GetCollectibleCategoryInfo

(luaindex topLevelIndex)

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

GetCollectibleCategoryId

(luaindex topLevelIndex, luaindex:nilable subCategoryIndex)

# Returns: integer categoryId

GetCollectibleCategorySpecialization

(luaindex topLevelIndex)

# Returns: CollectibleCategorySpecialization specialization

GetCollectibleCategoryKeyboardIcons

(luaindex topLevelIndex, luaindex:nilable subCategoryIndex)

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

GetCollectibleCategoryGamepadIcon

(luaindex topLevelIndex, luaindex:nilable subCategoryIndex)

# Returns: textureName gamepadIcon

GetCollectibleSubCategoryInfo

(luaindex topLevelIndex, luaindex subCategoryIndex)

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

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

GetCollectibleDescription

(integer collectibleId)

# Returns: string description

GetCollectibleCategoryType

(integer collectibleId)

# Returns: CollectibleCategoryType categoryType

GetSpecializedCollectibleType

(integer collectibleId)

# Returns: SpecializedCollectibleType specializedType

GetCollectibleFurnishingLimitType

(integer collectibleId)

# Returns: HousingFurnishingLimitType furnishingLimitType

GetCollectibleIcon

(integer collectibleId)

# Returns: textureName icon

GetCollectibleKeyboardBackgroundImage

(integer collectibleId)

# Returns: textureName backgroundImage

GetCollectibleGamepadBackgroundImage

(integer collectibleId)

# Returns: textureName backgroundImage

GetCategoryInfoFromCollectibleId

(integer collectibleId)

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

GetCategoryInfoFromCollectibleCategoryId

(integer collectibleCategoryId)

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

GetNumNewCollectibles

()

# Returns: integer count

GetTotalCollectiblesByCategoryType

(CollectibleCategoryType collectibleCategoryType)

# Returns: integer count

GetTotalUnlockedCollectiblesByCategoryType

(CollectibleCategoryType collectibleCategoryType)

# Returns: integer count

GetNumNewCollectiblesByCategoryType

(CollectibleCategoryType collectibleCategoryType)

# Returns: integer count

HasAnyUnlockedCollectiblesByCategoryType

(CollectibleCategoryType collectibleCategoryType)

# Returns: bool hasAnyUnlocked

HasAnyUnlockedCollectiblesAvailableToActorCategoryByCategoryType

(CollectibleCategoryType collectibleCategoryType, GameplayActorCategory actorCategory)

# Returns: bool hasAnyUnlocked

GetCollectibleIdFromType

(CollectibleCategoryType collectibleCategoryType, luaindex index)

# Returns: integer collectibleId

IsCollectibleCategorySlottable

(CollectibleCategoryType collectibleCategoryType)

# Returns: bool isSlottable

IsCollectibleCategoryFavoritable

(CollectibleCategoryType collectibleCategoryType)

# Returns: bool canBeFavorited

IsCollectibleCategoryUsable

(CollectibleCategoryType collectibleCategoryType, GameplayActorCategory actorCategory)

# Returns: bool isUsable

IsCollectibleCategoryPlaceableFurniture

(CollectibleCategoryType collectibleCategoryType)

# Returns: bool isPlaceable

IsCollectiblePlaceableFurniture

(integer collectibleId, bool ignoreHideMode)

# Returns: bool isPlaceable

IsCollectibleBlocked

(integer collectibleId, GameplayActorCategory actorCategory)

# Returns: bool isBlocked

IsCollectibleValidForPlayer

(integer collectibleId)

# Returns: bool isValidForPlayer

GetCollectibleBlockReason

(integer collectibleId, GameplayActorCategory actorCategory)

# Returns: CollectibleUsageBlockReason usageBlockReason

IsCollectibleSlottable

(integer collectibleId)

# Returns: bool isSlottable

IsCollectibleUsable

(integer collectibleId, GameplayActorCategory actorCategory)

# Returns: bool isUsable

IsCollectibleRenameable

(integer collectibleId)

# Returns: bool isRenameable

GetCollectibleHint

(integer collectibleId)

# Returns: string hint

DoesESOPlusUnlockCollectible

(integer collectibleId)

# Returns: bool unlockedViaSubscription

UseCollectible

(integer collectibleId, GameplayActorCategory actorCategory)

DoesCollectibleCategoryTypeHaveDefault

(CollectibleCategoryType collectibleCategoryType, GameplayActorCategory actorCategory)

# Returns: bool hasDefault

IsCollectibleCategoryTypeSetToDefault

(CollectibleCategoryType collectibleCategoryType, GameplayActorCategory actorCategory)

# Returns: bool isDefault

SetCollectibleCategoryTypeToDefault

(CollectibleCategoryType collectibleCategoryType, GameplayActorCategory actorCategory)

GetCollectibleLink

(integer collectibleId, LinkStyle linkStyle)

# Returns: string link

GetCollectibleCategoryTypeFromLink

(string link)

# Returns: CollectibleCategoryType categoryType

GetCollectibleIdFromLink

(string link)

# Returns: integer:nilable collectibleId

GetCollectibleAssociatedQuestState

(integer collectibleId)

# Returns: CollectibleAssociatedQuestState questState

StartCollectibleSearch

(string searchString)

GetNumCollectiblesSearchResults

()

# Returns: integer numSearchResults

GetCollectiblesSearchResult

(luaindex searchResultIndex)

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

IsValidCollectibleName

(string collectibleName)

# Uses variable returns...
# Returns: NamingError violationCode

IsValidHouseName

(string houseName)

# Uses variable returns...
# Returns: NamingError violationCode

RenameCollectible

(integer collectibleId, string name)

GetCollectibleNickname

(integer collectibleId)

# Returns: string name

GetCollectibleDefaultNickname

(integer collectibleId)

# Returns: string name

GetCollectibleHelpIndices

(integer collectibleId)

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

IsCollectibleNew

(integer collectibleId)

# Returns: bool isNew

ClearCollectibleNewStatus

(integer collectibleId)

ClearCollectibleCategoryNewStatuses

(luaindex categoryIndex, luaindex:nilable subcategoryIndex)

GetNumCollectibleNotifications

()

# Returns: integer count

GetCollectibleNotificationInfo

(luaindex notificationIndex)

# Returns: integer notificationId, integer collectibleId

RemoveCollectibleNotification

(integer notificationId)

RemoveCollectibleNotificationByCollectibleId

(integer collectibleId)

GetCollectibleUnlockStateById

(integer collectibleId)

# Returns: CollectibleUnlockState unlockState

IsCollectibleUnlocked

(integer collectibleId)

# Returns: bool isUnlocked

SetOrClearCollectibleUserFlag

(integer collectibleId, CollectibleUserFlags userFlag, bool isSet)

GetCollectibleUserFlags

(integer collectibleId)

# Returns: CollectibleUserFlags userFlags

DoesCollectibleCategoryContainAnyCollectiblesWithUserFlags

(CollectibleCategoryType categoryType, CollectibleUserFlags userFlags)

# Returns: bool containsCollectible

IsCollectibleActive

(integer collectibleId, GameplayActorCategory actorCategory)

# Returns: bool isActive

IsCollectibleOwnedByDefId

(integer collectibleId)

# Returns: bool owned

CanAcquireCollectibleByDefId

(integer collectibleId)

# Returns: bool canAcquire

GetImperialCityCollectibleId

()

# Returns: integer collectibleId

GetFurnitureVaultCollectibleId

()

# Returns: integer collectibleId

GetCollectibleQuestPreviewInfo

(integer collectibleId)

# Returns: string questName, string backgroundText

GetActiveCollectibleByType

(CollectibleCategoryType categoryType, GameplayActorCategory actorCategory)

# Returns: integer collectibleId

GetCollectibleCooldownAndDuration

(integer collectibleId)

# Returns: integer cooldownRemaining, integer cooldownDuration

GetCollectiblePersonalityOverridenEmoteDisplayNames

(integer collectibleId)

# Uses variable returns...
# Returns: string overriddenEmoteDisplayName

GetCollectiblePersonalityOverridenEmoteSlashCommandNames

(integer collectibleId)

# Uses variable returns...
# Returns: string overriddenEmoteSlashCommandName

GetCollectibleRestrictionsByType

(integer collectibleId, CollectibleRestrictionType restrictionType, GameplayActorCategory actorCategory)

# Returns: bool hasRestrictions, bool passesRestrictions, string allowedNamesString

GetCollectibleFurnitureDataId

(integer collectibleId)

# Returns: integer furnitureDataId

GetCollectibleFurnitureDataIdForPreview

(integer collectibleId)

# Returns: integer furnitureDataId

GetCollectibleReferenceId

(integer collectibleId)

# Returns: integer referenceId

GetCollectibleSortOrder

(integer collectibleId)

# Returns: integer sortOrder

GetCollectibleHideMode

(integer collectibleId)

# Returns: CollectibleHideMode hideMode

IsCollectibleDynamicallyHidden

(integer collectibleId)

# Returns: bool isDynamicallyHidden

GetCollectibleCategorySortOrder

(luaindex topLevelIndex, luaindex:nilable categoryIndex)

# Returns: integer sortOrder

DoesCollectibleCategoryContainSlottableCollectibles

(luaindex topLevelIndex, luaindex:nilable categoryIndex)

# Returns: bool containsSlottableCollectibles

GetCollectibleForBag

(Bag bagId)

# Returns: integer collectibleId

GetBagForCollectible

(integer collectibleId)

# Returns: Bag:nilable bagId

GetNextDirtyUnlockStateCollectibleId

(integer:nilable lastCollectibleId)

# Returns: integer:nilable nextCollectibleId

GetNextDirtyBlacklistCollectibleId

(integer:nilable lastCollectibleId)

# Returns: integer:nilable nextCollectibleId

CanCombinationFragmentBeUnlocked

(integer collectibleId)

# Returns: bool canBeUnlocked

GetNumCollectibleTags

(integer collectibleId)

# Returns: integer numTags

GetCollectibleTagInfo

(integer collectibleId, luaindex tagIndex)

# Returns: string tagDescription, ItemTagCategory tagCategory, bool hideInUi

IsCollectibleAvailableToActorCategory

(integer collectibleId, GameplayActorCategory actorCategory)

# Returns: bool isCollectibleAvailable

IsCollectibleTributePatronBookCardUpgraded

(integer patronId, luaindex cardIndex)

# Returns: bool isCardUpgraded

GetCollectiblePlayerFxOverrideType

(integer collectibleId)

# Returns: PlayerFxOverrideType:nilable playerFxOverrideType

GetCollectiblePlayerFxWhileHarvestingType

(integer collectibleId)

# Returns: PlayerFxWhileHarvestingType:nilable playerFxWhileHarvestingType

GetCollectiblePlayerFxOverrideAbilityType

(integer collectibleId)

# Returns: PlayerFxOverrideAbilityType:nilable playerFxOverrideAbilityType

GetCollectibleLinkedAchievement

(integer collectibleId)

# Returns: integer achievementId

GetCompanionIntroQuestId

(integer companionId)

# Returns: integer questId

GetQuestZoneId

(integer questId)

# Returns: integer zoneId

GetQuestName

(integer questId)

# Returns: string name

UpdateMarketDisplayGroup

private (MarketDisplayGroup displayGroup)

GetNumMarketProductCategories

private (MarketDisplayGroup displayGroup)

# Returns: integer numCategories

GetMarketProductCategoryInfo

private (MarketDisplayGroup displayGroup, luaindex topLevelIndex)

# Returns: string name, integer numSubCatgories, integer numMarketProducts, textureName normalIcon, textureName pressedIcon, textureName mouseoverIcon

GetMarketProductSubCategoryInfo

private (MarketDisplayGroup displayGroup, luaindex topLevelIndex, luaindex subCategoryIndex)

# Returns: string name, integer numMarketProducts, bool showGemIcon

IsLTODisabledForMarketProductCategory

(MarketDisplayGroup displayGroup, luaindex topLevelIndex, luaindex:nilable categoryIndex)

# Returns: bool isDisabled

DoesMarketProductCategoryContainFilteredProducts

(MarketDisplayGroup displayGroup, luaindex topLevelIndex, luaindex:nilable categoryIndex, integer filterTypes)

# Returns: bool containsProducts

DoesMarketProductCategoryOrSubcategoriesContainFilteredProducts

(MarketDisplayGroup displayGroup, luaindex topLevelIndex, luaindex:nilable categoryIndex, integer filterTypes)

# Returns: bool containsProducts

DoesMarketProductMatchFilter

(integer marketProductId, luaindex:nilable presentationIndex, integer filterTypes)

# Returns: bool matchesFilter

DoesAnyMarketProductPresentationMatchFilter

(integer marketProductId, integer filterTypes)

# Returns: bool matchesFilter

GetMarketProductInfo

private (integer marketProductId)

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

GetMarketProductPricingByPresentation

private (integer marketProductId, luaindex:nilable presentationIndex)

# Returns: MarketCurrencyType currencyType, integer:nilable cost, integer:nilable costAfterDiscount, integer discountPercent, integer:nilable esoPlusCost

GetMarketProductPresentationIds

(MarketDisplayGroup displayGroup, luaindex topLevelIndex, luaindex:nilable categoryIndex, luaindex marketProductIndex)

# Returns: integer marketProductId, luaindex presentationIndex

GetMarketProductIcon

private (integer marketProductId)

# Returns: textureName icon

GetMarketProductInstantUnlockId

private (integer marketProductId)

# Returns: integer instantUnlockId

GetMarketProductInstantUnlockType

private (integer marketProductId)

# Returns: InstantUnlockRewardType instantUnlock

GetCategoryIndicesFromMarketProductPresentation

(integer marketProductId, luaindex:nilable presentationIndex)

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

CouldPurchaseMarketProduct

private (integer marketProductId, luaindex:nilable presentationIndex, integer quantity)

# Returns: MarketPurchasableResult expectedPurchaseResult

CouldGiftMarketProduct

private (integer marketProductId, luaindex:nilable presentationIndex, integer quantity)

# Returns: MarketPurchasableResult expectedGiftResult

IsMarketProductPurchased

private (integer marketProductId)

# Returns: bool isPurchased

DoesMarketProductPassPurchasableReqList

private (integer marketProductId)

# Returns: bool passesPurchaseReq, integer errorStringId

GetMarketProductAssociatedAchievementId

(integer marketProductId)

# Returns: integer associatedAchievementId

DoesMarketProductContainDLC

private (integer marketProductId)

# Returns: bool hasDLC

GetMarketProductEligibilityErrorStringIds

private (integer marketProductId)

# Uses variable returns...
# Returns: integer errorStringId

GetMarketProductCompleteErrorStringId

private (integer marketProductId)

# Returns: integer errorStringId

GetMarketProductItemInfo

private (integer marketProductId)

# Returns: integer itemId, textureName iconFile, string name, ItemDisplayQuality itemDisplayQuality, integer requiredLevel, integer itemCount

GetMarketProductItemLink

private (integer marketProductId, LinkStyle linkStyle)

# Returns: string link

GetMarketProductType

private (integer marketProductId)

# Returns: MarketProductType productType

GetMarketProductDisplayName

(integer marketProductId)

# Returns: string displayName

GetMarketProductDescription

private (integer marketProductId)

# Returns: string description

GetMarketProductNumChildren

private (integer marketProductId)

# Returns: integer numChildren

GetMarketProductChildId

private (integer marketProductId, luaindex childIndex)

# Returns: integer childId

GetMarketProductNumFacadeChildren

private (integer marketProductId)

# Returns: integer numChildren

GetMarketProductFacadeChildId

private (integer marketProductId, luaindex childIndex)

# Returns: integer childId

GetMarketProductItemRewardListId

private (integer marketProductId)

# Returns: integer rewardListId

GetMarketProductNumBundledProducts

private (integer marketProductId)

# Returns: integer numBundledProducts

GetMarketProductStackCount

private (integer marketProductId)

# Returns: integer stackCount

GetMarketProductFurnitureDataId

private (integer marketProductId)

# Returns: integer furnitureDataId

GetMarketProductDisplayQuality

private (integer marketProductId)

# Returns: ItemDisplayQuality itemDisplayQuality

GetMarketProductOpenMarketBehavior

private (integer marketProductId)

# Returns: OpenMarketBehavior openBehavior

GetMarketProductOpenMarketBehaviorReferenceData

private (integer marketProductId)

# Returns: integer openToMarketProductId

ShouldMarketProductShowClaimGiftNotice

private (integer marketProductId)

# Returns: bool shouldShowNotice

GetMarketProductClaimGiftNoticeInfo

private (integer marketProductId)

# Returns: string noticeText, luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetMarketProductUnlockedByAchievementId

(integer marketProductId)

# Returns: integer achievementId

GetMarketProductUnlockedByCollectibleIds

(integer marketProductId)

# Uses variable returns...
# Returns: integer collectibleIds

GetMarketProductUnlockedHelpIndices

(integer marketProductId)

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

IsMarketProductNew

private (integer marketProductId)

# Returns: bool isNew

IsMarketProductFeatured

private (integer marketProductId)

# Returns: bool isFeatured

IsMarketProductGiftable

private (integer marketProductId, luaindex:nilable presentationIndex)

# Returns: bool isGiftable

GetMarketProductAnnounceSortOrder

private (integer marketProductId)

# Returns: integer announceSortOrder

GetMarketProductNumCollectibles

private (integer marketProductId)

# Returns: integer numCollectibles

GetMarketProductCollectibleInfo

private (integer marketProductId)

# Returns: integer collectibleId, textureName iconFile, string name, CollectibleCategoryType collectibleType, string description, bool owned, bool isPurchasable, string hint

GetMarketProductCollectibleId

private (integer marketProductId)

# Returns: integer collectibleId

GetMarketProductBundleInspectChildProductsAsList

private (integer marketProductId)

# Returns: bool inspectAsList

GetMarketProductCrownCrateId

private (integer marketProductId)

# Returns: integer crateId

GetMarketProductHouseId

private (integer marketProductId)

# Returns: integer houseId

GetMarketProductHouseTemplateId

private (integer marketProductId)

# Returns: integer houseTemplateId

GetMarketProductLTOTimeLeftInSeconds

private (integer marketProductId)

# Returns: number timeLeftSeconds

GetMarketProductSaleTimeLeftInSeconds

private (integer marketProductId)

# Returns: number timeLeftSeconds

GetMarketProductEndTimeString

private (integer marketProductId)

# Returns: string endTimeString

GetMarketProductCurrencyType

(integer marketProductId)

# Returns: CurrencyType currencyType

CouldAcquireMarketProduct

private (integer marketProductId)

# Returns: MarketPurchasableResult expectedPurchaseResult

GetSpaceNeededToAcquireMarketProduct

private (integer marketProductId)

# Returns: integer openSlotsNeeded

GetMarketProductMaxGiftQuantity

(integer marketProductId)

# Returns: integer maxQuantity

OpenMarket

private (MarketDisplayGroup displayGroup)

GetMarketState

private (MarketDisplayGroup displayGroup)

# Returns: MarketState marketState

GetMarketProductsForItem

(integer itemId, bool onlyActiveListings)

# Uses variable returns...
# Returns: integer marketProductId

GetActiveMarketProductListingsForHouseTemplate

(integer houseTemplateId, MarketDisplayGroup displayGroup)

# Uses variable returns...
# Returns: integer marketProductId, luaindex presentationIndex

GetActiveAnnouncementMarketProductListingsForHouseTemplate

(integer houseTemplateId)

# Uses variable returns...
# Returns: integer marketProductId, luaindex presentationIndex

GetActiveChapterUpgradeMarketProductListings

(MarketDisplayGroup displayGroup)

# Uses variable returns...
# Returns: integer marketProductId

OnMarketClose

private ()

RequestMarketAnnouncement

()

HasShownMarketAnnouncement

()

# Returns: bool hasShownAnnouncement

FlagMarketAnnouncementSeen

()

RequestEventAnnouncements

()

RespondToSendPartiallyOwnedGift

(bool shouldSendGift)

GetMarketAnnouncementCompletedDailyLoginRewardClaimsBackground

()

# Returns: textureName completedDailyLoginRewardClaimsBackground

GetMarketAnnouncementDailyLoginLockedBackground

()

# Returns: textureName dailyLoginLockedAnnouncementBackground

HasExpiringMarketCurrency

()

# Returns: bool hasExpiringMarketCurrency

RequestExpiringMarketCurrencyInfo

()

GetNumExpiringMarketCurrencyInfos

()

# Returns: integer numExpiringMarketCurrencyInfos

GetExpiringMarketCurrencyInfo

(luaindex index)

# Returns: integer marketCurrencyAmount, number timeLeftSeconds

GetEsoPlusSubscriptionBenefitsInfoHelpIndices

()

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetEsoPlusSubscriptionLapsedBenefitsInfoHelpIndices

()

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetGiftingAccountLockedHelpIndices

()

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetGiftingGraceStartedHelpIndices

()

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetGiftingUnlockedHelpIndices

()

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

GetMarketAnnouncementHelpLinkIndices

(integer marketProductId)

# Returns: luaindex:nilable helpCategoryIndex, luaindex:nilable helpIndex

SendCrownCrateOpenRequest

(integer crateId)

GetNumOwnedCrownCrateTypes

()

# Returns: integer numCrownCrateTypes

GetNextOwnedCrownCrateId

(integer:nilable lastCrateId)

# Returns: integer:nilable nextCrateId

GetOnSaleCrownCrateId

()

# Returns: integer:nilable crateId

GetCrownCrateName

(integer crateId)

# Returns: string crateName

GetCrownCrateDescription

(integer crateId)

# Returns: string crateDescription

GetCrownCrateCount

(integer crateId)

# Returns: integer count

GetCrownCrateIcon

(integer crateId)

# Returns: textureName icon

GetInventorySpaceRequiredToOpenCrownCrate

(integer crateId)

# Returns: integer inventorySpaceRequired

GetCrownCratePackNormalTexture

(integer crateId)

# Returns: textureName normalImage

GetCrownCrateCardTextures

(integer crateId)

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

GetCurrentCrownCrateId

()

# Returns: integer crateId

GetNumCurrentCrownCrateTotalRewards

()

# Returns: integer numRewards

GetNumCurrentCrownCratePrimaryRewards

()

# Returns: integer numPrimaryRewards

GetNumCurrentCrownCrateBonusRewards

()

# Returns: integer numBonusRewards

GetCrownCrateRewardInfo

(luaindex rewardIndex)

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

GetMarketProductCrownCrateRewardInfo

(integer marketProductId)

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

GetMarketProductCrownCrateTierId

(integer marketProductId)

# Returns: integer crownCrateTierId

GetCrownCrateRewardProductReferenceData

(luaindex rewardIndex)

# Returns: MarketProductType rewardProductType, integer referenceDataId

GetCrownCrateRewardStackCount

(luaindex rewardIndex)

# Returns: integer stackCount

GetCrownCrateRewardItemLink

(luaindex rewardIndex, LinkStyle linkStyle)

# Returns: string link

GetCrownCrateNPCBoneWorldPosition

(string boneName)

# Returns: bool success, number positionX, number positionY, number positionZ

CreateCrownCrateSpecificParticleEffect

private (integer crownCrateId, CrownCrateParticleEffects crownCrateParticleEffects, number worldX, number worldY, number worldZ)

# Returns: integer:nilable particleEffectId

CreateCrownCrateTierSpecificParticleEffect

private (integer crownCrateTierId, CrownCrateTierParticleEffects crownCrateTierParticleEffects, number worldX, number worldY, number worldZ)

# Returns: integer:nilable particleEffectId

GetCrownCrateNPCCardThrowingBoneName

()

# Returns: string boneName

SetCrownCrateNPCVisible

(bool show)

TriggerCrownCrateNPCAnimation

(CrownCrateEvent event, luaindex:nilable rewardIndex)

GetCrownCrateTierQualityColor

(integer crownCrateTierId)

# Returns: number r, number g, number b

GetCrownCrateTierReactionNPCAnimation

(integer crownCrateTierId)

# Returns: CrownCrateEvent reactionEvent

GetCrownCratesSystemState

()

# Returns: LootCratesSystemState crownCratesSystemState

CanInteractWithCrownCratesSystem

()

# Returns: bool canInteractWithCrownCratesSystem

IsPlayerAllowedToOpenCrownCrates

()

# Returns: bool isAllowed, integer errorStringId

PlayCrownCrateTierSpecificParticleSoundAndVibration

(integer crownCrateTierId, CrownCrateTierParticleEffects crownCrateTierParticleEffects)

PlayCrownCrateSpecificParticleSoundAndVibration

(integer crownCrateId, CrownCrateParticleEffects crownCrateTierParticleEffects)

RefreshCardsInCrownCrateNPCsHand

()

SetCrownCrateUIMenuActive

(bool active)

GetCrownCrateTierOrdering

(integer tierId)

# Returns: integer tierOrdering

GemifyItem

(integer itemId, integer howMany)

InitializePendingDyes

()

SetPendingSlotDyes

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

GetPendingSlotDyes

(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlotType)

# Returns: integer primaryDyeId, integer secondaryDyeId, integer accentDyeId

GetNumDyes

()

# Returns: integer numDyes

GetDyeInfo

(luaindex dyeIndex)

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

GetDyeInfoById

(integer dyeId)

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

GetDyeColorsById

(integer dyeId)

# Returns: number r, number g, number b

GetCurrentItemDyes

(Bag bagId, integer slotIndex)

# Returns: integer primaryDyeIndex, integer secondaryDyeIndex, integer accentDyeIndex

GetCurrentCollectibleDyes

(RestyleMode restyleMode, integer collectibleId)

# Returns: integer primaryDyeIndex, integer secondaryDyeIndex, integer accentDyeIndex

ApplyPendingDyes

(RestyleMode restyleMode)

GetNumSavedDyeSets

()

# Returns: integer numSavedDyeSets

GetSavedDyeSetDyes

(luaindex dyeSetIndex)

# Returns: integer primaryDyeId, integer secondaryDyeId, integer accentDyeId

SetSavedDyeSetDyes

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

CanUseCollectibleDyeing

()

# Returns: bool collectibleDyeingAllowed

IsDyeIndexKnown

(luaindex dyeIndex)

# Returns: bool isKnown

CanPlayerUseCostumeDyeStamp

(integer dyeStampId)

# Returns: DyeStampUseResult dyeStampUseResult

CanPlayerUseItemDyeStamp

(integer dyeStampId)

# Returns: DyeStampUseResult dyeStampUseResult

SetupDyeStampPreview

(Bag bagId, integer slotIndex)

SetRestylePreviewMode

(RestyleMode restyleMode)

BeginRestyling

(RestyleMode restyleMode)

EndRestyling

()

GetRestyleSlotId

(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlot)

# Returns: integer id

GetRestyleSlotIcon

(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlot)

# Returns: textureName icon

IsRestyleSlotDataDyeable

(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlot)

# Returns: bool isDyeable

IsRestyleEquipmentSlotBound

(EquipSlot equipSlot)

# Returns: bool isBound

AreRestyleSlotDyeChannelsDyeable

(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlot)

# Returns: bool primary, bool secondary, bool accent

GetRestyleSlotDyeData

(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlot)

# Returns: integer dyeData

GetRestyleSlotCurrentDyes

(RestyleMode restyleMode, luaindex restyleSetIndex, integer restyleSlot)

# Returns: integer primaryDyeId, integer secondaryDyeId, integer accentDyeId

GetNumUnlockedOutfits

(GameplayActorCategory actorCategory)

# Returns: integer numOutfits

IsCollectiblePresentInEffectivelyEquippedOutfit

(GameplayActorCategory actorCategory, integer collectibleId)

# Returns: bool isPresent

GetNumOutfitStyleItemMaterials

(integer outfitStyleId)

# Returns: integer numItemMaterials

GetOutfitStyleItemMaterialName

(integer outfitStyleId, luaindex itemMaterialIndex)

# Returns: string materialName

GetOutfitStyleCost

(integer outfitStyleId)

# Returns: integer goldCost, bool isFree

GetOutfitSlotClearCost

(OutfitSlot outfitSlot)

# Returns: integer cost

GetOutfitStyleItemStyleId

(integer outfitStyleId)

# Returns: integer itemStyleId

CanEquippedItemBeShownInOutfitSlot

(GameplayActorCategory actorCategory, EquipSlot equipSlot, OutfitSlot outfitSlot)

# Returns: bool canShowItem

GetEquipSlotForOutfitSlot

(OutfitSlot outfitSlot)

# Returns: EquipSlot equipSlot

GetEligibleOutfitSlotsForCollectible

(integer collectibleId)

# Uses variable returns...
# Returns: OutfitSlot outfitSlot

IsOutfitStyleArmor

(integer outfitStyleId)

# Returns: bool isArmor

IsCharacterPreviewingAvailable

()

# Returns: bool canPreview

CanCollectibleBePreviewed

(integer collectibleId)

# Returns: bool canCollectibleBePreviewed

ApplyChangesToPreviewCollectionShown

(PreviewOption previewOption)

EnablePreviewMode

(bool forceDismount)

DisablePreviewMode

()

ForceCancelMounted

private ()

GetPreviewModeEnabled

()

# Returns: bool previewModeEnabled

IsCurrentlyPreviewing

()

# Returns: bool isPreviewing

IsCurrentlyPreviewingPlacedFurniture

(id64 furnitureId)

# Returns: bool isPreviewing

IsCurrentlyPreviewingFurnitureCollectible

(integer collectibleId)

# Returns: bool isPreviewing

IsCurrentlyPreviewingInventoryItem

(Bag bagId, integer slotIndex)

# Returns: bool isPreviewing

EndCurrentItemPreview

()

ClearCurrentItemPreviewCollection

()

BeginItemPreviewSpin

()

EndItemPreviewSpin

()

CanSpinPreviewCharacter

()

# Returns: bool canSpin

SetShowHiddenGearOnActivePreviewRules

private (bool showHiddenGear)

GetShowHiddenGearFromActivePreviewRules

private ()

# Returns: bool showHiddenGear

SetPreviewInEmptyWorld

(number sunlightAzimuthRadians, number sunlightAltitudeRadians)

SetPreviewDynamicFramingOpening

(number openingWidthUI, number openingHeightUI, number cameraAngleRadians)

SetPreviewingOutfitIndexInPreviewCollection

(GameplayActorCategory actorCategory, luaindex outfitIndex)

SetPreviewingUnequippedOutfitInPreviewCollection

(GameplayActorCategory actorCategory)

ClearPreviewingOutfitIndexInPreviewCollection

()

AddOutfitSlotPreviewElementToPreviewCollection

private (OutfitSlot outfitSlot, integer collectibleDefId, luaindex:nilable itemMaterialIndex, integer primaryDyeDefId, integer secondaryDyeDefId, integer accentDyeDefId)

ClearOutfitSlotPreviewElementFromPreviewCollection

(OutfitSlot outfitSlot)

ClearAllOutfitSlotPreviewElementsFromPreviewCollection

()

GetOutfitSlotInfoForOutfitSlotInPreviewCollection

(OutfitSlot outfitSlot)

# Returns: integer collectibleDefId, luaindex:nilable itemMaterialIndex, integer primaryDyeDefId, integer secondaryDyeDefId, integer accentDyeDefId

PreviewDyeStamp

(integer dyeStampId, ItemUseType itemType)

PreviewDyeStampByItemLink

(string itemLink)

PreviewCraftItem

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

PreviewCollectible

private (integer collectibleDefId, luaindex variation, integer dyeBrushId)

PreviewCollectibleAsFurniture

private (integer collectibleDefId, luaindex variation)

PreviewCollectibleAction

private (integer collectibleDefId, luaindex action)

CanInventoryItemBePreviewed

(Bag bagId, integer slotIndex)

# Returns: bool canPreview

CanItemLinkBePreviewed

(string itemLink)

# Returns: bool canPreview

PreviewInventoryItem

(Bag bagId, integer slotIndex, luaindex variation)

PreviewInventoryItemCollectibleAction

(Bag bagId, integer slotIndex, luaindex action)

PreviewStoreEntry

(luaindex entryIndex, luaindex variation, integer dyeBrushId)

PreviewStoreEntryCollectibleAction

(luaindex entryIndex, luaindex action)

PreviewTradingHouseSearchResultItem

(luaindex index, luaindex variation)

PreviewTradingHouseSearchResultItemCollectibleAction

(luaindex index, luaindex action)

PreviewItemLink

(string itemLink, luaindex variation)

PreviewProvisionerItemAsFurniture

private (luaindex recipeListIndex, luaindex recipeIndex, luaindex variation)

PreviewPlacedFurniture

(id64 furnitureId, luaindex variation)

PreviewReward

(integer rewardId, luaindex variation)

PreviewRewardCollectibleAction

(integer rewardId, luaindex action)

GetNumCollectiblePreviewVariations

(integer collectibleDefId)

# Returns: integer numVariations

GetCollectiblePreviewVariationDisplayName

(integer collectibleDefId, luaindex variation)

# Returns: string variationDisplayName

GetNumCollectibleAsFurniturePreviewVariations

(integer collectibleDefId)

# Returns: integer numVariations

GetCollectibleAsFurniturePreviewVariationDisplayName

(integer collectibleDefId, luaindex variation)

# Returns: string variationDisplayName

GetNumCollectiblePreviewActions

(integer collectibleDefId, luaindex variation)

# Returns: integer numActions

GetCollectiblePreviewActionDisplayName

(integer collectibleDefId, luaindex variation, luaindex action)

# Returns: string previewActionDisplayName

GetNumCollectibleAsFurniturePreviewActions

(integer collectibleDefId, luaindex variation)

# Returns: integer numActions

GetCollectibleAsFurniturePreviewActionDisplayName

(integer collectibleDefId, luaindex variation, luaindex action)

# Returns: string previewActionDisplayName

GetNumInventoryItemPreviewVariations

(Bag bagId, integer slotIndex)

# Returns: integer numVariations

GetInventoryItemPreviewVariationDisplayName

(Bag bagId, integer slotIndex, luaindex variation)

# Returns: string variationDisplayName

GetNumInventoryItemPreviewCollectibleActions

(Bag bagId, integer slotIndex, luaindex variation)

# Returns: integer numActions

GetInventoryItemPreviewCollectibleActionDisplayName

(Bag bagId, integer slotIndex, luaindex variation, luaindex action)

# Returns: string actionDisplayName

GetNumItemLinkPreviewVariations

(string itemLink)

# Returns: integer numVariations

GetItemLinkPreviewVariationDisplayName

(string itemLink, luaindex variation)

# Returns: string variationDisplayName

GetNumStoreEntryPreviewVariations

(luaindex entryIndex)

# Returns: integer numVariations

GetStoreEntryPreviewVariationDisplayName

(luaindex entryIndex, luaindex variation)

# Returns: string variationDisplayName

GetNumStoreEntryPreviewCollectibleActions

(luaindex entryIndex, luaindex variation)

# Returns: integer numActions

GetStoreEntryPreviewCollectibleActionDisplayName

(luaindex entryIndex, luaindex variation, luaindex action)

# Returns: string actionDisplayName

GetNumTradingHouseSearchResultItemPreviewVariations

(luaindex index)

# Returns: integer numVariations

GetTradingHouseSearchResultItemPreviewVariationDisplayName

(luaindex index, luaindex variation)

# Returns: string variationDisplayName

GetNumTradingHouseSearchResultItemPreviewCollectibleActions

(luaindex index, luaindex variation)

# Returns: integer numActions

GetTradingHouseSearchResultItemPreviewCollectibleActionDisplayName

(luaindex index, luaindex variation, luaindex action)

# Returns: string actionDisplayName

GetNumProvisionerItemAsFurniturePreviewVariations

(luaindex recipeListIndex, luaindex recipeIndex)

# Returns: integer numVariations

GetProvisionerItemAsFurniturePreviewVariationDisplayName

(luaindex recipeListIndex, luaindex recipeIndex, luaindex variation)

# Returns: string variationDisplayName

GetNumPlacedFurniturePreviewVariations

(id64 furnitureId)

# Returns: integer numVariations

GetPlacedFurniturePreviewVariationDisplayName

(id64 furnitureId, luaindex variation)

# Returns: string variationDisplayName

PreviewMarketProduct

private (integer marketProductId, luaindex variation)

PreviewFurnitureMarketProduct

private (integer marketProductId, luaindex variation)

IsPreviewingMarketProduct

(integer marketProductId)

# Returns: bool isBeingPreviewed

CanPreviewMarketProduct

(integer marketProductId)

# Returns: bool isPreviewable

GetNumMarketProductPreviewVariations

(integer marketProductId)

# Returns: integer numVariations

GetMarketProductPreviewVariationDisplayName

(integer marketProductId, luaindex variation)

# Returns: string variationDisplayName

GetMarketProductChapterUpgradeId

(integer marketProductId)

# Returns: integer chapterUpgradeId

PreviewMarketProductCollectibleAction

private (integer marketProductId, luaindex action)

GetNumMarketProductCollectiblePreviewActions

(integer marketProductId, luaindex variation)

# Returns: integer numActions

GetMarketProductCollectiblePreviewActionDisplayName

(integer marketProductId, luaindex variation, luaindex action)

# Returns: string actionDisplayName

RequestJumpToHouse

(integer houseId, bool jumpOutside)

RequestJumpToHousePreviewWithTemplate

(integer houseTemplateId)

ClearCursor

()

# Returns: bool clearedSomething

SetCursorItemSoundsEnabled

(bool enabled)

GetCursorContentType

()

# Returns: integer cursorType

GetCraftingSkillName

(TradeskillType craftingSkillType)

# Returns: string name

GetFurnitureCategoryName

(integer furnitureCategoryId)

# Returns: string displayName

GetFurnitureDataInfo

(integer furnitureDataId)

# Returns: integer:nilable categoryId, integer:nilable subcategoryId, FurnitureThemeType furnitureTheme, HousingFurnishingLimitType placementLimitType

GetFurnitureDataCategoryInfo

(integer furnitureDataId)

# Returns: integer:nilable categoryId, integer:nilable subcategoryId

GetNumHouseTemplatesForHouse

(integer houseId)

# Returns: integer numHouseTemplates

GetHouseTemplateIdByIndexForHouse

(integer houseId, luaindex houseTemplateIndex)

# Returns: integer houseTemplateId

GetDefaultHouseTemplateIdForHouse

(integer houseId)

# Returns: integer houseTemplateId

GetCollectibleIdForHouse

(integer houseId)

# Returns: integer collectibleId

GetHouseFoundInZoneId

(integer houseId)

# Returns: integer zoneId

GetHouseCategoryType

(integer houseId)

# Returns: HouseCategoryType houseType

GetHouseTemplateBaseFurnishingCountInfo

(integer houseTemplateId, HousingFurnishingLimitType furnishingType)

# Returns: integer initialFurnishingCount, integer furnishingLimit

GetHousingLink

(integer houseId, string ownerDisplayName, LinkStyle linkStyle)

# Returns: string link

GetHouseFlags

(integer houseId)

# Returns: HouseFlags flags

SetInteractionUsingInteractCamera

(bool enabled)

IsInteractionUsingInteractCamera

()

# Returns: bool enabled

GetInteractionType

()

# Returns: InteractionType interactType

GetScribingCollectibleId

()

# Returns: integer scribingCollectibleId

GetUniversalStyleId

()

# Returns: integer universalStyleId

GetItemStyleName

(integer styleId)

# Returns: string styleName

GetJewelrycraftingCollectibleId

()

# Returns: integer jewelrycraftingCollectibleId

GetNumEmotes

()

# Returns: integer numEmotes

GetEmoteIndex

(integer emoteId)

# Returns: luaindex:nilable emoteIndex

GetEmoteInfo

(luaindex emoteIndex)

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

GetEmoteCollectibleId

(luaindex emoteIndex)

# Returns: integer:nilable collectibleId

GetEmoteSlashNameByIndex

(luaindex emoteIndex)

# Returns: string slashName

PlayEmoteByIndex

(luaindex emoteIndex)

GetEmoteCategoryKeyboardIcons

(EmoteCategory category)

# Returns: textureName unpressedButtonIcon, textureName pressedButtonIcon, textureName mouseoverButtonIcon

GetQuickChatCategoryKeyboardIcons

()

# Returns: textureName unpressedButtonIcon, textureName pressedButtonIcon, textureName mouseoverButtonIcon

GetSharedEmoteIconForCategory

(EmoteCategory category)

# Returns: textureName sharedEmoteIcon

GetSharedPersonalityEmoteIconForCategory

(EmoteCategory category)

# Returns: textureName sharedPersonalityEmoteIcon

GetSharedQuickChatIcon

()

# Returns: textureName sharedQuickChatIcon

GetRewardType

(integer rewardId)

# Returns: RewardEntryType:nilable rewardType

GetRewardListIdFromReward

(integer rewardId)

# Returns: integer rewardListId

GetNumRewardListEntries

(integer rewardListId)

# Returns: integer numRewards

GetRewardListEntryInfo

(integer rewardListId, luaindex listIndex)

# Returns: integer rewardDefId, RewardEntryType:nilable rewardType, integer quantity

GetRewardListDisplayName

(integer rewardListId)

# Returns: string displayName

GetRewardListDescription

(integer rewardListId)

# Returns: string displayName

GetAddCurrencyRewardInfo

(integer rewardId)

# Returns: CurrencyType currencyType

GetChoiceRewardListId

(integer rewardId)

# Returns: integer rewardListId

GetChoiceRewardDisplayName

(integer rewardId)

# Returns: string displayName

GetChoiceRewardIcon

(integer rewardId)

# Returns: textureName icon

GetCollectibleRewardCollectibleId

(integer rewardId)

# Returns: integer collectibleId

GetTributeCardUpgradeRewardTributeCardUpgradeInfo

(integer rewardId)

# Returns: integer tributePatronDefId, luaindex tributeCardIndex

GetItemRewardItemLink

(integer rewardId, integer quantity, RewardDisplayFlags displayFlags, LinkStyle linkStyle)

# Returns: string link

GetItemRewardItemId

(integer rewardId)

# Returns: integer itemId

GetCrownCrateRewardCrateId

(integer rewardId)

# Returns: integer crateId

GetInstantUnlockRewardInstantUnlockId

(integer rewardId)

# Returns: integer instantUnlockId

GetSkillLineExperienceRewardSkillLineId

(integer rewardId)

# Returns: integer skillLineId

GetMailItemRewardMailInfo

(integer rewardId)

# Returns: string sender, string subject, string body

CanPreviewReward

(integer rewardId)

# Returns: bool canPreview

GetNumRewardPreviewVariations

(integer rewardId)

# Returns: integer numVariations

GetRewardPreviewVariationDisplayName

(integer rewardId, luaindex variation)

# Returns: string displayName

IsPreviewingReward

(integer rewardId)

# Returns: bool isPreviewing

GetRewardAnnouncementBackgroundFileIndex

(integer rewardId)

# Returns: textureName fileIndex

GetNumRewardPreviewCollectibleActions

(integer rewardId, luaindex variation)

# Returns: integer numActions

GetRewardPreviewCollectibleActionDisplayName

(integer rewardId, luaindex variation, luaindex action)

# Returns: string actionDisplayName

GetFallbackReward

(integer rewardId)

# Returns: integer fallbackRewardId, integer fallbackRewardQuantity

ShouldUseFallbackReward

(integer rewardId)

# Returns: bool shouldUseFallback

GetInstantUnlockRewardType

(integer instantUnlockId)

# Returns: InstantUnlockRewardType instantUnlockType

GetInstantUnlockRewardDisplayName

(integer instantUnlockId)

# Returns: string displayName

GetInstantUnlockRewardDescription

(integer instantUnlockId)

# Returns: string description

GetInstantUnlockRewardIcon

(integer instantUnlockId)

# Returns: textureName icon

GetInstantUnlockRewardCategory

(integer instantUnlockId)

# Returns: InstantUnlockRewardCategory instantUnlockCategory

IsInstantUnlockRewardServiceToken

(integer instantUnlockId)

# Returns: bool isServiceToken

IsInstantUnlockRewardUpgrade

(integer instantUnlockId)

# Returns: bool isUpgrade

SetFrameLocalPlayerInGameCamera

(bool enabled)

RequestReframeLocalPlayerInGameCamera

()

SetFrameLocalPlayerTarget

(number normalizedScreenX, number normalizedScreenY)

SetFrameLocalPlayerLookAtDistanceFactor

(number:nilable lookAtDistanceFactor)

SetFramingScreenType

(GameCameraFramingScreenType screenType)

SetFrameInteractionTarget

(number normalizedScreenX, number normalizedScreenY)

GetChapterSummary

(integer chapterUpgradeId)

# Returns: string chapterSummary

GetChapterOverrideDisplayName

(integer chapterUpgradeId)

# Returns: string overrideDisplayName

GetChapterMarketBackgroundFileImage

(integer chapterUpgradeId)

# Returns: textureName marketBackgroundFileIndex

GetNumChapterPrePurchaseRewards

(integer chapterUpgradeId)

# Returns: integer numRewards

GetChapterPrePurchaseRewardInfo

(integer chapterUpgradeId, luaindex index)

# Returns: integer marketProductId, bool isStandardReward, bool isCollectorsReward

GetNumChapterPreOrderRewards

(integer chapterUpgradeId)

# Returns: integer numRewards

GetChapterPreOrdereRewardInfo

(integer chapterUpgradeId, luaindex index)

# Returns: integer marketProductId, bool isStandardReward, bool isCollectorsReward

GetNumChapterBasicRewards

(integer chapterUpgradeId)

# Returns: integer numRewards

GetChapterBasicRewardInfo

(integer chapterUpgradeId, luaindex index)

# Returns: integer marketProductId, bool isStandardReward, bool isCollectorsReward

IsChapterPreRelease

(integer chapterUpgradeId)

# Returns: bool isPreRelease

GetChapterReleaseDateString

(integer chapterUpgradeId)

# Returns: string releaseDateString

GetChapterEnumFromUpgradeId

(integer chapterUpgradeId)

# Returns: Chapter chapterEnum

IsChapterContentPass

(integer chapterUpgradeId)

# Returns: bool isContentPass

GetGiftMarketProductId

(id64 giftId)

# Returns: integer marketProductId

GetGiftQuantity

(id64 giftId)

# Returns: integer quantity

GetGiftClaimableQuantity

(id64 giftId)

# Returns: integer quantity

GetRandomGiftSendNoteText

()

# Returns: string giftSendNoteText

GetRandomGiftThankYouNoteText

()

# Returns: string giftThankYouNoteText

IsGiftRecipientNameValid

(string recipientName)

# Returns: GiftBoxActionResult result

GetGiftingGracePeriodTime

()

# Returns: integer gracePeriodTime

ClaimCurrentDailyLoginReward

()

GetDailyLoginClaimableRewardIndex

()

# Returns: luaindex:nilable rewardIndex

GetDailyLoginNumRewardsClaimedInMonth

()

# Returns: integer numRewardsClaimed

GetTimeUntilNextDailyLoginMonthS

()

# Returns: integer timeUntilNextMonthS

GetTimeUntilNextDailyLoginRewardClaimS

()

# Returns: integer timeUntilNextRewardClaimS

GetCurrentDailyLoginMonth

()

# Returns: GregorianCalendarMonths month

GetNumRewardsInCurrentDailyLoginMonth

()

# Returns: integer numEntries

GetDailyLoginRewardInfoForCurrentMonth

(luaindex rewardIndex)

# Returns: integer rewardId, integer quantity, bool isMilestone

IsDailyLoginRewardInCurrentMonthClaimed

(luaindex rewardIndex)

# Returns: bool isClaimed

GetNumClaimableDailyLoginRewardsInCurrentMonth

()

# Returns: integer numClaimable

GetNumInventorySlotsNeededForDailyLoginRewardInCurrentMonth

(luaindex rewardIndex)

# Returns: integer numSlots

GetNumReturningPlayerDailyLoginRewards

()

# Returns: integer numLoginRewards

GetNumReturningPlayerDailyLoginRewardsClaimed

()

# Returns: integer numClaimedLoginRewards

GetReturningPlayerDailyLoginRewardInfo

(luaindex rewardIndex)

# Returns: integer rewardId, integer quantity

GetReturningPlayerDailyLoginClaimableRewardIndex

()

# Returns: luaindex:nilable rewardIndex

ClaimCurrentReturningPlayerDailyLoginReward

()

GetTimeUntilNextReturningPlayerDailyLoginRewardClaimS

()

# Returns: integer timeUntilNextRewardClaimS

GetNumClaimableReturningPlayerRewards

()

# Returns: integer numClaimableRewards

GetZoneId

(luaindex zoneIndex)

# Returns: integer zoneId

GetParentZoneId

(integer zoneId)

# Returns: integer parentZoneId

CanJumpToHouseFromCurrentLocation

()

# Returns: bool canJumpToHouseFromCurrentLocation

GetZoneIndex

(integer zoneId)

# Returns: luaindex zoneIndex

IsZoneCollectibleLocked

(luaindex zoneIndex)

# Returns: bool isZoneCollectibleLocked

GetZoneNameById

(integer zoneId)

# Returns: string name

AreAllZoneStoryActivitiesCompleteForZoneCompletionType

(integer zoneId, ZoneCompletionType zoneCompletionType)

# Returns: bool isComplete

GetZoneStoryKeyboardBackground

(integer zoneId)

# Returns: textureName backgroundFile

IsZoneStoryComplete

(integer zoneId)

# Returns: bool isComplete

GetZoneStoryZoneIdForZoneId

(integer zoneId)

# Returns: integer zoneStoryZoneId

IsZoneStoryZoneAvailable

(integer zoneId)

# Returns: bool isZoneAvailable, string errorString

IsZoneStoryTracked

()

# Returns: bool isTracked

IsZoneStoryAssisted

()

# Returns: bool isAssisted

GetTrackedZoneStoryActivityInfo

()

# Returns: integer zoneId, ZoneCompletionType zoneCompletionType, integer activityId

GetAchievementName

(integer achievementId)

# Returns: string name

GetAchievementInfo

(integer achievementId)

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

GetAchievementNumCriteria

(integer achievementId)

# Returns: integer numCriteria

GetAchievementCriterion

(integer achievementId, luaindex criterionIndex)

# Returns: string description, integer numCompleted, integer numRequired

GetAchievementRewardItem

(integer achievementId)

# Returns: bool hasRewardOfType, string itemName, string iconTextureName, ItemDisplayQuality displayQuality

GetAchievementRewardTitle

(integer achievementId)

# Returns: bool hasRewardOfType, string titleName

GetAchievementRewardDye

(integer achievementId)

# Returns: bool hasRewardOfType, integer dyeId

GetAchievementRewardCollectible

(integer achievementId)

# Returns: bool hasRewardOfType, integer collectibleId

GetAchievementRewardTributeCardUpgradeInfo

(integer achievementId)

# Returns: bool hasRewardOfType, integer tributePatronId, luaindex tributeCardIndex

GetAchievementPersistenceLevel

(integer achievementId)

# Returns: AchievementPersistenceLevel persistenceLevel

IsAchievementComplete

(integer achievementId)

# Returns: bool completed

GetCharIdForCompletedAchievement

(integer achievementId)

# Returns: id64 charId

DoesAntiquityNeedCombination

(integer antiquityId)

# Returns: bool needsCombination

GetAntiquityIcon

(integer antiquityId)

# Returns: textureName iconFileIndex

GetNumAntiquityLoreEntries

(integer antiquityId)

# Returns: integer numLoreEntries

GetAntiquityLoreEntry

(integer antiquityId, luaindex loreEntryIndex)

# Returns: string displayName, string description

GetAntiquityName

(integer antiquityId)

# Returns: string name

GetAntiquityQuality

(integer antiquityId)

# Returns: AntiquityQuality antiquityQuality

GetAntiquityRewardId

(integer antiquityId)

# Returns: integer rewardId

GetAntiquitySetId

(integer antiquityId)

# Returns: integer setId

GetNumAntiquitiesRecovered

(integer antiquityId)

# Returns: integer numRecovered

GetNumAntiquityLoreEntriesAcquired

(integer antiquityId)

# Returns: integer numLoreEntriesAcquired

DoesAntiquityHaveLead

(integer antiquityId)

# Returns: bool hasLead

DoesAntiquityRequireLead

(integer antiquityId)

# Returns: bool requiresLead

GetAntiquitySetIcon

(integer antiquitySetId)

# Returns: textureName iconFileIndex

GetAntiquitySetName

(integer antiquitySetId)

# Returns: string name

GetAntiquitySetQuality

(integer antiquitySetId)

# Returns: AntiquityQuality antiquityQuality

GetNumAntiquitySetAntiquities

(integer antiquitySetId)

# Returns: integer numAntiquities

GetAntiquitySetAntiquityId

(integer antiquitySetId, luaindex antiquityIndex)

# Returns: integer antiquityId

GetAntiquityLeadIcon

()

# Returns: textureName leadIcon

GetScryingCurrentAntiquityId

()

# Returns: integer antiquityId

GetSelectedDiggingActiveSkill

()

# Returns: DiggingActiveSkills:nilable diggingActiveSkill

GetDiggingActiveSkillIndices

(DiggingActiveSkills diggingActiveSkill)

# Returns: SkillType skillType, luaindex skillLineIndex, luaindex skillIndex

GetDigToolUIKeybindPosition

(DiggingActiveSkills diggingActiveSkill)

# Returns: number x, number y

GetDigPowerBarUIPosition

()

# Returns: number x, number y

GetDigSpotAntiquityId

()

# Returns: integer antiquityId

GetDigSpotDurability

()

# Returns: integer current, integer max

GetDigSpotStability

()

# Returns: integer current, integer max

GetDigSpotStabilityTimeRemainingSeconds

()

# Returns: integer timeRemainingS

GetDigSpotDigPower

()

# Returns: integer current, integer max

IsDigSpotRadarLimited

()

# Returns: bool isLimited

GetDigSpotNumRadars

()

# Returns: integer current, integer max

GetRadarCountUIPosition

()

# Returns: number x, number y

GetDigSpotMinPowerPerSpender

()

# Returns: integer minPower

GetDiggingAntiquityHasNewLoreEntryToShow

()

# Returns: bool hasNewLoreEntryToShow

IsDiggingGameActive

()

# Returns: bool isGameActive

IsDiggingGameOver

()

# Returns: bool isGameOver

IsDiggingActiveSkillUnlocked

(DiggingActiveSkills diggingActiveSkill)

# Returns: bool isUnlocked

GetMouseOverDiggingActiveSkill

()

# Returns: DiggingActiveSkills:nilable diggingActiveSkill

OnSelectedDigToolChanged

()

SetShouldRenderWorld

(bool shouldRenderWorld)

GetAbilityName

(integer abilityId, string casterUnitTag)

# Returns: string abilityName

GetAbilityCastInfo

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

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

GetAbilityTargetDescription

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

# Returns: string:nilable targetDescription

GetAbilityRange

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

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

GetAbilityRadius

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

# Returns: integer:nilable radius

GetAbilityAngleDistance

(integer abilityId)

# Returns: integer:nilable angleDistance

IsAbilityDurationToggled

(integer abilityId, string casterUnitTag)

# Returns: bool:nilable isAbilityDurationToggled

GetAbilityDuration

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

# Returns: integer:nilable durationMs

GetAbilityCooldown

(integer abilityId, string casterUnitTag)

# Returns: integer:nilable durationMs

GetAbilityIcon

(integer abilityId)

# Returns: textureName icon

GetNextAbilityMechanicFlag

(integer abilityId, CombatMechanicFlags:nilable lastMechanicFlag)

# Returns: CombatMechanicFlags:nilable nextMechanicFlag

GetAbilityBaseCostInfo

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

# Returns: integer:nilable baseCost, CombatMechanicFlags:nilable mechanicFlags, bool:nilable isCostChargedPerTick

GetAbilityCost

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

# Returns: integer cost

GetCurrentChainedAbility

(integer abilityId, string casterUnitTag)

# Returns: integer chainedAbilityId

GetAbilityCostPerTick

(integer abilityId, CombatMechanicFlags mechanic, integer:nilable overrideRank)

# Returns: integer costPerTick

GetAbilityFrequencyMS

(integer abilityId, string casterUnitTag)

# Returns: integer:nilable frequencyMS

GetAbilityRoles

(integer abilityId)

# Returns: bool isTankRoleAbility, bool isHealerRoleAbility, bool isDamageRoleAbility

GetAbilityDescriptionHeader

(integer abilityId, string casterUnitTag)

# Returns: string header

GetAbilityDescription

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

# Returns: string description

IsAbilityPassive

(integer abilityId)

# Returns: bool isPassive

IsAbilityUltimate

(integer abilityId)

# Returns: bool isUltimate

ShouldAbilityShowStacks

(integer abilityId)

# Returns: bool shouldShowStacks

GetAbilityEndlessDungeonBuffType

(integer abilityId)

# Returns: EndlessDungeonBuffType buffType, bool isAvatarVision

GetAbilityEndlessDungeonBuffBucketType

(integer abilityId)

# Returns: EndlessDungeonBuffBucketType buffBucketType

GetAbilityCraftedAbilityId

(integer abilityId)

# Returns: integer craftedAbilityId

GetAbilityIdFromLink

(string link)

# Returns: integer abilityId

GetAbilityMundusStoneType

(integer abilityId)

# Returns: MundusStone mundusStoneType

GetAbilityNumDerivedStats

(integer abilityId)

# Returns: integer numDerivedStats

GetAbilityDerivedStatAndEffectByIndex

(integer abilityId, luaindex index)

# Returns: DerivedStats derivedStat, integer effect

GetAbilityNumAdvancedStats

(integer abilityId)

# Returns: integer numAdvancedStats

GetAbilityAdvancedStatAndEffectByIndex

(integer abilityId, luaindex index)

# Returns: AdvancedStatDisplayType advancedStat, AdvancedStatDisplayFormat displayFormat, integer effect

GetMundusWarningLevel

()

# Returns: integer warningLevel

DoesPlatformSupportCodeRedemption

()

# Returns: bool supportsCodeRedemption

IsItemSetCollectionPieceUnlocked

(integer pieceId)

# Returns: bool isUnlocked

GetCurrencyTypeFromMarketCurrencyType

(MarketCurrencyType marketCurrencyType)

# Returns: CurrencyType currencyType

GetMarketCurrencyTypeFromCurrencyType

(CurrencyType currencyType)

# Returns: MarketCurrencyType marketCurrencyType

GetSkillLineNameById

(integer skillLineId)

# Returns: string name

GetSkillLineDetailedIconById

(integer skillLineId)

# Returns: textureName detailedIcon

GetNumAttainSkillLineRanksInAchievement

(integer achievementId)

# Returns: integer numAttainSkillLineRanks

GetNumSkyshardsInAchievement

(integer achievementId)

# Returns: integer numSkyshards

GetNumUnlockedArmoryBuilds

()

# Returns: integer numBuilds

GetTributePlayerInfo

(TributePlayerPerspective playerPerspective)

# Returns: string name, TributePlayerType playerType

GetTributeMatchType

()

# Returns: TributeMatchType matchType

GetTributeMatchStatistics

()

# Returns: integer matchDurationMS, integer goldAccumulated, integer cardsAcquired

GetTributeMatchCampaignKey

()

# Returns: id64 tributeMatchCampaignKey

GetNumTributeClubRankRewardLists

()

# Returns: integer numTributeClubRankRewardLists

GetTributeClubRankRewardListIdByIndex

(luaindex rewardListIndex)

# Returns: integer rewardListId

GetTributeGeneralMatchRewardListId

()

# Returns: integer rewardListId

GetTributeGeneralMatchLFGRewardUIDataId

()

# Returns: integer rewardUIDataId

GetPendingTributeClubExperience

()

# Returns: integer pendingClubXP

GetPendingTributeCampaignExperience

()

# Returns: integer pendingCampaignXP

GetNewTributeCampaignRank

()

# Returns: TributeTier newTributeCampaignRank

GetTributeForfeitPenaltyDurationMs

()

# Returns: integer forfeitPenaltyMs

TributeMatchEndSummaryComplete

()

GetActiveTributePlayerPerspective

()

# Returns: TributePlayerPerspective playerPerspective

GetNumPatronsFavoringPlayerPerspective

(TributePlayerPerspective playerPerspective)

# Returns: integer numPatronsFavored

DoesTributeSkipPatronDrafting

()

# Returns: bool skipsDrafting

GetTributePlayerPerspectiveResource

(TributePlayerPerspective playerPerspective, TributeResource resource)

# Returns: integer value

GetTributeRemainingTimeForTurn

()

# Returns: integer:nilable timeRemainingMs

GetTributeResultsWinnerInfo

()

# Returns: TributePlayerPerspective winningPlayerPerspective, TributeVictoryType victoryType

IsTributeTutorialGame

()

# Returns: bool isTutorial

CanSkipCurrentTributeTutorialStep

()

# Returns: bool canSkip

TrySkipCurrentTributeTutorialStep

()

GetTributePrestigeRequiredToWin

()

# Returns: integer requiredPrestige

GetTributeMechanicIconPath

(TributeMechanic mechanicType, integer param1, integer param2, integer param3)

# Returns: string iconPath

GetTributePatronRequirementIconPath

(TributePatronRequirement requirementType, integer param1, integer param2)

# Returns: string iconPath

GetTributeMechanicTargetingText

(TributeMechanic mechanicType, integer quantity, integer param1, integer param2, integer param3, string targetingFormatterOverrideText)

# Returns: string targetingText

GetTributePatronRequirementTargetingText

(TributePatronRequirement requirementType, integer quantity, integer param1, integer param2, string targetingFormatterOverrideText)

# Returns: string targetingText

GetNumTributePatrons

()

# Returns: integer numPatrons

GetTributePatronIdAtIndex

(luaindex index)

# Returns: integer patronId

GetTributeCardPortrait

(integer cardDefId)

# Returns: textureName portrait, textureName portraitGlow

GetTributeCardPortraitIcon

(integer cardDefId)

# Returns: textureName portraitIcon

GetTributePatronSuitAtlas

(integer patronId, TributeCardType cardType)

# Returns: textureName suitAtlas, textureName suitAtlasGlow

GetTributePatronCollectibleId

(integer patronId)

# Returns: integer collectibleId

GetTributePatronSuitIcon

(integer patronId)

# Returns: textureName suitIcon

GetTributePatronSmallIcon

(integer patronId)

# Returns: textureName smallIcon

GetTributePatronLargeIcon

(integer patronId)

# Returns: textureName largeIcon

GetTributePatronLargeRingIcon

(integer patronId)

# Returns: textureName largeRingIcon

GetTributeCardType

(integer cardDefId)

# Returns: TributeCardType cardType

GetTributeCardName

(integer cardDefId)

# Returns: string name

GetTributeCardAcquireCost

(integer cardDefId)

# Returns: TributeResource resource, integer quantity

GetTributeCardDefeatCost

(integer cardDefId)

# Returns: TributeResource resource, integer quantity

DoesTributeCardTaunt

(integer cardDefId)

# Returns: bool taunts

IsTributeCardContract

(integer cardDefId)

# Returns: bool isContract

IsTributeCardCurse

(integer cardDefId)

# Returns: bool isCurse

DoesTributeCardChooseOneMechanic

(integer cardDefId)

# Returns: bool chooseOneMechanic

DoesTributeCardHaveTriggerMechanic

(integer cardDefId)

# Returns: bool hasTriggerMechanic

DoesTributeCardHaveSetbackMechanic

(integer cardDefId)

# Returns: bool hasSetbackMechanic

GetTributeMechanicSetbackTypeForPlayer

(TributeMechanic mechanicType, TributePlayerPerspective targetPlayer)

# Returns: TributeMechanicSetbackType mechanicSetbackType

DoesTributeCardHaveMechanicType

(integer cardDefId, TributeMechanic mechanicType)

# Returns: bool hasMechanicType

GetTributeCardFlavorText

(integer cardDefId)

# Returns: string flavorText

GetTributeCardUpgradeHintText

(integer patronId, luaindex cardIndex)

# Returns: string updateHintText

GetTributeCardRarity

(integer cardDefId)

# Returns: ItemDisplayQuality itemRarity

GetNumTributeCardMechanics

(integer cardDefId, TributeMechanicActivationSource activationSource)

# Returns: integer numMechanics

GetTributeCardMechanicInfo

(integer cardDefId, TributeMechanicActivationSource activationSource, luaindex mechanicIndex)

# Returns: TributeMechanic mechanicType, integer quantity, integer comboNum, integer param1, integer param2, integer param3, integer triggerId, TributePlayerPerspective targetPlayer

GetTributeCardMechanicText

(integer cardDefId, TributeMechanicActivationSource activationSource, luaindex mechanicIndex, bool prependIcon)

# Returns: string mechanicText

GetTributeTriggerDescription

(integer triggerId)

# Returns: string description

GetTributePatronName

(integer patronId)

# Returns: string patronName

GetTributePatronRarity

(integer patronId)

# Returns: ItemDisplayQuality itemRarity

IsTributePatronNeutral

(integer patronId)

# Returns: bool isNeutral

GetTributePatronFamily

(integer patronId)

# Returns: integer family

DoesTributePatronSkipNeutralFavorState

(integer patronId)

# Returns: bool doesSkipNeutral

GetTributePatronCategoryId

(integer patronId)

# Returns: integer categoryId

GetTributePatronCategoryName

(integer categoryId)

# Returns: string categoryName

GetTributePatronCategoryGamepadIcon

(integer categoryId)

# Returns: textureName gamepadIcon

GetTributePatronCategoryKeyboardIcons

(integer categoryId)

# Returns: textureName unpressedButtonIcon, textureName pressedButtonIcon, textureName mouseoverButtonIcon

GetTributePatronCategorySortOrder

(integer categoryId)

# Returns: integer sortOrder

GetTributePatronLoreDescription

(integer patronId)

# Returns: string loreDescription

GetTributePatronPlayStyleDescription

(integer patronId)

# Returns: string playStyleDescription

GetTributePatronAcquireHint

(integer patronId)

# Returns: string acquireHint

GetNumTributePatronRequirementsForFavorState

(integer patronId, TributePatronPerspectiveFavorState favorState)

# Returns: integer numRequirements

GetTributePatronRequirementInfo

(integer patronId, TributePatronPerspectiveFavorState favorState, luaindex requirementIndex)

# Returns: TributePatronRequirement requirementType, integer quantity, integer param1, integer param2

GetTributePatronRequirementText

(integer patronId, TributePatronPerspectiveFavorState favorState, luaindex requirementIndex)

# Returns: string requirementText

GetTributePatronRequirementsText

(integer patronId, TributePatronPerspectiveFavorState favorState)

# Returns: string requirementsText

GetNumTributePatronMechanicsForFavorState

(integer patronId, TributePatronPerspectiveFavorState favorState)

# Returns: integer numMechanics

GetTributePatronMechanicInfo

(integer patronId, TributePatronPerspectiveFavorState favorState, luaindex mechanicIndex)

# Returns: TributeMechanic mechanicType, integer quantity, integer param1, integer param2, integer param3

GetTributePatronMechanicText

(integer patronId, TributePatronPerspectiveFavorState favorState, luaindex mechanicIndex, bool prependIcon)

# Returns: string mechanicText

GetTributePatronMechanicsText

(integer patronId, TributePatronPerspectiveFavorState favorState)

# Returns: string mechanicsText

GetNumTributePatronPassiveMechanicsForFavorState

(integer patronId, TributePatronPerspectiveFavorState favorState)

# Returns: integer numPassiveMechanics

GetTributePatronPassiveMechanicInfo

(integer patronId, TributePatronPerspectiveFavorState favorState, luaindex mechanicIndex)

# Returns: TributeMechanic mechanicType, integer quantity, integer param1, integer param2, integer param3, integer triggerId

GetTributePatronPassiveMechanicText

(integer patronId, TributePatronPerspectiveFavorState favorState, luaindex mechanicIndex, bool prependIcon)

# Returns: string passiveMechanicText

GetTributePatronNumStarterCards

(integer patronId)

# Returns: integer numStarterCards

GetTributePatronStarterCardIdByIndex

(integer patronId, luaindex cardIndex)

# Returns: integer cardId

GetTributePatronNumDockCards

(integer patronId)

# Returns: integer numStarterCards

GetTributePatronDockCardInfoByIndex

(integer patronId, luaindex cardIndex)

# Returns: integer baseCardId, integer upgradeCardId, integer quantity

GetTributePlayerClubRank

()

# Returns: TributeClubRank tributeClubRank

GetTributePlayerClubTotalExperience

()

# Returns: integer totalTributeClubExperience

GetTributeClubRankExperienceRequirement

(TributeClubRank tributeClubRank)

# Returns: integer experienceRequirement

GetTributeClubRankNPCSkillLevelEquivalent

(TributeClubRank tributeClubRank)

# Returns: TributeNPCSkillLevel npcSkillLevel

GetTributePlayerExperienceInCurrentClubRank

()

# Returns: integer experience, integer clubRankRequirement

GetClubMatchResultFromHistoryByIndex

(integer matchIndex)

# Returns: bool wasAWin

GetClubMatchResultFromHistoryByMatchNumber

(integer matchIndex)

# Returns: bool hasRecord, bool wasAWin

GetTotalClubMatchesPlayed

()

# Returns: integer totalMatchesPlayed

GetCurrentClubMatchStreak

()

# Returns: integer currentStreak

GetTributePlayerCampaignRank

(id64:nilable campaignKey)

# Returns: TributeTier tributeCampaignRank

GetTributePlayerCampaignTotalExperience

(id64:nilable campaignKey)

# Returns: integer totalTributeCampaignExperience

GetTributeCampaignRankExperienceRequirement

(TributeTier tributeCampaignRank, id64:nilable campaignKey)

# Returns: integer experienceRequirement

GetTributePlayerExperienceInCurrentCampaignRank

(id64:nilable campaignKey)

# Returns: integer experience, integer rankExperienceRequirement

GetCampaignMatchResultFromHistoryByMatchIndex

(luaindex matchIndex, id64:nilable campaignKey)

# Returns: bool hasRecord, bool wasAWin

GetTotalCampaignMatchesPlayed

(id64:nilable campaignKey)

# Returns: integer totalMatchesPlayed

GetCurrentCampaignMatchStreak

(id64:nilable campaignKey)

# Returns: integer currentStreak

IsPlacedInCampaign

(id64:nilable campaignKey)

# Returns: bool isPlaced

GetCampaignPlacementRank

(id64:nilable campaignKey)

# Returns: TributeTier tributeCampaignRank

GetNumRequiredPlacementMatches

(id64:nilable campaignKey)

# Returns: integer requiredMatches

GetActiveTributeCampaignKey

()

# Returns: id64 tributeCampaignKey

GetActiveTributeCampaignTierRewardListId

(TributeTier tributeCampaignRank)

# Returns: integer rewardListId

GetActiveTributeCampaignLeaderboardTierRewardListId

(TributeLeaderboardTier tributeCampaignRank)

# Returns: integer rewardListId

RequestTributeClubData

()

# Returns: TributePlayerInitializationState state

RequestActiveTributeCampaignData

()

# Returns: TributePlayerInitializationState state

RequestTributeCampaignData

(id64:nilable campaignKey)

# Returns: TributePlayerInitializationState state

GetActiveTributeCampaignTimeRemainingS

()

# Returns: integer timeRemainingS

HasActiveCampaignStarted

()

# Returns: bool hasStarted

GetTributeLeaderboardRankInfo

()

# Returns: integer playerLeaderboardRank, integer totalLeaderboardSize

GetActivitySetRewardData

(integer activitySetId)

# Returns: integer rewardUIDataId, integer xpReward

GetNumLFGActivityRewardUINodes

(integer rewardUIDataId)

# Returns: integer numNodes

GetLFGActivityRewardUINodeInfo

(integer rewardUIDataId, luaindex nodeIndex)

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

GetLFGActivityRewardDescriptionOverride

(integer rewardUIDataId)

# Returns: string descriptionOverride

GetMailAttachmentInfo

(id64 mailId)

# Returns: integer numAttachments, integer attachedMoney, integer codAmount

GenerateCraftedAbilityScriptSlotDescriptionForAbilityDescription

(integer abilityId, ScribingSlot slotType, string casterUnitTag)

# Returns: string description

IsPromotionalEventSystemLocked

()

# Returns: bool isLocked

GetNumActivePromotionalEventCampaigns

()

# Returns: integer numActiveCampaigns

GetActivePromotionalEventCampaignKey

(luaindex campaignIndex)

# Returns: id64 campaignKey

GetSecondsRemainingInPromotionalEventCampaign

(id64 campaignKey)

# Returns: integer secondsRemaining

GetPromotionalEventCampaignInfo

(id64 campaignKey)

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