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

13 lines
45 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>
<br>
A <code>Utility</code> object is a variation of an <code>Amenity</code> object that might be found in a <code>Building</code> object.
The object itself is stored inside the <code>Utility</code> as if it were a container.
<code>Amenity</code> objects are required because they are to be owned by the <code>vehicle</code> for purposes of faction affinity.
Only specific kinds of objects count for being <code>Utility</code> contents/objects.
Additional "setup" logic can be supplied that will be called when the owner vehicle's control <code>Actor</code> is created.
Ostensibly, the purpose of the additional logic, when it is called,
is to initialize a control <code>Actor</code> for the contained object.
This <code>Actor</code> is expected by other logic.</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/vehicles/Utility.scala" target="_blank">Utility.scala</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>Amenity.Owner</code></p></span><span class="cmt"><p><code>Vehicle.LoadDefinition</code></p></span><span class="cmt"><p><code>VehicleDefinition.Utilities</code></p></span></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><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.vehicles.Utility"><span>Utility</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.vehicles.Utility#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(util:net.psforever.objects.vehicles.UtilityType.Value,vehicle:net.psforever.objects.Vehicle):net.psforever.objects.vehicles.Utility"></a><a id="&lt;init&gt;:Utility"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility.html#&lt;init&gt;(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">new</span></span> <span class="symbol"><span class="name">Utility</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><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">util</dt><dd class="cmt"><p>the type of the <code>Amenity</code> object to be created</p></dd><dt class="param">vehicle</dt><dd class="cmt"><p>the owner of this object</p></dd></dl></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=
While it is expected to construct an <code>Actor</code>, that is not required.</p></div><dl class="paramcmts block"><dt class="param">context</dt><dd class="cmt"><p>an <code>ActorContext</code> potentially useful for the function</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vehicles.Utility#UtilType" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UtilType:net.psforever.objects.vehicles.UtilityType.Value"></a><a id="UtilType:UtilityType.Value"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility.html#UtilType:net.psforever.objects.vehicles.UtilityType.Value" 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">UtilType</span><span class="result">: <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><p class="shortcomment cmt">Recover the original value used to initialize this object.</p><div class="fullcomment"><div class="comment cmt"><p>Recover the original value used to initialize this object.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the type of the <code>Amenity</code> object that was created</p></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():net.psforever.objects.serverobject.structures.Amenity"></a><a id="apply():Amenity"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility.html#apply():net.psforever.objects.serverobject.structures.Amenity" 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><span class="result">: <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></span><p class="shortcomment cmt">Access the contained object in this <code>Utility</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Access the contained object in this <code>Utility</code>.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the contained <code>Amenity</code> object</p></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility.html#asInstanceOf[T0]:T0" 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">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../net/psforever/objects/vehicles/Utility.html#clone():Object" 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">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment">