PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-04 21:10:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/terminals/ProximityTerminal.html

30 lines
148 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.ProximityTerminal</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.terminals.ProximityTerminal" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.terminals.ProximityTerminal" 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
triggered when a certain distance from the unit itself (proximity-based).<br>
<br>
Unlike conventional terminals, this structure 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>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/ProximityTerminal.scala" target="_blank">ProximityTerminal.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a>, <a href="Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a>, <a href="../hackable/Hackable.html" name="net.psforever.objects.serverobject.hackable.Hackable" id="net.psforever.objects.serverobject.hackable.Hackable" class="extype">Hackable</a>, <a href="../structures/Amenity.html" name="net.psforever.objects.serverobject.structures.Amenity" id="net.psforever.objects.serverobject.structures.Amenity" class="extype">Amenity</a>, <a href="../../vital/StandardResistanceProfile.html" name="net.psforever.objects.vital.StandardResistanceProfile" id="net.psforever.objects.vital.StandardResistanceProfile" class="extype">StandardResistanceProfile</a>, <a href="../../vital/resistance/ResistanceProfile.html" name="net.psforever.objects.vital.resistance.ResistanceProfile" id="net.psforever.objects.vital.resistance.ResistanceProfile" class="extype">ResistanceProfile</a>, <a href="../../vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a>, <a href="../../vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a>, <a href="../PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a>, <a href="../../zones/ZoneAware.html" name="net.psforever.objects.zones.ZoneAware" id="net.psforever.objects.zones.ZoneAware" class="extype">ZoneAware</a>, <a href="../affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a>, <a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>, <a href="../../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a>, <a href="../../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a>, <a href="../../entity/Identifiable.html" name="net.psforever.objects.entity.Identifiable" id="net.psforever.objects.entity.Identifiable" class="extype">Identifiable</a>, <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="../../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"
This reference is only set once, that is, as long as the internal <code>ActorRef</code> directs to <code>ActorRef.noSender</code> (<code>null</code>).</p></div><dl class="paramcmts block"><dt class="param">control</dt><dd class="cmt"><p>the <code>Actor</code> whose functionality will govern this server object</p></dd><dt>returns</dt><dd class="cmt"><p>the current internal <code>ActorRef</code></p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.terminals.ProximityUnit#AddUser" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AddUser(target:net.psforever.objects.PlanetSideGameObject):Boolean"></a><a id="AddUser(PlanetSideGameObject):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#AddUser(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">AddUser</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">Accept a new target for this unit.</p><div class="fullcomment"><div class="comment cmt"><p>Accept a new target for this unit.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the new target</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the entrant has been added and is new to the list;
<code>false</code> if the entrant is already in the list or can not be added</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.Vitality#CanDamage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CanDamage:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#CanDamage: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">CanDamage</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><a href="../../vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.Vitality#CanRepair" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CanRepair:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#CanRepair: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">CanRepair</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><a href="../../vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.VitalsHistory#ClearHistory" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ClearHistory():List[net.psforever.objects.vital.VitalsActivity]"></a><a id="ClearHistory():List[VitalsActivity]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#ClearHistory():List[net.psforever.objects.vital.VitalsActivity]" 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">ClearHistory</span><span class="params">()</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../vital/VitalsActivity.html" name="net.psforever.objects.vital.VitalsActivity" id="net.psforever.objects.vital.VitalsActivity" class="extype">VitalsActivity</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ZoneAware#Continent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Continent:String"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Continent:String" 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">Continent</span><span class="result">: <span name="scala.Predef.String" class="extype">String</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../zones/ZoneAware
Set the hack state if there is no current hack state.
Override the hack state with a new hack state if the new user has different faction affiliation.</p></div><dl class="paramcmts block"><dt class="param">agent</dt><dd class="cmt"><p>a <code>Player</code>, or no player</p></dd><dt>returns</dt><dd class="cmt"><p>the player hack entry</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../hackable/Hackable.html" name="net.psforever.objects.serverobject.hackable.Hackable" id="net.psforever.objects.serverobject.hackable.Hackable" class="extype">Hackable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.hackable.Hackable#HackedBy_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HackedBy_=(agent:net.psforever.objects.Player):Option[net.psforever.objects.serverobject.hackable.Hackable.HackInfo]"></a><a id="HackedBy_=(Player):Option[HackInfo]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#HackedBy_=(agent:net.psforever.objects.Player):Option[net.psforever.objects.serverobject.hackable.Hackable.HackInfo]" 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" title="gt4s: HackedBy_$eq">HackedBy_=</span><span class="params">(<span name="agent">agent: <a href="../../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../hackable/Hackable$$HackInfo.html" name="net.psforever.objects.serverobject.hackable.Hackable.HackInfo" id="net.psforever.objects.serverobject.hackable.Hackable.HackInfo" class="extype">HackInfo</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../hackable/Hackable.html" name="net.psforever.objects.serverobject.hackable.Hackable" id="net.psforever.objects.serverobject.hackable.Hackable" class="extype">Hackable</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.IdentifiableEntity#HasGUID" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HasGUID:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#HasGUID: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">HasGUID</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Flag when the object has no GUID (initial condition) or is considered stale.</p><div class="fullcomment"><div class="comment cmt"><p>Flag when the object has no GUID (initial condition) or is considered stale.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>whether the value of the GUID is a valid representation for this object</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.Vitality#Health" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Health:Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Health: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">Health</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition
Add new entry to the front of the list (for recent activity).</p></div><dl class="paramcmts block"><dt class="param">action</dt><dd class="cmt"><p>the fully-informed entry</p></dd><dt>returns</dt><dd class="cmt"><p>the list of previous changes to this object's vital statistics</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.VitalsHistory#History" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="History(action:net.psforever.objects.vital.VitalsActivity):List[net.psforever.objects.vital.VitalsActivity]"></a><a id="History(VitalsActivity):List[VitalsActivity]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#History(action:net.psforever.objects.vital.VitalsActivity):List[net.psforever.objects.vital.VitalsActivity]" 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">History</span><span class="params">(<span name="action">action: <a href="../../vital/VitalsActivity.html" name="net.psforever.objects.vital.VitalsActivity" id="net.psforever.objects.vital.VitalsActivity" class="extype">VitalsActivity</a></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../vital/VitalsActivity.html" name="net.psforever.objects.vital.VitalsActivity" id="net.psforever.objects.vital.VitalsActivity" class="extype">VitalsActivity</a>]</span></span><p class="shortcomment cmt">A <code>VitalsActivity</code> event must be recorded.</p><div class="fullcomment"><div class="comment cmt"><p>A <code>VitalsActivity</code> event must be recorded.
Add new entry to the front of the list (for recent activity).</p></div><dl class="paramcmts block"><dt class="param">action</dt><dd class="cmt"><p>the fully-informed entry</p></dd><dt>returns</dt><dd class="cmt"><p>the list of previous changes to this object's vital statistics</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.VitalsHistory#History" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="History:List[net.psforever.objects.vital.VitalsActivity]"></a><a id="History:List[VitalsActivity]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#History:List[net.psforever.objects.vital.VitalsActivity]" 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">History</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../vital/VitalsActivity.html" name="net.psforever.objects.vital.VitalsActivity" id="net.psforever.objects.vital.VitalsActivity" class="extype">VitalsActivity</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.IdentifiableEntity#Invalidate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Invalidate():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Invalidate():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">Invalidate</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Indicate that the current GUID is no longer a valid representation of the object.</p><div class="fullcomment"><div class="comment cmt"><p>Indicate that the current GUID is no longer a valid representation of the object.
Transforms whatever the current GUID is into a <code>StalePlanetSideGUID</code> entity with the same value.
Doing this restores the object to its default mutation option ("the ability to set a new valid GUID").
The current GUID will still be accessed as if it were valid, but it will be wrapped in the new stale object.
</p></div><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.VitalsHistory#LastShot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LastShot:Option[net.psforever.objects.ballistics.ResolvedProjectile]"></a><a id="LastShot:Option[ResolvedProjectile]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#LastShot:Option[net.psforever.objects.ballistics.ResolvedProjectile]" 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">LastShot</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../ballistics/ResolvedProjectile.html" name="net.psforever.objects.ballistics.ResolvedProjectile" id="net.psforever.objects.ballistics.ResolvedProjectile" class="extype">ResolvedProjectile</a>]</span></span><p class="shortcomment cmt">Find, specifically, the last instance of a weapon discharge vital statistics change.</p><div class="fullcomment"><div class="comment cmt"><p>Find, specifically, the last instance of a weapon discharge vital statistics change.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>information about the discharge</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/VitalsHistory.html" name="net.psforever.objects.vital.VitalsHistory" id="net.psforever.objects.vital.VitalsHistory" class="extype">VitalsHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Amenity#LocationOffset" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LocationOffset:net.psforever.types.Vector3"></a><a id="LocationOffset:Vector3"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#LocationOffset:net.psforever.types.Vector3" 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">LocationOffset</span><span class="result">: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../structures/Amenity.html" name="net.psforever.objects.serverobject.structures.Amenity" id="net.psforever.objects.serverobject.structures.Amenity" class="extype">Amenity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Amenity#LocationOffset_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LocationOffset_=(off:Option[net.psforever.types.Vector3]):net.psforever.types.Vector3"></a><a id="LocationOffset_=(Option[Vector3]):Vector3"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#LocationOffset_=(off:Option[net.psforever.types.Vector3]):net.psforever.types.Vector3" 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" title="gt4s: LocationOffset_$eq">LocationOffset_=</span><span class="params">(<span name="off">off: <span name="scala.Option" class="extype">Option</span>[<a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span>)</span><span class="result">: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3"
<code>false</code>, if the submitted entity was never in the list or can not be removed</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.terminals.Terminal#Repair" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Repair(rep:Int):Unit"></a><a id="Repair(Int):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Repair(rep:Int):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">Repair</span><span class="params">(<span name="rep">rep: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.terminals.ProximityTerminal#Request" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Request(player:net.psforever.objects.Player,msg:Any):net.psforever.objects.serverobject.terminals.Terminal.Exchange"></a><a id="Request(Player,Any):Exchange"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Request(player:net.psforever.objects.Player,msg:Any):net.psforever.objects.serverobject.terminals.Terminal.Exchange" 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">Request</span><span class="params">(<span name="player">player: <a href="../../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="msg">msg: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <a href="Terminal$$Exchange.html" name="net.psforever.objects.serverobject.terminals.Terminal.Exchange" id="net.psforever.objects.serverobject.terminals.Terminal.Exchange" class="extype">Exchange</a></span></span><p class="shortcomment cmt">Process a message (a "request") dispatched by the user.</p><div class="fullcomment"><div class="comment cmt"><p>Process a message (a "request") dispatched by the user.
To be accessible, the terminal must be:
owned by the same faction by the user
or must be compromised
or must be a zone owned object (GUID == 0, e.g. non-facility buildings in caves)</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player</p></dd><dt class="param">msg</dt><dd class="cmt"><p>the original packet carrying the request</p></dd><dt>returns</dt><dd class="cmt"><p>an actionable message that explains what resulted from interacting with this <code>Terminal</code></p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.serverobject.terminals.ProximityTerminal" id="net.psforever.objects.serverobject.terminals.ProximityTerminal" class="extype">ProximityTerminal</a> → <a href="Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>FactionAffinity</code></p></span><span class="cmt"><p><code>PlanetSideEmpire</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.PlanetSideServerObject#ResetControl" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ResetControl():akka.actor.ActorRef"></a><a id="ResetControl():ActorRef"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#ResetControl():akka.actor.ActorRef" 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">ResetControl</span><span class="params">()</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.resistance.ResistanceProfile#Resist" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Resist(dtype:net.psforever.objects.vital.DamageType.Value):Float"></a><a id="Resist(vital.DamageType.Value):Float"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Resist(dtype:net.psforever.objects.vital.DamageType.Value):Float" 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">Resist</span><span class="params">(<span name="dtype">dtype: <a href="../../vital/DamageType$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.vital.DamageType.Value" id="net.psforever.objects.vital.DamageType.Value" class="extmbr">vital.DamageType.Value</a></span>)</span><span class="result">: <span name="scala.Float" class="extype">Float</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/resistance/ResistanceProfile.html" name="net.psforever.objects.vital.resistance.ResistanceProfile" id="net.psforever.objects.vital.resistance.ResistanceProfile" class="extype">ResistanceProfile</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.StandardResistanceProfile#ResistanceAggravated" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ResistanceAggravated:Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#ResistanceAggravated: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">ResistanceAggravated</span><span class="result">: <span nam
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><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></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/ProximityTerminal.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><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Velocity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Velocity:Option[net.psforever.types.Vector3]"></a><a id="Velocity:Option[Vector3]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Velocity:Option[net.psforever.types.Vector3]" 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">Velocity</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> → <a href="../../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.PlanetSideGameObject#Velocity_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Velocity_=(vec:Option[net.psforever.types.Vector3]):Option[net.psforever.types.Vector3]"></a><a id="Velocity_=(Option[Vector3]):Option[Vector3]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Velocity_=(vec:Option[net.psforever.types.Vector3]):Option[net.psforever.types.Vector3]" 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" title="gt4s: Velocity_$eq">Velocity_=</span><span class="params">(<span name="vec">vec: <span name="scala.Option" class="extype">Option</span>[<a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> → <a href="../../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.WorldEntity#Velocity_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Velocity_=(vec:net.psforever.types.Vector3):Option[net.psforever.types.Vector3]"></a><a id="Velocity_=(Vector3):Option[Vector3]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/terminals/ProximityTerminal.html#Velocity_=(vec:net.psforever.types.Vector3):Option[net.psforever.types.Vector3]" 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" title="gt4s: Velocity_$eq">Velocity_=</span><span class="params">(<span name="vec">vec: <a href="../../../
Reference in a new issue Copy permalink