PSF-LoginServer/net/psforever/packet/game/Shortcut.html

26 lines
131 KiB
HTML
Raw Permalink 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.packet.game.Shortcut</title><meta content="PSF - LoginServer - master - net.psforever.packet.game.Shortcut" name="description"/><meta content="PSF LoginServer master net.psforever.packet.game.Shortcut" 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.packet" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="packet" class="anchorToMember"></a><a id="packet:packet" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/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">packet</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.packet.game" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="game" class="anchorToMember"></a><a id="game:game" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/index.html" title="Permalink"><i class="material-icons"><EFBFBD><EFBFBD>
<br>
The parameters <code>purpose</code> and <code>tile</code> are closely related.
These two fields are consistent for all shortcuts of the same type.
<code>purpose</code> indicates the purpose of the shortcut.
<code>tile</code> is related to what kind of graphic is displayed in this shortcut's slot on the hotbar based on its purpose.
The parameters <code>effect1</code> and <code>effect2</code> are exclusive to text macro shortcuts and are defaulted to empty <code>String</code>s.<br>
<br>
The <code>shortcut_macro</code> setting displays a word bubble superimposed by the (first three letters of) <code>effect1</code> text.<br>
Implants and the medkit should have self-explanatory graphics.
<br>
Tile - Code<br>
<code>advanced_regen</code> (regeneration) - 2<br>
<code>audio_amplifier</code> - 2<br>
<code>darklight_vision</code> - 2<br>
<code>medkit</code> - 0<br>
<code>melee_booster</code> - 2<br>
<code>personal_shield</code> - 2<br>
<code>range_magnifier</code> - 2<br>
<code>second_wind</code> - 2<br>
<code>shortcut_macro</code> - 1<br>
<code>silent_run</code> (sensor shield) - 2<br>
<code>surge</code> - 2<br>
<code>targeting</code> (enhanced targeting) - 2</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/packet/game/CreateShortcutMessage.scala" target="_blank">CreateShortcutMessage.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 class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="Shortcut$$Implant.html" name="net.psforever.packet.game.Shortcut.Implant" id="net.psforever.packet.game.Shortcut.Implant" class="extype">Implant</a>, <a href="Shortcut$$Macro.html" name="net.psforever.packet.game.Shortcut.Macro" id="net.psforever.packet.game.Shortcut.Macro" class="extype">Macro</a>, <a href="Shortcut$$Medkit.html" name="net.psforever.packet.game.Shortcut.Medkit" id="net.psforever.packet.game.Shortcut.Medkit" class="extype">Medkit</a></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.packet.game.Shortcut"><span>Shortcut</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.packet.game.Shortcut#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(code:Int):net.psforever.packet.game.Shortcut" class="anchorToMember"></a><a id="&lt;init&gt;:Shortcut" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/Shortcut.html#&lt;init&gt;(code:Int):net.psforever.packet.game.Shortcut" 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">Shortcut</span><span class="params">(<span name="code">code: <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">code</dt><dd class="cmt"><p>the primary use of this shortcut</p></dd></dl></div></li></ol></div><div class="values members"><h3>Abstract Value Members</h3><ol><li class="indented0 " name="net.psforever.packet.game.Shortcut#tile" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="tile:String" class="anchorToMember"></a> <span class="permalink"><a href="../../../../net/psforever/packet/game/Shortcut.html#tile:String" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">tile</span><span class="result">: <span name="scala.Predef.String" class="extype">String</span></span></span></li></ol><