PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-13 11:43:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/environment/InteractWithEnvironment$.html

19 lines
43 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +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.InteractWithEnvironment</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.environment.InteractWithEnvironment" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.environment.InteractWithEnvironment" 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
test whether that special terrain component has an affect upon the target entity.</p><div class="fullcomment"><div class="comment cmt"><p>While on unstable, interactive, or special terrain,
test whether that special terrain component has an affect upon the target entity.
If no interaction exists,
treat the target as if it had been previously affected by the given terrain,
and instruct it to cease that assumption.
Transition between the affects of different special terrains is possible.
Considered tail recursive, but not treated that way.</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>the zone in which the terrain is located</p></dd><dt class="param">body</dt><dd class="cmt"><p>the special terrain</p></dd><dt class="param">obj</dt><dd class="cmt"><p>the target entity</p></dd><dt>returns</dt><dd class="cmt"><p>the function literal that represents the next iterative call of ongoing interaction testing;
may return itself</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>blockedFromInteracting</code></p></span><span class="cmt"><p><code>checkAllEnvironmentInteractions</code></p></span><span class="cmt"><p><code>checkSpecificEnvironmentInteraction</code></p></span><span class="cmt"><p><code>onStableEnvironment</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.InteractWithEnvironment#blockedFromInteracting" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="blockedFromInteracting()(obj:net.psforever.objects.serverobject.PlanetSideServerObject,allow:Boolean):Any"></a><a id="blockedFromInteracting()(PlanetSideServerObject,Boolean):Any"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/InteractWithEnvironment$.html#blockedFromInteracting()(obj:net.psforever.objects.serverobject.PlanetSideServerObject,allow:Boolean):Any" 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">blockedFromInteracting</span><span class="params">()</span><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="allow">allow: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Any" class="extype">Any</span></span></span><p class="shortcomment cmt">Do not care whether on stable non-interactive terrain or on unstable interactive terrain.</p><div class="fullcomment"><div class="comment cmt"><p>Do not care whether on stable non-interactive terrain or on unstable interactive terrain.
Wait until allowed to test again (external flag).
Considered tail recursive, but not treated that way.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the target entity</p></dd><dt>returns</dt><dd class="cmt"><p>the function literal that represents the next iterative call of ongoing interaction testing;
may return itself</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>onStableEnvironment</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.environment.InteractWithEnvironment#checkAllEnvironmentInteractions" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="checkAllEnvironmentInteractions(obj:net.psforever.objects.serverobject.PlanetSideServerObject):Option[net.psforever.objects.serverobject.environment.PieceOfEnvironment]"></a><a id="checkAllEnvironmentInteractions(PlanetSideServerObject):Option[PieceOfEnvironment]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/InteractWithEnvironment$.html#checkAllEnvironmentInteractions(obj:net.psforever.objects.serverobject.PlanetSideServerObject):Option[net.psforever.objects.serverobject.environment.PieceOfEnvironment]" 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">checkAllEnvironmentInteractions</span><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><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="PieceOfEnvironment.html" name="net.psforever.objects.serverobject.environment.PieceOfEnvironment" id="net.psforever.objects.serverobject.environment.PieceOfEnvironment" class="extype">PieceOfEnvironment</a>]</span></span><p class="shortcomment cmt">Test whether any special terrain component has an affect upon the target entity.</p><div class="fullcomment"><div class="comment cmt"><p>Test whether any special terrain component has an affect upon the target entity.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the target entity</p></dd><dt>returns</dt><dd class="cmt"><p>any unstable, interactive, or special terrain that is being interacted</p></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/InteractWithEnvironment$.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/environment/InteractWithEnvironment$.html#eq(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="full
test whether any special terrain component has an affect upon the target entity.</p><div class="fullcomment"><div class="comment cmt"><p>While on stable non-interactive terrain,
test whether any special terrain component has an affect upon the target entity.
If so, instruct the target that an interaction should occur.
Considered tail recursive, but not treated that way.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the target entity</p></dd><dt>returns</dt><dd class="cmt"><p>the function literal that represents the next iterative call of ongoing interaction testing;
may return itself</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>blockedFromInteracting</code></p></span><span class="cmt"><p><code>checkAllEnvironmentInteractions</code></p></span><span class="cmt"><p><code>awaitOngoingInteraction</code></p></span></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/environment/InteractWithEnvironment$.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/environment/InteractWithEnvironment$.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="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/environment/InteractWithEnvironment$.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/environment/InteractWithEnvironment$.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><s
Reference in a new issue Copy permalink