API:EA Window HelpGetHelpTipsList

UI Lua API · Help functions
Version: WAR 1.4.8

Returns the list of help tips known to the client.

tips = EA_Window_HelpGetHelpTipsList()

Arguments

None.

Returns

tips

table – Array of tip tables, indexed from 1.

Each tip table has one field:

Key	Type	Meaning
unlockId	number	Id of the tip. The stock UI subtracts HelpTips.INDEX_OFFSET from it to find the tip's name in the HelpTipNames string table.

Details

• The ids come from a fixed table in the client with room for 255 entries. The list stops at the first empty (0) slot.
• The list has no names or texts; the stock tips window looks them up itself (see the example).
• A new table is built on every call.
• Arguments are not checked; anything passed is ignored.

Errors

None.

Example

From ea_helpwindow/source/tipswindow.lua:

local function InitListData()
    TipsWindow.data = EA_Window_HelpGetHelpTipsList()
    for dataIndex, tipData in ipairs(TipsWindow.data)
    do
        tipData.sortId = dataIndex

        local stringId = tipData.unlockId - HelpTips.INDEX_OFFSET
        tipData.name = GetStringFromTable("HelpTipNames", stringId )
    end
end

See also

• EA_Window_HelpGetTopicList
• GetStringFromTable