PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-01-30 16:01:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
PSF-LoginServer/net/psforever/objects/serverobject/pad/VehicleSpawnControl.html

34 lines
80 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<!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.serverobject.pad.VehicleSpawnControl</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.pad.VehicleSpawnControl" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.pad.VehicleSpawnControl" 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 */
Deploying to gh-pages from @ psforever/PSF-LoginServer@7fca0a55825f9b41c1b8cd265b82d54e268c21a5 🚀
2021-05-05 14:17:26 +00:00
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.serverobject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="serverobject"></a><a id="serverobject:serverobject"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/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
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
The basic <code>VehicleSpawnControl</code> is the root of a sequence of "spawn control" objects that chain to each other.
Each object performs one (or more related) actions upon the vehicle order that was submitted.<br>
<br>
The purpose of the base actor is to serve as the entry point for the spawning process
and to manage the order queue.
A spawn pad receives vehicle orders from a related <code>Terminal</code> object.
The control object accepts orders, enqueues them, and,
whenever prompted by a previous complete order or by an absence of active orders,
will select the first available order to be completed.
This order will be "tracked" and will be given to the first functional "spawn control" object of the process.
If the process is completed, or is ever aborted by any of the subsequent tasks,
control will propagate down back to this control object.
At this time, (or) once again, a new order can be submitted or will be selected.
Deploying to gh-pages from @ psforever/PSF-LoginServer@7fca0a55825f9b41c1b8cd265b82d54e268c21a5 🚀
2021-05-05 14:17:26 +00:00
</p></div><dl class="attributes block"><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/objects/serverobject/pad/VehicleSpawnControl.scala" target="_blank">VehicleSpawnControl.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="../affinity/FactionAffinityBehavior$$Check.html" name="net.psforever.objects.serverobject.affinity.FactionAffinityBehavior.Check" id="net.psforever.objects.serverobject.affinity.FactionAffinityBehavior.Check" class="extype">Check</a>, <a href="../affinity/FactionAffinityBehavior$$BasicAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinityBehavior.BasicAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinityBehavior.BasicAffinity" class="extype">BasicAffinity</a>, <a href="process/VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a>, <span name="akka.actor.Actor" class="extype">Actor</span>, <span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.objects.serverobject.pad.VehicleSpawnControl"><span>VehicleSpawnControl</span></li><li class="in" name="net.psforever.objects.serverobject.affinity.FactionAffinityBehavior.Check"><span>Check</span></li><li class="in" name="net.psforever.objects.serverobject.affinity.FactionAffinityBehavior.BasicAffinity"><span>BasicAffinity</span></li><li class="in" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase"><span>VehicleSpawnControlBase</span></li><li class="in" name="akka.actor.Actor"><span>Actor</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(pad:net.psforever.objects.serverobject.pad.VehicleSpawnPad):net.psforever.objects.serverobject.pad.VehicleSpawnControl"></a><a id="&lt;init&gt;:VehicleSpawnControl"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#&lt;init&gt;(pad:net.psforever.objects.serverobject.pad.VehicleSpawnPad):net.psforever.objects.serverobject.pad.VehicleSpawnControl" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">VehicleSpawnControl</span><span class="params">(<span name="pad">pad: <a href="VehicleSpawnPad.html" name="net.psforever.objects.serverobject.pad.VehicleSpawnPad" id="net.psforever.objects.serverobject
All orders accepted in the meantime will be queued and a note about priority will be issued.</p></div><dl class="paramcmts block"><dt class="param">order</dt><dd class="cmt"><p>the order being accepted</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#ProcessOrder" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ProcessOrder(order:Option[net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder]):Unit"></a><a id="ProcessOrder(Option[VehicleOrder]):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#ProcessOrder(order:Option[net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder]):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">ProcessOrder</span><span class="params">(<span name="order">order: <span name="scala.Option" class="extype">Option</span>[<a href="VehicleSpawnPad$$VehicleOrder.html" name="net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder" id="net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder" class="extype">VehicleOrder</a>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">If a new order is accepted, begin processing it.</p><div class="fullcomment"><div class="comment cmt"><p>If a new order is accepted, begin processing it.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Inform all customers whose orders are still queued of their priority number
and activate the guard to ensure multiple orders don't get processed at the same time.</p></div><dl class="paramcmts block"><dt class="param">order</dt><dd class="cmt"><p>the order being accepted;
Deploying to gh-pages from @ psforever/PSF-LoginServer@7fca0a55825f9b41c1b8cd265b82d54e268c21a5 🚀
2021-05-05 14:17:26 +00:00
<code>None</code>, if no order found or submitted</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#QueuedTasking" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="QueuedTasking(order:net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder):Unit"></a><a id="QueuedTasking(VehicleOrder):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#QueuedTasking(order:net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder):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">QueuedTasking</span><span class="params">(<span name="order">order: <a href="VehicleSpawnPad$$VehicleOrder.html" name="net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder" id="net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder" class="extype">VehicleOrder</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">While an order is being processed,
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
all orders accepted in the meantime will be queued and a note about priority will be issued.</p><div class="fullcomment"><div class="comment cmt"><p>While an order is being processed,
Deploying to gh-pages from @ psforever/PSF-LoginServer@7fca0a55825f9b41c1b8cd265b82d54e268c21a5 🚀
2021-05-05 14:17:26 +00:00
all orders accepted in the meantime will be queued and a note about priority will be issued.</p></div><dl class="paramcmts block"><dt class="param">order</dt><dd class="cmt"><p>the order being accepted</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#SelectFirstOrder" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SelectFirstOrder():Option[net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder]"></a><a id="SelectFirstOrder():Option[VehicleOrder]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#SelectFirstOrder():Option[net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder]" 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">SelectFirstOrder</span><span class="params">()</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="VehicleSpawnPad$$VehicleOrder.html" name="net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder" id="net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder" class="extype">VehicleOrder</a>]</span></span><p class="shortcomment cmt">Select the next-available queued order if there is no current order being fulfilled.</p><div class="fullcomment"><div class="comment cmt"><p>Select the next-available queued order if there is no current order being fulfilled.
If the queue has been exhausted, set functionality to prepare to accept the next order as a "first order."</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the next-available order</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#SelectOrder" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SelectOrder():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#SelectOrder():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">SelectOrder</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Select the next available queued order and begin processing it.</p></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/serverobject/pad/VehicleSpawnControl.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/serverobject/pad/VehicleSpawnControl.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/serverobject/pad/VehicleSpawnControl.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="e
and partition all orders that should be cancelled for one reason or another.</p><div class="fullcomment"><div class="comment cmt"><p>For all orders, ensure that that order's details match acceptable specifications
and partition all orders that should be cancelled for one reason or another.
Generate informative error messages for the failing orders, cancel those partitioned orders,
and only return all orders that are still valid.</p></div><dl class="paramcmts block"><dt class="param">recipients</dt><dd class="cmt"><p>the original list of orders</p></dd><dt>returns</dt><dd class="cmt"><p>the list of still-acceptable orders</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#orders" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="orders:List[net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder]"></a><a id="orders:List[VehicleOrder]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#orders:List[net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">orders</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="VehicleSpawnPad$$VehicleOrder.html" name="net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder" id="net.psforever.objects.serverobject.pad.VehicleSpawnPad.VehicleOrder" class="extype">VehicleOrder</a>]</span></span><p class="shortcomment cmt">a list of vehicle orders that have been submitted for this spawn pad</p></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#periodicReminder" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="periodicReminder:akka.actor.Cancellable"></a><a id="periodicReminder:Cancellable"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#periodicReminder:akka.actor.Cancellable" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">periodicReminder</span><span class="result">: <span name="akka.actor.Cancellable" class="extype">Cancellable</span></span></span><p class="shortcomment cmt">a reminder sent to future customers</p></li><li class="indented0 " name="akka.actor.Actor#postRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="postRestart(reason:Throwable):Unit"></a><a id="postRestart(Throwable):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#postRestart(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">postRestart</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>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Exception]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#postStop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="postStop():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#postStop():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">postStop</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>Definition Classes</dt><dd><a href="" name="net.psforever.objects.serverobject.pad.VehicleSpawnControl" id="net.psf
either start a periodic examination of those credentials until the queue has been emptied or
cancel a running periodic examination if the queue is already empty.</p></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#receive" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="receive:VehicleSpawnControl.this.Receive"></a><a id="receive:Receive"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#receive:VehicleSpawnControl.this.Receive" 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">receive</span><span class="result">: <a href="#Receive=akka.actor.Actor.Receive" name="net.psforever.objects.serverobject.pad.VehicleSpawnControl.Receive" id="net.psforever.objects.serverobject.pad.VehicleSpawnControl.Receive" class="extmbr">Receive</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.serverobject.pad.VehicleSpawnControl" id="net.psforever.objects.serverobject.pad.VehicleSpawnControl" class="extype">VehicleSpawnControl</a> → Actor</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#self" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="self:akka.actor.ActorRef"></a><a id="self:ActorRef"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#self:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">implicit final </span> <span class="kind">val</span></span> <span class="symbol"><span class="name">self</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#sender" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="sender():akka.actor.ActorRef"></a><a id="sender():ActorRef"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#sender():akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sender</span><span class="params">()</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#supervisorStrategy" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="supervisorStrategy:akka.actor.OneForOneStrategy"></a><a id="supervisorStrategy:OneForOneStrategy"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#supervisorStrategy:akka.actor.OneForOneStrategy" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">supervisorStrategy</span><span class="result">: <span name="akka.actor.OneForOneStrategy" class="extype">OneForOneStrategy</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.serverobject.pad.VehicleSpawnControl" id="net.psforever.objects.serverobject.pad.VehicleSpawnControl" class="extype">VehicleSpawnControl</a> → Actor</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=&gt;T0):T0"></a><a id="synchronized[T0](=&gt;T0):T0"></a> <span class="
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
The default should be <code>trace</code>-level comments.
No important messages should processed by this agent; only consume general vehicle spawn status.</p></div><dl class="paramcmts block"><dt class="param">msg</dt><dd class="cmt"><p>the message</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="process/VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.VehicleSpawnControl#trackedOrder" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="trackedOrder:Option[net.psforever.objects.serverobject.pad.VehicleSpawnControl.Order]"></a><a id="trackedOrder:Option[Order]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#trackedOrder:Option[net.psforever.objects.serverobject.pad.VehicleSpawnControl.Order]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">trackedOrder</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="VehicleSpawnControl$$Order.html" name="net.psforever.objects.serverobject.pad.VehicleSpawnControl.Order" id="net.psforever.objects.serverobject.pad.VehicleSpawnControl.Order" class="extype">Order</a>]</span></span><p class="shortcomment cmt">the current vehicle order being acted upon;
used as a guard condition to control order processing rate
</p></li><li class="indented0 " name="akka.actor.Actor#unhandled" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unhandled(message:Any):Unit"></a><a id="unhandled(Any):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#unhandled(message: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">unhandled</span><span class="params">(<span name="message">message: <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>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#wait():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </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><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#wait(x$1:Long,x$2:Int):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/pad/VehicleSpawnControl.html#wait(x$1:Long):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="net.psforever.objects.serverobject.affinity.FactionAffinityBehavior.Check" class="parent"><h3>Inherited from
Reference in a new issue Copy permalink