PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-25 09:33:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/zones/blockmap/BlockMap$.html

17 lines
44 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.zones.blockmap.BlockMap</title><meta content="PSF - LoginServer - master - net.psforever.objects.zones.blockmap.BlockMap" name="description"/><meta content="PSF LoginServer master net.psforever.objects.zones.blockmap.BlockMap" 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@229777559f6c68be9f4272d5b89fd782ac5032ad 🚀
2022-06-25 02:11:25 +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.zones" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="zones"></a><a id="zones:zones"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/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=""><spa
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
so find the indices of the sectors that correspond to the region
defined by the range around a coordinate position.</p><div class="fullcomment"><div class="comment cmt"><p>The blockmap is mapped to a coordinate range in two directions,
so find the indices of the sectors that correspond to the region
Deploying to gh-pages from @ psforever/PSF-LoginServer@5787c14a297132e1e328b61ae21ea89cad5bbfb9 🚀
2022-05-07 04:43:54 +00:00
defined by the range around a coordinate position.</p></div><dl class="paramcmts block"><dt class="param">blockMap</dt><dd class="cmt"><p>the blockmap structure</p></dd><dt class="param">p</dt><dd class="cmt"><p>the coordinate position</p></dd><dt class="param">rangeX</dt><dd class="cmt"><p>a rectangular range aigned with the lateral x-axis extending from a coordinate position</p></dd><dt class="param">rangeY</dt><dd class="cmt"><p>a rectangular range aigned with the lateral y-axis extending from a coordinate position</p></dd><dt>returns</dt><dd class="cmt"><p>the indices of the sectors in the blockmap structure</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#findSectorIndices" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="findSectorIndices(blockMap:net.psforever.objects.zones.blockmap.BlockMap,p:net.psforever.types.Vector3,range:Float):Iterable[Int]"></a><a id="findSectorIndices(BlockMap,Vector3,Float):Iterable[Int]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.html#findSectorIndices(blockMap:net.psforever.objects.zones.blockmap.BlockMap,p:net.psforever.types.Vector3,range:Float):Iterable[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">findSectorIndices</span><span class="params">(<span name="blockMap">blockMap: <a href="BlockMap.html" name="net.psforever.objects.zones.blockmap.BlockMap" id="net.psforever.objects.zones.blockmap.BlockMap" class="extype">BlockMap</a></span>, <span name="p">p: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="range">range: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="result">: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">The blockmap is mapped to a coordinate range in two directions,
so find the indices of the sectors that correspond to the region
defined by the range around a coordinate position.</p><div class="fullcomment"><div class="comment cmt"><p>The blockmap is mapped to a coordinate range in two directions,
so find the indices of the sectors that correspond to the region
defined by the range around a coordinate position.</p></div><dl class="paramcmts block"><dt class="param">blockMap</dt><dd class="cmt"><p>the blockmap structure</p></dd><dt class="param">p</dt><dd class="cmt"><p>the coordinate position</p></dd><dt class="param">range</dt><dd class="cmt"><p>a rectangular range aigned with lateral axes extending from a coordinate position</p></dd><dt>returns</dt><dd class="cmt"><p>the indices of the sectors in the blockmap structure</p></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_&lt;:AnyRef]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.html#getClass():Class[_]" 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">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.Class" name="java.lang.Class" id="java.lang.Class" class="extype">Class</a>[_ &lt;: <span name="scala.AnyRef" class="extype">AnyRef</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#hashCode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hashCode():Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.html#hashCode():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">hashCode</span><span class="params">()</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>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.html#isInstanceOf[T0]: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">isInstanceOf</span><span class="tparams">[<span name="T0">T0</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>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#ne" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.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"></a> <span class="per
If a group of sectors, organize them into a single referential sector.</p></div><dl class="paramcmts block"><dt class="param">rangeX</dt><dd class="cmt"><p>a custom range value for the x-axis</p></dd><dt class="param">rangeY</dt><dd class="cmt"><p>a custom range value for the y-axis</p></dd><dt class="param">to</dt><dd class="cmt"><p>all allocated sectors</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></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#quickToSectorGroup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="quickToSectorGroup(range:Float,to:Iterable[net.psforever.objects.zones.blockmap.Sector]):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="quickToSectorGroup(Float,Iterable[Sector]):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.html#quickToSectorGroup(range:Float,to:Iterable[net.psforever.objects.zones.blockmap.Sector]):net.psforever.objects.zones.blockmap.SectorPopulation" 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">quickToSectorGroup</span><span class="params">(<span name="range">range: <span name="scala.Float" class="extype">Float</span></span>, <span name="to">to: <span name="scala.Iterable" class="extype">Iterable</span>[<a href="Sector.html" name="net.psforever.objects.zones.blockmap.Sector" id="net.psforever.objects.zones.blockmap.Sector" class="extype">Sector</a>]</span>)</span><span class="result">: <a href="SectorPopulation.html" name="net.psforever.objects.zones.blockmap.SectorPopulation" id="net.psforever.objects.zones.blockmap.SectorPopulation" class="extype">SectorPopulation</a></span></span><p class="shortcomment cmt">If only one sector, just return that sector.</p><div class="fullcomment"><div class="comment cmt"><p>If only one sector, just return that sector.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6ae0b4484862d657a5e0c449e5612cfe8779746b 🚀
2022-01-27 15:01:40 +00:00
If a group of sectors, organize them into a single referential sector.</p></div><dl class="paramcmts block"><dt class="param">range</dt><dd class="cmt"><p>a custom range value</p></dd><dt class="param">to</dt><dd class="cmt"><p>all allocated sectors</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></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#quickToSectorGroup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="quickToSectorGroup(to:Iterable[net.psforever.objects.zones.blockmap.Sector]):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="quickToSectorGroup(Iterable[Sector]):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.html#quickToSectorGroup(to:Iterable[net.psforever.objects.zones.blockmap.Sector]):net.psforever.objects.zones.blockmap.SectorPopulation" 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">quickToSectorGroup</span><span class="params">(<span name="to">to: <span name="scala.Iterable" class="extype">Iterable</span>[<a href="Sector.html" name="net.psforever.objects.zones.blockmap.Sector" id="net.psforever.objects.zones.blockmap.Sector" class="extype">Sector</a>]</span>)</span><span class="result">: <a href="SectorPopulation.html" name="net.psforever.objects.zones.blockmap.SectorPopulation" id="net.psforever.objects.zones.blockmap.SectorPopulation" class="extype">SectorPopulation</a></span></span><p class="shortcomment cmt">If only one sector, just return that sector.</p><div class="fullcomment"><div class="comment cmt"><p>If only one sector, just return that sector.
Deploying to gh-pages from @ psforever/PSF-LoginServer@5787c14a297132e1e328b61ae21ea89cad5bbfb9 🚀
2022-05-07 04:43:54 +00:00
If a group of sectors, organize them into a single referential sector.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>all allocated sectors</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></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#rangeFromEntity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="rangeFromEntity(target:net.psforever.objects.zones.blockmap.BlockMapEntity,defaultX:Option[Float],defaultY:Option[Float]):(Float,Float)"></a><a id="rangeFromEntity(BlockMapEntity,Option[Float],Option[Float]):(Float,Float)"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.html#rangeFromEntity(target:net.psforever.objects.zones.blockmap.BlockMapEntity,defaultX:Option[Float],defaultY:Option[Float]):(Float,Float)" 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">rangeFromEntity</span><span class="params">(<span name="target">target: <a href="BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</a></span>, <span name="defaultX">defaultX: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Float" class="extype">Float</span>] = <span class="symbol">None</span></span>, <span name="defaultY">defaultY: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Float" class="extype">Float</span>] = <span class="symbol">None</span></span>)</span><span class="result">: (<span name="scala.Float" class="extype">Float</span>, <span name="scala.Float" class="extype">Float</span>)</span></span><p class="shortcomment cmt">Calculate the range expressed by a certain entity that can be allocated into a sector on the blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Calculate the range expressed by a certain entity that can be allocated into a sector on the blockmap.
Entities have different ways of expressing these ranges.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">defaultX</dt><dd class="cmt"><p>a default range for the x-axis, if no specific case is discovered;
if no default case, the default-default case is a single unit (<code>1.0f</code>)</p></dd><dt class="param">defaultY</dt><dd class="cmt"><p>a default range for the y-axis, if no specific case is discovered;
if no default case, the default-default case is a single unit (<code>1.0f</code>)</p></dd><dt>returns</dt><dd class="cmt"><p>the distance from a central position along the major axes (y-axis, then x-axis)</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"></a><a id="synchronized[T0](=&gt;T0):T0"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.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/zones/blockmap/BlockMap$.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/zones/blockmap/BlockMap$.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/zones/blockmap/BlockMap$.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" ful
Reference in a new issue Copy permalink