API:GetInspectionBragData

UI Lua API · Social functions
Version: WAR 1.4.8

Returns the bragging rights of the player being inspected.

brags = GetInspectionBragData()

Arguments

None.

Returns

brags

table – Array of 10 brag tables, one per slot.

Each brag table has these fields:

Key	Type	Meaning
id	number	Tome entry id in the slot. 0 for an empty slot.
name	wstring	Name of the tome entry.
cardData	table	Data of the card that belongs to the entry. Empty when the entry has no card. The stock UI checks cardData.cardId and passes the table to TomeWindow.SetCard, the same function it uses for TomeGetCardData results.
rewards	table	Only present when the entry has reward data. Array of up to two reward tables with rewardType (number) and rewardId (number). The first one always has rewardType 0. The second one also has a rewardData table with the details of an item (types 4 and 7), tactic (type 3) or title (type 1) reward.

Details

• The data is the client's copy of the last inspection result. Use SendPlayerInspectionRequest to ask the server for it.
• Unlike GetBraggingRights, the card is returned as a full cardData table instead of a cardId, and the second reward carries rewardData.
• The table always has 10 entries.

Errors

None.

Example

From default/ea_inspectionwindow/source/inspectionwindow.lua:

EA_Window_Inspection.bragData = GetInspectionBragData()

for index, brag in ipairs( EA_Window_Inspection.bragData )
do
    ...
    LabelSetText( windowName.."Text", brag.name )
    ...
    -- Set the card if there is one
    local cardData = nil
    if( brag.cardData.cardId and brag.cardData.cardId ~= 0 )
    then
        cardData = brag.cardData
    end
    TomeWindow.SetCard( windowName.."Card", cardData )
end

See also

• GetInspectionData
• GetBraggingRights
• SendPlayerInspectionRequest