PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-03-01 11:33:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/environment/index.html

32 lines
70 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ 1a6beba335b41caf128caaae7b2ea9fbad4a71f8 🚀
2020-12-24 13:08:10 +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.environment</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.environment" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.environment" 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@ffa173374777e13de2f76f701a543492bf7058f9 🚀
2022-04-02 21:24:35 +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_"></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
Deploying to gh-pages from @ 1a6beba335b41caf128caaae7b2ea9fbad4a71f8 🚀
2020-12-24 13:08:10 +00:00
The modifier "deep" indicates that the valid area goes down from the altitude to the bottom of the world.</p></div><dl class="paramcmts block"><dt class="param">center</dt><dd class="cmt"><p>the center of the geometry (height)</p></dd><dt class="param">radius</dt><dd class="cmt"><p>how large the circle is</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.DeepPlane" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeepPlaneextendsEnvironmentCollisionwithProductwithSerializable"></a><a id="DeepPlane:DeepPlane"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/DeepPlane.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DeepPlane.html" title="A mathematical plane that is always perpendicular to world-up."><span class="name">DeepPlane</span></a><span class="params">(<span name="altitude">altitude: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result"> extends <a href="EnvironmentCollision.html" name="net.psforever.objects.serverobject.environment.EnvironmentCollision" id="net.psforever.objects.serverobject.environment.EnvironmentCollision" class="extype">EnvironmentCollision</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">A mathematical plane that is always perpendicular to world-up.</p><div class="fullcomment"><div class="comment cmt"><p>A mathematical plane that is always perpendicular to world-up.
The modifier "deep" indicates that the valid area goes down from the altitude to the bottom of the world.</p></div><dl class="paramcmts block"><dt class="param">altitude</dt><dd class="cmt"><p>the z-coordinate of the geometry (height)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.DeepSquare" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeepSquareextendsEnvironmentCollisionwithProductwithSerializable"></a><a id="DeepSquare:DeepSquare"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/DeepSquare.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DeepSquare.html" title="From above, a rectangular region that is always perpendicular to world-up and whose sides align with the X-axis and Y-axis, respectively."><span class="name">DeepSquare</span></a><span class="params">(<span name="altitude">altitude: <span name="scala.Float" class="extype">Float</span></span>, <span name="north">north: <span name="scala.Float" class="extype">Float</span></span>, <span name="east">east: <span name="scala.Float" class="extype">Float</span></span>, <span name="south">south: <span name="scala.Float" class="extype">Float</span></span>, <span name="west">west: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result"> extends <a href="EnvironmentCollision.html" name="net.psforever.objects.serverobject.environment.EnvironmentCollision" id="net.psforever.objects.serverobject.environment.EnvironmentCollision" class="extype">EnvironmentCollision</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">From above, a rectangular region that is always perpendicular to world-up
and whose sides align with the X-axis and Y-axis, respectively.</p><div class="fullcomment"><div class="comment cmt"><p>From above, a rectangular region that is always perpendicular to world-up
and whose sides align with the X-axis and Y-axis, respectively.
The modifier "deep" indicates that the valid area goes down from the altitude to the bottom of the world.</p></div><dl class="paramcmts block"><dt class="param">altitude</dt><dd class="cmt"><p>the z-coordinate of the geometry (height)</p></dd><dt class="param">north</dt><dd class="cmt"><p>the y-coordinate of the greatest side</p></dd><dt class="param">east</dt><dd class="cmt"><p>the x-coordinate of the other greatest side</p></dd><dt class="param">south</dt><dd class="cmt"><p>the y-coordinate of the least side</p></dd><dt class="param">west</dt><dd class="cmt"><p>the x-coordinate of the other least side</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.DeepSurface" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeepSurfaceextendsEnvironmentCollisionwithProductwithSerializable"></a><a id="DeepSurface:DeepSurface"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/DeepSurface.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DeepSurface.html" title="Similar to DeepRectangle, from above, a rectangular region that is always perpendicular to world-up and whose sides align with the X-axis and Y-axis, respectively."><span class="name">DeepSurface</span></a><span class="params">(<span name="altitude">altitude: <span name="scala.Float" class="extype">Float</span></span>, <span name="north">north: <span name="scala.Float" class="extype">Float</span></span>, <span name="east">east: <span name="scala.Float" class="extype">Float</span></span>, <span name="south">south: <span name="scala.Float" class="extype">Float</span></span>, <span name="west">west: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result"> extends <a href="EnvironmentCollision.html" name="net.psforever.objects.serverobject.environment.EnvironmentCollision" id="net.psforever.objects.serverobject.environment.EnvironmentCollision" class="extype">EnvironmentCollision</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Similar to <code>DeepRectangle</code>,
from above, a rectangular region that is always perpendicular to world-up
and whose sides align with the X-axis and Y-axis, respectively.</p><div class="fullcomment"><div class="comment cmt"><p>Similar to <code>DeepRectangle</code>,
from above, a rectangular region that is always perpendicular to world-up
and whose sides align with the X-axis and Y-axis, respectively.
The modifier "deep" indicates that the valid area goes down from the altitude to the bottom of the world.
It is never subject to variable intersection depth during testing.</p></div><dl class="paramcmts block"><dt class="param">altitude</dt><dd class="cmt"><p>the z-coordinate of the geometry (height)</p></dd><dt class="param">north</dt><dd class="cmt"><p>the y-coordinate of the greatest side</p></dd><dt class="param">east</dt><dd class="cmt"><p>the x-coordinate of the other greatest side</p></dd><dt class="param">south</dt><dd class="cmt"><p>the y-coordinate of the least side</p></dd><dt class="param">west</dt><dd class="cmt"><p>the x-coordinate of the other least side</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.EnvironmentCollision" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="EnvironmentCollisionextendsAnyRef"></a><a id="EnvironmentCollision:EnvironmentCollision"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/EnvironmentCollision.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="EnvironmentCollision.html" title="The coordinate representation of a feature of the game world that is not a formal game object, usually terrain, but can be used to represent any bounded region."><span class="name">EnvironmentCollision</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">The coordinate representation of a feature of the game world that is not a formal game object,
usually terrain, but can be used to represent any bounded region.</p><div class="fullcomment"><div class="comment cmt"><p>The coordinate representation of a feature of the game world that is not a formal game object,
usually terrain, but can be used to represent any bounded region.
Calling this "geometry" would be accurate yet still generous.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.EnvironmentTrait" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="EnvironmentTraitextendsEnumEntry"></a><a id="EnvironmentTrait:EnvironmentTrait"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/EnvironmentTrait.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="EnvironmentTrait.html" title="A general description of environment and its interactive possibilities."><span class="name">EnvironmentTrait</span></a><span class="result"> extends <span name="enumeratum.EnumEntry" class="extype">EnumEntry</span></span></span><p class="shortcomment cmt">A general description of environment and its interactive possibilities.</p></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.EscapeFromEnvironment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EscapeFromEnvironmentextendsProductwithSerializable"></a><a id="EscapeFromEnvironment:EscapeFromEnvironment"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/EscapeFromEnvironment.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="EscapeFromEnvironment.html" title="The target has ceased to clip into a critical region of a piece of environment."><span class="name">EscapeFromEnvironment</span></a><span class="params">(<span name="obj">obj: <a href="../PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a></span>, <span name="environment">environment: <a href="PieceOfEnvironment.html" name="net.psforever.objects.serverobject.environment.PieceOfEnvironment" id="net.psforever.objects.serverobject.environment.PieceOfEnvironment" class="extype">PieceOfEnvironment</a></span>, <span name="mountedVehicle">mountedVehicle: <span name="scala.Option" class="extype">Option</span>[<a href="OxygenStateTarget.html" name="net.psforever.objects.serverobject.environment.OxygenStateTarget" id="net.psforever.objects.serverobject.environment.OxygenStateTarget" class="extype">OxygenStateTarget</a>]</span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">The target has ceased to clip into a critical region of a piece of environment.</p><div class="fullcomment"><div class="comment cmt"><p>The target has ceased to clip into a critical region of a piece of environment.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the target</p></dd><dt class="param">environment</dt><dd class="cmt"><p>the previous terrain clipping region</p></dd><dt class="param">mountedVehicle</dt><dd class="cmt"><p>whether or not the target is mounted
Deploying to gh-pages from @ psforever/PSF-LoginServer@ffa173374777e13de2f76f701a543492bf7058f9 🚀
2022-04-02 21:24:35 +00:00
(specifically, if the target is a <code>Player</code> who is mounted in a <code>Vehicle</code>)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.GantryDenialField" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="GantryDenialFieldextendsPieceOfEnvironmentwithProductwithSerializable"></a><a id="GantryDenialField:GantryDenialField"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/GantryDenialField.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GantryDenialField.html" title=""><span class="name">GantryDenialField</span></a><span class="params">(<span name="obbasemesh">obbasemesh: <a href="../../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="mountPoint">mountPoint: <span name="scala.Int" class="extype">Int</span></span>, <span name="collision">collision: <a href="EnvironmentCollision.html" name="net.psforever.objects.serverobject.environment.EnvironmentCollision" id="net.psforever.objects.serverobject.environment.EnvironmentCollision" class="extype">EnvironmentCollision</a></span>)</span><span class="result"> extends <a href="PieceOfEnvironment.html" name="net.psforever.objects.serverobject.environment.PieceOfEnvironment" id="net.psforever.objects.serverobject.environment.PieceOfEnvironment" class="extype">PieceOfEnvironment</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.GeneralMovementField" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="GeneralMovementFieldextendsPieceOfEnvironmentwithProductwithSerializable"></a><a id="GeneralMovementField:GeneralMovementField"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/GeneralMovementField.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GeneralMovementField.html" title=""><span class="name">GeneralMovementField</span></a><span class="params">(<span name="triggerAction">triggerAction: (<a href="../../PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>) =&gt; <span name="scala.Unit" class="extype">Unit</span></span>, <span name="collision">collision: <a href="EnvironmentCollision.html" name="net.psforever.objects.serverobject.environment.EnvironmentCollision" id="net.psforever.objects.serverobject.environment.EnvironmentCollision" class="extype">EnvironmentCollision</a></span>)</span><span class="result"> extends <a href="PieceOfEnvironment.html" name="net.psforever.objects.serverobject.environment.PieceOfEnvironment" id="net.psforever.objects.serverobject.environment.PieceOfEnvironment" class="extype">PieceOfEnvironment</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.InteractWithEnvironment" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InteractWithEnvironmentextendsZoneInteraction"></a><a id="InteractWithEnvironment:InteractWithEnvironment"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/InteractWithEnvironment.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <sp
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
(specifically, if the target is a <code>Player</code> who is mounted in a <code>Vehicle</code>)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.OxygenStateTarget" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OxygenStateTargetextendsProductwithSerializable"></a><a id="OxygenStateTarget:OxygenStateTarget"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/OxygenStateTarget.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="OxygenStateTarget.html" title="Related to the progress of interacting with a body of water deeper than you are tall or deeper than your vehicle is off the ground."><span class="name">OxygenStateTarget</span></a><span class="params">(<span name="guid">guid: <a href="../../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="state">state: <a href="../../../types/OxygenState.html" name="net.psforever.types.OxygenState" id="net.psforever.types.OxygenState" class="extype">OxygenState</a></span>, <span name="progress">progress: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Related to the progress of interacting with a body of water deeper than you are tall or
Deploying to gh-pages from @ 1a6beba335b41caf128caaae7b2ea9fbad4a71f8 🚀
2020-12-24 13:08:10 +00:00
deeper than your vehicle is off the ground.</p><div class="fullcomment"><div class="comment cmt"><p>Related to the progress of interacting with a body of water deeper than you are tall or
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
deeper than your vehicle is off the ground.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the target</p></dd><dt class="param">state</dt><dd class="cmt"><p>whether they are recovering or suffocating</p></dd><dt class="param">progress</dt><dd class="cmt"><p>the percentage of completion towards the state</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.PieceOfEnvironment" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="PieceOfEnvironmentextendsBlockMapEntity"></a><a id="PieceOfEnvironment:PieceOfEnvironment"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/PieceOfEnvironment.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="PieceOfEnvironment.html" title="The representation of a feature of the game world that is not a formal game object, usually terrain, but can be used to represent any bounded region."><span class="name">PieceOfEnvironment</span></a><span class="result"> extends <a href="../../zones/blockmap/BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></span></span><p class="shortcomment cmt">The representation of a feature of the game world that is not a formal game object,
usually terrain, but can be used to represent any bounded region.</p></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.Pool" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PoolextendsPieceOfEnvironmentwithProductwithSerializable"></a><a id="Pool:Pool"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/Pool.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Pool.html" title="A limited environment that spans no specific region."><span class="name">Pool</span></a><span class="params">(<span name="attribute">attribute: <a href="EnvironmentTrait.html" name="net.psforever.objects.serverobject.environment.EnvironmentTrait" id="net.psforever.objects.serverobject.environment.EnvironmentTrait" class="extype">EnvironmentTrait</a></span>, <span name="collision">collision: <a href="EnvironmentCollision.html" name="net.psforever.objects.serverobject.environment.EnvironmentCollision" id="net.psforever.objects.serverobject.environment.EnvironmentCollision" class="extype">EnvironmentCollision</a></span>)</span><span class="result"> extends <a href="PieceOfEnvironment.html" name="net.psforever.objects.serverobject.environment.PieceOfEnvironment" id="net.psforever.objects.serverobject.environment.PieceOfEnvironment" class="extype">PieceOfEnvironment</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">A limited environment that spans no specific region.</p><div class="fullcomment"><div class="comment cmt"><p>A limited environment that spans no specific region.</p></div><dl class="paramcmts block"><dt class="param">attribute</dt><dd class="cmt"><p>of what the environment is composed</p></dd><dt class="param">collision</dt><dd class="cmt"><p>a special representation of the region that qualifies as "this environment"</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.RecoveredFromEnvironmentInteraction" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="RecoveredFromEnvironmentInteractionextendsProductwithSerializable"></a><a id="RecoveredFromEnvironmentInteraction:RecoveredFromEnvironmentInteraction"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/RecoveredFromEnvironmentInteraction.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="RecoveredFromEnvironmentInteraction.html" title="Completely reset any internal actions or processes related to environment clipping."><span class="name">RecoveredFromEnvironmentInteraction</span></a><span class="params">()</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">Completely reset any internal actions or processes related to environment clipping.</p></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.RespondsToZoneEnvironment" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="RespondsToZoneEnvironmentextendsAnyRef"></a><a id="RespondsToZoneEnvironment:RespondsToZoneEnvironment"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/RespondsToZoneEnvironment.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="RespondsToZoneEnvironment.html" title="The mixin code for any server object that responds to environmental representations in the game world."><span cl
Deploying to gh-pages from @ 1a6beba335b41caf128caaae7b2ea9fbad4a71f8 🚀
2020-12-24 13:08:10 +00:00
Specific types of environmental region is bound by geometry,
designated by attributes,
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
and targets react when coming into contact with it.
Deploying to gh-pages from @ 1a6beba335b41caf128caaae7b2ea9fbad4a71f8 🚀
2020-12-24 13:08:10 +00:00
Ideally, the target under control instigates the responses towards the environment
by independently re-evaluating the conditions of its interactions.
Only one kind of environment can elicit a response at a time.
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
While a reversal of this trigger scheme is possible, it is not ideal.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>InteractsWithEnvironment</code></p></span><span class="cmt"><p><code>PieceOfEnvironment</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.SeaLevel" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SeaLevelextendsPieceOfEnvironmentwithProductwithSerializable"></a><a id="SeaLevel:SeaLevel"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/SeaLevel.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SeaLevel.html" title="A planar environment that spans the whole of the game world and starts at and below a certain altitude."><span class="name">SeaLevel</span></a><span class="params">(<span name="attribute">attribute: <a href="EnvironmentTrait.html" name="net.psforever.objects.serverobject.environment.EnvironmentTrait" id="net.psforever.objects.serverobject.environment.EnvironmentTrait" class="extype">EnvironmentTrait</a></span>, <span name="altitude">altitude: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result"> extends <a href="PieceOfEnvironment.html" name="net.psforever.objects.serverobject.environment.PieceOfEnvironment" id="net.psforever.objects.serverobject.environment.PieceOfEnvironment" class="extype">PieceOfEnvironment</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span><p class="shortcomment cmt">A planar environment that spans the whole of the game world
Deploying to gh-pages from @ 1a6beba335b41caf128caaae7b2ea9fbad4a71f8 🚀
2020-12-24 13:08:10 +00:00
and starts at and below a certain altitude.</p><div class="fullcomment"><div class="comment cmt"><p>A planar environment that spans the whole of the game world
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
and starts at and below a certain altitude.</p></div><dl class="paramcmts block"><dt class="param">attribute</dt><dd class="cmt"><p>of what the environment is composed</p></dd><dt class="param">altitude</dt><dd class="cmt"><p>how high the environment starts</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.serverobject.environment.EnvironmentAttribute" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="EnvironmentAttribute"></a><a id="EnvironmentAttribute:EnvironmentAttribute"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/EnvironmentAttribute$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="EnvironmentAttribute$.html" title=""><span class="name">EnvironmentAttribute</span></a><span class="result"> extends <span name="enumeratum.Enum" class="extype">Enum</span>[<a href="EnvironmentTrait.html" name="net.psforever.objects.serverobject.environment.EnvironmentTrait" id="net.psforever.objects.serverobject.environment.EnvironmentTrait" class="extype">EnvironmentTrait</a>]</span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.EnvironmentInteraction" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="EnvironmentInteraction"></a><a id="EnvironmentInteraction:EnvironmentInteraction"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/EnvironmentInteraction$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case object</span></span> <span class="symbol"><a href="EnvironmentInteraction$.html" title=""><span class="name">EnvironmentInteraction</span></a><span class="result"> extends <a href="../../zones/ZoneInteractionType.html" name="net.psforever.objects.zones.ZoneInteractionType" id="net.psforever.objects.zones.ZoneInteractionType" class="extype">ZoneInteractionType</a> with <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.InteractWithEnvironment" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InteractWithEnvironment"></a><a id="InteractWithEnvironment:InteractWithEnvironment"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/InteractWithEnvironment$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="InteractWithEnvironment$.html" title=""><span class="name">InteractWithEnvironment</span></a></span></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.PieceOfEnvironment" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PieceOfEnvironment"></a><a id="PieceOfEnvironment:PieceOfEnvironment"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/PieceOfEnvironment$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="PieceOfEnvironment$.html" title=""><span class="name">PieceOfEnvironment</span></a></span></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.Pool" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Pool"></a><a id="Pool:Pool"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/Pool$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span c
Reference in a new issue Copy permalink