PSF-LoginServer/net/psforever/objects/Tool$.html

17 lines
57 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.Tool</title><meta content="PSF - LoginServer - master - net.psforever.objects.Tool" name="description"/><meta content="PSF LoginServer master net.psforever.objects.Tool" 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.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../net/psforever/objects/avatar/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="avatar/index.html" title=""><span class="name">avatar</span></a></span><div class="fullcomment"><dl class="
Most weapons will have only one ammunition slot and swap different ammunition into it as needed.</p><div class="fullcomment"><div class="comment cmt"><p>The <code>FireModeSlot</code> can be called the "magazine feed," an abstracted "ammunition slot."
Most weapons will have only one ammunition slot and swap different ammunition into it as needed.
In general to swap ammunition means to unload the onld ammunition and load the new ammunition.
Many weapons also have one ammunition slot and multiple fire modes using the same list of ammunition
This slot manages either of two ammunitions where one does not need to unload to be swapped to the other;
however, the fire mod has most likely been changed.
The Punisher -
six ammunition types in total,
two uniquely different types without unloading,
two exclusive groups of ammunition divided into 2 cycled types and 4 cycled types -
is an example of a weapon that benefits from this implementation.
</p></div></div></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/Tool$.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/Tool$.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="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/Tool$.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: $eq$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="net.psforever.objects.Tool#LoadDefinition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadDefinition(tool:net.psforever.objects.Tool,tdef:net.psforever.objects.definition.ToolDefinition):Unit"></a><a id="LoadDefinition(Tool,ToolDefinition):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$.html#LoadDefinition(tool:net.psforever.objects.Tool,tdef:net.psforever.objects.definition.ToolDefinition):Unit" 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">LoadDefinition</span><span class="params">(<span name="tool">tool: <a href="Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a></span>, <span name="tdef">tdef: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Substitute this <code>Definition</code> for the one that was originally provided for this entity.</p><div class="fullcomment"><div class="comment cmt"><p>Substitute this <code>Definition</code> for the one that was originally provided for this entity.
Calling this will not reconstruct the internal fields of the entity.</p></div><dl class="paramcmts block"><dt class="param">tool</dt><dd class="cmt"><p>the <code>Tool</code> being modified</p></dd><dt class="param">tdef</dt><dd class="cmt"><p>the definition used to override the definition that was previously assigned this <code>Tool</code>;
WILL override the assignment in the original constructor</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Tool#LoadDefinition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadDefinition(tool:net.psforever.objects.Tool):Unit"></a><a id="LoadDefinition(Tool):Unit"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$.html#LoadDefinition(tool:net.psforever.objects.Tool):Unit" 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">LoadDefinition</span><span class="params">(<span name="tool">tool: <a href="Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Use the <code>*Definition</code> that was provided to this object to initialize its fields and settings.</p><div class="fullcomment"><div class="comment cmt"><p>Use the <code>*Definition</code> that was provided to this object to initialize its fields and settings.</p></div><dl class="paramcmts block"><dt class="param">tool</dt><dd class="cmt"><p>the <code>Tool</code> being initialized</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.Tool#apply" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="apply(toolDef:net.psforever.objects.definition.ToolDefinition):net.psforever.objects.Tool"></a><a id="apply(ToolDefinition):Tool"></a> <span class="permalink"><a href="../../../net/psforever/objects/Tool$.html#apply(toolDef:net.psforever.objects.definition.ToolDefinition):net.psforever.objects.Tool" 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">apply</span><span class="params">(<span name="toolDef">toolDef: <a href="definition/ToolDefinition.html" name="net.psforever.objects.definition.ToolDefinition" id="net.psforever.objects.definition.ToolDefinition" class="extype">ToolDefinition</a></span>)</span><span class="result">: <a href="Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a></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/Tool$.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/Tool$.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.CloneNotSupportedExceptio