PSF-LoginServer/net/psforever/objects/LockerContainerControl.html

10 lines
79 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.LockerContainerControl</title><meta content="PSF - LoginServer - master - net.psforever.objects.LockerContainerControl" name="description"/><meta content="PSF LoginServer master net.psforever.objects.LockerContainerControl" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../lib/index.js"></script><script type="text/javascript" src="../../../index.js"></script><script type="text/javascript" src="../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../net/psforever/objects/avatar/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="
To be implemented.</p></div><dl class="paramcmts block"><dt class="param">msg</dt><dd class="cmt"><p>the deferred message</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.LockerContainerControl" id="net.psforever.objects.LockerContainerControl" class="extype">LockerContainerControl</a><a href="serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.LockerContainerControl#PutItemInSlotCallback" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PutItemInSlotCallback(item:net.psforever.objects.equipment.Equipment,slot:Int):Unit"></a><a id="PutItemInSlotCallback(Equipment,Int):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#PutItemInSlotCallback(item:net.psforever.objects.equipment.Equipment,slot:Int):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">PutItemInSlotCallback</span><span class="params">(<span name="item">item: <a href="equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>, <span name="slot">slot: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Reaction to an item being placed into a container.</p><div class="fullcomment"><div class="comment cmt"><p>Reaction to an item being placed into a container.
To be implemented.</p></div><dl class="paramcmts block"><dt class="param">item</dt><dd class="cmt"><p>the item that was removed</p></dd><dt class="param">slot</dt><dd class="cmt"><p>the slot from which is was removed</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.LockerContainerControl" id="net.psforever.objects.LockerContainerControl" class="extype">LockerContainerControl</a><a href="serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.LockerContainerControl#RemoveItemFromSlotCallback" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveItemFromSlotCallback(item:net.psforever.objects.equipment.Equipment,slot:Int):Unit"></a><a id="RemoveItemFromSlotCallback(Equipment,Int):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#RemoveItemFromSlotCallback(item:net.psforever.objects.equipment.Equipment,slot:Int):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">RemoveItemFromSlotCallback</span><span class="params">(<span name="item">item: <a href="equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>, <span name="slot">slot: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Reaction to an item being removed a container.</p><div class="fullcomment"><div class="comment cmt"><p>Reaction to an item being removed a container.
To be implemented.</p></div><dl class="paramcmts block"><dt class="param">item</dt><dd class="cmt"><p>the item that was removed</p></dd><dt class="param">slot</dt><dd class="cmt"><p>the slot from which is was removed</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.LockerContainerControl" id="net.psforever.objects.LockerContainerControl" class="extype">LockerContainerControl</a><a href="serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#RepeatMessageLater" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RepeatMessageLater(msg:Any):Unit"></a><a id="RepeatMessageLater(Any):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#RepeatMessageLater(msg:Any):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">RepeatMessageLater</span><span class="params">(<span name="msg">msg: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Defer a message until later.</p><div class="fullcomment"><div class="comment cmt"><p>Defer a message until later.</p></div><dl class="paramcmts block"><dt class="param">msg</dt><dd class="cmt"><p>the message to defer</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>ContainableBehavior.Defer</code></p></span><span class="cmt"><p><code>DeferrableMsg</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#Reset" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Reset():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#Reset():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">Reset</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Stop blocking messages.</p><div class="fullcomment"><div class="comment cmt"><p>Stop blocking messages.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#Resume" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Resume():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#Resume():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">Resume</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Decrement the flag for blocking messages.</p><div class="fullcomment"><div class="comment cmt"><p>Decrement the flag for blocking messages.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.LockerContainerControl#SwapItemCallback" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SwapItemCallback(item:net.psforever.objects.equipment.Equipment,fromSlot:Int):Unit"></a><a id="SwapItemCallback(Equipment,Int):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#SwapItemCallback(item:net.psforever.objects.equipment.Equipment,fromSlot:Int):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">SwapItemCallback</span><span class="params">(<span name="item">item: <a href="equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>, <span name="fromSlot">fromSlot: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Reaction to the existence of a swap item being produced from a container into the environment.</p><div class="fullcomment"><div class="comment cmt"><p>Reaction to the existence of a swap item being produced from a container into the environment.
To be implemented.</p></div><dl class="paramcmts block"><dt class="param">item</dt><dd class="cmt"><p>the item that was removed</p></dd><dt class="param">fromSlot</dt><dd class="cmt"><p>the slot from where the item was removed (where it previous was)</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.LockerContainerControl" id="net.psforever.objects.LockerContainerControl" class="extype">LockerContainerControl</a><a href="serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.containable.ContainableBehavior#Wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Wait():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#Wait():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">Wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Increment the flag for blocking messages.</p><div class="fullcomment"><div class="comment cmt"><p>Increment the flag for blocking messages.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="serverobject/containable/ContainableBehavior.html" name="net.psforever.objects.serverobject.containable.ContainableBehavior" id="net.psforever.objects.serverobject.containable.ContainableBehavior" class="extype">ContainableBehavior</a></dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostRestart(reason:Throwable):Unit"></a><a id="aroundPostRestart(Throwable):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#aroundPostRestart(reason:Throwable):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">aroundPostRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostStop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostStop():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#aroundPostStop():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">aroundPostStop</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreRestart(reason:Throwable,message:Option[Any]):Unit"></a><a id="aroundPreRestart(Throwable,Option[Any]):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#aroundPreRestart(reason:Throwable,message:Option[Any]):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">aroundPreRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>, <span name="message">message: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreStart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreStart():Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/LockerContainerControl.html#aroundPreStart():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><