PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-19 14:43:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/pad/process/index.html

52 lines
29 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.process</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.pad.process" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.pad.process" 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">pac
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Provide a common convention for the logging system's name.
Additional functionality that recovers the <code>Zone</code> of the owned amenity <code>VehicleSpawnPad</code>.</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlConcealPlayer" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlConcealPlayerextendsVehicleSpawnControlBase"></a><a id="VehicleSpawnControlConcealPlayer:VehicleSpawnControlConcealPlayer"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlConcealPlayer.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="VehicleSpawnControlConcealPlayer.html" title="An Actor that handles vehicle spawning orders for a VehicleSpawnPad."><span class="name">VehicleSpawnControlConcealPlayer</span></a><span class="result"> extends <a href="VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a></span></span><p class="shortcomment cmt">An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.</p><div class="fullcomment"><div class="comment cmt"><p>An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.
The basic <code>VehicleSpawnControl</code> is the root of a simple tree of "spawn control" objects that chain to each other.
Each object performs on (or more than one related) actions upon the vehicle order that was submitted.<br>
<br>
This object is the first link in the process chain that spawns the ordered vehicle.
It is devoted to causing the prospective driver to become hidden during the first part of the process
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
with the goal of appearing to be "teleported" into the driver mount.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
It has failure cases should the driver be in an incorrect state.</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlDriverControl" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlDriverControlextendsVehicleSpawnControlBase"></a><a id="VehicleSpawnControlDriverControl:VehicleSpawnControlDriverControl"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlDriverControl.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="VehicleSpawnControlDriverControl.html" title="An Actor that handles vehicle spawning orders for a VehicleSpawnPad."><span class="name">VehicleSpawnControlDriverControl</span></a><span class="result"> extends <a href="VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a></span></span><p class="shortcomment cmt">An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.</p><div class="fullcomment"><div class="comment cmt"><p>An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.
The basic <code>VehicleSpawnControl</code> is the root of a simple tree of "spawn control" objects that chain to each other.
Each object performs on (or more than one related) actions upon the vehicle order that was submitted.<br>
<br>
A certain amount of time after the server has asserted control over a newly-spawned vehicle,
control of that vehicle is given over to the driver.
It has failure cases should the driver be in an incorrect state.</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlFinalClearance" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlFinalClearanceextendsVehicleSpawnControlBase"></a><a id="VehicleSpawnControlFinalClearance:VehicleSpawnControlFinalClearance"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlFinalClearance.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="VehicleSpawnControlFinalClearance.html" title="An Actor that handles vehicle spawning orders for a VehicleSpawnPad."><span class="name">VehicleSpawnControlFinalClearance</span></a><span class="result"> extends <a href="VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a></span></span><p class="shortcomment cmt">An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.</p><div class="fullcomment"><div class="comment cmt"><p>An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.
The basic <code>VehicleSpawnControl</code> is the root of a simple tree of "spawn control" objects that chain to each other.
Each object performs on (or more than one related) actions upon the vehicle order that was submitted.<br>
<br>
Deploying to gh-pages from @ psforever/PSF-LoginServer@7fca0a55825f9b41c1b8cd265b82d54e268c21a5 🚀
2021-05-05 14:17:26 +00:00
There is nothing left to do except make certain that the vehicle has moved far enough away from the spawn pad
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
to not block the next order that may be queued.
A long call is made to the root of this <code>Actor</code> object chain to start work on any subsequent vehicle order.</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlLoadVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlLoadVehicleextendsVehicleSpawnControlBase"></a><a id="VehicleSpawnControlLoadVehicle:VehicleSpawnControlLoadVehicle"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlLoadVehicle.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="VehicleSpawnControlLoadVehicle.html" title="An Actor that handles vehicle spawning orders for a VehicleSpawnPad."><span class="name">VehicleSpawnControlLoadVehicle</span></a><span class="result"> extends <a href="VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a></span></span><p class="shortcomment cmt">An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.</p><div class="fullcomment"><div class="comment cmt"><p>An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.
The basic <code>VehicleSpawnControl</code> is the root of a simple tree of "spawn control" objects that chain to each other.
Each object performs on (or more than one related) actions upon the vehicle order that was submitted.<br>
<br>
This object introduces the vehicle into the game environment.
The vehicle must be added to the <code>Zone</code> object, loaded onto other players' clients, and given an initial timed deconstruction event.
For actual details on this process, please refer to the external source represented by <code>pad.Zone.VehicleEvents</code>.
It has failure cases should the driver be in an incorrect state.</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlRailJack" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlRailJackextendsVehicleSpawnControlBase"></a><a id="VehicleSpawnControlRailJack:VehicleSpawnControlRailJack"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlRailJack.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="VehicleSpawnControlRailJack.html" title="An Actor that handles vehicle spawning orders for a VehicleSpawnPad."><span class="name">VehicleSpawnControlRailJack</span></a><span class="result"> extends <a href="VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a></span></span><p class="shortcomment cmt">An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.</p><div class="fullcomment"><div class="comment cmt"><p>An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.
The basic <code>VehicleSpawnControl</code> is the root of a simple tree of "spawn control" objects that chain to each other.
Each object performs on (or more than one related) actions upon the vehicle order that was submitted.<br>
<br>
When the vehicle is added into the environment, it is attached to the spawn pad platform.
Deploying to gh-pages from @ psforever/PSF-LoginServer@7fca0a55825f9b41c1b8cd265b82d54e268c21a5 🚀
2021-05-05 14:17:26 +00:00
On cue, the trapdoor of the platform will open, and the vehicle will be raised on a railed platform.</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlSeatDriver" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlSeatDriverextendsVehicleSpawnControlBase"></a><a id="VehicleSpawnControlSeatDriver:VehicleSpawnControlSeatDriver"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlSeatDriver.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="VehicleSpawnControlSeatDriver.html" title="An Actor that handles vehicle spawning orders for a VehicleSpawnPad."><span class="name">VehicleSpawnControlSeatDriver</span></a><span class="result"> extends <a href="VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a></span></span><p class="shortcomment cmt">An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.</p><div class="fullcomment"><div class="comment cmt"><p>An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
The basic <code>VehicleSpawnControl</code> is the root of a simple tree of "spawn control" objects that chain to each other.
Each object performs on (or more than one related) actions upon the vehicle order that was submitted.<br>
<br>
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
This object forces the prospective driver to take the driver mount.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Multiple separate but sequentially significant steps occur within the scope of this object.
First, this step waits for the vehicle to be completely ready to accept the driver.
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
Second, this step triggers the player to actually be moved into the driver mount.
Finally, this step waits until the driver is properly in the driver mount.
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
It has failure cases should the driver or the vehicle be in an incorrect state.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ZonePopulationActor</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlServerVehicleOverride" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlServerVehicleOverrideextendsVehicleSpawnControlBase"></a><a id="VehicleSpawnControlServerVehicleOverride:VehicleSpawnControlServerVehicleOverride"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlServerVehicleOverride.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="VehicleSpawnControlServerVehicleOverride.html" title="An Actor that handles vehicle spawning orders for a VehicleSpawnPad."><span class="name">VehicleSpawnControlServerVehicleOverride</span></a><span class="result"> extends <a href="VehicleSpawnControlBase.html" name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" id="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlBase" class="extype">VehicleSpawnControlBase</a></span></span><p class="shortcomment cmt">An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.</p><div class="fullcomment"><div class="comment cmt"><p>An <code>Actor</code> that handles vehicle spawning orders for a <code>VehicleSpawnPad</code>.
The basic <code>VehicleSpawnControl</code> is the root of a simple tree of "spawn control" objects that chain to each other.
Each object performs on (or more than one related) actions upon the vehicle order that was submitted.<br>
<br>
This object asserts automated control over the vehicle's motion after it has been released from its lifting platform.
Normally, the vehicle drives forward for a bit under its own power.
After a certain amount of time, control of the vehicle is given over to the driver.
Deploying to gh-pages from @ psforever/PSF-LoginServer@7fca0a55825f9b41c1b8cd265b82d54e268c21a5 🚀
2021-05-05 14:17:26 +00:00
It has failure cases should the driver be in an incorrect state.</p></div></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlFinalClearance" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlFinalClearance"></a><a id="VehicleSpawnControlFinalClearance:VehicleSpawnControlFinalClearance"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlFinalClearance$.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="VehicleSpawnControlFinalClearance$.html" title=""><span class="name">VehicleSpawnControlFinalClearance</span></a></span></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlRailJack" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlRailJack"></a><a id="VehicleSpawnControlRailJack:VehicleSpawnControlRailJack"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlRailJack$.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="VehicleSpawnControlRailJack$.html" title=""><span class="name">VehicleSpawnControlRailJack</span></a></span></li><li class="indented0 " name="net.psforever.objects.serverobject.pad.process.VehicleSpawnControlSeatDriver" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="VehicleSpawnControlSeatDriver"></a><a id="VehicleSpawnControlSeatDriver:VehicleSpawnControlSeatDriver"></a> <span class="permalink"><a href="../../../../../../net/psforever/objects/serverobject/pad/process/VehicleSpawnControlSeatDriver$.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="VehicleSpawnControlSeatDriver$.html" title=""><span class="name">VehicleSpawnControlSeatDriver</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>
Reference in a new issue Copy permalink