API:GetIgnoreList

UI Lua API · Social functions
Version: WAR 1.4.8

Returns the player's ignore list.

ignored = GetIgnoreList()

Arguments

None.

Returns

ignored

table – Array of player tables, indexed from 1. Empty if the list is empty.

Each player table has these fields:

Key	Type	Meaning
name	wstring	Character name.
rank	number	Character rank (level).
careerID	number	Career id.
careerName	wstring	Career name. The stock UI treats L"" as "details unknown" and hides the rank.
zoneID	number	Zone the player is in.
guildName	wstring	Guild name.

Details

• The list is the client's copy; the function does not contact the server.
• Names added with AddTemporaryIgnore are kept in a separate list and are not returned here.
• A new table is built on every call.

Errors

None.

Example

From default/ea_socialwindow/source/socialwindowtabignore.lua:

local IgnoreListData = GetIgnoreList()

if ( IgnoreListData ~= nil ) then
    for key, value in ipairs( IgnoreListData )
    do
        SocialWindowTabIgnore.playerListData[key] = {}
        SocialWindowTabIgnore.playerListData[key].name = value.name
        SocialWindowTabIgnore.playerListData[key].career = value.careerName
        if (value.careerName == L"") then
            SocialWindowTabIgnore.playerListData[key].rankString = L""
        else
            SocialWindowTabIgnore.playerListData[key].rankString = L""..value.rank
        ...

See also

• GetFriendsList
• AddTemporaryIgnore