PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-07-15 00:14:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/zones/blockmap/index.html

20 lines
24 KiB
HTML
Raw Permalink 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</title><meta content="PSF - LoginServer - master - net.psforever.objects.zones.blockmap" name="description"/><meta content="PSF LoginServer master net.psforever.objects.zones.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@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
var toRoot = '../../../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net" class="anchorToMember"></a><a id="net:net" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever" class="anchorToMember"></a><a id="psforever:psforever" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects" class="anchorToMember"></a><a id="objects:objects" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.zones" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="zones" class="anchorToMember"></a><a id="zones:zones" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/ind
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
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.
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
A bucket on the blockmap should contain only a small fraction of the full zone's entities.</p></div></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMapEntity" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="BlockMapEntityextendsWorldEntity" class="anchorToMember"></a><a id="BlockMapEntity:BlockMapEntity" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMapEntity.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="BlockMapEntity.html" title="An game object that can be represented on a blockmap."><span class="name">BlockMapEntity</span></a><span class="result"> extends <a href="../../entity/WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></span></span><p class="shortcomment cmt">An game object that can be represented on a blockmap.</p><div class="fullcomment"><div class="comment cmt"><p>An game object that can be represented on a blockmap.
The only requirement is that the entity can position itself in a zone's coordinate space.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>BlockMap</code></p></span><span class="cmt"><p><code>WorldEntity</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMapEntry" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="BlockMapEntryextendsProductwithSerializable" class="anchorToMember"></a><a id="BlockMapEntry:BlockMapEntry" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMapEntry.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BlockMapEntry.html" title=""><span class="name">BlockMapEntry</span></a><span class="params">(<span name="map">map: <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="coords">coords: <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 name="sectors">sectors: <span name="scala.Predef.Set" class="extype">Set</span>[<span name="scala.Int" class="extype">Int</span>]</span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="extype">Serializable</span></span></span></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.Sector" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SectorextendsSectorPopulation" class="anchorToMember"></a><a id="Sector:Sector" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/Sector.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><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."><span class="name">Sector</span></a><span class="result"> extends <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">The bucket of a blockmap structure
Deploying to gh-pages from @ psforever/PSF-LoginServer@3966b0264dccfe824354b313ff8bf1692a95baef 🚀
2021-06-12 03:06:39 +00:00
that contains lists of entities that, within a given span of coordinate distance,
are considered neighbors.</p><div class="fullcomment"><div class="comment cmt"><p>The bucket of a blockmap structure
that contains lists of entities that, within a given span of coordinate distance,
are considered neighbors.
While the coordinate space that supports a blockmap (?) may be any combination of two dimensions,
Deploying to gh-pages from @ psforever/PSF-LoginServer@6c3fd970c44dcc5abbe4da0d2b21b87f5c890a77 🚀
2023-04-15 19:13:59 +00:00
the sectors are always square.</p></div></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.SectorGroup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SectorGroupextendsSectorPopulation" class="anchorToMember"></a><a id="SectorGroup:SectorGroup" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/SectorGroup.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="SectorGroup.html" title="The specific datastructure that is mentioned when using the term &quot;sector conglomerate&quot;."><span class="name">SectorGroup</span></a><span class="result"> extends <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">The specific datastructure that is mentioned when using the term "sector conglomerate".</p><div class="fullcomment"><div class="comment cmt"><p>The specific datastructure that is mentioned when using the term "sector conglomerate".
Typically used to compose the lists of entities from various individual sectors.</p></div></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.SectorListOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SectorListOf[A]extendsAnyRef" class="anchorToMember"></a><a id="SectorListOf[A]:SectorListOf[A]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/SectorListOf.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="SectorListOf.html" title="Custom lists of entities for sector buckets."><span class="name">SectorListOf</span></a><span class="tparams">[<span name="A">A</span>]</span><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Custom lists of entities for sector buckets.</p><div class="fullcomment"><div class="comment cmt"><p>Custom lists of entities for sector buckets.</p></div><dl class="paramcmts block"><dt class="tparam">A</dt><dd class="cmt"><p>the type of object that will be the entities stored in the list</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.SectorPopulation" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="SectorPopulationextendsAnyRef" class="anchorToMember"></a><a id="SectorPopulation:SectorPopulation" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/SectorPopulation.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="SectorPopulation.html" title="The collections of entities in a sector conglomerate."><span class="name">SectorPopulation</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">The collections of entities in a sector conglomerate.</p></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.SectorTraits" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="SectorTraitsextendsAnyRef" class="anchorToMember"></a><a id="SectorTraits:SectorTraits" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/SectorTraits.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="SectorTraits.html" title="Information about the sector."><span class="name">SectorTraits</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">Information about the sector.</p></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="BlockMap" class="anchorToMember"></a><a id="BlockMap:BlockMap" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMap$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="BlockMap$.html" title=""><span class="name">BlockMap</span></a></span></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMapEntity" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="BlockMapEntity" class="anchorToMember"></a><a id="BlockMapEntity:BlockMapEntity" class="anchorToMember"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/BlockMapEntity$.html" title="Permalink"><i class="material-ic
Reference in a new issue Copy permalink