Add and fix documentation.

TR5Main/Scripting/GameScriptItemInfo.cpp

@@ -188,8 +188,12 @@ void GameScriptItemInfo::Register(sol::state* state)
 // @mem objectID
 		"objectID", sol::property(&GameScriptItemInfo::GetObjectID, &GameScriptItemInfo::SetObjectID),
 
-		/// (int) State of current animation
+/*** (int) current animation state
-		// @mem currentAnimState
+
+The state number of the animation the object is currently doing.
+This corresponds to "state" number shown in the animation editor of WadTool.
+@mem currentAnimState
+*/
 		"currentAnimState", sol::property(&GameScriptItemInfo::GetCurrentAnimState, &GameScriptItemInfo::SetCurrentAnimState),
 
 /// (int) State of required animation
@@ -200,12 +204,21 @@ void GameScriptItemInfo::Register(sol::state* state)
 // @mem goalAnimState
 		"goalAnimState", sol::property(&GameScriptItemInfo::GetGoalAnimState, &GameScriptItemInfo::SetGoalAnimState),
 
-		/// (int) animation number
+/*** (int) animation number
-		// @mem animNumber
+
+The index of the animation the object is currently doing.
+This corresponds to the number shown in the item's animation list in WadTool.
+@mem animNumber
+*/
 		"animNumber", sol::property(&GameScriptItemInfo::GetAnimNumber, &GameScriptItemInfo::SetAnimNumber),
 
-		/// (int) frame number
+/*** (int) frame number
-		// @mem frameNumber
+
+Current fame of the animation the object is currently doing.
+The number of frames in an animation can be seen under the heading "End frame" in
+the WadTool animation editor.
+@mem frameNumber
+*/
 		"frameNumber", sol::property(&GameScriptItemInfo::GetFrameNumber, &GameScriptItemInfo::SetFrameNumber),
 
 /// (int) HP (hit points/health points) of object 
@@ -256,7 +269,7 @@ void GameScriptItemInfo::Register(sol::state* state)
 		"rot", sol::property(&GameScriptItemInfo::GetRot, &GameScriptItemInfo::SetRot),
 
 /// (string) unique string identifier.
-		// e.g. "door_back_room" or "cracked_greek_statue"
+// e.g. "door\_back\_room" or "cracked\_greek\_statue"
 // @mem name
 		"name", sol::property(&GameScriptItemInfo::GetName, &GameScriptItemInfo::SetName)
 		);

doc/classes/ItemInfo.html

@@ -81,7 +81,9 @@ pickups, and Lara herself.</p>
 	</tr>
 	<tr>
 	<td class="name" ><a href="#ItemInfo.currentAnimState">ItemInfo.currentAnimState</a></td>
-	<td class="summary">(int) State of current animation</td>
+	<td class="summary">(int) current animation state</p>
+
+<p>The state number of the animation the object is currently doing.</td>
 	</tr>
 	<tr>
 	<td class="name" ><a href="#ItemInfo.requiredAnimState">ItemInfo.requiredAnimState</a></td>
@@ -93,11 +95,15 @@ pickups, and Lara herself.</p>
 	</tr>
 	<tr>
 	<td class="name" ><a href="#ItemInfo.animNumber">ItemInfo.animNumber</a></td>
-	<td class="summary">(int) animation number</td>
+	<td class="summary">(int) animation number</p>
+
+<p>The index of the animation the object is currently doing.</td>
 	</tr>
 	<tr>
 	<td class="name" ><a href="#ItemInfo.frameNumber">ItemInfo.frameNumber</a></td>
-	<td class="summary">(int) frame number</td>
+	<td class="summary">(int) frame number</p>
+
+<p>Current fame of the animation the object is currently doing.</td>
 	</tr>
 	<tr>
 	<td class="name" ><a href="#ItemInfo.HP">ItemInfo.HP</a></td>
@@ -208,7 +214,10 @@ out of scope).</td>
     <strong>ItemInfo.currentAnimState</strong>
     </dt>
     <dd>
-    (int) State of current animation
+    (int) current animation state</p>
+
+<p>The state number of the animation the object is currently doing.
+This corresponds to "state" number shown in the animation editor of WadTool.
 
 
 
@@ -250,7 +259,10 @@ out of scope).</td>
     <strong>ItemInfo.animNumber</strong>
     </dt>
     <dd>
-    (int) animation number
+    (int) animation number</p>
+
+<p>The index of the animation the object is currently doing.
+This corresponds to the number shown in the item's animation list in WadTool.
 
 
 
@@ -264,7 +276,11 @@ out of scope).</td>
     <strong>ItemInfo.frameNumber</strong>
     </dt>
     <dd>
-    (int) frame number
+    (int) frame number</p>
+
+<p>Current fame of the animation the object is currently doing.
+The number of frames in an animation can be seen under the heading "End frame" in
+the WadTool animation editor.
 
 
 
@@ -424,7 +440,7 @@ out of scope).</td>
     </dt>
     <dd>
     (string) unique string identifier.
- e.g. "door<em>back</em>room" or "cracked<em>greek</em>statue"
+ e.g. "door_back_room" or "cracked_greek_statue"
 
 
 
@@ -655,7 +671,7 @@ Use this if you called new with no arguments
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2021-08-16 12:53:44 </i>
+<i style="float:right;">Last updated 2021-08-21 00:29:08 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>