Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:30Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Guild}}
Returns the recruitment profile of the player's guild, as last received from the server.

<pre>
profile = GuildRecruitmentProfileGetData()
</pre>

== Arguments ==
None.

== Returns ==
;profile : <code>table</code> – The guild's recruitment profile.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Guild id. The stock UI builds <code>L"GUILD:"..profile.id</code> hyperlinks from it.
|-
| <code>name</code> || <code>wstring</code> || Guild name.
|-
| <code>allianceName</code> || <code>wstring</code> || Name of the guild's alliance.
|-
| <code>guildLeader</code> || <code>wstring</code> || Name of the guild leader.
|-
| <code>desc</code> || <code>wstring</code> || Brief description.
|-
| <code>summary</code> || <code>wstring</code> || Public summary.
|-
| <code>playStyle</code> || <code>number</code> || Play style, compared with <code>GameData.Recruitment.PlayStyleFlag</code> values. The client adds 1 to the stored value.
|-
| <code>atmosphere</code> || <code>number</code> || Atmosphere, compared with <code>GameData.Recruitment.AtmosphereFlag</code> values. The client adds 1 to the stored value.
|-
| <code>rank</code> || <code>number</code> || Guild rank.
|-
| <code>playersTotal</code> || <code>number</code> || Number of members.
|-
| <code>playersOnline</code> || <code>number</code> || Number of members online.
|-
| <code>tiersNeeded</code> || <code>table</code> || Booleans keyed 1–6, indexed by <code>GameData.Recruitment.TierFlag</code> values.
|-
| <code>careersNeeded</code> || <code>table</code> || Booleans keyed 0–24, indexed by <code>GameData.Recruitment.CareerFlags</code> values.
|-
| <code>interests</code> || <code>table</code> || Booleans keyed 1–7, indexed by <code>GameData.Recruitment.InterestFlag</code> values.
|-
| <code>recruitingStatus</code> || <code>table</code> || Booleans keyed 1–5, indexed by <code>GameData.Recruitment.RecruitingFlag</code> values.
|-
| <code>recruiters</code> || <code>table</code> || Array of recruiter tables, each with <code>name</code> (<code>wstring</code>) and <code>desc</code> (<code>wstring</code>).
|-
| <code>keep</code> || <code>table</code> || Table with <code>idNum</code> (<code>number</code>) and <code>zoneNum</code> (<code>number</code>).
|}

== Details ==
* The table is built from the profile the client stores for the player's own guild. The function does not contact the server. The stock UI refreshes its recruitment tab when <code>SystemData.Events.GUILD_RECRUITMENT_PROFILE_UPDATED</code> fires.
* Each key of the flag sub-tables holds <code>true</code> or <code>false</code>.
* The stock UI also passes the result to <code>EA_ChatWindow.InsertGuildLink</code> when the guild link is shift-clicked.
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_guildwindow/source/guildwindowtabrecruitprofile.lua</code>:
<pre>
local profileData = GuildRecruitmentProfileGetData()
...
local pressed = profileData.recruitingStatus[ statusData.flagId ]
ButtonSetPressedFlag( windowName.."Button", pressed )
...
TextEditBoxSetText( "GWRecruitProfileDescEditBox", profileData.desc )
TextEditBoxSetText( "GWRecruitProfileSummaryEditBox", profileData.summary )
</pre>

== See also ==
* [[API:GuildRecruitmentProfileSetData|GuildRecruitmentProfileSetData]]
* [[API:GuildRecruitmentSearch|GuildRecruitmentSearch]]

API:GuildRecruitmentProfileGetData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)