UnitTag

From ESOUI Wiki

A unitTag is a string which is sent as parameter or result for all functions using them. Function then returns different values depending of the given parameter. Please note that some functions are limited to some unitTag for security or conception reasons. UnitTags can also be sent by events. Group share the groupX tag's so group1 unitTag leads to same userName on every group member.

List

• player : The local player

This unitTag don't have any restrictions on functions

Following events are not sent for this unitTag :

• companion : The summoned companion

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

• reticleover : The target of the reticle

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

• reticleovertarget : The target of reticleover

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

• groupX : The group member with corresponding number. The value is a number between 1 and GROUP_SIZE_MAX

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

• groupXcompanion : The group member-companion with corresponding number. The value is a number between 1 and GROUP_SIZE_MAX

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

• bossX : The boss with corresponding number. The value is a number between 1 and MAX_BOSSES

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

• interact : The NPC, player or item which interact with the player

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

• playerpetX : The summoned pet with the corresponding number. The value is a number between 1 and MAX_PET_UNIT_TAGS

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

• worldeventX : The world event with the corresponding number. The value is a number between 1 and MAX_WORLD_EVENT_UNITS

Following functions returns nil or empty value for this unitTag :

Following events are not sent for this unitTag :

Events

List is up to date to API 100017.

For a detailled list, please see API page -> current API version -> API TXT Documentation file

• EVENT_TITLE_UPDATE
• EVENT_RANK_POINT_UPDATE
• EVENT_CHAMPION_POINT_UPDATE
• EVENT_DISGUISE_STATE_CHANGED
• EVENT_EFFECT_CHANGED
• EVENT_POWER_UPDATE
• EVENT_STEALTH_STATE_CHANGED
• EVENT_TARGET_CHANGED
• EVENT_UNIT_ATTRIBUTE_VISUAL_ADDED
• EVENT_UNIT_ATTRIBUTE_VISUAL_REMOVED
• EVENT_UNIT_ATTRIBUTE_VISUAL_UPDATED
• EVENT_UNIT_CREATED
• EVENT_UNIT_DESTROYED
• EVENT_EXPERIENCE_UPDATE
• EVENT_LEVEL_UPDATE
• EVENT_STATS_UPDATED
• EVENT_GROUP_MEMBER_CONNECTED_STATUS
• EVENT_GROUP_MEMBER_IN_REMOTE_REGION
• EVENT_GROUP_MEMBER_ROLES_CHANGED
• EVENT_GROUP_SUPPORT_RANGE_UPDATE
• EVENT_LEADER_UPDATE
• EVENT_UNIT_FRAME_UPDATE
• EVENT_UNIT_DEATH_STATE_CHANGED
• EVENT_ZONE_UPDATE
• EVENT_VETERAN_DIFFICULTY_CHANGED
• EVENT_DISPOSITION_UPDATE
• EVENT_FINESSE_RANK_CHANGED

Functions

List is up to date to API 100017. For a detailled list, please see API page -> current API version -> API TXT Documentation file

• DoesUnitExist(string unitTag)
  • Returns: boolean exists

• GetUnitName(string unitTag)
  • Returns: string name

• GetRawUnitName(string unitTag)
  • Returns: string rawName

• GetUnitDisplayName(string unitTag)
  • Returns: string displayName (@name)

• GetUnitGender(string unitTag)
  • Returns: number Gender gender

• GetUnitNameHighlightedByReticle()
  • Returns: string name

• GetUnitClass(string unitTag)
  • Returns: string className

• GetUnitClassId(string unitTag)
  • Returns: number classId

• GetUnitLevel(string unitTag)
  • Returns: number level

• GetUnitChampionPoints(string unitTag)
  • Returns: number championPoints

• GetUnitEffectiveChampionPoints(string unitTag)
  • Returns: number championPoints

• CanUnitGainChampionPoints(string unitTag)
  • Returns: boolean canGainChampionPoints

• GetUnitEffectiveLevel(string unitTag)
  • Returns: number level

• GetUnitZone(string unitTag)
  • Returns: string zoneName

• GetUnitZoneIndex(string unitTag)
  • Returns: number:nilable zoneIndex

• GetUnitXP(string unitTag)
  • Returns: number exp

• GetUnitXPMax(string unitTag)
  • Returns: number maxExp

• IsUnitChampion(string unitTag)
  • Returns: boolean isChampion

• IsUnitUsingVeteranDifficulty(string unitTag)
  • Returns: boolean isVeteranDifficulty

• IsUnitBattleLeveled(string unitTag)
  • Returns: boolean isBattleLeveled

• IsUnitChampionBattleLeveled(string unitTag)
  • Returns: boolean isChampBattleLeveled

• GetUnitBattleLevel(string unitTag)
  • Returns: number battleLevel

• GetUnitChampionBattleLevel(string unitTag)
  • Returns: number champBattleLevel

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

• IsUnitInGroupSupportRange(string unitTag)
  • Returns: boolean result

• GetUnitType(string unitTag)
  • Returns: number type

• CanUnitTrade(string unitTag)
  • Returns: boolean canTrade

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

• IsUnitGrouped(string unitTag)
  • Returns: boolean isGrouped

• IsUnitGroupLeader(string unitTag)
  • Returns: boolean isGroupLeader

• IsUnitSoloOrGroupLeader(string unitTag)
  • Returns: boolean isSoloOrGroupLeader

• GetGroupLeaderUnitTag()
  • Returns: string leaderUnitTag

• IsUnitFriend(string unitTag)
  • Returns: boolean isOnFriendList

• IsUnitIgnored(string unitTag)
  • Returns: boolean isIgnored

• IsUnitPlayer(string unitTag)
  • Returns: boolean isPlayer

• IsUnitPvPFlagged(string unitTag)
  • Returns: boolean isPvPFlagged

• IsUnitAttackable(string unitTag)
  • Returns: boolean attackable

• IsUnitJusticeGuard(string unitTag)
  • Returns: boolean isJusticeGuard

• IsUnitInvulnerableGuard(string unitTag)
  • Returns: boolean isInvulnerableGuard

• GetUnitAlliance(string unitTag)
  • Returns: number alliance

• AreUnitsCurrentlyAllied(string unitTag1, string unitTag2)
  • Returns: boolean allied

• GetUnitRace(string unitTag)
  • Returns: string race

• GetUnitRaceId(string unitTag)
  • Returns: number raceId

• IsUnitFriendlyFollower(string unitTag)
  • Returns: boolean isFollowing

• GetUnitReaction(string unitTag)
  • Returns: number UnitReactionType unitReaction

• GetUnitAvARankPoints(string unitTag)
  • Returns: number AvARankPoints

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

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

• IsUnitInCombat(string unitTag)
  • Returns: boolean isInCombat

• IsUnitDead(string unitTag)
  • Returns: boolean isDead

• IsUnitReincarnating(string unitTag)
  • Returns: boolean isReincarnating

• IsUnitDeadOrReincarnating(string unitTag)
  • Returns: boolean isDead

• IsUnitSwimming(string unitTag)
  • Returns: boolean isSwimming

• IsUnitResurrectableByPlayer(string unitTag)
  • Returns: boolean isResurrectable

• IsUnitBeingResurrected(string unitTag)
  • Returns: boolean isBeingResurrected

• DoesUnitHaveResurrectPending(string unitTag)
  • Returns: boolean hasResurrectPending

• GetUnitStealthState(string unitTag)
  • Returns: number stealthState

• GetUnitDisguiseState(string unitTag)
  • Returns: number disguiseState

• GetUnitHidingEndTime(string unitTag)
  • Returns: number endTime

• IsUnitOnline(string unitTag)
  • Returns: boolean isOnline

• IsUnitInspectableSiege(string unitTag)
  • Returns: boolean isInspectableSiege

• IsUnitInDungeon(string unitTag)
  • Returns: boolean isInDungeon

• GetUnitCaption(string unitTag)
  • Returns: string caption

• GetUnitSilhouetteTexture(string unitTag)
  • Returns: string icon

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

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

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

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

• GetUnitDifficulty(string unitTag)
  • Returns: number UIMonsterDifficulty difficult

• GetUnitTitle(string unitTag)
  • Returns: string title

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

• GetNumBuffs(string unitTag)
  • Returns: number numBuffs

• GroupInvite(string unitTag)

• GroupKick(string unitTag)

• GroupPromote(string unitTag)

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

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

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

• CanJumpToGroupMember(string unitTag)
  • Returns: boolean canJump, number JumpToPlayerResult result

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

• GetGroupIndexByUnitTag(string unitTag)
  • Returns: number sortIndex

• IsGroupMemberInRemoteRegion(string unitTag)
  • Returns: boolean inRemoteRegion

• GetGroupMemberAssignedRole(string unitTag)
  • Returns: number LFGRole assignedRole

• GetGroupElectionInfo()
  • Returns: number GroupElectionType electionType, number timeRemainingSeconds, string electionDescriptor, string targetUnitTag

• BeginGroupElection(number GroupElectionType electionType, string electionDescriptor, string targetUnitTag)

• GenerateUnitNameTooltipLine(string unitTag)
  • Returns: string text, number InterfaceColorType interfaceColorType, number color

• GenerateMapPingTooltipLine(number MapDisplayPinType mapPingType, string unitTag)
  • Returns: string text, number InterfaceColorType interfaceColorType, number color

• • Returns: boolean sentSuccessfully