document the type accessor for player weapons

Aleph-One-Marathon · Jul 22, 2023 · 0da8885 · 0da8885
1 parent 1c8ac4a
commit 0da8885
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 11 deletions.
diff --git a/docs/Lua.html b/docs/Lua.html
@@ -1698,13 +1698,10 @@ <h3>
 </dl></dd>
 <dt>:select()</dt>
 <dd><p class="description">attempts to force player to ready weapon</p></dd>
-</dl></dd>
-      <dt>.weapons.current<span class="access"> (read-only)</span>
+<dt>.type<span class="access"> (read-only)</span>
 </dt>
-<dd>
-<p class="description">weapon the player is currently wielding</p>
-<p class="note">can be nil </p>
-</dd>
+<dd><p class="description">type of this weapon</p></dd>
+</dl></dd>
       <dt>.x<span class="access"> (read-only)</span>
 </dt>
 <dd><p class="description"></p></dd>

diff --git a/docs/Lua.xml b/docs/Lua.xml
@@ -1691,12 +1691,11 @@
 		<function name="select">
 		  <description>attempts to force player to ready weapon</description>
 		</function>
+		<variable name="type" access="read-only">
+		  <description>type of this weapon</description>
+		  <type>weapon_type</type>
+		</variable>
       </subtable-accessor>
-      <variable name="weapons.current" access="read-only">
-		<description>weapon the player is currently wielding</description>
-		<type>player_weapon</type>
-		<note>can be nil</note>
-      </variable>
       <variable name="x" access="read-only">
 		<type>WU</type>
       </variable>