PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-01 19:43:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/vehicles/CarrierBehavior$.html

8 lines
70 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ psforever/PSF-LoginServer@1e5e11be6b3a5e6980efc447e9b224d3223cdca5 🚀
2021-10-05 19:25:42 +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.vehicles.CarrierBehavior</title><meta content="PSF - LoginServer - master - net.psforever.objects.vehicles.CarrierBehavior" name="description"/><meta content="PSF LoginServer master net.psforever.objects.vehicles.CarrierBehavior" 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@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +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.vehicles" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="vehicles"></a><a id="vehicles:vehicles"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/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">vehicles</span>
Deploying to gh-pages from @ psforever/PSF-LoginServer@1e5e11be6b3a5e6980efc447e9b224d3223cdca5 🚀
2021-10-05 19:25:42 +00:00
that will set up a realized parent-child association between a ferrying vehicle and a ferried vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Produce an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet
that will set up a realized parent-child association between a ferrying vehicle and a ferried vehicle.</p></div><dl class="paramcmts block"><dt class="param">carrierGUID</dt><dd class="cmt"><p>the ferrying vehicle</p></dd><dt class="param">cargoGUID</dt><dd class="cmt"><p>the ferried vehicle</p></dd><dt class="param">mountPoint</dt><dd class="cmt"><p>the point on the ferryoing vehicle where the ferried vehicle is attached</p></dd><dt class="param">orientation</dt><dd class="cmt"><p>the positioning of the cargo vehicle in the carrier cargo bay</p></dd><dt>returns</dt><dd class="cmt"><p>a tuple composed of an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CargoMountPointStatusMessage</code></p></span><span class="cmt"><p><code>ObjectAttachMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.CarrierBehavior#CargoMountMessages" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CargoMountMessages(carrier:net.psforever.objects.Vehicle,cargo:net.psforever.objects.Vehicle,mountPoint:Int):(net.psforever.packet.game.ObjectAttachMessage,net.psforever.packet.game.CargoMountPointStatusMessage)"></a><a id="CargoMountMessages(Vehicle,Vehicle,Int):(ObjectAttachMessage,CargoMountPointStatusMessage)"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/CarrierBehavior$.html#CargoMountMessages(carrier:net.psforever.objects.Vehicle,cargo:net.psforever.objects.Vehicle,mountPoint:Int):(net.psforever.packet.game.ObjectAttachMessage,net.psforever.packet.game.CargoMountPointStatusMessage)" 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">CargoMountMessages</span><span class="params">(<span name="carrier">carrier: <a href="../Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="cargo">cargo: <a href="../Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="mountPoint">mountPoint: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: (<a href="../../packet/game/ObjectAttachMessage.html" name="net.psforever.packet.game.ObjectAttachMessage" id="net.psforever.packet.game.ObjectAttachMessage" class="extype">ObjectAttachMessage</a>, <a href="../../packet/game/CargoMountPointStatusMessage.html" name="net.psforever.packet.game.CargoMountPointStatusMessage" id="net.psforever.packet.game.CargoMountPointStatusMessage" class="extype">CargoMountPointStatusMessage</a>)</span></span><p class="shortcomment cmt">Produce an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet
that will set up a realized parent-child association between a ferrying vehicle and a ferried vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Produce an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet
that will set up a realized parent-child association between a ferrying vehicle and a ferried vehicle.</p></div><dl class="paramcmts block"><dt class="param">carrier</dt><dd class="cmt"><p>the ferrying vehicle</p></dd><dt class="param">cargo</dt><dd class="cmt"><p>the ferried vehicle</p></dd><dt class="param">mountPoint</dt><dd class="cmt"><p>the point on the ferryoing vehicle where the ferried vehicle is attached;
also known as a "cargo hold"</p></dd><dt>returns</dt><dd class="cmt"><p>a tuple composed of an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CargoMountPointStatusMessage</code></p></span><span class="cmt"><p><code>ObjectAttachMessage</code></p></span><span class="cmt"><p><code>Vehicles.CargoOrientation</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.CarrierBehavior#CargoMountMessagesForOthers" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CargoMountMessagesForOthers(zone:net.psforever.objects.zones.Zone,exclude:net.psforever.types.PlanetSideGUID,attachMessage:net.psforever.packet.game.ObjectAttachMessage,mountPointStatusMessage:net.psforever.packet.game.CargoMountPointStatusMessage):Unit"></a><a id="CargoMountMessagesForOthers(Zone,PlanetSideGUID,ObjectAttachMessage,CargoMountPointStatusMessage):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/CarrierBehavior$.html#CargoMountMessagesForOthers(zone:net.psforever.objects.zones.Zone,exclude:net.psforever.types.PlanetSideGUID,attachMessage:net.psforever.packet.game.ObjectAttachMessage,mountPointStatusMessage:net.psforever.packet.game.CargoMountPointStatusMessage):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">CargoMountMessagesForOthers</span><span class="params">(<span name="zone">zone: <a href="../zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>, <span name="exclude">exclude: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="attachMessage">attachMessage: <a href="../../packet/game/ObjectAttachMessage.html" name="net.psforever.packet.game.ObjectAttachMessage" id="net.psforever.packet.game.ObjectAttachMessage" class="extype">ObjectAttachMessage</a></span>, <span name="mountPointStatusMessage">mountPointStatusMessage: <a href="../../packet/game/CargoMountPointStatusMessage.html" name="net.psforever.packet.game.CargoMountPointStatusMessage" id="net.psforever.packet.game.CargoMountPointStatusMessage" class="extype">CargoMountPointStatusMessage</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Dispatch an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet to all other clients, not this one.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet to all other clients, not this one.</p></div><dl class="paramcmts block"><dt class="param">attachMessage</dt><dd class="cmt"><p>an <code>ObjectAttachMessage</code> packet suitable for initializing cargo operations</p></dd><dt class="param">mountPointStatusMessage</dt><dd class="cmt"><p>a <code>CargoMountPointStatusMessage</code> packet suitable for initializing cargo operations</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CargoMountPointStatusMessage</code></p></span><span class="cmt"><p><code>ObjectAttachMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.CarrierBehavior#HandleCheckCargoDismounting" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleCheckCargoDismounting(zone:net.psforever.objects.zones.Zone,carrierGUID:net.psforever.types.PlanetSideGUID,cargoGUID:net.psforever.types.PlanetSideGUID,carrier:net.psforever.objects.Vehicle,mountPoint:Int,iteration:Int,bailed:Boolean):Boolean"></a><a id="HandleCheckCargoDismounting(Zone,PlanetSideGUID,PlanetSide
Reference in a new issue Copy permalink