View source for API:SendPlayerSearchRequest

{{LuaApi|group=Social}}
Asks the server for a list of players matching search criteria.

<pre>
SendPlayerSearchRequest(name, guildName, careerName, zoneIds, minRank, maxRank, advisorsOnly)
</pre>

== Arguments ==
;name : <code>wstring</code> – Player name to search for; <code>L""</code> for any.
;guildName : <code>wstring</code> – Guild name to search for; <code>L""</code> for any.
;careerName : <code>wstring</code> – Career name; <code>L""</code> for any.
;zoneIds : <code>number-table</code> – List of zone ids to search. The stock UI passes <code>{ -1 }</code> to search all zones.
;minRank : <code>number</code> – Lowest rank. Sent as an 8-bit value.
;maxRank : <code>number</code> – Highest rank. Sent as an 8-bit value.
;advisorsOnly : <code>boolean</code> – State of the stock UI's "include advisors only" check box.

== Returns ==
Nothing.

== Details ==
* The client turns <code>careerName</code> into a career line id by matching it against the male and female career line names. An empty or unmatched name is sent as 0.
* If <code>minRank</code> is greater than <code>maxRank</code>, the two are swapped.
* The results are read with [[API:GetSearchList|GetSearchList]].
* If there is no player object, or the Lua state is not available, nothing is sent.
* The function needs at least seven arguments and only reads the last seven. <code>advisorsOnly</code> must be a real boolean.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.

== Example ==
From <code>default/ea_socialwindow/source/socialwindowtabsearch.lua</code>:
<pre>
local includeAdvisorsOnly = ButtonGetPressedFlag( "SocialWindowTabSearchIncludeAdvisorsOnlyButton" )

SendPlayerSearchRequest(SocialWindowTabSearchEditBoxPlayerName.Text,
                        SocialWindowTabSearchEditBoxGuildName.Text,
                        SocialWindowTabSearchEditBoxCareerName.Text,
                        SocialWindowTabSearch.ZoneID,
                        minRank, maxRank,
                        includeAdvisorsOnly)
</pre>
The stock UI clamps the ranks to 1–40 first; a comment there notes that the server only ignores -1 values.

== See also ==
* [[API:GetSearchList|GetSearchList]]