mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-02-25 17:43:37 +00:00
44 lines
71 KiB
HTML
44 lines
71 KiB
HTML
<!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 */
|
|
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"><</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=""><span class="name">zones</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.zones.blockmap" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="blockmap"></a><a id="blockmap:blockmap"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/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">blockmap</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.zones" id="net.psforever.objects.zones" class="extype">zones</a></dd></dl></div></li><li class="current-entities indented5"><a href="BlockMap$.html" title="" class="object"></a> <a href="" title="A data structure which divides coordinate space into buckets or coordinate spans." class="class"></a><a href="" title="A data structure which divides coordinate space into buckets or coordinate spans.">BlockMap</a></li><li class="current-entities indented5"><a href="BlockMapEntity$.html" title="" class="object"></a> <a href="BlockMapEntity.html" title="An game object that can be represented on a blockmap." class="trait"></a><a href="BlockMapEntity.html" title="An game object that can be represented on a blockmap.">BlockMapEntity</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="BlockMapEntry.html" title="" class="class"></a><a href="BlockMapEntry.html" title="">BlockMapEntry</a></li><li class="current-entities indented5"><a href="Sector$.html" title="" class="object"></a> <a href="Sector.html" title="The bucket of a blockmap structure that contains lists of entities that, within a given span of coordinate distance, are considered neighbors." class="class"></a><a href="Sector.html" title="The bucket of a blockmap structure that contains lists of entities that, within a given span of coordinate distance, are considered neighbors.">Sector</a></li><li class="current-entities indented5"><a href="SectorGroup$.html" title="" class="object"></a> <a href="SectorGroup.html" title="The specific datastructure that is mentioned when using the term "sector conglomerate"." class="class"></a><a href="SectorGroup.html" title="The specific datastructure that is mentioned when using the term "sector conglomerate".">SectorGroup</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="SectorListOf.html" title="Custom lists of entities for sector buckets." class="class"></a><a href="SectorListOf.html" title="Custom lists of entities for sector buckets.">SectorListOf</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="SectorPopulation.html" title="The collections of entities in a sector conglomerate." class="trait"></a><a href="SectorPopulation.html" title="The collections of entities in a sector conglomerate.">SectorPopulation</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="SectorTraits.html" title="Information about the sector." class="trait"></a><a href="SectorTraits.html" title="Information about the sector.">SectorTraits</a></li></ul></div></div><div id="content"><body class="class type"><div id="definition"><a href="BlockMap$.html" title="See companion object"><div class="big-circle class-companion-object">c</div></a><p id="owner"><a href="../../../../index.html" name="net" id="net" class="extype">net</a>.<a href="../../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a>.<a href="../../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a>.<a href="../index.html" name="net.psforever.objects.zones" id="net.psforever.objects.zones" class="extype">zones</a>.<a href="index.html" name="net.psforever.objects.zones.blockmap" id="net.psforever.objects.zones.blockmap" class="extype">blockmap</a></p><h1><a href="BlockMap$.html" title="See companion object">BlockMap</a><span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html" title="Permalink"><i class="material-icons"></i></a></span></h1><h3><span class="morelinks"><div>Companion <a href="BlockMap$.html" title="See companion object">object BlockMap</a></div></span></h3></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><span class="name">BlockMap</span><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span></h4><div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A data structure which divides coordinate space into buckets or coordinate spans.
|
|
The function of the blockmap is to organize the instantiated game objects (entities)
|
|
that can be represented in coordinate space into a bucket each or into multiple buckets each
|
|
that reflect their locality with other game objects in the same coordinate space.
|
|
Polling based on either positions or on entities should be able to recover a lists of entities
|
|
that are considered neighbors in the context of that position and a rectangular distance around the position.
|
|
The purpose of the blockmap is to improve targeting when making such locality determinations.<br>
|
|
<br>
|
|
The coordinate space of a PlanetSide zone may contain 65535 entities, one of which is the same target entity.
|
|
A bucket on the blockmap should contain only a small fraction of the full zone's entities.</p></div><dl class="attributes block"><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/objects/zones/blockmap/BlockMap.scala" target="_blank">BlockMap.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.objects.zones.blockmap.BlockMap"><span>BlockMap</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#<init>" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="<init>(fullMapWidth:Int,fullMapHeight:Int,desiredSpanSize:Int):net.psforever.objects.zones.blockmap.BlockMap"></a><a id="<init>:BlockMap"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#<init>(fullMapWidth:Int,fullMapHeight:Int,desiredSpanSize:Int):net.psforever.objects.zones.blockmap.BlockMap" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">BlockMap</span><span class="params">(<span name="fullMapWidth">fullMapWidth: <span name="scala.Int" class="extype">Int</span></span>, <span name="fullMapHeight">fullMapHeight: <span name="scala.Int" class="extype">Int</span></span>, <span name="desiredSpanSize">desiredSpanSize: <span name="scala.Int" class="extype">Int</span></span>)</span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">fullMapWidth</dt><dd class="cmt"><p>maximum width of the coordinate space (m)</p></dd><dt class="param">fullMapHeight</dt><dd class="cmt"><p>maximum height of the coordinate space (m)</p></dd><dt class="param">desiredSpanSize</dt><dd class="cmt"><p>the amount of coordinate space attributed to each bucket in the blockmap (m)</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#!=(x$1:Any):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" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</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###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html###:Int" 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" title="gt4s: $hash$hash">##</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></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#==(x$1:Any):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" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</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="net.psforever.objects.zones.blockmap.BlockMap#addTo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,rangeX:Float,rangeY:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="addTo(BlockMapEntity,Vector3,Float,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,rangeX:Float,rangeY:Float):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">addTo</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="toPosition">toPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="rangeX">rangeX: <span name="scala.Float" class="extype">Float</span></span>, <span name="rangeY">rangeY: <span name="scala.Float" class="extype">Float</span></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">Allocate this entity into appropriate sectors on the blockmap
|
|
using the provided game world coordinates and the provided axis range.</p><div class="fullcomment"><div class="comment cmt"><p>Allocate this entity into appropriate sectors on the blockmap
|
|
using the provided game world coordinates and the provided axis range.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">toPosition</dt><dd class="cmt"><p>the game world coordinates that indicate the central sector</p></dd><dt class="param">rangeX</dt><dd class="cmt"><p>the distance from the central sector along the major x-axis</p></dd><dt class="param">rangeY</dt><dd class="cmt"><p>the distance from the central sector along the major y-axis</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>BlockMap.findSectorIndices</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#addTo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,range:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="addTo(BlockMapEntity,Vector3,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,range:Float):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">addTo</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="toPosition">toPosition: <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">: <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">Allocate this entity into appropriate sectors on the blockmap
|
|
using the provided game world coordinates and the provided axis range.</p><div class="fullcomment"><div class="comment cmt"><p>Allocate this entity into appropriate sectors on the blockmap
|
|
using the provided game world coordinates and the provided axis range.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">toPosition</dt><dd class="cmt"><p>the game world coordinates that indicate the central sector</p></dd><dt class="param">range</dt><dd class="cmt"><p>the distance from the central sector along the major axes</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>BlockMap.findSectorIndices</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#addTo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity,range:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="addTo(BlockMapEntity,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity,range:Float):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">addTo</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="range">range: <span name="scala.Float" class="extype">Float</span></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">Allocate this entity into appropriate sectors on the blockmap
|
|
using the provided custom axis range.</p><div class="fullcomment"><div class="comment cmt"><p>Allocate this entity into appropriate sectors on the blockmap
|
|
using the provided custom axis range.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">range</dt><dd class="cmt"><p>the custom distance from the central sector along the major axes</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>addTo(BlockMapEntity, Vector3, Float)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#addTo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="addTo(BlockMapEntity,Vector3):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3):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">addTo</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="toPosition">toPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</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">Allocate this entity into appropriate sectors on the blockmap
|
|
at the provided game world coordinates.</p><div class="fullcomment"><div class="comment cmt"><p>Allocate this entity into appropriate sectors on the blockmap
|
|
at the provided game world coordinates.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">toPosition</dt><dd class="cmt"><p>the custom game world coordinates that indicate the central sector</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>addTo(BlockMapEntity, Vector3, Float)</code></p></span><span class="cmt"><p><code>BlockMap.rangeFromEntity</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#addTo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="addTo(BlockMapEntity):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#addTo(target:net.psforever.objects.zones.blockmap.BlockMapEntity):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">addTo</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><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">Allocate this entity into appropriate sectors on the blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Allocate this entity into appropriate sectors on the blockmap.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>addTo(BlockMapEntity, Vector3)</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#asInstanceOf[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">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#blocks" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="blocks:scala.collection.mutable.ListBuffer[net.psforever.objects.zones.blockmap.Sector]"></a><a id="blocks:ListBuffer[Sector]"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#blocks:scala.collection.mutable.ListBuffer[net.psforever.objects.zones.blockmap.Sector]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">blocks</span><span class="result">: <span name="scala.collection.mutable.ListBuffer" class="extype">ListBuffer</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><p class="shortcomment cmt">the sectors / blocks / buckets into which entities that submit themselves are divided;
|
|
while the represented region need not be square, the sectors are defined as squares
|
|
</p></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#blocksInRow" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="blocksInRow:Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#blocksInRow:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">blocksInRow</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">how many sectors are in a row;
|
|
the far side sector may run off into un-navigable regions but will always contain a sliver of represented map space,
|
|
for example, on a 0-10 grid where the span size is 3, the spans will begin at (0, 3, 6, 9)
|
|
and the last span will only have two-thirds of its region valid;
|
|
the invalid, not represented regions should be silently ignored
|
|
</p></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/zones/blockmap/BlockMap.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/zones/blockmap/BlockMap.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"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.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"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.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></span>)</span> </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[_<: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>[_ <: <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="net.psforever.objects.zones.blockmap.BlockMap#move" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="move(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,fromPosition:net.psforever.types.Vector3,rangeX:Float,rangeY:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="move(BlockMapEntity,Vector3,Vector3,Float,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#move(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,fromPosition:net.psforever.types.Vector3,rangeX:Float,rangeY:Float):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">move</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="toPosition">toPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="fromPosition">fromPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="rangeX">rangeX: <span name="scala.Float" class="extype">Float</span></span>, <span name="rangeY">rangeY: <span name="scala.Float" class="extype">Float</span></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">Move an entity on the blockmap structure and update the prerequisite internal information.</p><div class="fullcomment"><div class="comment cmt"><p>Move an entity on the blockmap structure and update the prerequisite internal information.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">toPosition</dt><dd class="cmt"><p>the next location of the entity in world coordinates</p></dd><dt class="param">fromPosition</dt><dd class="cmt"><p>the current location of the entity in world coordinates</p></dd><dt class="param">rangeX</dt><dd class="cmt"><p>the distance from the location along the major x-axis</p></dd><dt class="param">rangeY</dt><dd class="cmt"><p>the distance from the location along the major y-axis</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#move" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="move(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,fromPosition:net.psforever.types.Vector3,range:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="move(BlockMapEntity,Vector3,Vector3,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#move(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,fromPosition:net.psforever.types.Vector3,range:Float):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">move</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="toPosition">toPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="fromPosition">fromPosition: <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">: <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">Move an entity on the blockmap structure and update the prerequisite internal information.</p><div class="fullcomment"><div class="comment cmt"><p>Move an entity on the blockmap structure and update the prerequisite internal information.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">toPosition</dt><dd class="cmt"><p>the next location of the entity in world coordinates</p></dd><dt class="param">fromPosition</dt><dd class="cmt"><p>the current location of the entity in world coordinates</p></dd><dt class="param">range</dt><dd class="cmt"><p>the distance from the location along the major axes</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#move" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="move(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,fromPosition:net.psforever.types.Vector3):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="move(BlockMapEntity,Vector3,Vector3):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#move(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3,fromPosition:net.psforever.types.Vector3):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">move</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="toPosition">toPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="fromPosition">fromPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</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">Move an entity on the blockmap structure and update the prerequisite internal information.</p><div class="fullcomment"><div class="comment cmt"><p>Move an entity on the blockmap structure and update the prerequisite internal information.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">toPosition</dt><dd class="cmt"><p>the next location of the entity in world coordinates</p></dd><dt class="param">fromPosition</dt><dd class="cmt"><p>ignored</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>move(BlockMapEntity, Vector3)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#move" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="move(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="move(BlockMapEntity,Vector3):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#move(target:net.psforever.objects.zones.blockmap.BlockMapEntity,toPosition:net.psforever.types.Vector3):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">move</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="toPosition">toPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</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">Move an entity on the blockmap structure and update the prerequisite internal information.</p><div class="fullcomment"><div class="comment cmt"><p>Move an entity on the blockmap structure and update the prerequisite internal information.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">toPosition</dt><dd class="cmt"><p>the next location of the entity in world coordinates</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>move(BlockMapEntity, Vector3, Vector3, Float)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#move" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="move(target:net.psforever.objects.zones.blockmap.BlockMapEntity):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="move(BlockMapEntity):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#move(target:net.psforever.objects.zones.blockmap.BlockMapEntity):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">move</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><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">Move an entity on the blockmap structure and update the prerequisite internal information.</p><div class="fullcomment"><div class="comment cmt"><p>Move an entity on the blockmap structure and update the prerequisite internal information.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>move(BlockMapEntity, Vector3, Vector3, Float)</code></p></span></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="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.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"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#notifyAll():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">notifyAll</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="net.psforever.objects.zones.blockmap.BlockMap#removeFrom" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="removeFrom(target:net.psforever.objects.zones.blockmap.BlockMapEntity,fromPosition:net.psforever.types.Vector3,range:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="removeFrom(BlockMapEntity,Vector3,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#removeFrom(target:net.psforever.objects.zones.blockmap.BlockMapEntity,fromPosition:net.psforever.types.Vector3,range:Float):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">removeFrom</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="fromPosition">fromPosition: <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">: <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">Deallocate this entity from appropriate sectors on the blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Deallocate this entity from appropriate sectors on the blockmap.
|
|
Other parameters are included for symmetry with a respective <code>addto</code> method,
|
|
but are ignored since removing an entity from a sector from which it is not represented is ill-advised
|
|
as is not removing an entity from any sector that it occupies.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">fromPosition</dt><dd class="cmt"><p>ignored</p></dd><dt class="param">range</dt><dd class="cmt"><p>ignored</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>removeFrom(BlockMapEntity)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#removeFrom" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="removeFrom(target:net.psforever.objects.zones.blockmap.BlockMapEntity,range:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="removeFrom(BlockMapEntity,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#removeFrom(target:net.psforever.objects.zones.blockmap.BlockMapEntity,range:Float):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">removeFrom</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="range">range: <span name="scala.Float" class="extype">Float</span></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">Deallocate this entity from appropriate sectors on the blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Deallocate this entity from appropriate sectors on the blockmap.
|
|
Other parameters are included for symmetry with a respective <code>addto</code> method,
|
|
but are ignored since removing an entity from a sector from which it is not represented is ill-advised
|
|
as is not removing an entity from any sector that it occupies.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">range</dt><dd class="cmt"><p>ignored</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>removeFrom(BlockMapEntity)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#removeFrom" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="removeFrom(target:net.psforever.objects.zones.blockmap.BlockMapEntity,fromPosition:net.psforever.types.Vector3):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="removeFrom(BlockMapEntity,Vector3):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#removeFrom(target:net.psforever.objects.zones.blockmap.BlockMapEntity,fromPosition:net.psforever.types.Vector3):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">removeFrom</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="fromPosition">fromPosition: <a href="../../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</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">Deallocate this entity from appropriate sectors on the blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Deallocate this entity from appropriate sectors on the blockmap.
|
|
Other parameters are included for symmetry with a respective <code>addto</code> method,
|
|
but are ignored since removing an entity from a sector from which it is not represented is ill-advised
|
|
as is not removing an entity from any sector that it occupies.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt class="param">fromPosition</dt><dd class="cmt"><p>ignored</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>removeFrom(BlockMapEntity)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#removeFrom" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="removeFrom(target:net.psforever.objects.zones.blockmap.BlockMapEntity):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="removeFrom(BlockMapEntity):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#removeFrom(target:net.psforever.objects.zones.blockmap.BlockMapEntity):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">removeFrom</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><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">Deallocate this entity from appropriate sectors on the blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>Deallocate this entity from appropriate sectors on the blockmap.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the allocated sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>actuallyRemoveFrom(BlockMapEntity, Vector3, Float)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#sector" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="sector(p:net.psforever.types.Vector3,range:Float):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="sector(Vector3,Float):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#sector(p:net.psforever.types.Vector3,range:Float):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">sector</span><span class="params">(<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">: <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">Given a coordinate position within representable space and a range from that representable space,
|
|
find the sector conglomerate to which this range allocates.</p><div class="fullcomment"><div class="comment cmt"><p>Given a coordinate position within representable space and a range from that representable space,
|
|
find the sector conglomerate to which this range allocates.</p></div><dl class="paramcmts block"><dt class="param">p</dt><dd class="cmt"><p>the game world coordinates</p></dd><dt class="param">range</dt><dd class="cmt"><p>the axis distance from the provided coordinates</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the discovered sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>BlockMap.findSectorIndices</code></p></span><span class="cmt"><p><code>BlockMap.quickToSectorGroup</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#sector" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="sector(entity:net.psforever.objects.zones.blockmap.BlockMapEntity):net.psforever.objects.zones.blockmap.SectorPopulation"></a><a id="sector(BlockMapEntity):SectorPopulation"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#sector(entity:net.psforever.objects.zones.blockmap.BlockMapEntity):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">sector</span><span class="params">(<span name="entity">entity: <a href="BlockMapEntity.html" name="net.psforever.objects.zones.blockmap.BlockMapEntity" id="net.psforever.objects.zones.blockmap.BlockMapEntity" class="extype">BlockMapEntity</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">Given a blockmap entity,
|
|
one that is allegedly represented on this blockmap,
|
|
find the sector conglomerate in which this entity is allocated.</p><div class="fullcomment"><div class="comment cmt"><p>Given a blockmap entity,
|
|
one that is allegedly represented on this blockmap,
|
|
find the sector conglomerate in which this entity is allocated.</p></div><dl class="paramcmts block"><dt class="param">entity</dt><dd class="cmt"><p>the target entity</p></dd><dt>returns</dt><dd class="cmt"><p>a conglomerate sector which lists all of the entities in the discovered sector(s)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>BlockMap.quickToSectorGroup</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap#spanSize" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="spanSize:Int"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#spanSize:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">spanSize</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">a clamping of the desired span size to a realistic value to use for the span size;
|
|
blocks can not be too small, but also should not be much larger than the width of the representable region
|
|
a block spanning as wide as the map is an acceptable cap
|
|
</p></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=>T0):T0"></a><a id="synchronized[T0](=>T0):T0"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#synchronized[T0](x$1:=>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: => <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" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap.html#wait(x$1:Long):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="scala.AnyRef" class="parent"><h3>Inherited from <span name="scala.AnyRef" class="extype">AnyRef</span></h3></div><div name="scala.Any" class="parent"><h3>Inherited from <span name="scala.Any" class="extype">Any</span></h3></div></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
|