https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGuildRecruitmentSearchAPI:GuildRecruitmentSearch - Revision history2026-10-18T04:53:52ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GuildRecruitmentSearch&diff=30498&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:45:31Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Guild}}<br />
Asks the server for a list of guilds that match recruitment search criteria.<br />
<br />
<pre><br />
GuildRecruitmentSearch(playStyle, atmosphere, searchType, isRecruitingPlayer, minTotalPlayers, minOnlinePlayers, minGuildRank)<br />
</pre><br />
<br />
== Arguments ==<br />
;playStyle : <code>number</code> – A <code>GameData.Recruitment.PlayStyleFlag</code> value.<br />
;atmosphere : <code>number</code> – A <code>GameData.Recruitment.AtmosphereFlag</code> value.<br />
;searchType : <code>number</code> – A <code>GameData.Recruitment.RecruitingFlag</code> value.<br />
;isRecruitingPlayer : <code>boolean</code> – State of the stock UI's "is recruiting player" check box.<br />
;minTotalPlayers : <code>number</code> – Minimum number of members (0 = any). Sent as a 16-bit value.<br />
;minOnlinePlayers : <code>number</code> – Minimum number of members online (0 = any). Sent as a 16-bit value.<br />
;minGuildRank : <code>number</code> – Minimum guild rank. Sent as an 8-bit value.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* <code>playStyle</code>, <code>atmosphere</code> and <code>searchType</code> are sent minus 1.<br />
* The results are not returned by this function. The stock UI receives them in its handler for <code>SystemData.Events.GUILD_RECRUITMENT_SEARCH_RESULTS_UPDATED</code>, which takes a results table, and keeps its Search button disabled until they arrive.<br />
* <code>isRecruitingPlayer</code> must be a real boolean.<br />
* The function needs at least seven arguments and only reads the last seven.<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_guildwindow/source/guildwindowtabrecruitsearch.lua</code>:<br />
<pre><br />
GuildRecruitmentSearch( playStyle,<br />
atmosphere,<br />
searchType,<br />
isRecruitingPlayer,<br />
minTotalPlayers,<br />
minOnlinePlayers,<br />
minGuildRank )<br />
<br />
-- Disable the Search Button<br />
GuildWindowTabRecruit.Search.waitingForSearchResults = true<br />
ButtonSetDisabledFlag( "GWRecruitSearchSearchButton", true )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GuildRecruitmentProfileGetData|GuildRecruitmentProfileGetData]]<br />
* [[API:GuildRecruitmentProfileSetData|GuildRecruitmentProfileSetData]]</div>Maintenance script