Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:09Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Social}}
Returns the player's bragging rights (Tome of Knowledge entries shown to other players) and bragging-rights card slots.

<pre>
brags, cards = GetBraggingRights()
</pre>

== Arguments ==
None.

== Returns ==
;brags : <code>table</code> – Array of 10 brag tables, one per slot.
;cards : <code>table</code> – Array of 6 tables, one per card slot. Each has one field, <code>id</code> (<code>number</code>), the value set with [[API:SetBraggingRightsCard|SetBraggingRightsCard]].

Each brag table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Tome entry id in the slot. 0 for an empty slot.
|-
| <code>name</code> || <code>wstring</code> || Name of the tome entry.
|-
| <code>cardId</code> || <code>number</code> || Id of the card that belongs to the entry, or 0. The stock UI passes it to <code>TomeGetCardData</code>.
|-
| <code>rewards</code> || <code>table</code> || Only present when the entry has reward data. Array of up to two reward tables with <code>rewardType</code> (<code>number</code>) and <code>rewardId</code> (<code>number</code>). The first one always has <code>rewardType</code> 0.
|}

== Details ==
* Both tables always have all their entries (10 and 6), including empty slots.
* The data is the client's local copy. [[API:SetBraggingRight|SetBraggingRight]] and [[API:SetBraggingRightsCard|SetBraggingRightsCard]] change it at once and fire <code>SystemData.Events.SOCIAL_BRAGGING_RIGHTS_UPDATED</code>.

== Errors ==
None.

== Example ==
From <code>default/ea_characterwindow/source/characterwindowbrags.lua</code>:
<pre>
CharacterWindow.braggingRights = GetBraggingRights()

for index, brag in ipairs( CharacterWindow.braggingRights )
do
...
LabelSetText( windowName.."Text", brag.name )

-- set the reward data
if( not brag.rewards )
then
WindowSetShowing( windowName.."Reward1", false )
WindowSetShowing( windowName.."Reward2", false )
else
TomeWindow.SetTomeReward( windowName.."Reward1", brag.rewards[1] )
TomeWindow.SetTomeReward( windowName.."Reward2", brag.rewards[2] )
...
</pre>

Reading both results, from <code>default/ea_tomeofknowledge/source/tomewindow.lua</code>:
<pre>
TomeWindow.braggingRights, TomeWindow.braggingRightsCards = GetBraggingRights()
WindowRegisterEventHandler( "TomeWindow", SystemData.Events.SOCIAL_BRAGGING_RIGHTS_UPDATED, "TomeWindow.OnBraggingRightsUpdated")
</pre>

== See also ==
* [[API:SetBraggingRight|SetBraggingRight]]
* [[API:SetBraggingRightsCard|SetBraggingRightsCard]]
* [[API:GetInspectionBragData|GetInspectionBragData]]

API:GetBraggingRights - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)