PSF-LoginServer/net/psforever/objects/vehicles/Utility$.html

13 lines
52 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.vehicles.Utility</title><meta content="PSF - LoginServer - master - net.psforever.objects.vehicles.Utility" name="description"/><meta content="PSF LoginServer master net.psforever.objects.vehicles.Utility" 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.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>
and allows it to serve as one of the terminal points of a Router-telepad teleportation system.</p></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility.InternalTelepadDefinition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InternalTelepadDefinitionextendsAmenityDefinitionwithBaseDeployableDefinition"></a><a id="InternalTelepadDefinition:InternalTelepadDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$$InternalTelepadDefinition.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="Utility$$InternalTelepadDefinition.html" title="As the InternalTelepad object is a unique intersection of Amenity and TelepadLike that is treated like a Deployable, its definition must be a unique intersection of AmenityDefinition and BaseDeployableDefinition."><span class="name">InternalTelepadDefinition</span></a><span class="result"> extends <a href="../serverobject/structures/AmenityDefinition.html" name="net.psforever.objects.serverobject.structures.AmenityDefinition" id="net.psforever.objects.serverobject.structures.AmenityDefinition" class="extype">AmenityDefinition</a> with <a href="../definition/BaseDeployableDefinition.html" name="net.psforever.objects.definition.BaseDeployableDefinition" id="net.psforever.objects.definition.BaseDeployableDefinition" class="extype">BaseDeployableDefinition</a></span></span><p class="shortcomment cmt">As the <code>InternalTelepad</code> object is a unique intersection of <code>Amenity</code> and <code>TelepadLike</code>
that is treated like a <code>Deployable</code>,
its definition must be a unique intersection of <code>AmenityDefinition</code> and <code>BaseDeployableDefinition</code>.</p><div class="fullcomment"><div class="comment cmt"><p>As the <code>InternalTelepad</code> object is a unique intersection of <code>Amenity</code> and <code>TelepadLike</code>
that is treated like a <code>Deployable</code>,
its definition must be a unique intersection of <code>AmenityDefinition</code> and <code>BaseDeployableDefinition</code>.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AmenityDefinition</code></p></span><span class="cmt"><p><code>BaseDeployableDefinition</code></p></span><span class="cmt"><p><code>DeployableDefinition</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility.ProximityTerminalUtility" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ProximityTerminalUtilityextendsProximityTerminalwithUtility.UtilityWorldEntity"></a><a id="ProximityTerminalUtility:ProximityTerminalUtility"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$$ProximityTerminalUtility.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="Utility$$ProximityTerminalUtility.html" title="Override for a Terminal object so that it inherits the spatial characteristics of its Owner."><span class="name">ProximityTerminalUtility</span></a><span class="result"> extends <a href="../serverobject/terminals/ProximityTerminal.html" name="net.psforever.objects.serverobject.terminals.ProximityTerminal" id="net.psforever.objects.serverobject.terminals.ProximityTerminal" class="extype">ProximityTerminal</a> with <a href="Utility$$UtilityWorldEntity.html" name="net.psforever.objects.vehicles.Utility.UtilityWorldEntity" id="net.psforever.objects.vehicles.Utility.UtilityWorldEntity" class="extype">UtilityWorldEntity</a></span></span><p class="shortcomment cmt">Override for a <code>Terminal</code> object so that it inherits the spatial characteristics of its <code>Owner</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Override for a <code>Terminal</code> object so that it inherits the spatial characteristics of its <code>Owner</code>.
The <code>Terminal</code> <code>Utility</code> produced has proximity effects.</p></div></div></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility.SpawnTubeUtility" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SpawnTubeUtilityextendsSpawnTubewithUtility.UtilityWorldEntity"></a><a id="SpawnTubeUtility:SpawnTubeUtility"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$$SpawnTubeUtility.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="Utility$$SpawnTubeUtility.html" title="Override for SpawnTube objects so that they inherit the spatial characteristics of their Owner."><span class="name">SpawnTubeUtility</span></a><span class="result"> extends <a href="../serverobject/tube/SpawnTube.html" name="net.psforever.objects.serverobject.tube.SpawnTube" id="net.psforever.objects.serverobject.tube.SpawnTube" class="extype">SpawnTube</a> with <a href="Utility$$UtilityWorldEntity.html" name="net.psforever.objects.vehicles.Utility.UtilityWorldEntity" id="net.psforever.objects.vehicles.Utility.UtilityWorldEntity" class="extype">UtilityWorldEntity</a></span></span><p class="shortcomment cmt">Override for <code>SpawnTube</code> objects so that they inherit the spatial characteristics of their <code>Owner</code>.</p></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility.TeleportPadTerminalUtility" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TeleportPadTerminalUtilityextendsUtility.TerminalUtility"></a><a id="TeleportPadTerminalUtility:TeleportPadTerminalUtility"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$$TeleportPadTerminalUtility.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="Utility$$TeleportPadTerminalUtility.html" title="Override for a Terminal object so that it inherits the spatial characteristics of its Owner."><span class="name">TeleportPadTerminalUtility</span></a><span class="result"> extends <a href="Utility$$TerminalUtility.html" name="net.psforever.objects.vehicles.Utility.TerminalUtility" id="net.psforever.objects.vehicles.Utility.TerminalUtility" class="extype">TerminalUtility</a></span></span><p class="shortcomment cmt">Override for a <code>Terminal</code> object so that it inherits the spatial characteristics of its <code>Owner</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Override for a <code>Terminal</code> object so that it inherits the spatial characteristics of its <code>Owner</code>.
The <code>Terminal</code> <code>Utility</code> produced dispenses a specific item
that retain knowledge of the <code>Owner</code> of the <code>Terminal</code> that dispensed it.</p></div></div></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility.TerminalUtility" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="TerminalUtilityextendsTerminalwithUtility.UtilityWorldEntity"></a><a id="TerminalUtility:TerminalUtility"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$$TerminalUtility.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="Utility$$TerminalUtility.html" title="Override for a Terminal object so that it inherits the spatial characteristics of its Owner."><span class="name">TerminalUtility</span></a><span class="result"> extends <a href="../serverobject/terminals/Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a> with <a href="Utility$$UtilityWorldEntity.html" name="net.psforever.objects.vehicles.Utility.UtilityWorldEntity" id="net.psforever.objects.vehicles.Utility.UtilityWorldEntity" class="extype">UtilityWorldEntity</a></span></span><p class="shortcomment cmt">Override for a <code>Terminal</code> object so that it inherits the spatial characteristics of its <code>Owner</code>.</p></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility.UtilLogic" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UtilLogic=(net.psforever.objects.serverobject.structures.Amenity,akka.actor.ActorContext)=&gt;Unit"></a><a id="UtilLogic:UtilLogic"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$.html#UtilLogic=(net.psforever.objects.serverobject.structures.Amenity,akka.actor.ActorContext)=&gt;Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">type</span></span> <span class="symbol"><span class="name">UtilLogic</span><span class="result alias"> = (<a href="../serverobject/structures/Amenity.html" name="net.psforever.objects.serverobject.structures.Amenity" id="net.psforever.objects.serverobject.structures.Amenity" class="extype">Amenity</a>, <span name="akka.actor.ActorContext" class="extype">ActorContext</span>) =&gt; <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility.UtilityWorldEntity" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="UtilityWorldEntityextendsAnyRef"></a><a id="UtilityWorldEntity:UtilityWorldEntity"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$$UtilityWorldEntity.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">trait</span></span> <span class="symbol"><a href="Utility$$UtilityWorldEntity.html" title="Embedded (owned) entities are known in relation to their parent entity."><span class="name">UtilityWorldEntity</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Embedded (owned) entities are known in relation to their parent entity.</p><div class="fullcomment"><div class="comment cmt"><p>Embedded (owned) entities are known in relation to their parent entity.
These overrides to the <code>Position</code> method and the <code>Orientation</code> method reflect this.
</p></div></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$.html#!=(x$1:Any):Boolean" 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" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$.html###:Int" 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" title="gt4s: $hash$hash">##</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$.html#==(x$1:Any):Boolean" 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" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility#apply" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="apply(util:net.psforever.objects.vehicles.UtilityType.Value,vehicle:net.psforever.objects.Vehicle):net.psforever.objects.vehicles.Utility"></a><a id="apply(UtilityType.Value,Vehicle):Utility"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility$.html#apply(util:net.psforever.objects.vehicles.UtilityType.Value,vehicle:net.psforever.objects.Vehicle):net.psforever.objects.vehicles.Utility" 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">apply</span><span class="params">(<span name="util">util: <a href="UtilityType$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.vehicles.UtilityType.Value" id="net.psforever.objects.vehicles.UtilityType.Value" class="extmbr">UtilityType.Value</a></span>, <span name="vehicle">vehicle: <a href="../Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <a href="Utility.html" name="net.psforever.objects.vehicles.Utility" id="net.psforever.objects.vehicles.Utility" class="extype">Utility</a></span></span><p class="shortcomment cmt">Overloaded constructor.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded constructor.</p></div><dl class="paramcmts block"><dt class="param">util</dt><dd class="cmt"><p>the type of t