PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-27 10:33:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/structures/Amenity.html

20 lines
129 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.structures.Amenity</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.structures.Amenity" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.structures.Amenity" 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 */
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
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_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></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" class="anchorToMember"></a><a id="net:net" class="anchorToMember"></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" class="anchorToMember"></a><a id="psforever:psforever" class="anchorToMember"></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" class="anchorToMember"></a><a id="objects:objects" class="anchorToMember"></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" class="anchorToMember"></a><a id="serverobject:serverobject" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
<br>
Normal <code>PlanetSideServerObject</code> entities (server objects) tend to have properties that are completely internalized.
An <code>Amenity</code> is a server object that maintains a fixed association with another server object.
This association strips away at the internalization and redirects a reference to some properties somewhere else.
An <code>Amenity</code> object belongs to its <code>Owner</code> object;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
the <code>Amenity</code> objects look to its <code>Owner</code> object for some of its properties.</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/structures/Amenity.scala" target="_blank">Amenity.scala</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>AmenityOwner</code></p></span><span class="cmt"><p><code>FactionAffinity</code></p></span></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><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/InGameHistory.html" name="net.psforever.objects.vital.InGameHistory" id="net.psforever.objects.vital.InGameHistory" class="extype">InGameHistory</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="../doors/Door.html" name="net.psforever.objects.serverobject.doors.Door" id="net.psforever.objects.serverobject.doors.Door" class="extype">Door</a>, <a href="../generator/Generator.html" name="net.psforever.objects.serverobject.generator.Generator" id="net.psforever.objects.serverobject.generator.Generator" class="extype">Generator</a>, <a href="../llu/CaptureFlag.html" name="net.psforever.objects.serverobject.llu.CaptureFlag" id="net.psforever.objects.serverobject.llu.CaptureFlag" class="extype">CaptureFlag</a>, <a href="../llu/CaptureFlagSocket.html" name="net.psforever.objects.serverobject.llu.CaptureFlagSocket" id="net.psforever.objects.serverobject.llu.CaptureFlagSocket" class="extype">CaptureFlagSocket</a>, <a href="../locks/IFFLock.html" name="net.psforever.objects.serverobject.locks.IFFLock" id="net.psforever.objects.serverobject.locks.IFFLock" class="extype">IFFLock</a>, <a href
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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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.InGameHistory#ClearHistory" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ClearHistory():List[net.psforever.objects.vital.InGameActivity]" class="anchorToMember"></a><a id="ClearHistory():List[InGameActivity]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.html#ClearHistory():List[net.psforever.objects.vital.InGameActivity]" 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/InGameActivity.html" name="net.psforever.objects.vital.InGameActivity" id="net.psforever.objects.vital.InGameActivity" class="extype">InGameActivity</a>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/InGameHistory.html" name="net.psforever.objects.vital.InGameHistory" id="net.psforever.objects.vital.InGameHistory" class="extype">InGameHistory</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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.html#Continent:String" title="Permalink"
Deploying to gh-pages from @ cf9e4ea194ccf8c7471e168e4576f5b510c1c26f 🚀
2020-08-26 04:22:45 +00:00
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 @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +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.InGameHistory#LastDamage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LastDamage:Option[net.psforever.objects.vital.interaction.DamageResult]" class="anchorToMember"></a><a id="LastDamage:Option[DamageResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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/InGameHistory.html" name="net.psforever.objects.vital.InGameHistory" id="net.psforever.objects.vital.InGameHistory" class="extype">InGameHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.InGameHistory#LastShot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LastShot:Option[net.psforever.objects.vital.interaction.DamageResult]" class="anchorToMember"></a><a id="LastShot:Option[DamageResult]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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 that caused damage.</p><div class="fullcomment"><div class="comment cmt"><p>Find, specifically, the last instance of a weapon discharge that caused damage.</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/InGameHistory.html" name="net.psforever.objects.vital.InGameHistory" id="net.psforever.objects.vital.InGameHistory" class="extype">InGameHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.structures.Amenity#LocationOffset" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="LocationOffset:net.psforever.types.Vector3" class="anchorToMember"></a><a id="LocationOffset:Vector3" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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></li><li class="indented0 " name="net.psforever.objects.serverob
They are repackaged before submission and are often tagged for specific blame.</p></div><dl class="paramcmts block"><dt class="param">result</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/InGameHistory.html" name="net.psforever.objects.vital.InGameHistory" id="net.psforever.objects.vital.InGameHistory" class="extype">InGameHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.InGameHistory#LogActivity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LogActivity(action:Option[net.psforever.objects.vital.InGameActivity]):List[net.psforever.objects.vital.InGameActivity]" class="anchorToMember"></a><a id="LogActivity(Option[InGameActivity]):List[InGameActivity]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.html#LogActivity(action:Option[net.psforever.objects.vital.InGameActivity]):List[net.psforever.objects.vital.InGameActivity]" 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">LogActivity</span><span class="params">(<span name="action">action: <span name="scala.Option" class="extype">Option</span>[<a href="../../vital/InGameActivity.html" name="net.psforever.objects.vital.InGameActivity" id="net.psforever.objects.vital.InGameActivity" class="extype">InGameActivity</a>]</span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../vital/InGameActivity.html" name="net.psforever.objects.vital.InGameActivity" id="net.psforever.objects.vital.InGameActivity" class="extype">InGameActivity</a>]</span></span><p class="shortcomment cmt">An in-game event must be recorded.</p><div class="fullcomment"><div class="comment cmt"><p>An in-game 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 entity</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/InGameHistory.html" name="net.psforever.objects.vital.InGameHistory" id="net.psforever.objects.vital.InGameHistory" class="extype">InGameHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.InGameHistory#LogActivity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LogActivity(action:net.psforever.objects.vital.InGameActivity):List[net.psforever.objects.vital.InGameActivity]" class="anchorToMember"></a><a id="LogActivity(InGameActivity):List[InGameActivity]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.html#LogActivity(action:net.psforever.objects.vital.InGameActivity):List[net.psforever.objects.vital.InGameActivity]" 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">LogActivity</span><span class="params">(<span name="action">action: <a href="../../vital/InGameActivity.html" name="net.psforever.objects.vital.InGameActivity" id="net.psforever.objects.vital.InGameActivity" class="extype">InGameActivity</a></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../vital/InGameActivity.html" name="net.psforever.objects.vital.InGameActivity" id="net.psforever.objects.vital.InGameActivity" class="extype">InGameActivity</a>]</span></span><p class="shortcomment cmt">An in-game event must be recorded.</p><div class="fullcomment"><div class="comment cmt"><p>An in-game 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 entity</p></dd></dl><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../vital/InGameHistory.html" name="net.psforever.objects.vital.InGameHistory" id="net.psforever.objects.vital.InGameHistory" class="extype">InGameHistory</a></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.vital.Vitality#MaxHealth" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MaxHealth:Int" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.html#MaxHealth: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">MaxHealth</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/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#MaxHealth_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MaxHealth_=(default:Option[Int]):Int" class="anchorToMember"></a><a id="MaxHealth_=(Option[Int]):Int" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.html#MaxHealth_=(default:Option[Int]):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" title="gt4s: MaxHealth_$eq">MaxHealth_=</span><span class="params">(<span name="default">default: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span>)</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/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#MaxHealth_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MaxHealth_=(default:Int):Int" class="anchorToMember"></a><a id="MaxHealth_=(Int):Int" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.html#MaxHealth_=(default:Int):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" title="gt4s: MaxHealth_$eq">MaxHealth_=</span><span class="params">(<span name="default">default: <span name="scala.Int" class="extype">Int</span></span>)</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/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.PlanetSideGameObject#Orientation" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Orientation:net.psforever.types.Vector3" class="anchorToMember"></a><a id="Orientation:Vector3" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.html#Orientation:net.psforeve
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" class="anchorToMember"></a><a id="synchronized[T0](=&gt;T0):T0" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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" class="anchorToMember"></a><a id="updateBlockMapEntry(Vector3):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
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;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
<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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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" class="anchorToMember"></a><a id="wait(Long,Int):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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" class="anchorToMember"></a><a id="wait(Long):Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/structures/Amenity.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.zones.blockmap.BlockMapEntity" class="parent"><h3>Inherited from <a href="../../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></h3></div><div name="net.psforever.objects.vital.resistance.StandardResistanceProfile" class="parent"><h3>Inherited from <a href="../../vital/resistance/StandardResistanceProfile.html" name="net.psforever.objects.vital.resistance.StandardResistanceProfile" id="net.
Reference in a new issue Copy permalink