Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:43Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interact}}
Returns the main menu of the NPC or object the player is interacting with: its name, greeting text, interaction options and quests.

<pre>
menuData = InteractGetBaseInteractionData(interactionId)
</pre>

== Arguments ==
;interactionId : <code>number</code> – Id of the current interaction, as passed to handlers of <code>SystemData.Events.INTERACT_DEFAULT</code>. Only its low 16 bits are compared.

== Returns ==
;menuData : <code>table</code> – The menu, or nothing if <code>interactionId</code> does not match the current interaction.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Name of the interaction target.
|-
| <code>text</code> || <code>wstring</code> || Greeting text.
|-
| <code>options</code> || <code>table</code> || Array of option tables (see below).
|-
| <code>quests</code> || <code>table</code> || Array of quest tables (see below).
|}

Each table in <code>options</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>type</code> || <code>number</code> || Interaction type, compared by the stock UI with <code>GameData.InteractType</code> values. Pass it to [[API:InteractSelect|InteractSelect]].
|-
| <code>trainType</code> || <code>number</code> || Only on options with <code>type</code> 0: the trainer type, one of 1, 2, 4, 8 or 16. The stock UI compares it with <code>GameData.InteractTrainerType</code> values.
|}

Each table in <code>quests</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Quest name.
|-
| <code>type</code> || <code>number</code> || Always <code>6</code>. Pass it to [[API:InteractSelect|InteractSelect]].
|-
| <code>icon</code> || <code>number</code> || –
|-
| <code>completion</code> || <code>number</code> || Quest state; the stock UI compares it with <code>GameData.QuestCompletion.OFFER</code>, <code>REPEATABLE_OFFER</code> and <code>PENDING</code>.
|-
| <code>slot</code> || <code>number</code> || Position of the quest in the list, starting at 0. Pass it as the third argument of [[API:InteractSelect|InteractSelect]].
|}

== Details ==
* The options list is built from the target's interaction flags, types 0 to 23. Type 6 never appears in <code>options</code>; quests are listed in <code>quests</code> instead.
* A trainer can offer several trainer types. Each one gets its own option with <code>type</code> 0 and a different <code>trainType</code>.
* The stock UI treats a <code>nil</code> result as "nothing to show" and closes the window.
* 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>default/ea_interactionwindow/source/interactionbase.lua</code>:
<pre>
local menuData = InteractGetBaseInteractionData( interactionTargetID )

if (menuData == nil)
then
EA_Window_InteractionBase.Done()
return
else
LabelSetText( "EA_Window_InteractionBaseTargetName", menuData.name )
LabelSetText( "EA_Window_InteractionBaseText", menuData.text )

EA_Window_InteractionBase.optionListData = menuData.options
EA_Window_InteractionBase.questListData = menuData.quests
end
</pre>

== See also ==
* [[API:InteractSelect|InteractSelect]]
* [[API:GetDesiredInteractAction|GetDesiredInteractAction]]

API:InteractGetBaseInteractionData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)