GetFriendCharacterInfo
ESO Lua API function — used by 43 of the 3,030 addons we indexed (combined 5,435,172 downloads). Signature from the official ESOUIDocumentation.txt, API version 101050.
Official signature
GetFriendCharacterInfo(luaindex friendIndex)Returns: bool hasCharacter, string characterName, string zoneName, integer classType, alliance, integer level, integer championRank, integer zoneId, id64 consoleId
Real usage — from pChat (Chat customization & help: look/notification/sound/automation/history)
if accountNameGuildOrFriend ~= nil and friendIndex ~= nil then
local hasCharacter, charName, _zoneName, _classType, _alliance, level, championRank = GetFriendCharacterInfo(friendIndex)
Short excerpt from the shipping addon pChat (Chat customization & help: look/notification/sound/automation/history) — its ESOUI page; the code belongs to its author. Shown because documentation without a working example is half a reference.
Most-downloaded addons using it
| Addon | Total downloads |
|---|---|
| pChat (Chat customization & help: look/notification/sound/automation/history) | 1,832,805 |
| Port to Friend's House | 1,303,975 |
| OdySupportIcons - Group Role Icons & More | 484,590 |
| Faster Travel (Wayshrines menu & Teleporter) | 369,697 |
| EasyTravel | 293,327 |
| AutoInvite - Updated | 229,026 |