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

12 lines
53 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.ObjectDefinition</title><meta content="PSF - LoginServer - master - net.psforever.objects.definition.ObjectDefinition" name="description"/><meta content="PSF LoginServer master net.psforever.objects.definition.ObjectDefinition" 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.definition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="definition"></a><a id="definition:definition"></a> <span class="permalink"><a href="../../../../net/psforever/objects/definition/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">defin
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><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/definition/ObjectDefinition.scala" target="_blank">ObjectDefinition.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="BasicDefinition.html" name="net.psforever.objects.definition.BasicDefinition" id="net.psforever.objects.definition.BasicDefinition" class="extype">BasicDefinition</a>, <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="../ExplosiveDeployableDefinition.html" name="net.psforever.objects.ExplosiveDeployableDefinition" id="net.psforever.objects.ExplosiveDeployableDefinition" class="extype">ExplosiveDeployableDefinition</a>, <a href="../SensorDeployableDefinition.html" name="net.psforever.objects.SensorDeployableDefinition" id="net.psforever.objects.SensorDeployableDefinition" class="extype">SensorDeployableDefinition</a>, <a href="../ShieldGeneratorDefinition.html" name="net.psforever.objects.ShieldGeneratorDefinition" id="net.psforever.objects.ShieldGeneratorDefinition" class="extype">ShieldGeneratorDefinition</a>, <a href="../TrapDeployableDefinition.html" name="net.psforever.objects.TrapDeployableDefinition" id="net.psforever.objects.TrapDeployableDefinition" class="extype">TrapDeployableDefinition</a>, <a href="../TurretDeployableDefinition.html" name="net.psforever.objects.TurretDeployableDefinition" id="net.psforever.objects.TurretDeployableDefinition" class="extype">TurretDeployableDefinition</a>, <a href="../ballistics/NonvitalDefinition.html" name="net.psforever.objects.ballistics.NonvitalDefinition" id="net.psforever.objects.ballistics.NonvitalDefinition" class="extype">NonvitalDefinition</a>, <a href="AmmoBoxDefinition.html" name="net.psforever.objects.definition.AmmoBoxDefinition" id="net.psforever.objects.definition.AmmoBoxDefinition" class="extype">AmmoBoxDefinition</a>, <a href="AvatarDefinition.html" name="net.psforever.objects.definition.AvatarDefinition" id="net.psforever.objects.definition.AvatarDefinition" class="extype">AvatarDefinition</a>, <a href="ComplexDeployableDefinition.html" name="net.psforever.objects.definition.ComplexDeployableDefinition" id="net.psforever.objects.definition.ComplexDeployableDefinition" class="extype">ComplexDeployableDefinition</a>, <a href="ConstructionItemDefinition.html" name="net.psforever.objects.definition.ConstructionItemDefinition" id="net.psforever.objects.definition.ConstructionItemDefinition" class="extype">ConstructionItemDefinition</a>, <a href="DeployableDefinition.html" name="net.psforever.objects.definition.DeployableDefinition" id="net.psforever.objects.definition.DeployableDefinition" class="extype">DeployableDefinition</a>, <a href="EquipmentDefinition.html" name="net.psforever.objects.definition.EquipmentDefinition" id="net.psforever.objects.definition.EquipmentDefinition" class="extype">EquipmentDefinition</a>, <a href="KitDefinition.html" name="net.psforever.objects.definition.KitDefinition" id="net.psforever.objects.definition.KitDefinition" class="extype">KitDefinition</a>, <a href="ProjectileDefinition.html" name="net.psforever.objects.definition.ProjectileDefinition" id="net.psforever.objects.definition.ProjectileDefinition" class="extype">ProjectileDefinition</a>, <a href="SimpleDeployableDefinition.html" name="net.psforever.objects.definition.SimpleDeployableDefinition" id="net.psforever.objects.definition.SimpleDeployableDefinition" class="extype">SimpleDeployableDefinition</a>, <a href="SimpleItemDefinition.html" name="net.psforever.objects.definition.SimpleItemDefinition" id="net.psforever.objects