View source for API:GetIgnoreList

{{LuaApi|group=Social}}
Returns the player's ignore list.

<pre>
ignored = GetIgnoreList()
</pre>

== Arguments ==
None.

== Returns ==
;ignored : <code>table</code> – Array of player tables, indexed from 1. Empty if the list is empty.

Each player table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Character name.
|-
| <code>rank</code> || <code>number</code> || Character rank (level).
|-
| <code>careerID</code> || <code>number</code> || Career id.
|-
| <code>careerName</code> || <code>wstring</code> || Career name. The stock UI treats <code>L""</code> as "details unknown" and hides the rank.
|-
| <code>zoneID</code> || <code>number</code> || Zone the player is in.
|-
| <code>guildName</code> || <code>wstring</code> || Guild name.
|}

== Details ==
* The list is the client's copy; the function does not contact the server.
* Names added with [[API:AddTemporaryIgnore|AddTemporaryIgnore]] are kept in a separate list and are not returned here.
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_socialwindow/source/socialwindowtabignore.lua</code>:
<pre>
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
        ...
</pre>

== See also ==
* [[API:GetFriendsList|GetFriendsList]]
* [[API:AddTemporaryIgnore|AddTemporaryIgnore]]