PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-01 03:23:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/locks/IFFLock.html

28 lines
136 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.locks.IFFLock</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.locks.IFFLock" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.locks.IFFLock" 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
<br>
The "door lock" exerts an "identify friend or foe" field that detects the faction affiliation of a target player.
It also indirectly inherits faction affiliation from the structure to which it is connected
or it can be "hacked" whereupon the person exploiting it leaves their "faction" as the aforementioned affiliated faction.
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
The <code>IFFLock</code> is ideally associated with a server map object - a <code>Door</code> - to which it acts as a gatekeeper.</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/locks/IFFLock.scala" target="_blank">IFFLock.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><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="../../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a>, <a href="../../vital/resistance/StandardResistanceProfile.html" name="net.psforever.objects.vital.resistance.StandardResistanceProfile" id="net.psforever.objects.vital.resistance.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><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.locks.IFFLock"><span>IFFLock</span></li><li class="in" name="net.psforever.objects.serverobject.hackable.Hackable"><span>Hackable</span></li><li class="in" name="net.psf
Deploying to gh-pages from @ 151b201f06266558e243c0fbc17b311e39167dc8 🚀
2020-12-08 19:37:03 +00:00
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.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/locks/IFFLock.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/locks/IFFLock.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/locks/IFFLock.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/locks/IFFLock.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><
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
Set the hack state if there is no current hack state.
Deploying to gh-pages from @ 151b201f06266558e243c0fbc17b311e39167dc8 🚀
2020-12-08 19:37:03 +00:00
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/locks/IFFLock.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/locks/IFFLock.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/locks/IFFLock.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 Classes</dt><dd><a href="../../vital/Vita
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
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/locks/IFFLock.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/locks/IFFLock.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/locks/IFFLock.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.
Deploying to gh-pages from @ 151b201f06266558e243c0fbc17b311e39167dc8 🚀
2020-12-08 19:37:03 +00:00
</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#LastDamage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LastDamage:Option[net.psforever.objects.vital.interaction.DamageResult]"></a><a id="LastDamage:Option[DamageResult]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#LastDamage:Option[net.psforever.objects.vital.interaction.DamageResult]" 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">LastDamage</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../vital/interaction/DamageResult.html" name="net.psforever.objects.vital.interaction.DamageResult" id="net.psforever.objects.vital.interaction.DamageResult" class="extype">DamageResult</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.vital.VitalsHistory#LastShot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LastShot:Option[net.psforever.objects.vital.interaction.DamageResult]"></a><a id="LastShot:Option[DamageResult]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#LastShot:Option[net.psforever.objects.vital.interaction.DamageResult]" 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="../../vital/interaction/DamageResult.html" name="net.psforever.objects.vital.interaction.DamageResult" id="net.psforever.objects.vital.interaction.DamageResult" class="extype">DamageResult</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/locks/IFFLock.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.objec
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
use the angular data to determine an "inside" side and an "outside" side.<br>
<br>
Doors are always positioned with the frame perpendicular to the ground.</p><div class="fullcomment"><div class="comment cmt"><p>While setting the normal rotation angle for the IFF lock for a door (?),
use the angular data to determine an "inside" side and an "outside" side.<br>
<br>
Doors are always positioned with the frame perpendicular to the ground.
The <code>i</code> and <code>j</code> components can be excused for this reason and only the <code>k</code> component (rotation around world-up) matters.
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
Due to angle-corrected North, add 90 degrees before switching to radians and negate the cosine.</p></div><dl class="paramcmts block"><dt class="param">orient</dt><dd class="cmt"><p>the orientation of the door</p></dd><dt>returns</dt><dd class="cmt"><p>the clamped orientation of the door</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.objects.serverobject.locks.IFFLock" id="net.psforever.objects.serverobject.locks.IFFLock" class="extype">IFFLock</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></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.locks.IFFLock#Outwards" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Outwards:net.psforever.types.Vector3"></a><a id="Outwards:Vector3"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#Outwards: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">Outwards</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></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Amenity#Owner" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Owner:net.psforever.objects.serverobject.structures.AmenityOwner"></a><a id="Owner:AmenityOwner"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#Owner:net.psforever.objects.serverobject.structures.AmenityOwner" 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">Owner</span><span class="result">: <a href="../structures/AmenityOwner.html" name="net.psforever.objects.serverobject.structures.AmenityOwner" id="net.psforever.objects.serverobject.structures.AmenityOwner" class="extype">AmenityOwner</a></span></span><p class="shortcomment cmt">Reference the object that is in direct association with (is superior to) this one.</p><div class="fullcomment"><div class="comment cmt"><p>Reference the object that is in direct association with (is superior to) this one.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the object associated as this object's "owner"</p></dd></dl><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#Owner_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Owner_=(obj:net.psforever.objects.serverobject.structures.AmenityOwner):net.psforever.objects.serverobject.structures.AmenityOwner"></a><a id="Owner_=(AmenityOwner):AmenityOwner"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#Owner_=(obj:net.psforever.objects.serverobject.structures.AmenityOwner):net.psforever.objects.serverobject.structures.AmenityOwner" 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: Owner_$eq">Owner_=</span><span class="params">(<span name="obj">obj: <a href="../structures/AmenityOwner.html" name="net.psfo
Find the sectors in a given blockmap in which the entity would be represented within a given range.</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>what region the blockmap represents</p></dd><dt class="param">range</dt><dd class="cmt"><p>the custom distance from the central sector along the major axes</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=&gt;T0):T0"></a><a id="synchronized[T0](=&gt;T0):T0"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#synchronized[T0](x$1:=&gt;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">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: =&gt; <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</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#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#toString():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">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></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.zones.blockmap.BlockMapEntity#updateBlockMapEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="updateBlockMapEntry(newCoords:net.psforever.types.Vector3):Boolean"></a><a id="updateBlockMapEntry(Vector3):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#updateBlockMapEntry(newCoords:net.psforever.types.Vector3):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">updateBlockMapEntry</span><span class="params">(<span name="newCoords">newCoords: <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.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Update the internal data's known coordinate position without changing representation on whatever blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Update the internal data's known coordinate position without changing representation on whatever blockmap.
Has the potential to cause major issues with the blockmap if used without external checks.</p></div><dl class="paramcmts block"><dt class="param">newCoords</dt><dd class="cmt"><p>the coordinate position</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the coordinates were updated;
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#wait():Unit" 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">wait</span><span class="params">()</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>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#wait(x$1:Long,x$2:Int):Unit" 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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <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>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/locks/IFFLock.html#wait(x$1:Long):Unit" 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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</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>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="net.psforever.objects.serverobject.hackable.Hackable" class="parent"><h3>Inherited from <a href="../hackable/Hackable.html" name="net.psforever.objects.serverobject.hackable.Hackable" id="net.psforever.objects.serverobject.hackable.Hackable" class="extype">Hackable</a></h3></div><div name="net.psforever.objects.serverobject.structures.Amenity" class="parent"><h3>Inherited from <a href="../structures/Amenity.html" name="net.psforever.objects.serverobject.structures.Amenity" id="net.psforever.objects.serverobject.structures.Amenity" class="extype">Amenity</a></h3></div><div name="net.psforever.objects.zones.blockmap.BlockMapEntity" class="parent"><h3>Inherited from <a href="..
Reference in a new issue Copy permalink