Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:14Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Help}}
Returns the text of one entry of the in-game manual.

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

== Arguments ==
;entryId : <code>number</code> – Entry id, the <code>id</code> field of an entry from [[API:EA_Window_HelpGetTopicList|EA_Window_HelpGetTopicList]]. 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 entry's text. Missing if the client's manual text list is not loaded.
|}

== Details ==
* The text comes from the client's <code>game_manual_entry_text</code> data list at the position given by the id. The id is cut to 16 bits. An id beyond the end of the list gives an empty string.
* The client loads its manual data the first time it is needed.
* The entry's title is not included; use the <code>name</code> field from [[API:EA_Window_HelpGetTopicList|EA_Window_HelpGetTopicList]].
* 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/manualwindow.lua</code>:
<pre>
function ManualWindow.DisplayManualEntry( entryData )
local entryText = EA_Window_HelpGetEntryData( entryData.id )
LabelSetText( "ManualWindowTopicLabel", entryData.name ) -- display the title for the entry
LabelSetText( "ManualWindowMainText", entryText.text )-- display the entry's text
</pre>

== See also ==
* [[API:EA_Window_HelpGetTopicList|EA_Window_HelpGetTopicList]]
* [[API:EA_Window_HelpGetFAQEntryData|EA_Window_HelpGetFAQEntryData]]

API:EA Window HelpGetEntryData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)