https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetSiegeWeaponControlDataAPI:GetSiegeWeaponControlData - Revision history2026-10-17T16:47:45ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetSiegeWeaponControlData&diff=30464&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:44:59Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=RvR}}<br />
Returns the definition of the siege weapon the client currently has as its active siege weapon.<br />
<br />
<pre><br />
controlData = GetSiegeWeaponControlData()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;controlData : <code>table</code> – A table with one field, <code>weaponDef</code> (<code>table</code>), the weapon definition described below.<br />
<br />
=== Siege weapon table ===<br />
The same table format is used for each entry of [[API:GetSiegePadBuildData|GetSiegePadBuildData]].<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>id</code> || <code>number</code> || Siege weapon id. [[API:BuildSiegeWeapon|BuildSiegeWeapon]] takes this value.<br />
|-<br />
| <code>name</code> || <code>wstring</code> || Weapon name.<br />
|-<br />
| <code>level</code> || <code>number</code> || Weapon level.<br />
|-<br />
| <code>hitPoints</code> || <code>number</code> || Hit points.<br />
|-<br />
| <code>maxBuilders</code> || <code>number</code> || Maximum number of players building it. The stock UI uses it as the user limit while the weapon is being built.<br />
|-<br />
| <code>maxUsers</code> || <code>number</code> || Maximum number of players using it.<br />
|-<br />
| <code>buildTime</code> || <code>number</code> || Filled from the same stored value as <code>maxUsers</code>, see Details.<br />
|-<br />
| <code>repairTime</code> || <code>number</code> || Filled from the same stored value as <code>maxUsers</code>, see Details.<br />
|-<br />
| <code>decayTime</code> || <code>number</code> || –<br />
|-<br />
| <code>decayPerFire</code> || <code>number</code> || –<br />
|-<br />
| <code>fireMode</code> || <code>number</code> || –<br />
|-<br />
| <code>fireAbility</code> || <code>table</code> || The weapon's fire ability, in the format of [[API:GetAbilityData#Ability data table|GetAbilityData]]. Only present when there is a player object.<br />
|-<br />
| <code>requiredItems</code> || <code>table</code> || Array of item tables, indexed from 1, in the format of [[API:GetInventoryItemData#Item data table|GetInventoryItemData]]. Empty if no items are needed.<br />
|}<br />
<br />
== Details ==<br />
* '''Client bug:''' <code>maxUsers</code>, <code>buildTime</code> and <code>repairTime</code> are all filled from the same stored byte, so <code>buildTime</code> and <code>repairTime</code> always equal <code>maxUsers</code>. Do not rely on them.<br />
* The function always returns a table; it does not check whether the player is using a siege weapon. The stock UI treats <code>weaponDef.name == L""</code> as "no weapon" and hides its window.<br />
* A new table is built on every call.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/ea_siegeweaponwindow/source/siegeweaponcontrolwindow.lua</code>:<br />
<pre><br />
SiegeWeaponControlWindow.controlData = GetSiegeWeaponControlData()<br />
<br />
local weaponName = SiegeWeaponControlWindow.controlData.weaponDef.name<br />
...<br />
local showWindow = SiegeWeaponControlWindow.controlData.weaponDef.name ~= L""<br />
</pre><br />
<br />
Picking the user limit, from the same file:<br />
<pre><br />
maxUsers = SiegeWeaponControlWindow.controlData.weaponDef.maxBuilders<br />
...<br />
maxUsers = SiegeWeaponControlWindow.controlData.weaponDef.maxUsers<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetSiegeWeaponUsersData|GetSiegeWeaponUsersData]]<br />
* [[API:RepairSiegeWeapon|RepairSiegeWeapon]]<br />
* [[API:GetSiegePadBuildData|GetSiegePadBuildData]]</div>Maintenance script