PSF-LoginServer/net/psforever/objects/zones/ActivityReport.html

11 lines
47 KiB
HTML
Raw Normal View History

<!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.ActivityReport</title><meta content="PSF - LoginServer - master - net.psforever.objects.zones.ActivityReport" name="description"/><meta content="PSF LoginServer master net.psforever.objects.zones.ActivityReport" 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">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.zones" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="zones"></a><a id="zones:zones"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">zones</span></a></span><div cl
In terms of hotspots, the "denomination" are the factions.
While a given report of activity will only be valid from the time or arrival for a given amount of time,
subsequent activity reporting before this duration concludes will cause the lifespan to artificially increase.
</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/HotSpotInfo.scala" target="_blank">HotSpotInfo.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.ActivityReport"><span>ActivityReport</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.ActivityReport#&lt;init&gt;" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="&lt;init&gt;():net.psforever.objects.zones.ActivityReport"></a><a id="&lt;init&gt;:ActivityReport"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ActivityReport.html#&lt;init&gt;():net.psforever.objects.zones.ActivityReport" 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">ActivityReport</span><span class="params">()</span></span></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/ActivityReport.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/ActivityReport.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="Ungrou
Set heat to zero to flag no activity and set duration to "0 seconds" to eliminate its lifespan.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.zones.ActivityReport#Duration" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Duration:scala.concurrent.duration.FiniteDuration"></a><a id="Duration:FiniteDuration"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ActivityReport.html#Duration:scala.concurrent.duration.FiniteDuration" 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">Duration</span><span class="result">: <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span></span></span><p class="shortcomment cmt">The length of time that this (ongoing) activity is relevant.</p><div class="fullcomment"><div class="comment cmt"><p>The length of time that this (ongoing) activity is relevant.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the time</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ActivityReport#Duration_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Duration_=(time:Long):scala.concurrent.duration.FiniteDuration"></a><a id="Duration_=(Long):FiniteDuration"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ActivityReport.html#Duration_=(time:Long):scala.concurrent.duration.FiniteDuration" 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" title="gt4s: Duration_$eq">Duration_=</span><span class="params">(<span name="time">time: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span></span></span><p class="shortcomment cmt">Set the length of time that this (ongoing) activity is relevant.</p><div class="fullcomment"><div class="comment cmt"><p>Set the length of time that this (ongoing) activity is relevant.
The duration length can only increase.</p></div><dl class="paramcmts block"><dt class="param">time</dt><dd class="cmt"><p>the time, as a <code>Long</code> value</p></dd><dt>returns</dt><dd class="cmt"><p>the time</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ActivityReport#Duration_=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Duration_=(time:scala.concurrent.duration.FiniteDuration):scala.concurrent.duration.FiniteDuration"></a><a id="Duration_=(FiniteDuration):FiniteDuration"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ActivityReport.html#Duration_=(time:scala.concurrent.duration.FiniteDuration):scala.concurrent.duration.FiniteDuration" 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" title="gt4s: Duration_$eq">Duration_=</span><span class="params">(<span name="time">time: <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span></span>)</span><span class="result">: <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span></span></span><p class="shortcomment cmt">Set the length of time that this (ongoing) activity is relevant.</p><div class="fullcomment"><div class="comment cmt"><p>Set the length of time that this (ongoing) activity is relevant.</p></div><dl class="paramcmts block"><dt class="param">time</dt><dd class="cmt"><p>the time, as a <code>Duration</code></p></dd><dt>returns</dt><dd class="cmt"><p>the time</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ActivityReport#Heat" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Heat:Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ActivityReport.html#Heat: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">Heat</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">The increasing heat does nothing, presently, but acts as a flag for activity.</p><div class="fullcomment"><div class="comment cmt"><p>The increasing heat does nothing, presently, but acts as a flag for activity.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the heat</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ActivityReport#LastReport" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LastReport:Long"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ActivityReport.html#LastReport:Long" 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">LastReport</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span><p class="shortcomment cmt">As a <code>Long</code> value, if there was no previous report, the value will be considered <code>0L</code>.</p><div class="fullcomment"><div class="comment cmt"><p>As a <code>Long</code> value, if there was no previous report, the value will be considered <code>0L</code>.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the time of the last activity report</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ActivityReport#Renew" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Renew:Long"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ActivityReport.html#Renew:Long" 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">Renew
Do not increase the lifespan of the current report's existence.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the current report</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.zones.ActivityReport#SetLastReport" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SetLastReport(time:Long):Long"></a><a id="SetLastReport(Long):Long"></a> <span class="permalink"><a href="../../../../net/psforever/objects/zones/ActivityReport.html#SetLastReport(time:Long):Long" 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">SetLastReport</span><span class="params">(<span name="time">time: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span></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/ActivityReport.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="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/ActivityReport.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/ActivityReport.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/ActivityReport.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