mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-02-25 09:33:39 +00:00
19 lines
23 KiB
HTML
19 lines
23 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</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 */
|
|
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 current" 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"><span class="name">blockmap</span></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="BlockMap.html" title="A data structure which divides coordinate space into buckets or coordinate spans." class="class"></a><a href="BlockMap.html" 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="package value"><div id="definition"><div class="big-circle package">p</div><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></p><h1>blockmap<span class="permalink"><a href="../../../../../net/psforever/objects/zones/blockmap/index.html" title="Permalink"><i class="material-icons"></i></a></span></h1></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">blockmap</span></span></h4><div id="comment" class="fullcommenttop"></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></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="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMap" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BlockMapextendsAnyRef"></a><a id="BlockMap:BlockMap"></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">class</span></span> <span class="symbol"><a href="BlockMap.html" title="A data structure which divides coordinate space into buckets or coordinate spans."><span class="name">BlockMap</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">A data structure which divides coordinate space into buckets or coordinate spans.</p><div class="fullcomment"><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></div></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.BlockMapEntity" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="BlockMapEntityextendsWorldEntity"></a><a id="BlockMapEntity:BlockMapEntity"></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"></a><a id="BlockMapEntry:BlockMapEntry"></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"></a><a id="Sector:Sector"></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
|
|
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,
|
|
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"></a><a id="SectorGroup:SectorGroup"></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 "sector conglomerate"."><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"></a><a id="SectorListOf[A]:SectorListOf[A]"></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"></a><a id="SectorPopulation:SectorPopulation"></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"></a><a id="SectorTraits:SectorTraits"></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"></a><a id="BlockMap:BlockMap"></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"></a><a id="BlockMapEntity:BlockMapEntity"></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">object</span></span> <span class="symbol"><a href="BlockMapEntity$.html" title=""><span class="name">BlockMapEntity</span></a></span></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.Sector" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Sector"></a><a id="Sector:Sector"></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">object</span></span> <span class="symbol"><a href="Sector$.html" title=""><span class="name">Sector</span></a></span></li><li class="indented0 " name="net.psforever.objects.zones.blockmap.SectorGroup" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SectorGroup"></a><a id="SectorGroup:SectorGroup"></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">object</span></span> <span class="symbol"><a href="SectorGroup$.html" title=""><span class="name">SectorGroup</span></a></span></li></ol></div></div><div id="inheritedMembers"></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>
|