Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:17Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Help}}
Returns the answer text of one FAQ entry.

<pre>
entry = EA_Window_HelpGetFAQEntryData(entryId)
</pre>

== Arguments ==
;entryId : <code>number</code> – Entry id, the <code>id</code> field of an entry from the <code>entries</code> list of [[API:EA_Window_HelpGetFAQTopicList|EA_Window_HelpGetFAQTopicList]]. Fractions are dropped.

== Returns ==
;entry : <code>table</code> – A table with one field:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>text</code> || <code>wstring</code> || The answer text. Empty if the client's FAQ text list is not loaded.
|}

== Details ==
* The client looks the entry up by id in its FAQ data and reads the text from its <code>game_faq_entry_text</code> data list.
* The question itself is not included; use the <code>name</code> field from [[API:EA_Window_HelpGetFAQTopicList|EA_Window_HelpGetFAQTopicList]].
* Only ids that come from [[API:EA_Window_HelpGetFAQTopicList|EA_Window_HelpGetFAQTopicList]] should be passed: the client does not check that the id exists before using the lookup result.
* The function needs at least one argument and only reads the last one.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.

== Example ==
From <code>ea_helpwindow/source/faqwindow.lua</code>:
<pre>
function FAQWindow.DisplayFAQEntry( id, name )
local entryData = EA_Window_HelpGetFAQEntryData( id )
LabelSetText( "FAQWindowTopicLabel", name ) -- display the title for the entry
LabelSetText( "FAQWindowMainText", entryData.text )-- display the entry's text
</pre>

== See also ==
* [[API:EA_Window_HelpGetFAQTopicList|EA_Window_HelpGetFAQTopicList]]
* [[API:EA_Window_HelpGetEntryData|EA_Window_HelpGetEntryData]]

API:EA Window HelpGetFAQEntryData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)