PSF-LoginServer/net/psforever/objects/serverobject/CommonMessages$.html

10 lines
56 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.serverobject.CommonMessages</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.CommonMessages" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.CommonMessages" 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_" 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.serverobject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="serverobject" class="anchorToMember"></a><a id="serverobject:serverobject" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/index.html
allowed to be <code>None</code>;
most often, a <code>Building</code>;
if the vehicle instigated its own charge (battleframe robotics), specify that</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>FacilityBenefitShieldChargeRequestMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.CommonMessages.ClearHack" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ClearHackextendsProductwithSerializable" class="anchorToMember"></a><a id="ClearHack:ClearHack" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/CommonMessages$$ClearHack.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CommonMessages$$ClearHack.html" title=""><span class="name">ClearHack</span></a><span class="params">()</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.serverobject.CommonMessages.Hack" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="HackextendsProductwithSerializable" class="anchorToMember"></a><a id="Hack:Hack" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/CommonMessages$$Hack.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CommonMessages$$Hack.html" title=""><span class="name">Hack</span></a><span class="params">(<span name="player">player: <a href="../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="obj">obj: <a href="PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="hackable/Hackable.html" name="net.psforever.objects.serverobject.hackable.Hackable" id="net.psforever.objects.serverobject.hackable.Hackable" class="extype">Hackable</a></span>, <span name="data">data: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>] = <span class="symbol">None</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.serverobject.CommonMessages.Progress" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ProgressextendsProductwithSerializable" class="anchorToMember"></a><a id="Progress:Progress" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/CommonMessages$$Progress.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CommonMessages$$Progress.html" title="The message that initializes a process - some form of user-driven activity with a certain eventual outcome and potential feedback per cycle."><span class="name">Progress</span></a><span class="params">(<span name="delta">delta: <span name="scala.Float" class="extype">Float</span></span>, <span name="completionAction">completionAction: () =&gt; <span name="scala.Unit" class="extype">Unit</span></span>, <span name="tickAction">tickAction: (<span name="scala.Float" class="extype">Float</span>) =&gt; <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result"> extends <span name="scala.Product" class="extype">Product</span> with <span name="scala.Serializable" class="e
some form of user-driven activity with a certain eventual outcome and potential feedback per cycle.</p><div class="fullcomment"><div class="comment cmt"><p>The message that initializes a process -
some form of user-driven activity with a certain eventual outcome and potential feedback per cycle.
The feedback is usually only known to the individual attempting the process.</p></div><dl class="paramcmts block"><dt class="param">delta</dt><dd class="cmt"><p>how much the progress value changes each tick, which will be treated as a percentage;
must be a positive value</p></dd><dt class="param">completionAction</dt><dd class="cmt"><p>a finalizing action performed once the progress reaches 100(%)</p></dd><dt class="param">tickAction</dt><dd class="cmt"><p>an action that is performed for each increase of progress</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.CommonMessages.Unuse" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UnuseextendsProductwithSerializable" class="anchorToMember"></a><a id="Unuse:Unuse" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/CommonMessages$$Unuse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CommonMessages$$Unuse.html" title=""><span class="name">Unuse</span></a><span class="params">(<span name="player">player: <a href="../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="data">data: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>] = <span class="symbol">None</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.serverobject.CommonMessages.Use" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UseextendsProductwithSerializable" class="anchorToMember"></a><a id="Use:Use" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/CommonMessages$$Use.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CommonMessages$$Use.html" title=""><span class="name">Use</span></a><span class="params">(<span name="player">player: <a href="../Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="data">data: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>] = <span class="symbol">None</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></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" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/CommonMessages$.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" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/objects/serverobject/CommonMessages$.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 cla