https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetGuildPermissionDataAPI:GetGuildPermissionData - Revision history2026-10-18T04:53:33ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetGuildPermissionData&diff=30396&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:53Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Game}}<br />
Returns the player's guild ranks (titles) and the permissions of each.<br />
<br />
<pre><br />
ranks = GetGuildPermissionData()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;ranks : <code>table</code> – Array of rank tables, indexed from 1.<br />
<br />
Each rank table has these fields:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>rankID</code> || <code>number</code> || Rank number.<br />
|-<br />
| <code>rankTitle</code> || <code>wstring</code> || Title of the rank.<br />
|-<br />
| <code>rankUsed</code> || <code>boolean</code> || <code>true</code> if the rank is enabled.<br />
|-<br />
| <code>rankQty</code> || <code>number</code> || Number of guild members with this rank.<br />
|-<br />
| <code>0</code>, <code>1</code>, <code>2</code>, … || <code>boolean</code> || Permission flags, keyed by permission index from 0 (at most 62 flags).<br />
|}<br />
<br />
== Details ==<br />
* The permission flags are stored directly in the rank table with numeric keys. Index the table with a permission number to test it.<br />
* The stock UI indexes the result with a member's <code>statusNumber + 1</code> (see [[API:GetGuildMemberData|GetGuildMemberData]]) and checks it for <code>nil</code> before use.<br />
* <code>rankQty</code> is counted from the current guild roster each time the function is called.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
Testing a permission, from <code>ea_guildwindow/source/guildwindowtabadmin.lua</code>:<br />
<pre><br />
local guildPermissionData = GetGuildPermissionData()<br />
if( guildPermissionData ~= nil and guildPermissionData[statusNumber + 1] ~= nil ) then<br />
local playerPermissions = guildPermissionData[statusNumber + 1] -- StatusNumbers are 0-9, but the LUA tables are 1-10]<br />
return playerPermissions[permissionIndex]<br />
end<br />
</pre><br />
<br />
Listing the ranks, from the same file:<br />
<pre><br />
for key, value in ipairs( guildPermissionData )<br />
...<br />
LabelSetText( qtyWindow, L""..value.rankQty )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetGuildMemberData|GetGuildMemberData]]</div>Maintenance script