https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ASendPlayerSearchRequestAPI:SendPlayerSearchRequest - Revision history2026-10-17T16:47:25ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:SendPlayerSearchRequest&diff=30705&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:48:47Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Social}}<br />
Asks the server for a list of players matching search criteria.<br />
<br />
<pre><br />
SendPlayerSearchRequest(name, guildName, careerName, zoneIds, minRank, maxRank, advisorsOnly)<br />
</pre><br />
<br />
== Arguments ==<br />
;name : <code>wstring</code> – Player name to search for; <code>L""</code> for any.<br />
;guildName : <code>wstring</code> – Guild name to search for; <code>L""</code> for any.<br />
;careerName : <code>wstring</code> – Career name; <code>L""</code> for any.<br />
;zoneIds : <code>number-table</code> – List of zone ids to search. The stock UI passes <code>{ -1 }</code> to search all zones.<br />
;minRank : <code>number</code> – Lowest rank. Sent as an 8-bit value.<br />
;maxRank : <code>number</code> – Highest rank. Sent as an 8-bit value.<br />
;advisorsOnly : <code>boolean</code> – State of the stock UI's "include advisors only" check box.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* 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.<br />
* If <code>minRank</code> is greater than <code>maxRank</code>, the two are swapped.<br />
* The results are read with [[API:GetSearchList|GetSearchList]].<br />
* If there is no player object, or the Lua state is not available, nothing is sent.<br />
* The function needs at least seven arguments and only reads the last seven. <code>advisorsOnly</code> must be a real boolean.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.<br />
<br />
== Example ==<br />
From <code>default/ea_socialwindow/source/socialwindowtabsearch.lua</code>:<br />
<pre><br />
local includeAdvisorsOnly = ButtonGetPressedFlag( "SocialWindowTabSearchIncludeAdvisorsOnlyButton" )<br />
<br />
SendPlayerSearchRequest(SocialWindowTabSearchEditBoxPlayerName.Text,<br />
SocialWindowTabSearchEditBoxGuildName.Text,<br />
SocialWindowTabSearchEditBoxCareerName.Text,<br />
SocialWindowTabSearch.ZoneID,<br />
minRank, maxRank,<br />
includeAdvisorsOnly)<br />
</pre><br />
The stock UI clamps the ranks to 1–40 first; a comment there notes that the server only ignores -1 values.<br />
<br />
== See also ==<br />
* [[API:GetSearchList|GetSearchList]]</div>Maintenance script