PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-26 01:53:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/terminals/ProximityUnit.html

15 lines
44 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.terminals.ProximityUnit</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.terminals.ProximityUnit" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.terminals.ProximityUnit" 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.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
Unlike conventional terminals, this one is not necessarily structure-owned.
For example, the cavern crystals are considered owner-neutral elements that are not attached to a <code>Building</code> object.
</p></div><dl class="attributes block"><dt>Self Type</dt><dd><a href="" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a> with <a href="Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a></dd><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/terminals/ProximityUnit.scala" target="_blank">ProximityUnit.scala</a></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 class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="ProximityTerminal.html" name="net.psforever.objects.serverobject.terminals.ProximityTerminal" id="net.psforever.objects.serverobject.terminals.ProximityTerminal" class="extype">ProximityTerminal</a>, <a href="../../vehicles/Utility$$ProximityTerminalUtility.html" name="net.psforever.objects.vehicles.Utility.ProximityTerminalUtility" id="net.psforever.objects.vehicles.Utility.ProximityTerminalUtility" class="extype">ProximityTerminalUtility</a></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.terminals.ProximityUnit"><span>ProximityUnit</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 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/serverobject/terminals/ProximityUnit.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/serverobject/terminals/ProximityUnit.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:
<code>false</code> if the entrant is already in the list or can not be added</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.terminals.ProximityUnit#NumberUsers" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="NumberUsers:Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityUnit.html#NumberUsers:Int" 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">NumberUsers</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.terminals.ProximityUnit#RemoveUser" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveUser(target:net.psforever.objects.PlanetSideGameObject):Boolean"></a><a id="RemoveUser(PlanetSideGameObject):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityUnit.html#RemoveUser(target:net.psforever.objects.PlanetSideGameObject):Boolean" 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">RemoveUser</span><span class="params">(<span name="target">target: <a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Remove an existing target for this unit.</p><div class="fullcomment"><div class="comment cmt"><p>Remove an existing target for this unit.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the target</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the submitted entity was previously in the list but is not longer in the list;
<code>false</code>, if the submitted entity was never in the list or can not be removed</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.terminals.ProximityUnit#Targets" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Targets:Seq[net.psforever.objects.PlanetSideGameObject]"></a><a id="Targets:Seq[PlanetSideGameObject]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityUnit.html#Targets:Seq[net.psforever.objects.PlanetSideGameObject]" 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">Targets</span><span class="result">: <span name="scala.Seq" class="extype">Seq</span>[<a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.terminals.ProximityUnit#Validate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Validate(radius:Float,validations:Seq[net.psforever.objects.PlanetSideGameObject=&gt;Boolean])(target:net.psforever.objects.PlanetSideGameObject):Boolean"></a><a id="Validate(Float,Seq[(PlanetSideGameObject)=&gt;Boolean])(PlanetSideGameObject):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityUnit.html#Validate(radius:Float,validations:Seq[net.psforever.objects.PlanetSideGameObject=&gt;Boolean])(target:net.psforever.objects.PlanetSideGameObject):Boolean" 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">Validate</span><span class="params">(<span name="radius">radius: <span name="scala.Float" class="extype">Float</span></span>, <span name="validations">validations: <span name="scala.Seq" class="extype">Seq</span>[(<a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>) =&gt; <span name="scala.Boolean" class="extype">Boolean</span>]</span>)</span><span class="params">(<span name="target">target: <a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Confirm whether the entity is a valid target for the effects of this unit.</p><div class="fullcomment"><div class="comment cmt"><p>Confirm whether the entity is a valid target for the effects of this unit.
Curried to accept parameters for the tests separately from the entity to be tested.
In general, the two requirements beyond the custom validations involve
distance (from the unit)
and inclusiveness (known to the unit beforehand).</p></div><dl class="paramcmts block"><dt class="param">radius</dt><dd class="cmt"><p>the squared minimum activation distance</p></dd><dt class="param">validations</dt><dd class="cmt"><p>the custom tests that the entity must pass to be considered valid;
in general, regardless of the type of the target, any of the tests must be passed</p></dd><dt class="param">target</dt><dd class="cmt"><p>the submitted entity</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the entity passes the validation tests;
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.terminals.ProximityUnit#Validate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Validate(target:net.psforever.objects.PlanetSideGameObject):Boolean"></a><a id="Validate(PlanetSideGameObject):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityUnit.html#Validate(target:net.psforever.objects.PlanetSideGameObject):Boolean" 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">Validate</span><span class="params">(<span name="target">target: <a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Confirm whether the entity is a valid target for the effects of this unit.</p><div class="fullcomment"><div class="comment cmt"><p>Confirm whether the entity is a valid target for the effects of this unit.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the submitted entity</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the entity passes the validation tests;
<code>false</code>, otherwise</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/serverobject/terminals/ProximityUnit.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/serverobject/terminals/ProximityUnit.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"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><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.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityUnit.html#eq(x$1:AnyRef):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">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</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</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityUnit.html#equals(x$1:Object):Boolean" 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">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</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#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityUnit.html#finalize():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 cla
Reference in a new issue Copy permalink