Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:00Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=RvR}}
Returns the players currently using (or building) the client's active siege weapon.

<pre>
users = GetSiegeWeaponUsersData()
</pre>

== Arguments ==
None.

== Returns ==
;users : <code>table</code> – Array of user tables, indexed from 1. Nothing if there is no player object.

Each user table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>objectNum</code> || <code>number</code> || World object number of the user.
|-
| <code>name</code> || <code>wstring</code> || Character name.
|-
| <code>level</code> || <code>number</code> || Character level. For the local player this is the player's own rank.
|}

== Details ==
* The list comes from the siege weapon's world object. If the client has no data for that object, an empty table is returned.
* Users the client cannot resolve to a known world object are skipped, but the remaining entries keep their original positions, so the array can have gaps. The stock UI counts users with <code>#</code>.
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_siegeweaponwindow/source/siegeweaponcontrolwindow.lua</code>:
<pre>
SiegeWeaponControlWindow.currentUsers = GetSiegeWeaponUsersData()

local numUsers = # SiegeWeaponControlWindow.currentUsers
...
local userData = SiegeWeaponControlWindow.currentUsers[index]
local text = GetFormatStringFromTable( "SiegeStrings", StringTables.Siege.LABEL_SIEGE_USER_AND_RANK, { userData.name, L""..userData.level } )
</pre>

== See also ==
* [[API:GetSiegeWeaponControlData|GetSiegeWeaponControlData]]

API:GetSiegeWeaponUsersData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)