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

12 lines
50 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +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.mount.MountableSpace</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.mount.MountableSpace" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.mount.MountableSpace" 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 @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
a condition whereupon it can be unmounted under duress?
The conditions of the duress do not matter at the moment;
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
this is only a test of possibility.</p></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.MountableSpace#canBeOccupied" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="canBeOccupied:Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#canBeOccupied: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">canBeOccupied</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Can something be mounted?
Use this method as a test for "availability".</p></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.MountableSpace#canBeOccupiedBy" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="canBeOccupiedBy(target:A):Boolean" class="anchorToMember"></a><a id="canBeOccupiedBy(A):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#canBeOccupiedBy(target:A):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">canBeOccupiedBy</span><span class="params">(<span name="target">target: <span name="net.psforever.objects.serverobject.mount.MountableSpace.A" class="extype">A</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Is this specific entity allowed to be mounted in this space?
Deploying to gh-pages from @ psforever/PSF-LoginServer@71ab35ecab7d8975cceccf1969188af758f160b6 🚀
2021-03-23 13:48:01 +00:00
Utiltizes restriction tests, but not "availability" tests.</p><div class="fullcomment"><div class="comment cmt"><p>Is this specific entity allowed to be mounted in this space?
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
Utiltizes restriction tests, but not "availability" tests.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>MountableDefinition[A].restriction</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object" class="anchorToMember"></a><a id="clone():AnyRef" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.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" class="anchorToMember"></a><a id="eq(AnyRef):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.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="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean" class="anchorToMember"></a><a id="equals(AnyRef):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#equals(x$1:Object):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">equals</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="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#finalize():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">finalize</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>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="symbol">classOf[java.lang.Throwable]</span></s
Do not use this method as a test for "availability".</p></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.MountableSpace#isOccupiedBy" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="isOccupiedBy(target:A):Boolean" class="anchorToMember"></a><a id="isOccupiedBy(A):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#isOccupiedBy(target:A):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">isOccupiedBy</span><span class="params">(<span name="target">target: <span name="net.psforever.objects.serverobject.mount.MountableSpace.A" class="extype">A</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Is this specific entity currently mounted?
</p></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.MountableSpace#mount" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="mount(target:Option[A]):Option[A]" class="anchorToMember"></a><a id="mount(Option[A]):Option[A]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#mount(target:Option[A]):Option[A]" 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">mount</span><span class="params">(<span name="target">target: <span name="scala.Option" class="extype">Option</span>[<span name="net.psforever.objects.serverobject.mount.MountableSpace.A" class="extype">A</span>]</span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="net.psforever.objects.serverobject.mount.MountableSpace.A" class="extype">A</span>]</span></span><p class="shortcomment cmt">Attempt to mount the target entity in this space.</p></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.MountableSpace#mount" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="mount(target:A):Option[A]" class="anchorToMember"></a><a id="mount(A):Option[A]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#mount(target:A):Option[A]" 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">mount</span><span class="params">(<span name="target">target: <span name="net.psforever.objects.serverobject.mount.MountableSpace.A" class="extype">A</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="net.psforever.objects.serverobject.mount.MountableSpace.A" class="extype">A</span>]</span></span><p class="shortcomment cmt">Attempt to mount the target entity in this space.</p></li><li class="indented0 " name="scala.AnyRef#ne" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ne(x$1:AnyRef):Boolean" class="anchorToMember"></a><a id="ne(AnyRef):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#ne(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">ne</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="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#notify():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">notify</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">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit" class="anchorToMember"></a> <span
Useful for compiling all seated users using <code>flatMap</code>.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>all mounted entities</p></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/mount/MountableSpace.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="net.psforever.objects.serverobject.mount.MountableSpace#testToMount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="testToMount(target:A):Boolean" class="anchorToMember"></a><a id="testToMount(A):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#testToMount(target:A):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">testToMount</span><span class="params">(<span name="target">target: <span name="net.psforever.objects.serverobject.mount.MountableSpace.A" class="extype">A</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Tests whether the target is allowed to be mounted.</p><div class="fullcomment"><div class="comment cmt"><p>Tests whether the target is allowed to be mounted.</p></div><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>See also</dt><dd><span class="cmt"><p><code>MountableSpace[A].canBeOccupiedBy(A)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.mount.MountableSpace#testToUnmount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="testToUnmount(target:A):Boolean" class="anchorToMember"></a><a id="testToUnmount(A):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/mount/MountableSpace.html#testToUnmount(target:A):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">testToUnmount</span><span class="params">(<span name="target">target: <span name="net.psforever.objects.serverobject.mount.MountableSpace.A" class="extype">A</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Tests whether the target is capable of being unmounted from this place.</p><div class="fullcomment"><div class="comment cmt"><p>Tests whether the target is capable of being unmounted from this place.</p></div><dl class="attributes block"><dt>Attributes</dt><dd>protected </dd><dt>See also</dt><dd><span class="cmt"><p><code>MountableSpace[A].isOccupiedBy(A)</code></p></span></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/mount/
Reference in a new issue Copy permalink