Deploying to gh-pages from @ psforever/PSF-LoginServer@082d58108f 🚀

net/psforever/actors/session/AvatarActor$.html

@@ -11,14 +11,15 @@ Together, these are occasionally referred to as an "inventory".</p></div><dl cla
 into encoded object to time data in a string format
 and filter out mappings that have exceeded the current time.</p><div class="fullcomment"><div class="comment cmt"><p>Transform the proper object to proper time references
 into encoded object to time data in a string format
-and filter out mappings that have exceeded the current time.</p></div><dl class="paramcmts block"><dt class="param">cooldowns</dt><dd class="cmt"><p>a base reference for entity to time comparison</p></dd><dt>returns</dt><dd class="cmt"><p>the resulting map that represents object to time string data</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#buildContainedEquipmentFromClob" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="buildContainedEquipmentFromClob(container:net.psforever.objects.inventory.Container,clob:String,log:org.log4s.Logger):Unit"></a><a id="buildContainedEquipmentFromClob(Container,String,Logger):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor$.html#buildContainedEquipmentFromClob(container:net.psforever.objects.inventory.Container,clob:String,log:org.log4s.Logger):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">buildContainedEquipmentFromClob</span><span class="params">(<span name="container">container: <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>, <span name="clob">clob: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="log">log: <span name="org.log4s.Logger" class="extype">Logger</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Transform from encoded inventory data as a CLOB - character large object - into individual items.</p><div class="fullcomment"><div class="comment cmt"><p>Transform from encoded inventory data as a CLOB - character large object - into individual items.
+and filter out mappings that have exceeded the current time.</p></div><dl class="paramcmts block"><dt class="param">cooldowns</dt><dd class="cmt"><p>a base reference for entity to time comparison</p></dd><dt>returns</dt><dd class="cmt"><p>the resulting map that represents object to time string data</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#buildContainedEquipmentFromClob" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="buildContainedEquipmentFromClob(container:net.psforever.objects.inventory.Container,clob:String,log:org.log4s.Logger,restoreAmmo:Boolean):Unit"></a><a id="buildContainedEquipmentFromClob(Container,String,Logger,Boolean):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor$.html#buildContainedEquipmentFromClob(container:net.psforever.objects.inventory.Container,clob:String,log:org.log4s.Logger,restoreAmmo:Boolean):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">buildContainedEquipmentFromClob</span><span class="params">(<span name="container">container: <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>, <span name="clob">clob: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="log">log: <span name="org.log4s.Logger" class="extype">Logger</span></span>, <span name="restoreAmmo">restoreAmmo: <span name="scala.Boolean" class="extype">Boolean</span> = <span class="symbol">false</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Transform from encoded inventory data as a CLOB - character large object - into individual items.</p><div class="fullcomment"><div class="comment cmt"><p>Transform from encoded inventory data as a CLOB - character large object - into individual items.
 Install those items into positions in a target container
 in the same positions in which they were previously recorded.<br>
 <br>
 There is no guarantee that the structure of the retained container data encoded in the CLOB
 will fit the current dimensions of the container.
 No tests are performed.
-A partial decompression of the CLOB may occur.</p></div><dl class="paramcmts block"><dt class="param">container</dt><dd class="cmt"><p>the container in which to place the pieces of equipment produced from the CLOB</p></dd><dt class="param">clob</dt><dd class="cmt"><p>the inventory data in string form</p></dd><dt class="param">log</dt><dd class="cmt"><p>a reference to a logging context</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#buildCooldownsFromClob" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="buildCooldownsFromClob(clob:String,cooldownDurations:Map[net.psforever.objects.definition.BasicDefinition,scala.concurrent.duration.FiniteDuration],log:org.log4s.Logger):Map[String,org.joda.time.LocalDateTime]"></a><a id="buildCooldownsFromClob(String,Map[BasicDefinition,FiniteDuration],Logger):Map[String,LocalDateTime]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor$.html#buildCooldownsFromClob(clob:String,cooldownDurations:Map[net.psforever.objects.definition.BasicDefinition,scala.concurrent.duration.FiniteDuration],log:org.log4s.Logger):Map[String,org.joda.time.LocalDateTime]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">buildCooldownsFromClob</span><span class="params">(<span name="clob">clob: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="cooldownDurations">cooldownDurations: <span name="scala.Predef.Map" class="extype">Map</span>[<a href="../../objects/definition/BasicDefinition.html" name="net.psforever.objects.definition.BasicDefinition" id="net.psforever.objects.definition.BasicDefinition" class="extype">BasicDefinition</a>, <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span>]</span>, <span name="log">log: <span name="org.log4s.Logger" class="extype">Logger</span></span>)</span><span class="result">: <span name="scala.Predef.Map" class="extype">Map</span>[<span name="scala.Predef.String" class="extype">String</span>, <span name="org.joda.time.LocalDateTime" class="extype">LocalDateTime</span>]</span></span><p class="shortcomment cmt">Transform the encoded object to time data
+A partial decompression of the CLOB may occur.</p></div><dl class="paramcmts block"><dt class="param">container</dt><dd class="cmt"><p>the container in which to place the pieces of equipment produced from the CLOB</p></dd><dt class="param">clob</dt><dd class="cmt"><p>the inventory data in string form</p></dd><dt class="param">log</dt><dd class="cmt"><p>a reference to a logging context</p></dd><dt class="param">restoreAmmo</dt><dd class="cmt"><p>by default, when <code>false</code>, use the maximum ammunition for all ammunition boixes and for all tools;
+                   if <code>true</code>, load the last saved ammunition count for all ammunition boxes and for all tools</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.AvatarActor#buildCooldownsFromClob" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="buildCooldownsFromClob(clob:String,cooldownDurations:Map[net.psforever.objects.definition.BasicDefinition,scala.concurrent.duration.FiniteDuration],log:org.log4s.Logger):Map[String,org.joda.time.LocalDateTime]"></a><a id="buildCooldownsFromClob(String,Map[BasicDefinition,FiniteDuration],Logger):Map[String,LocalDateTime]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/AvatarActor$.html#buildCooldownsFromClob(clob:String,cooldownDurations:Map[net.psforever.objects.definition.BasicDefinition,scala.concurrent.duration.FiniteDuration],log:org.log4s.Logger):Map[String,org.joda.time.LocalDateTime]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">buildCooldownsFromClob</span><span class="params">(<span name="clob">clob: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="cooldownDurations">cooldownDurations: <span name="scala.Predef.Map" class="extype">Map</span>[<a href="../../objects/definition/BasicDefinition.html" name="net.psforever.objects.definition.BasicDefinition" id="net.psforever.objects.definition.BasicDefinition" class="extype">BasicDefinition</a>, <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span>]</span>, <span name="log">log: <span name="org.log4s.Logger" class="extype">Logger</span></span>)</span><span class="result">: <span name="scala.Predef.Map" class="extype">Map</span>[<span name="scala.Predef.String" class="extype">String</span>, <span name="org.joda.time.LocalDateTime" class="extype">LocalDateTime</span>]</span></span><p class="shortcomment cmt">Transform the encoded object to time data
 into proper object to proper time references
 and filter out mappings that have exceeded the sample duration.</p><div class="fullcomment"><div class="comment cmt"><p>Transform the encoded object to time data
 into proper object to proper time references

net/psforever/objects/inventory/index.html

@@ -55,4 +55,4 @@ the equipment is registered to it, assigned one of its internal unique numbers.
 The equipment must not already be registered to another unique number system for that reason.
 Upon being removed, the removed equipment is unregistered.
 The registration system adds another unspoken layer to <code>Capacity</code>
-as it imposes a total object count to the inventory.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>NumberSourceHub</code></p></span><span class="cmt"><p><code>RandomSelector</code></p></span><span class="cmt"><p><code>SpecificNumberSource</code></p></span></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.inventory.GridInventory" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="GridInventory"></a><a id="GridInventory:GridInventory"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/GridInventory$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="GridInventory$.html" title=""><span class="name">GridInventory</span></a></span></li><li class="indented0 " name="net.psforever.objects.inventory.InventoryDisarrayException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InventoryDisarrayException"></a><a id="InventoryDisarrayException:InventoryDisarrayException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/InventoryDisarrayException$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="InventoryDisarrayException$.html" title=""><span class="name">InventoryDisarrayException</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.inventory.InventoryItem" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InventoryItem"></a><a id="InventoryItem:InventoryItem"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/InventoryItem$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="InventoryItem$.html" title=""><span class="name">InventoryItem</span></a></span></li><li class="indented0 " name="net.psforever.objects.inventory.InventoryTile" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InventoryTile"></a><a id="InventoryTile:InventoryTile"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/InventoryTile$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="InventoryTile$.html" title=""><span class="name">InventoryTile</span></a></span></li></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
+as it imposes a total object count to the inventory based on he number of unique identifiers available.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>NumberSourceHub</code></p></span><span class="cmt"><p><code>RandomSelector</code></p></span><span class="cmt"><p><code>SpecificNumberSource</code></p></span></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.inventory.GridInventory" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="GridInventory"></a><a id="GridInventory:GridInventory"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/GridInventory$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="GridInventory$.html" title=""><span class="name">GridInventory</span></a></span></li><li class="indented0 " name="net.psforever.objects.inventory.InventoryDisarrayException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InventoryDisarrayException"></a><a id="InventoryDisarrayException:InventoryDisarrayException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/InventoryDisarrayException$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="InventoryDisarrayException$.html" title=""><span class="name">InventoryDisarrayException</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.inventory.InventoryItem" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InventoryItem"></a><a id="InventoryItem:InventoryItem"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/InventoryItem$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="InventoryItem$.html" title=""><span class="name">InventoryItem</span></a></span></li><li class="indented0 " name="net.psforever.objects.inventory.InventoryTile" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InventoryTile"></a><a id="InventoryTile:InventoryTile"></a> <span class="permalink"><a href="../../../../net/psforever/objects/inventory/InventoryTile$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="InventoryTile$.html" title=""><span class="name">InventoryTile</span></a></span></li></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>