Merge pull request #887 from Malivil/dev

Added "signed" parameter to "util.BitsRequired" from base TTT

Author: Malivil

API/METHODS_UTIL.md

@@ -1,12 +1,13 @@
 # Utility Methods
 Utility methods created to help with various common scenarios
 
-### util.BitsRequired(num)
+### util.BitsRequired(num, signed)
 Returns how many bits are required to transmit the given number over the network.\
 *Realm:* Client and Server\
 *Added in:* 2.3.3\
 *Parameters:*
 - *num* - The number being transmitted
+- *signed* - Whether the number being transmitted is signed *(Added in 2.3.5)*
 
 ### util.BurnRagdoll(rag, burn_time, scorch)
 Burns a player ragdoll, shows scorch marks, and automatically destroys the ragdoll unless it's been extinguished by water.\

docs/api/methods_util.html

@@ -17,7 +17,7 @@ <h1>Utility Methods <span id="betaswitch"></span></h1>
         <p>Utility methods created to help with various common scenarios</p>
     </div>
     <div class="contentbody panel">
-        <h3><a id="utilbitsrequirednum" href="#utilbitsrequirednum">util.BitsRequired(num)</a> <span data-text="Beta Only" class="betaonly betaicon tooltip">&nbsp;</span></h3>
+        <h3><a id="utilbitsrequirednum-signed" href="#utilbitsrequirednum-signed">util.BitsRequired(num, signed)</a> <span data-text="Beta Only" class="betaonly betaicon tooltip">&nbsp;</span></h3>
         <p>
             Returns how many bits are required to transmit the given number over the network.<br>
             <em>Realm:</em> Client and Server<br>
@@ -26,6 +26,7 @@ <h3><a id="utilbitsrequirednum" href="#utilbitsrequirednum">util.BitsRequired(nu
         </p>
         <ul>
             <li><em>num</em> - The number being transmitted</li>
+            <li><em>signed</em> - Whether the number being transmitted is signed <em>(Added in 2.3.5)</em></li>
         </ul>
 
         <h3><a id="utilburnragdollrag-burn_time_scorch" href="#utilburnragdollrag-burn_time_scorch">util.BurnRagdoll(rag, burn_time, scorch)</a></h3>

gamemodes/terrortown/gamemode/util.lua

@@ -472,6 +472,21 @@ function util.SimpleTime(seconds, fmt)
     return StringFormat(fmt, m, s, ms)
 end
 
+-- Returns the number of bits required to network an integer
+function util.BitsRequired(num, signed)
+    local bits, max = 0, 1
+    while max <= num do
+        bits = bits + 1
+        max = max + max
+    end
+
+    if signed then
+        bits = bits + 1
+    end
+
+    return bits
+end
+
 if SERVER then
     function util.ExecFile(filePath, errorIfMissing)
         if not FileExists(filePath, "GAME") then
@@ -554,20 +569,10 @@ function util.FormattedList(tbl, formatting)
     return result
 end
 
-function util.BitsRequired(num)
-    local bits, max = 0, 1
-    while max <= num do
-        bits = bits + 1
-        max = max + max
-    end
-    return bits
-end
-
 local roleBits = nil
 function util.RoleBits()
     if not roleBits then
-        -- Add a bit to the required for this since we're sending it as signed to support ROLE_NONE (-1)
-        roleBits = math.max(8, util.BitsRequired(ROLE_MAX) + 1)
+        roleBits = math.max(8, util.BitsRequired(ROLE_MAX, true))
     end
 
     return roleBits