PSF-LoginServer/net/psforever/objects/definition/index.html

24 lines
54 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.definition</title><meta content="PSF - LoginServer - master - net.psforever.objects.definition" name="description"/><meta content="PSF LoginServer master net.psforever.objects.definition" 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></
Players are influenced by the exo-suit they wear in a variety of ways, with speed and available equipment slots being major differences.</p></div></div></li><li class="indented0 " name="net.psforever.objects.definition.ImplantDefinition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ImplantDefinitionextendsBasicDefinition"></a><a id="ImplantDefinition:ImplantDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/ImplantDefinition.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="ImplantDefinition.html" title="The definition for an installable player utility that grants a perk, usually in exchange for stamina (energy). Most of the definition deals with the costs of activation and operation."><span class="name">ImplantDefinition</span></a><span class="result"> extends <a href="BasicDefinition.html" name="net.psforever.objects.definition.BasicDefinition" id="net.psforever.objects.definition.BasicDefinition" class="extype">BasicDefinition</a></span></span><p class="shortcomment cmt">The definition for an installable player utility that grants a perk, usually in exchange for stamina (energy).<br>
<br>
Most of the definition deals with the costs of activation and operation.</p><div class="fullcomment"><div class="comment cmt"><p>The definition for an installable player utility that grants a perk, usually in exchange for stamina (energy).<br>
<br>
Most of the definition deals with the costs of activation and operation.
When activated by the user, an <code>activationCharge</code> may be deducted form that user's stamina reserves.
This does not necessarily have to be a non-zero value.
Passive implants are always active and thus have no cost.
After being activated, a non-passive implant consumes a specific amount of stamina at regular intervals
Some implants will specify a different interval for consuming stamina based on the exo-suit the player is wearing
</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ImplantType</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.definition.KitDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="KitDefinitionextendsEquipmentDefinition"></a><a id="KitDefinition:KitDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/KitDefinition.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="KitDefinition.html" title="The definition for a personal one-time-use recovery item."><span class="name">KitDefinition</span></a><span class="result"> extends <a href="EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span></span><p class="shortcomment cmt">The definition for a personal one-time-use recovery item.</p></li><li class="indented0 " name="net.psforever.objects.definition.ObjectDefinition" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="ObjectDefinitionextendsBasicDefinition"></a><a id="ObjectDefinition:ObjectDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/ObjectDefinition.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="ObjectDefinition.html" title="Associate an object's canned in-game representation with its basic game identification unit."><span class="name">ObjectDefinition</span></a><span class="result"> extends <a href="BasicDefinition.html" name="net.psforever.objects.definition.BasicDefinition" id="net.psforever.objects.definition.BasicDefinition" class="extype">BasicDefinition</a></span></span><p class="shortcomment cmt">Associate an object's canned in-game representation with its basic game identification unit.</p><div class="fullcomment"><div class="comment cmt"><p>Associate an object's canned in-game representation with its basic game identification unit.
The extension of this <code>class</code> would identify the common data necessary to construct such a given game object.<br>
<br>
The converter transforms a game object that is created by this <code>ObjectDefinition</code> into packet data through method-calls.
The field for this converter is a <code>PacketConverter</code>, the superclass for <code>ObjectCreateConverter</code>;
the type of the mutator's parameter is <code>ObjectCreateConverter</code> of a wildcard <code>tparam</code>;
and, the accessor return type is <code>ObjectCreateConverter[PlanetSideGameObject]</code>, a minimum-true statement.
The actual type of the converter at a given point, casted or otherwise, is mostly meaningless.
Casting the external object does not mutate any of the types used by the methods within that object.
So long as it is an <code>ObjectCreatePacket</code>, those methods can be called correctly for a game object of the desired type.</p></div></div></li><li class="indented0 " name="net.psforever.objects.definition.ProjectileDefinition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ProjectileDefinitionextendsObjectDefinitionwithDamageWithPosition"></a><a id="ProjectileDefinition:ProjectileDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/ProjectileDefinition.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="ProjectileDefinition.html" title="The definition that outlines the damage-dealing characteristics of any projectile."><span class="name">ProjectileDefinition</span></a><span class="result"> extends <a href="ObjectDefinition.html" name="net.psforever.objects.definition.ObjectDefinition" id="net.psforever.objects.definition.ObjectDefinition" class="extype">ObjectDefinition</a> with <a href="../vital/prop/DamageWithPosition.html" name="net.psforever.objects.vital.prop.DamageWithPosition" id="net.psforever.objects.vital.prop.DamageWithPosition" class="extype">DamageWithPosition</a></span></span><p class="shortcomment cmt">The definition that outlines the damage-dealing characteristics of any projectile.</p><div class="fullcomment"><div class="comment cmt"><p>The definition that outlines the damage-dealing characteristics of any projectile.
<code>Tool</code> objects emit <code>ProjectileDefinition</code> objects and that is later wrapped into a <code>Projectile</code> object.</p></div></div></li><li class="indented0 " name="net.psforever.objects.definition.SimpleItemDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SimpleItemDefinitionextendsEquipmentDefinition"></a><a id="SimpleItemDefinition:SimpleItemDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/SimpleItemDefinition.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="SimpleItemDefinition.html" title=""><span class="name">SimpleItemDefinition</span></a><span class="result"> extends <a href="EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.definition.SpecialExoSuitDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SpecialExoSuitDefinitionextendsExoSuitDefinition"></a><a id="SpecialExoSuitDefinition:SpecialExoSuitDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/SpecialExoSuitDefinition.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="SpecialExoSuitDefinition.html" title=""><span class="name">SpecialExoSuitDefinition</span></a><span class="result"> extends <a href="ExoSuitDefinition.html" name="net.psforever.objects.definition.ExoSuitDefinition" id="net.psforever.objects.definition.ExoSuitDefinition" class="extype">ExoSuitDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.definition.ToolDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ToolDefinitionextendsEquipmentDefinition"></a><a id="ToolDefinition:ToolDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/ToolDefinition.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="ToolDefinition.html" title=""><span class="name">ToolDefinition</span></a><span class="result"> extends <a href="EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a></span></span></li><li class="indented0 " name="net.psforever.objects.definition.VehicleDefinition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="VehicleDefinitionextendsObjectDefinitionwithMountableWeaponsDefinitionwithVitalityDefinitionwithNtuContainerDefinitionwithResistanceProfileMutatorswithDamageResistanceModel"></a><a id="VehicleDefinition:VehicleDefinition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/VehicleDefinition.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="VehicleDefinition.html" title="An object definition system used to construct and retain the parameters of various vehicles."><span class="name">VehicleDefinition</span></a><span class="result"> extends <a href="ObjectDefinition.html" name="net.psforever.objects.definition.ObjectDefinition" id="net.psforever.objects.definition.ObjectDefinition" class="extype">ObjectDefinition</a> with <a href="../vehicles/MountableWeaponsDefinition.html" name="net.psforever.objects.vehicles.MountableWeaponsDefinition" id="net.psforever.objects.vehicles.MountableWeaponsDefinition" class="extype">MountableWeaponsDefinition</a> with <a href="