mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-01-20 02:54:46 +00:00
595 lines
420 KiB
HTML
595 lines
420 KiB
HTML
<!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.actors.session.SessionActor</title><meta content="PSF - LoginServer - master - net.psforever.actors.session.SessionActor" name="description"/><meta content="PSF LoginServer master net.psforever.actors.session.SessionActor" 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"><</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.actors" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="actors"></a><a id="actors:actors"></a> <span class="permalink"><a href="../../../../net/psforever/actors/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">actors</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.actors.session" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="session"></a><a id="session:session"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/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">session</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.actors" id="net.psforever.actors" class="extype">actors</a></dd></dl></div></li><li class="current-entities indented4"><a href="AvatarActor$.html" title="" class="object"></a> <a href="AvatarActor.html" title="" class="class"></a><a href="AvatarActor.html" title="">AvatarActor</a></li><li class="current-entities indented4"><a href="ChatActor$.html" title="" class="object"></a> <a href="ChatActor.html" title="" class="class"></a><a href="ChatActor.html" title="">ChatActor</a></li><li class="current-entities indented4"><a href="SessionActor$.html" title="" class="object"></a> <a href="" title="" class="class"></a><a href="" title="">SessionActor</a></li></ul></div></div><div id="content"><body class="class type"><div id="definition"><a href="SessionActor$.html" title="See companion object"><div class="big-circle class-companion-object">c</div></a><p id="owner"><a href="../../../index.html" name="net" id="net" class="extype">net</a>.<a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a>.<a href="../index.html" name="net.psforever.actors" id="net.psforever.actors" class="extype">actors</a>.<a href="index.html" name="net.psforever.actors.session" id="net.psforever.actors.session" class="extype">session</a></p><h1><a href="SessionActor$.html" title="See companion object">SessionActor</a><span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html" title="Permalink"><i class="material-icons"></i></a></span></h1><h3><span class="morelinks"><div>Companion <a href="SessionActor$.html" title="See companion object">object SessionActor</a></div></span></h3></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><span class="name">SessionActor</span><span class="result"> extends <span name="akka.actor.Actor" class="extype">Actor</span> with <a href="../../../../akka/actor/MDCContextAware.html" name="akka.actor.MDCContextAware" id="akka.actor.MDCContextAware" class="extype">MDCContextAware</a></span></span></h4><div id="comment" class="fullcommenttop"><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/actors/session/SessionActor.scala" target="_blank">SessionActor.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="../../../../akka/actor/MDCContextAware.html" name="akka.actor.MDCContextAware" id="akka.actor.MDCContextAware" class="extype">MDCContextAware</a>, <span name="akka.actor.ActorLogging" class="extype">ActorLogging</span>, <span name="akka.actor.Actor" class="extype">Actor</span>, <span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></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.actors.session.SessionActor"><span>SessionActor</span></li><li class="in" name="akka.actor.MDCContextAware"><span>MDCContextAware</span></li><li class="in" name="akka.actor.ActorLogging"><span>ActorLogging</span></li><li class="in" name="akka.actor.Actor"><span>Actor</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.actors.session.SessionActor#<init>" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="<init>(middlewareActor:akka.actor.typed.ActorRef[net.psforever.actors.net.MiddlewareActor.Command],connectionId:String,sessionId:Long):net.psforever.actors.session.SessionActor"></a><a id="<init>:SessionActor"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#<init>(middlewareActor:akka.actor.typed.ActorRef[net.psforever.actors.net.MiddlewareActor.Command],connectionId:String,sessionId:Long):net.psforever.actors.session.SessionActor" 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">SessionActor</span><span class="params">(<span name="middlewareActor">middlewareActor: <span name="akka.actor.typed.ActorRef" class="extype">ActorRef</span>[<a href="../net/MiddlewareActor$$Command.html" name="net.psforever.actors.net.MiddlewareActor.Command" id="net.psforever.actors.net.MiddlewareActor.Command" class="extype">Command</a>]</span>, <span name="connectionId">connectionId: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="sessionId">sessionId: <span name="scala.Long" class="extype">Long</span></span>)</span></span></li></ol></div><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="akka.actor.Actor.Receive" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Receive=akka.actor.Actor.Receive"></a><a id="Receive:Receive"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#Receive=akka.actor.Actor.Receive" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">type</span></span> <span class="symbol"><span class="name">Receive</span><span class="result alias"> = <span name="scala.PartialFunction" class="extype">PartialFunction</span>[<span name="scala.Any" class="extype">Any</span>, <span name="scala.Unit" class="extype">Unit</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></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/actors/session/SessionActor.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/actors/session/SessionActor.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/actors/session/SessionActor.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.actors.session.SessionActor#AccessContainer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AccessContainer(container:net.psforever.objects.inventory.Container):Unit"></a><a id="AccessContainer(Container):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AccessContainer(container:net.psforever.objects.inventory.Container):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">AccessContainer</span><span class="params">(<span name="container">container: <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#AccessContainerChannel" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AccessContainerChannel(events:akka.actor.ActorRef,channel:String):Unit"></a><a id="AccessContainerChannel(ActorRef,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AccessContainerChannel(events:akka.actor.ActorRef,channel:String):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">AccessContainerChannel</span><span class="params">(<span name="events">events: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="channel">channel: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Join an entity-specific group for shared updates.</p><div class="fullcomment"><div class="comment cmt"><p>Join an entity-specific group for shared updates.</p></div><dl class="paramcmts block"><dt class="param">events</dt><dd class="cmt"><p>the event system bus to which to subscribe</p></dd><dt class="param">channel</dt><dd class="cmt"><p>the channel name</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#AccessCorpseContents" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AccessCorpseContents(tplayer:net.psforever.objects.Player):Unit"></a><a id="AccessCorpseContents(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AccessCorpseContents(tplayer:net.psforever.objects.Player):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">AccessCorpseContents</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common preparation for interfacing with a corpse (former player's backpack).</p><div class="fullcomment"><div class="comment cmt"><p>Common preparation for interfacing with a corpse (former player's backpack).
|
|
Join a corpse-specific group for shared updates.
|
|
Construct every object in the player's hands and inventory for shared manipulation updates.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the corpse</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Container.Inventory</code></p></span><span class="cmt"><p><code>GridInventory.Items</code></p></span><span class="cmt"><p><code>Player.HolsterItems</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#AccessGenericContainer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AccessGenericContainer(container:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container):Unit"></a><a id="AccessGenericContainer(PlanetSideServerObjectwithContainer):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AccessGenericContainer(container:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container):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">AccessGenericContainer</span><span class="params">(<span name="container">container: <a href="../../objects/serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#AccessVehicleContents" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AccessVehicleContents(vehicle:net.psforever.objects.Vehicle):Unit"></a><a id="AccessVehicleContents(Vehicle):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AccessVehicleContents(vehicle:net.psforever.objects.Vehicle):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">AccessVehicleContents</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common preparation for interfacing with a vehicle trunk.</p><div class="fullcomment"><div class="comment cmt"><p>Common preparation for interfacing with a vehicle trunk.
|
|
Join a vehicle-specific group for shared updates.
|
|
Construct every object in the vehicle's inventory for shared manipulation updates.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Container.Inventory</code></p></span><span class="cmt"><p><code>GridInventory.Items</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#AdministrativeKick" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AdministrativeKick(tplayer:net.psforever.objects.Player):Unit"></a><a id="AdministrativeKick(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AdministrativeKick(tplayer:net.psforever.objects.Player):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">AdministrativeKick</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ApplyPurchaseTimersBeforePackingLoadout" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ApplyPurchaseTimersBeforePackingLoadout(player:net.psforever.objects.Player,target:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,slots:List[net.psforever.objects.inventory.InventoryItem]):Unit"></a><a id="ApplyPurchaseTimersBeforePackingLoadout(Player,PlanetSideServerObjectwithContainer,List[InventoryItem]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ApplyPurchaseTimersBeforePackingLoadout(player:net.psforever.objects.Player,target:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,slots:List[net.psforever.objects.inventory.InventoryItem]):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">ApplyPurchaseTimersBeforePackingLoadout</span><span class="params">(<span name="player">player: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="target">target: <a href="../../objects/serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>, <span name="slots">slots: <span name="scala.List" class="extype">List</span>[<a href="../../objects/inventory/InventoryItem.html" name="net.psforever.objects.inventory.InventoryItem" id="net.psforever.objects.inventory.InventoryItem" class="extype">InventoryItem</a>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Enforce constraints on bulk purchases as determined by a given player's previous purchase times and hard acquisition delays.</p><div class="fullcomment"><div class="comment cmt"><p>Enforce constraints on bulk purchases as determined by a given player's previous purchase times and hard acquisition delays.
|
|
Intended to assist in sanitizing loadout information from the perspectvie of the player, or target owner.
|
|
The equipment is expected to be unregistered and already fitted to their ultimate slot in the target container.</p></div><dl class="paramcmts block"><dt class="param">player</dt><dd class="cmt"><p>the player whose purchasing constraints are to be tested</p></dd><dt class="param">target</dt><dd class="cmt"><p>the location in which the equipment will be stowed</p></dd><dt class="param">slots</dt><dd class="cmt"><p>the equipment, in the standard object-slot format container</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ArmorRepairAction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ArmorRepairAction(tplayer:net.psforever.objects.Player,repairValue:Int):Boolean"></a><a id="ArmorRepairAction(Player,Int):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ArmorRepairAction(tplayer:net.psforever.objects.Player,repairValue:Int):Boolean" 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">ArmorRepairAction</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="repairValue">repairValue: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">10</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Restore, at most, a specific amount of personal armor points on a player.</p><div class="fullcomment"><div class="comment cmt"><p>Restore, at most, a specific amount of personal armor points on a player.
|
|
Send messages to connected client and to events system.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd><dt class="param">repairValue</dt><dd class="cmt"><p>the amount to repair;
|
|
10 by default</p></dd><dt>returns</dt><dd class="cmt"><p>whether the player can be repaired for any more armor points</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#AvatarCreate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AvatarCreate():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AvatarCreate():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">AvatarCreate</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">A part of the process of spawning the player into the game world.</p><div class="fullcomment"><div class="comment cmt"><p>A part of the process of spawning the player into the game world.
|
|
The function should work regardless of whether the player is alive or dead - it will make them alive.
|
|
It adds the <code>WorldSessionActor</code>-current <code>Player</code> to the current zone and sends out the expected packets.<br>
|
|
<br>
|
|
If that player is in a vehicle, it will construct that vehicle.
|
|
If the player is the driver of the vehicle,
|
|
they must temporarily be removed from the driver seat in order for the vehicle to be constructed properly.
|
|
These two previous statements operate through similar though distinct mechanisms and imply different conditions.
|
|
In reality, they produce the same output but enforce different relationships between the components.
|
|
The vehicle without a rendered player will always be created if that vehicle exists.
|
|
The vehicle should only be constructed once.
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#AvatarCreateInVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AvatarCreateInVehicle(tplayer:net.psforever.objects.Player,vehicle:net.psforever.objects.Vehicle,seat:Int):Unit"></a><a id="AvatarCreateInVehicle(Player,Vehicle,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AvatarCreateInVehicle(tplayer:net.psforever.objects.Player,vehicle:net.psforever.objects.Vehicle,seat:Int):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">AvatarCreateInVehicle</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="seat">seat: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Create an avatar character so that avatar's player is mounted in a vehicle's seat.</p><div class="fullcomment"><div class="comment cmt"><p>Create an avatar character so that avatar's player is mounted in a vehicle's seat.
|
|
A part of the process of spawning the player into the game world.<br>
|
|
<br>
|
|
This is a very specific configuration of the player character that is not visited very often.
|
|
The value of <code>player.VehicleSeated</code> should be set to accommodate <code>Packet.DetailedConstructorData</code> and,
|
|
though not explicitly checked,
|
|
should be the same as the globally unique identifier that is assigned to the <code>vehicle</code> parameter for the current zone.
|
|
The priority of this function is consider "initial" so it introduces the avatar to the game world in this state
|
|
and is permitted to introduce the avatar to the vehicle's internal settings in a similar way.
|
|
Neither the player avatar nor the vehicle should be reconstructed before the next zone load operation
|
|
to avoid damaging the critical setup of this function.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player avatar seated in the vehicle's seat</p></dd><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle the player is riding</p></dd><dt class="param">seat</dt><dd class="cmt"><p>the seat index</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AccessContainer</code></p></span><span class="cmt"><p><code>UpdateWeaponAtSeatPosition</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#AvatarRejoin" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AvatarRejoin():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#AvatarRejoin():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">AvatarRejoin</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">A part of the process of spawning the player into the game world
|
|
in the case of a restored game connection (relogging).<br>
|
|
<br>
|
|
A login protocol that substitutes the first call to <code>avatarSetupFunc</code> (replacing <code>AvatarCreate</code>)
|
|
in consideration of a user re-logging into the game
|
|
before the period of time where an avatar/player instance would decay and be cleaned-up.</p><div class="fullcomment"><div class="comment cmt"><p>A part of the process of spawning the player into the game world
|
|
in the case of a restored game connection (relogging).<br>
|
|
<br>
|
|
A login protocol that substitutes the first call to <code>avatarSetupFunc</code> (replacing <code>AvatarCreate</code>)
|
|
in consideration of a user re-logging into the game
|
|
before the period of time where an avatar/player instance would decay and be cleaned-up.
|
|
Large portions of this function operate as a combination of the mechanics
|
|
for normal <code>AvatarCreate</code> and for <code>AvatarCreateInVehicle</code>.
|
|
Unlike either of the previous, this functionlality is disinterested in updating other clients
|
|
as the target player and potential vehicle already exist as far as other clients are concerned.<br>
|
|
<br>
|
|
If that player is in a vehicle, it will construct that vehicle.
|
|
If the player is the driver of the vehicle,
|
|
they must temporarily be removed from the driver seat in order for the vehicle to be constructed properly.
|
|
These two previous statements operate through similar though distinct mechanisms and imply different conditions.
|
|
In reality, they produce the same output but enforce different relationships between the components.
|
|
The vehicle without a rendered player will always be created if that vehicle exists.<br>
|
|
<br>
|
|
The value of <code>player.VehicleSeated</code> should be set to accommodate <code>Packet.DetailedConstructorData</code> and,
|
|
though not explicitly checked,
|
|
should be the same as the globally unique identifier that is assigned to the <code>vehicle</code> parameter for the current zone.
|
|
The priority of this function is consider "initial" so it introduces the avatar to the game world in this state
|
|
and is permitted to introduce the avatar to the vehicle's internal settings in a similar way.
|
|
Neither the player avatar nor the vehicle should be reconstructed before the next zone load operation
|
|
to avoid damaging the critical setup of this function.
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CallBackForTask" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="CallBackForTask(task:net.psforever.objects.guid.TaskResolver.GiveTask,sendTo:akka.actor.ActorRef,pass:Any):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="CallBackForTask(GiveTask,ActorRef,Any):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CallBackForTask(task:net.psforever.objects.guid.TaskResolver.GiveTask,sendTo:akka.actor.ActorRef,pass:Any):net.psforever.objects.guid.TaskResolver.GiveTask" 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">CallBackForTask</span><span class="params">(<span name="task">task: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span>, <span name="sendTo">sendTo: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="pass">pass: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CanNotChangeDeployment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CanNotChangeDeployment(obj:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.serverobject.deploy.Deployment,state:net.psforever.types.DriveState.Value,reason:String):Unit"></a><a id="CanNotChangeDeployment(PlanetSideServerObjectwithDeployment,types.DriveState.Value,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CanNotChangeDeployment(obj:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.serverobject.deploy.Deployment,state:net.psforever.types.DriveState.Value,reason:String):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">CanNotChangeDeployment</span><span class="params">(<span name="obj">obj: <a href="../../objects/serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="../../objects/serverobject/deploy/Deployment.html" name="net.psforever.objects.serverobject.deploy.Deployment" id="net.psforever.objects.serverobject.deploy.Deployment" class="extype">Deployment</a></span>, <span name="state">state: <a href="../../types/DriveState$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.types.DriveState.Value" id="net.psforever.types.DriveState.Value" class="extmbr">types.DriveState.Value</a></span>, <span name="reason">reason: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common reporting behavior when a <code>Deployment</code> object fails to properly transition between states.</p><div class="fullcomment"><div class="comment cmt"><p>Common reporting behavior when a <code>Deployment</code> object fails to properly transition between states.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the game object that could not</p></dd><dt class="param">state</dt><dd class="cmt"><p>the <code>DriveState</code> that could not be promoted</p></dd><dt class="param">reason</dt><dd class="cmt"><p>a string explaining why the state can not or will not change</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CancelAllProximityUnits" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CancelAllProximityUnits():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CancelAllProximityUnits():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">CancelAllProximityUnits</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Cease all current interactions with proximity-based units.</p><div class="fullcomment"><div class="comment cmt"><p>Cease all current interactions with proximity-based units.
|
|
Pair with <code>PlayerActionsToCancel</code>, except when logging out (stopping).
|
|
This operations may invoke callback messages.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>postStop</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CancelZoningProcess" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="CancelZoningProcess():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CancelZoningProcess():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">CancelZoningProcess</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The user no longer expects to perform a zoning event,
|
|
or the process is merely resetting its internal state.</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CancelZoningProcessWithDescriptiveReason" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CancelZoningProcessWithDescriptiveReason(msg:String):Unit"></a><a id="CancelZoningProcessWithDescriptiveReason(String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CancelZoningProcessWithDescriptiveReason(msg:String):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">CancelZoningProcessWithDescriptiveReason</span><span class="params">(<span name="msg">msg: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The user no longer expects to perform a zoning event for this reason.</p><div class="fullcomment"><div class="comment cmt"><p>The user no longer expects to perform a zoning event for this reason.</p></div><dl class="paramcmts block"><dt class="param">msg</dt><dd class="cmt"><p>the message to the user</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CancelZoningProcessWithReason" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CancelZoningProcessWithReason(msg:String,msgType:Option[net.psforever.types.ChatMessageType]):Unit"></a><a id="CancelZoningProcessWithReason(String,Option[ChatMessageType]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CancelZoningProcessWithReason(msg:String,msgType:Option[net.psforever.types.ChatMessageType]):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">CancelZoningProcessWithReason</span><span class="params">(<span name="msg">msg: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msgType">msgType: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/ChatMessageType.html" name="net.psforever.types.ChatMessageType" id="net.psforever.types.ChatMessageType" class="extype">ChatMessageType</a>] = <span class="symbol">None</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The user no longer expects to perform a zoning event for this reason.</p><div class="fullcomment"><div class="comment cmt"><p>The user no longer expects to perform a zoning event for this reason.
|
|
</p></div><dl class="paramcmts block"><dt class="param">msg</dt><dd class="cmt"><p>the message to the user</p></dd><dt class="param">msgType</dt><dd class="cmt"><p>the type of message, influencing how it is presented to the user;
|
|
normally, this message uses the same value as <code>zoningChatMessageType</code>s
|
|
defaults to <code>None</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CapacitorTick" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="CapacitorTick(jump_thrust:Boolean):Unit"></a><a id="CapacitorTick(Boolean):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CapacitorTick(jump_thrust:Boolean):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">CapacitorTick</span><span class="params">(<span name="jump_thrust">jump_thrust: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CargoMountBehaviorForUs" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CargoMountBehaviorForUs(carrier:net.psforever.objects.Vehicle,cargo:net.psforever.objects.Vehicle,mountPoint:Int):(net.psforever.packet.game.ObjectAttachMessage,net.psforever.packet.game.CargoMountPointStatusMessage)"></a><a id="CargoMountBehaviorForUs(Vehicle,Vehicle,Int):(ObjectAttachMessage,CargoMountPointStatusMessage)"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CargoMountBehaviorForUs(carrier:net.psforever.objects.Vehicle,cargo:net.psforever.objects.Vehicle,mountPoint:Int):(net.psforever.packet.game.ObjectAttachMessage,net.psforever.packet.game.CargoMountPointStatusMessage)" 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">CargoMountBehaviorForUs</span><span class="params">(<span name="carrier">carrier: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="cargo">cargo: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="mountPoint">mountPoint: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: (<a href="../../packet/game/ObjectAttachMessage.html" name="net.psforever.packet.game.ObjectAttachMessage" id="net.psforever.packet.game.ObjectAttachMessage" class="extype">ObjectAttachMessage</a>, <a href="../../packet/game/CargoMountPointStatusMessage.html" name="net.psforever.packet.game.CargoMountPointStatusMessage" id="net.psforever.packet.game.CargoMountPointStatusMessage" class="extype">CargoMountPointStatusMessage</a>)</span></span><p class="shortcomment cmt">Dispatch an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet only to this client.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet only to this client.</p></div><dl class="paramcmts block"><dt class="param">carrier</dt><dd class="cmt"><p>the ferrying vehicle</p></dd><dt class="param">cargo</dt><dd class="cmt"><p>the ferried vehicle</p></dd><dt class="param">mountPoint</dt><dd class="cmt"><p>the point on the ferryoing vehicle where the ferried vehicle is attached</p></dd><dt>returns</dt><dd class="cmt"><p>a tuple composed of an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CargoMountPointStatusMessage</code></p></span><span class="cmt"><p><code>ObjectAttachMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CargoMountMessagesForUs" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CargoMountMessagesForUs(attachMessage:net.psforever.packet.game.ObjectAttachMessage,mountPointStatusMessage:net.psforever.packet.game.CargoMountPointStatusMessage):Unit"></a><a id="CargoMountMessagesForUs(ObjectAttachMessage,CargoMountPointStatusMessage):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CargoMountMessagesForUs(attachMessage:net.psforever.packet.game.ObjectAttachMessage,mountPointStatusMessage:net.psforever.packet.game.CargoMountPointStatusMessage):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">CargoMountMessagesForUs</span><span class="params">(<span name="attachMessage">attachMessage: <a href="../../packet/game/ObjectAttachMessage.html" name="net.psforever.packet.game.ObjectAttachMessage" id="net.psforever.packet.game.ObjectAttachMessage" class="extype">ObjectAttachMessage</a></span>, <span name="mountPointStatusMessage">mountPointStatusMessage: <a href="../../packet/game/CargoMountPointStatusMessage.html" name="net.psforever.packet.game.CargoMountPointStatusMessage" id="net.psforever.packet.game.CargoMountPointStatusMessage" class="extype">CargoMountPointStatusMessage</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Dispatch an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet only to this client.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch an <code>ObjectAttachMessage</code> packet and a <code>CargoMountPointStatusMessage</code> packet only to this client.</p></div><dl class="paramcmts block"><dt class="param">attachMessage</dt><dd class="cmt"><p>an <code>ObjectAttachMessage</code> packet suitable for initializing cargo operations</p></dd><dt class="param">mountPointStatusMessage</dt><dd class="cmt"><p>a <code>CargoMountPointStatusMessage</code> packet suitable for initializing cargo operations</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CargoMountPointStatusMessage</code></p></span><span class="cmt"><p><code>ObjectAttachMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CheckForHitPositionDiscrepancy" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="CheckForHitPositionDiscrepancy(projectile_guid:net.psforever.types.PlanetSideGUID,hitPos:net.psforever.types.Vector3,target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinitywithnet.psforever.objects.vital.Vitality):Unit"></a><a id="CheckForHitPositionDiscrepancy(PlanetSideGUID,Vector3,PlanetSideGameObjectwithFactionAffinitywithVitality):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CheckForHitPositionDiscrepancy(projectile_guid:net.psforever.types.PlanetSideGUID,hitPos:net.psforever.types.Vector3,target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinitywithnet.psforever.objects.vital.Vitality):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">CheckForHitPositionDiscrepancy</span><span class="params">(<span name="projectile_guid">projectile_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="hitPos">hitPos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="target">target: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a> with <a href="../../objects/vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CleanUpRemoteProjectile" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CleanUpRemoteProjectile(projectile_guid:net.psforever.types.PlanetSideGUID,projectile:net.psforever.objects.ballistics.Projectile,local_index:Int):Unit"></a><a id="CleanUpRemoteProjectile(PlanetSideGUID,Projectile,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CleanUpRemoteProjectile(projectile_guid:net.psforever.types.PlanetSideGUID,projectile:net.psforever.objects.ballistics.Projectile,local_index:Int):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">CleanUpRemoteProjectile</span><span class="params">(<span name="projectile_guid">projectile_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="projectile">projectile: <a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a></span>, <span name="local_index">local_index: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">For a given registered remote projectile, perform all the actions necessary to properly dispose of it.</p><div class="fullcomment"><div class="comment cmt"><p>For a given registered remote projectile, perform all the actions necessary to properly dispose of it.
|
|
Those actions involve:
|
|
informing that the projectile should explode,
|
|
unregistering the projectile's globally unique identifier,
|
|
and managing the projectiles's local status information.</p></div><dl class="paramcmts block"><dt class="param">projectile_guid</dt><dd class="cmt"><p>the globally unique identifier of the projectile</p></dd><dt class="param">projectile</dt><dd class="cmt"><p>the projectile</p></dd><dt class="param">local_index</dt><dd class="cmt"><p>an index of the absolute sequence of the projectile, for internal lists</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CleanUpRemoteProjectile" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CleanUpRemoteProjectile(projectile_guid:net.psforever.types.PlanetSideGUID,projectile:net.psforever.objects.ballistics.Projectile):Unit"></a><a id="CleanUpRemoteProjectile(PlanetSideGUID,Projectile):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CleanUpRemoteProjectile(projectile_guid:net.psforever.types.PlanetSideGUID,projectile:net.psforever.objects.ballistics.Projectile):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">CleanUpRemoteProjectile</span><span class="params">(<span name="projectile_guid">projectile_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="projectile">projectile: <a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">For a given registered remote projectile, perform all the actions necessary to properly dispose of it.</p><div class="fullcomment"><div class="comment cmt"><p>For a given registered remote projectile, perform all the actions necessary to properly dispose of it.
|
|
Those actions involve:
|
|
informing that the projectile should explode,
|
|
unregistering the projectile's globally unique identifier,
|
|
and managing the projectiles's local status information.</p></div><dl class="paramcmts block"><dt class="param">projectile_guid</dt><dd class="cmt"><p>the globally unique identifier of the projectile</p></dd><dt class="param">projectile</dt><dd class="cmt"><p>the projectile</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CleanUpRemoteProjectile(PlanetSideGUID, Projectile, Int)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CommonDestroyConstructionItem" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CommonDestroyConstructionItem(tool:net.psforever.objects.ConstructionItem,index:Int):Unit"></a><a id="CommonDestroyConstructionItem(ConstructionItem,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CommonDestroyConstructionItem(tool:net.psforever.objects.ConstructionItem,index:Int):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">CommonDestroyConstructionItem</span><span class="params">(<span name="tool">tool: <a href="../../objects/ConstructionItem.html" name="net.psforever.objects.ConstructionItem" id="net.psforever.objects.ConstructionItem" class="extype">ConstructionItem</a></span>, <span name="index">index: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Destroy a <code>ConstructionItem</code> object that can be found in the indexed slot.</p><div class="fullcomment"><div class="comment cmt"><p>Destroy a <code>ConstructionItem</code> object that can be found in the indexed slot.</p></div><dl class="paramcmts block"><dt class="param">tool</dt><dd class="cmt"><p>the <code>ConstructionItem</code> object currently in the slot (checked)</p></dd><dt class="param">index</dt><dd class="cmt"><p>the slot index</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Player.Find</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ConstructionItemPermissionComparison" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ConstructionItemPermissionComparison(sample:Set[net.psforever.objects.avatar.Certification],test:Set[net.psforever.objects.avatar.Certification]):Boolean"></a><a id="ConstructionItemPermissionComparison(Set[Certification],Set[Certification]):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ConstructionItemPermissionComparison(sample:Set[net.psforever.objects.avatar.Certification],test:Set[net.psforever.objects.avatar.Certification]):Boolean" 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">ConstructionItemPermissionComparison</span><span class="params">(<span name="sample">sample: <span name="scala.Predef.Set" class="extype">Set</span>[<a href="../../objects/avatar/Certification.html" name="net.psforever.objects.avatar.Certification" id="net.psforever.objects.avatar.Certification" class="extype">Certification</a>]</span>, <span name="test">test: <span name="scala.Predef.Set" class="extype">Set</span>[<a href="../../objects/avatar/Certification.html" name="net.psforever.objects.avatar.Certification" id="net.psforever.objects.avatar.Certification" class="extype">Certification</a>]</span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Compare sets of certifications to determine if
|
|
the requested <code>Engineering</code>-like certification requirements of the one group can be found in a another group.</p><div class="fullcomment"><div class="comment cmt"><p>Compare sets of certifications to determine if
|
|
the requested <code>Engineering</code>-like certification requirements of the one group can be found in a another group.</p></div><dl class="paramcmts block"><dt class="param">sample</dt><dd class="cmt"><p>the certifications to be compared against</p></dd><dt class="param">test</dt><dd class="cmt"><p>the desired certifications</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the desired certification requirements are met; <code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CertificationType</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CountSpawnDelay" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CountSpawnDelay(toZoneId:String,toSpawnPoint:net.psforever.objects.SpawnPoint,fromZoneId:String):scala.concurrent.duration.FiniteDuration"></a><a id="CountSpawnDelay(String,SpawnPoint,String):FiniteDuration"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CountSpawnDelay(toZoneId:String,toSpawnPoint:net.psforever.objects.SpawnPoint,fromZoneId:String):scala.concurrent.duration.FiniteDuration" 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">CountSpawnDelay</span><span class="params">(<span name="toZoneId">toZoneId: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="toSpawnPoint">toSpawnPoint: <a href="../../objects/SpawnPoint.html" name="net.psforever.objects.SpawnPoint" id="net.psforever.objects.SpawnPoint" class="extype">SpawnPoint</a></span>, <span name="fromZoneId">fromZoneId: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span></span></span><p class="shortcomment cmt">Given an origin and a destination, determine how long the process of traveling should take in reconstruction time.</p><div class="fullcomment"><div class="comment cmt"><p>Given an origin and a destination, determine how long the process of traveling should take in reconstruction time.
|
|
For most destinations, the unit of receiving ("spawn point") determines the reconstruction time.
|
|
In a special consideration, travel to any sanctuary or sanctuary-special zone should be as immediate as zone loading.
|
|
</p></div><dl class="paramcmts block"><dt class="param">toZoneId</dt><dd class="cmt"><p>the zone where the target is headed</p></dd><dt class="param">toSpawnPoint</dt><dd class="cmt"><p>the unit the target is using as a destination</p></dd><dt class="param">fromZoneId</dt><dd class="cmt"><p>the zone where the target current is located</p></dd><dt>returns</dt><dd class="cmt"><p>how long the spawning process will take</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#CreateRouterInternalTelepad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CreateRouterInternalTelepad(router:net.psforever.objects.Vehicle,internalTelepad:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.TelepadLike):Unit"></a><a id="CreateRouterInternalTelepad(Vehicle,PlanetSideGameObjectwithTelepadLike):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#CreateRouterInternalTelepad(router:net.psforever.objects.Vehicle,internalTelepad:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.TelepadLike):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">CreateRouterInternalTelepad</span><span class="params">(<span name="router">router: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="internalTelepad">internalTelepad: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/TelepadLike.html" name="net.psforever.objects.ce.TelepadLike" id="net.psforever.objects.ce.TelepadLike" class="extype">TelepadLike</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Create the mechanism that serves as one endpoint of the linked router teleportation system.<br>
|
|
<br>
|
|
Technically, the mechanism - an <code>InternalTelepad</code> object - is always made to exist
|
|
due to how the Router vehicle object is encoded into an <code>ObjectCreateMessage</code> packet.</p><div class="fullcomment"><div class="comment cmt"><p>Create the mechanism that serves as one endpoint of the linked router teleportation system.<br>
|
|
<br>
|
|
Technically, the mechanism - an <code>InternalTelepad</code> object - is always made to exist
|
|
due to how the Router vehicle object is encoded into an <code>ObjectCreateMessage</code> packet.
|
|
Regardless, that internal mechanism is created anew each time the system links a new remote telepad.</p></div><dl class="paramcmts block"><dt class="param">router</dt><dd class="cmt"><p>the vehicle that houses one end of the teleportation system (the <code>internalTelepad</code>)</p></dd><dt class="param">internalTelepad</dt><dd class="cmt"><p>the endpoint of the teleportation system housed by the router</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DeconstructDeployable" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeconstructDeployable(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable,guid:net.psforever.types.PlanetSideGUID,pos:net.psforever.types.Vector3,orient:net.psforever.types.Vector3,deletionType:Int):Unit"></a><a id="DeconstructDeployable(PlanetSideGameObjectwithDeployable,PlanetSideGUID,Vector3,Vector3,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DeconstructDeployable(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable,guid:net.psforever.types.PlanetSideGUID,pos:net.psforever.types.Vector3,orient:net.psforever.types.Vector3,deletionType:Int):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">DeconstructDeployable</span><span class="params">(<span name="obj">obj: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/Deployable.html" name="net.psforever.objects.ce.Deployable" id="net.psforever.objects.ce.Deployable" class="extype">Deployable</a></span>, <span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="orient">orient: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="deletionType">deletionType: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common behavior for deconstructing deployables in the game environment.</p><div class="fullcomment"><div class="comment cmt"><p>Common behavior for deconstructing deployables in the game environment.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the deployable</p></dd><dt class="param">guid</dt><dd class="cmt"><p>the globally unique identifier for the deployable</p></dd><dt class="param">pos</dt><dd class="cmt"><p>the previous position of the deployable</p></dd><dt class="param">orient</dt><dd class="cmt"><p>the previous orientation of the deployable</p></dd><dt class="param">deletionType</dt><dd class="cmt"><p>the value passed to <code>ObjectDeleteMessage</code> concerning the deconstruction animation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DeconstructDeployable" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeconstructDeployable(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable,guid:net.psforever.types.PlanetSideGUID,pos:net.psforever.types.Vector3):Unit"></a><a id="DeconstructDeployable(PlanetSideGameObjectwithDeployable,PlanetSideGUID,Vector3):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DeconstructDeployable(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable,guid:net.psforever.types.PlanetSideGUID,pos:net.psforever.types.Vector3):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">DeconstructDeployable</span><span class="params">(<span name="obj">obj: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/Deployable.html" name="net.psforever.objects.ce.Deployable" id="net.psforever.objects.ce.Deployable" class="extype">Deployable</a></span>, <span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common behavior for deconstructing expended explosive deployables in the game environment.</p><div class="fullcomment"><div class="comment cmt"><p>Common behavior for deconstructing expended explosive deployables in the game environment.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the deployable</p></dd><dt class="param">guid</dt><dd class="cmt"><p>the globally unique identifier for the deployable</p></dd><dt class="param">pos</dt><dd class="cmt"><p>the previous position of the deployable</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DepictPlayerAsCorpse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DepictPlayerAsCorpse(tplayer:net.psforever.objects.Player):Unit"></a><a id="DepictPlayerAsCorpse(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DepictPlayerAsCorpse(tplayer:net.psforever.objects.Player):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">DepictPlayerAsCorpse</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Creates a player that has the characteristics of a corpse.</p><div class="fullcomment"><div class="comment cmt"><p>Creates a player that has the characteristics of a corpse.
|
|
To the game, that is a backpack (or some pastry, festive graphical modification allowing).</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CorpseConverter.converter</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DeployableBuildActivity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeployableBuildActivity(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable):Unit"></a><a id="DeployableBuildActivity(PlanetSideGameObjectwithDeployable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DeployableBuildActivity(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable):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">DeployableBuildActivity</span><span class="params">(<span name="obj">obj: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/Deployable.html" name="net.psforever.objects.ce.Deployable" id="net.psforever.objects.ce.Deployable" class="extype">Deployable</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common actions related to constructing a new <code>Deployable</code> object in the game environment.<br>
|
|
<br>
|
|
Besides the standard <code>ObjectCreateMessage</code> packet that produces the model and game object on the client,
|
|
two messages are dispatched in accordance with enforced deployable limits.</p><div class="fullcomment"><div class="comment cmt"><p>Common actions related to constructing a new <code>Deployable</code> object in the game environment.<br>
|
|
<br>
|
|
Besides the standard <code>ObjectCreateMessage</code> packet that produces the model and game object on the client,
|
|
two messages are dispatched in accordance with enforced deployable limits.
|
|
The first limit of note is the actual number of a specific type of deployable can be placed.
|
|
The second limit of note is the actual number of a specific group (category) of deployables that can be placed.
|
|
For example, the player can place 25 mines but that count adds up all types of mines;
|
|
specific mines have individual limits such as 25 and 5 and only that many of that type can be placed at once.
|
|
Depending on which limit is encountered, an "oldest entry" is struck from the list to make space.
|
|
This generates the first message - "@*OldestDestroyed."
|
|
The other message is generated if the number of that specific type of deployable
|
|
or the number of deployables available in its category
|
|
matches against the maximum count allowed.
|
|
This generates the second message - "@*LimitReached."
|
|
These messages are mutually exclusive, with "@*OldestDestroyed" taking priority over "@*LimitReached."<br>
|
|
<br>
|
|
The map icon for the deployable just introduced is also created on the clients of all faction-affiliated players.
|
|
This icon is important as, short of destroying it,
|
|
the owner has no other means of controlling the created object that it is associated with.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>Deployable</code> object to be built</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DestroyDisplayMessage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DestroyDisplayMessage(killer:net.psforever.objects.ballistics.SourceEntry,victim:net.psforever.objects.ballistics.SourceEntry,method:Int,unk:Int):net.psforever.packet.game.DestroyDisplayMessage"></a><a id="DestroyDisplayMessage(SourceEntry,SourceEntry,Int,Int):DestroyDisplayMessage"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DestroyDisplayMessage(killer:net.psforever.objects.ballistics.SourceEntry,victim:net.psforever.objects.ballistics.SourceEntry,method:Int,unk:Int):net.psforever.packet.game.DestroyDisplayMessage" 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">DestroyDisplayMessage</span><span class="params">(<span name="killer">killer: <a href="../../objects/ballistics/SourceEntry.html" name="net.psforever.objects.ballistics.SourceEntry" id="net.psforever.objects.ballistics.SourceEntry" class="extype">SourceEntry</a></span>, <span name="victim">victim: <a href="../../objects/ballistics/SourceEntry.html" name="net.psforever.objects.ballistics.SourceEntry" id="net.psforever.objects.ballistics.SourceEntry" class="extype">SourceEntry</a></span>, <span name="method">method: <span name="scala.Int" class="extype">Int</span></span>, <span name="unk">unk: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">121</span></span>)</span><span class="result">: <a href="../../packet/game/DestroyDisplayMessage.html" name="net.psforever.packet.game.DestroyDisplayMessage" id="net.psforever.packet.game.DestroyDisplayMessage" class="extype">DestroyDisplayMessage</a></span></span><p class="shortcomment cmt">Properly format a <code>DestroyDisplayMessage</code> packet
|
|
given sufficient information about a target (victim) and an actor (killer).</p><div class="fullcomment"><div class="comment cmt"><p>Properly format a <code>DestroyDisplayMessage</code> packet
|
|
given sufficient information about a target (victim) and an actor (killer).
|
|
For the packet, the <code>charId</code> field is important for determining distinction between players.</p></div><dl class="paramcmts block"><dt class="param">killer</dt><dd class="cmt"><p>the killer's entry</p></dd><dt class="param">victim</dt><dd class="cmt"><p>the victim's entry</p></dd><dt class="param">method</dt><dd class="cmt"><p>the manner of death</p></dd><dt class="param">unk</dt><dd class="cmt"><p>na;
|
|
defaults to 121, the object id of <code>avatar</code></p></dd><dt>returns</dt><dd class="cmt"><p>a <code>DestroyDisplayMessage</code> packet that is properly formatted</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DismountAction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DismountAction(tplayer:net.psforever.objects.Player,obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.mount.Mountable,seatNum:Int):Unit"></a><a id="DismountAction(Player,PlanetSideGameObjectwithMountable,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DismountAction(tplayer:net.psforever.objects.Player,obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.mount.Mountable,seatNum:Int):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">DismountAction</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="obj">obj: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/serverobject/mount/Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a></span>, <span name="seatNum">seatNum: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common activities/procedure when a player dismounts a valid object.</p><div class="fullcomment"><div class="comment cmt"><p>Common activities/procedure when a player dismounts a valid object.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd><dt class="param">obj</dt><dd class="cmt"><p>the mountable object</p></dd><dt class="param">seatNum</dt><dd class="cmt"><p>the seat out of which which the player is disembarking</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DisplayContainerContents" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DisplayContainerContents(containerId:net.psforever.types.PlanetSideGUID,items:Iterable[net.psforever.objects.inventory.InventoryItem]):Unit"></a><a id="DisplayContainerContents(PlanetSideGUID,Iterable[InventoryItem]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DisplayContainerContents(containerId:net.psforever.types.PlanetSideGUID,items:Iterable[net.psforever.objects.inventory.InventoryItem]):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">DisplayContainerContents</span><span class="params">(<span name="containerId">containerId: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="items">items: <span name="scala.Iterable" class="extype">Iterable</span>[<a href="../../objects/inventory/InventoryItem.html" name="net.psforever.objects.inventory.InventoryItem" id="net.psforever.objects.inventory.InventoryItem" class="extype">InventoryItem</a>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Depict the contents of a container by building them in the local client
|
|
in their container as a group of detailed entities.</p><div class="fullcomment"><div class="comment cmt"><p>Depict the contents of a container by building them in the local client
|
|
in their container as a group of detailed entities.</p></div><dl class="paramcmts block"><dt class="param">containerId</dt><dd class="cmt"><p>the container's unique identifier</p></dd><dt class="param">items</dt><dd class="cmt"><p>a list of the entities to be depicted</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>ObjectCreateDetailedMessage</code></p></span><span class="cmt"><p><code>ObjectCreateMessageParent</code></p></span><span class="cmt"><p><code>PacketConverter.DetailedConstructorData</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DontRedrawIcons" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DontRedrawIcons(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable):Unit"></a><a id="DontRedrawIcons(PlanetSideGameObjectwithDeployable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DontRedrawIcons(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable):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">DontRedrawIcons</span><span class="params">(<span name="obj">obj: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/Deployable.html" name="net.psforever.objects.ce.Deployable" id="net.psforever.objects.ce.Deployable" class="extype">Deployable</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Do not draw any icon for this deployable object.<br>
|
|
<br>
|
|
When a client first joins a zone, all deployables are drawn on the continent map once.</p><div class="fullcomment"><div class="comment cmt"><p>Do not draw any icon for this deployable object.<br>
|
|
<br>
|
|
When a client first joins a zone, all deployables are drawn on the continent map once.
|
|
Should the player place any deployables, those deployables belong to that player.
|
|
Ownership causes icon to be drawn in yellow to the player (as opposed to a white icon)
|
|
and that signifies a certain level of control over the deployable, at least the ability to quietly deconstruct it.
|
|
Under normal death/respawn cycles while the player is in a given zone,
|
|
the map icons for owned deployables remain manipulable by that given user.
|
|
They do not have to be redrawn to stay accurate.
|
|
Upon leaving a zone, where the icons are erased, and returning back to the zone, where they are drawn again,
|
|
the deployables that a player owned should be restored in terms of their map icon visibility.
|
|
This control can not be recovered, however, until they are updated with the player's globally unique identifier.
|
|
Since the player does not need to redraw his own deployable icons each time he respawns,
|
|
but will not possess a valid GUID for that zone until he spawns in it at least once,
|
|
this function swaps out with another after the first spawn in any given zone.
|
|
It stays swapped in until the player changes zones.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>a <code>Deployable</code> object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RedrawDeployableIcons</code></p></span><span class="cmt"><p><code>SetCurrentAvatar</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DrawCurrentAmsSpawnPoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DrawCurrentAmsSpawnPoint():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DrawCurrentAmsSpawnPoint():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">DrawCurrentAmsSpawnPoint</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">In the background, a list of advanced mobile spawn vehicles that are deployed in the zone is being updated constantly.</p><div class="fullcomment"><div class="comment cmt"><p>In the background, a list of advanced mobile spawn vehicles that are deployed in the zone is being updated constantly.
|
|
Select, from this list, the AMS that is closest to the player's current or last position
|
|
and draw its spawn selection icon onto the deployment map.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>BindPlayerMessage</code></p></span><span class="cmt"><p><code>DeadState.Release</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#DriverVehicleControl" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DriverVehicleControl(vehicle:net.psforever.objects.Vehicle,speed:Int,flight:Int):Unit"></a><a id="DriverVehicleControl(Vehicle,Int,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#DriverVehicleControl(vehicle:net.psforever.objects.Vehicle,speed:Int,flight:Int):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">DriverVehicleControl</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="speed">speed: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">0</span></span>, <span name="flight">flight: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">0</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Place the current vehicle under the control of the driver's commands,
|
|
but leave it in a cancellable auto-drive.</p><div class="fullcomment"><div class="comment cmt"><p>Place the current vehicle under the control of the driver's commands,
|
|
but leave it in a cancellable auto-drive.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle</p></dd><dt class="param">speed</dt><dd class="cmt"><p>how fast the vehicle is moving forward</p></dd><dt class="param">flight</dt><dd class="cmt"><p>whether the vehicle is ascending or not, if the vehicle is an applicable type</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#EmptyMagazine" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EmptyMagazine(weapon_guid:net.psforever.types.PlanetSideGUID,tool:net.psforever.objects.Tool):Unit"></a><a id="EmptyMagazine(PlanetSideGUID,Tool):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#EmptyMagazine(weapon_guid:net.psforever.types.PlanetSideGUID,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">EmptyMagazine</span><span class="params">(<span name="weapon_guid">weapon_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="tool">tool: <a href="../../objects/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">For a certain weapon that can load ammunition, enforce that its magazine is empty.</p><div class="fullcomment"><div class="comment cmt"><p>For a certain weapon that can load ammunition, enforce that its magazine is empty.
|
|
Punctuate that emptiness with a ceasation of weapons fire and a dry fire sound effect.</p></div><dl class="paramcmts block"><dt class="param">weapon_guid</dt><dd class="cmt"><p>the weapon (GUID)</p></dd><dt class="param">tool</dt><dd class="cmt"><p>the weapon (object)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#EmptyMagazine" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EmptyMagazine(weapon_guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="EmptyMagazine(PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#EmptyMagazine(weapon_guid:net.psforever.types.PlanetSideGUID):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">EmptyMagazine</span><span class="params">(<span name="weapon_guid">weapon_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">For a certain weapon that cna load ammunition, enforce that its magazine is empty.</p><div class="fullcomment"><div class="comment cmt"><p>For a certain weapon that cna load ammunition, enforce that its magazine is empty.</p></div><dl class="paramcmts block"><dt class="param">weapon_guid</dt><dd class="cmt"><p>the weapon</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindContainedEquipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindContainedEquipment:(Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container],Option[net.psforever.objects.equipment.Equipment])"></a><a id="FindContainedEquipment:(Option[PlanetSideGameObjectwithContainer],Option[Equipment])"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindContainedEquipment:(Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container],Option[net.psforever.objects.equipment.Equipment])" 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">FindContainedEquipment</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a>], <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a>])</span></span><p class="shortcomment cmt">Check two locations for a controlled piece of equipment that is associated with the <code>player</code>.<br>
|
|
<br>
|
|
The first location is dependent on whether the avatar is in a vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Check two locations for a controlled piece of equipment that is associated with the <code>player</code>.<br>
|
|
<br>
|
|
The first location is dependent on whether the avatar is in a vehicle.
|
|
Some vehicle seats may have a "controlled weapon" which counts as the first location to be checked.
|
|
The second location is dependent on whether the avatar has a raised hand.
|
|
That is only possible if the player has something in their hand at the moment, hence the second location.
|
|
Players do have a concept called a "last drawn slot" (hand) but that former location is not eligible.<br>
|
|
<br>
|
|
Along with any discovered item, a containing object such that the statement:<br>
|
|
<code>container.Find(object) = Some(slot)</code><br>
|
|
... will return a proper result.
|
|
For a seat controlled weapon, the vehicle is returned.
|
|
For the player's hand, the player is returned.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>a <code>Tuple</code> of the returned values;
|
|
the first value is a <code>Container</code> object;
|
|
the second value is an <code>Equipment</code> object in the former</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindContainedWeapon" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindContainedWeapon:(Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container],Option[net.psforever.objects.Tool])"></a><a id="FindContainedWeapon:(Option[PlanetSideGameObjectwithContainer],Option[Tool])"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindContainedWeapon:(Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container],Option[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">FindContainedWeapon</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a>], <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a>])</span></span><p class="shortcomment cmt">Check two locations for a controlled piece of equipment that is associated with the <code>player</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Check two locations for a controlled piece of equipment that is associated with the <code>player</code>.
|
|
Filter for discovered <code>Tool</code>-type <code>Equipment</code>.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>a <code>Tuple</code> of the returned values;
|
|
the first value is a <code>Container</code> object;
|
|
the second value is an <code>Tool</code> object in the former</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindDetectedProjectileTargets" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindDetectedProjectileTargets(targets:Iterable[net.psforever.types.PlanetSideGUID]):Iterable[String]"></a><a id="FindDetectedProjectileTargets(Iterable[PlanetSideGUID]):Iterable[String]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindDetectedProjectileTargets(targets:Iterable[net.psforever.types.PlanetSideGUID]):Iterable[String]" 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">FindDetectedProjectileTargets</span><span class="params">(<span name="targets">targets: <span name="scala.Iterable" class="extype">Iterable</span>[<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>]</span>)</span><span class="result">: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Predef.String" class="extype">String</span>]</span></span><p class="shortcomment cmt">The main purpose of this method is to determine which targets will receive "locked on" warnings from remote projectiles.</p><div class="fullcomment"><div class="comment cmt"><p>The main purpose of this method is to determine which targets will receive "locked on" warnings from remote projectiles.
|
|
For a given series of globally unique identifiers, indicating targets,
|
|
and that may include mounted elements (players),
|
|
estimate a series of channel names for communication with the vulnerable targets.</p></div><dl class="paramcmts block"><dt class="param">targets</dt><dd class="cmt"><p>the globally unique identifiers of the immediate detected targets</p></dd><dt>returns</dt><dd class="cmt"><p>channels names that allow direct communication to specific realized targets</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindEquipment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindEquipment:Option[net.psforever.objects.equipment.Equipment]"></a><a id="FindEquipment:Option[Equipment]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindEquipment:Option[net.psforever.objects.equipment.Equipment]" 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">FindEquipment</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a>]</span></span><p class="shortcomment cmt">Runs <code>FindContainedEquipment</code> but ignores the <code>Container</code> object output.</p><div class="fullcomment"><div class="comment cmt"><p>Runs <code>FindContainedEquipment</code> but ignores the <code>Container</code> object output.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>an <code>Equipment</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindEquipmentToDelete" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindEquipmentToDelete(object_guid:net.psforever.types.PlanetSideGUID,obj:net.psforever.objects.equipment.Equipment):Boolean"></a><a id="FindEquipmentToDelete(PlanetSideGUID,Equipment):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindEquipmentToDelete(object_guid:net.psforever.types.PlanetSideGUID,obj:net.psforever.objects.equipment.Equipment):Boolean" 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">FindEquipmentToDelete</span><span class="params">(<span name="object_guid">object_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="obj">obj: <a href="../../objects/equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">A simple object searching algorithm that is limited to containers currently known and accessible by the player.</p><div class="fullcomment"><div class="comment cmt"><p>A simple object searching algorithm that is limited to containers currently known and accessible by the player.
|
|
If all relatively local containers are checked and the object is not found,
|
|
the player's locker inventory will be checked, and then
|
|
the game environment (items on the ground) will be checked too.
|
|
If the target object is discovered, it is removed from its current location and is completely destroyed.</p></div><dl class="paramcmts block"><dt class="param">object_guid</dt><dd class="cmt"><p>the target object's globally unique identifier;
|
|
it is not expected that the object will be unregistered, but it is also not gauranteed</p></dd><dt class="param">obj</dt><dd class="cmt"><p>the target object</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the target object was discovered and removed;
|
|
<code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RequestDestroyMessage</code><br>
|
|
<code>Zone.ItemIs.Where</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindInLocalContainer" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindInLocalContainer(object_guid:net.psforever.types.PlanetSideGUID)(parent:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container):Option[(net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,Option[Int])]"></a><a id="FindInLocalContainer(PlanetSideGUID)(PlanetSideServerObjectwithContainer):Option[(PlanetSideServerObjectwithContainer,Option[Int])]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindInLocalContainer(object_guid:net.psforever.types.PlanetSideGUID)(parent:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container):Option[(net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,Option[Int])]" 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">FindInLocalContainer</span><span class="params">(<span name="object_guid">object_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="params">(<span name="parent">parent: <a href="../../objects/serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[(<a href="../../objects/serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a>, <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>])]</span></span><p class="shortcomment cmt">Given an object globally unique identifier, search in a given location for it.</p><div class="fullcomment"><div class="comment cmt"><p>Given an object globally unique identifier, search in a given location for it.</p></div><dl class="paramcmts block"><dt class="param">object_guid</dt><dd class="cmt"><p>the object</p></dd><dt class="param">parent</dt><dd class="cmt"><p>a <code>Container</code> object wherein to search</p></dd><dt>returns</dt><dd class="cmt"><p>an optional tuple that contains two values;
|
|
the first value is the container that matched correctly with the object's GUID;
|
|
the second value is the slot position of the object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindLocalVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindLocalVehicle:Option[net.psforever.objects.Vehicle]"></a><a id="FindLocalVehicle:Option[Vehicle]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindLocalVehicle:Option[net.psforever.objects.Vehicle]" 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">FindLocalVehicle</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a>]</span></span><p class="shortcomment cmt">Get the current <code>Vehicle</code> object that the player is riding/driving.</p><div class="fullcomment"><div class="comment cmt"><p>Get the current <code>Vehicle</code> object that the player is riding/driving.
|
|
The vehicle must be found solely through use of <code>player.VehicleSeated</code>.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>the vehicle</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindProjectileEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindProjectileEntry(projectile_guid:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.ballistics.Projectile]"></a><a id="FindProjectileEntry(PlanetSideGUID):Option[Projectile]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindProjectileEntry(projectile_guid:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.ballistics.Projectile]" 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">FindProjectileEntry</span><span class="params">(<span name="projectile_guid">projectile_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a>]</span></span><p class="shortcomment cmt">Given a globally unique identifier in the 40100 to 40124 range
|
|
(with an optional 25 as buffer),
|
|
find a projectile.</p><div class="fullcomment"><div class="comment cmt"><p>Given a globally unique identifier in the 40100 to 40124 range
|
|
(with an optional 25 as buffer),
|
|
find a projectile.</p></div><dl class="paramcmts block"><dt class="param">projectile_guid</dt><dd class="cmt"><p>the projectile's GUID</p></dd><dt>returns</dt><dd class="cmt"><p>the discovered projectile</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindProximityUnitTargetsInScope" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindProximityUnitTargetsInScope(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit):Seq[net.psforever.objects.PlanetSideGameObject]"></a><a id="FindProximityUnitTargetsInScope(TerminalwithProximityUnit):Seq[PlanetSideGameObject]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindProximityUnitTargetsInScope(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit):Seq[net.psforever.objects.PlanetSideGameObject]" 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">FindProximityUnitTargetsInScope</span><span class="params">(<span name="terminal">terminal: <a href="../../objects/serverobject/terminals/Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a> with <a href="../../objects/serverobject/terminals/ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></span>)</span><span class="result">: <span name="scala.Seq" class="extype">Seq</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>]</span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">terminal</dt><dd class="cmt"><p>na</p></dd><dt>returns</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindReplacementConstructionItem" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindReplacementConstructionItem(tool:net.psforever.objects.ConstructionItem,index:Int):Unit"></a><a id="FindReplacementConstructionItem(ConstructionItem,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindReplacementConstructionItem(tool:net.psforever.objects.ConstructionItem,index:Int):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">FindReplacementConstructionItem</span><span class="params">(<span name="tool">tool: <a href="../../objects/ConstructionItem.html" name="net.psforever.objects.ConstructionItem" id="net.psforever.objects.ConstructionItem" class="extype">ConstructionItem</a></span>, <span name="index">index: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Find a <code>ConstructionItem</code> object in player's inventory
|
|
that is the same type as a target <code>ConstructionItem</code> object and
|
|
transfer it into the designated slot index, usually a holster.</p><div class="fullcomment"><div class="comment cmt"><p>Find a <code>ConstructionItem</code> object in player's inventory
|
|
that is the same type as a target <code>ConstructionItem</code> object and
|
|
transfer it into the designated slot index, usually a holster.
|
|
Draw that holster.
|
|
After being transferred, the replacement should be reconfigured to match the fire mode of the original.
|
|
The primary use of this operation is following the successful manifestation of a deployable in the game world.<br>
|
|
<br>
|
|
As this function should be used in response to some other action such as actually placing a deployable,
|
|
do not instigate bundling from within the function's scope.</p></div><dl class="paramcmts block"><dt class="param">tool</dt><dd class="cmt"><p>the <code>ConstructionItem</code> object to match</p></dd><dt class="param">index</dt><dd class="cmt"><p>where to put the discovered replacement</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>WorldSessionActor.FinalizeDeployable</code><br>
|
|
<code>FindEquipmentStock</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FindWeapon" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FindWeapon:Option[net.psforever.objects.Tool]"></a><a id="FindWeapon:Option[Tool]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FindWeapon:Option[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">FindWeapon</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a>]</span></span><p class="shortcomment cmt">Runs <code>FindContainedWeapon</code> but ignores the <code>Container</code> object output.</p><div class="fullcomment"><div class="comment cmt"><p>Runs <code>FindContainedWeapon</code> but ignores the <code>Container</code> object output.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>a <code>Tool</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FireCycleCleanup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FireCycleCleanup(tool:net.psforever.objects.Tool):Unit"></a><a id="FireCycleCleanup(Tool):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FireCycleCleanup(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">FireCycleCleanup</span><span class="params">(<span name="tool">tool: <a href="../../objects/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">After a weapon has finished shooting, determine if it needs to be sorted in a special way.</p><div class="fullcomment"><div class="comment cmt"><p>After a weapon has finished shooting, determine if it needs to be sorted in a special way.</p></div><dl class="paramcmts block"><dt class="param">tool</dt><dd class="cmt"><p>a weapon</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FirstTimeSquadSetup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FirstTimeSquadSetup():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FirstTimeSquadSetup():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">FirstTimeSquadSetup</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">These messages are dispatched when first starting up the client and connecting to the server for the first time.</p><div class="fullcomment"><div class="comment cmt"><p>These messages are dispatched when first starting up the client and connecting to the server for the first time.
|
|
While many of thee messages will be reused for other situations, they appear in this order only during startup.
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ForgetAllProximityTerminals" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ForgetAllProximityTerminals(term_guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="ForgetAllProximityTerminals(PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ForgetAllProximityTerminals(term_guid:net.psforever.types.PlanetSideGUID):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">ForgetAllProximityTerminals</span><span class="params">(<span name="term_guid">term_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na
|
|
</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#FriskDeadBody" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FriskDeadBody(obj:net.psforever.objects.Player):Unit"></a><a id="FriskDeadBody(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#FriskDeadBody(obj:net.psforever.objects.Player):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">FriskDeadBody</span><span class="params">(<span name="obj">obj: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Remove items from a deceased player that are not expected to be found on a corpse.</p><div class="fullcomment"><div class="comment cmt"><p>Remove items from a deceased player that are not expected to be found on a corpse.
|
|
Most all players have their melee slot knife (which can not be un-equipped normally) removed.
|
|
MAX's have their primary weapon in the designated slot removed.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the player to be turned into a corpse</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#GetKnownVehicleAndSeat" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetKnownVehicleAndSeat():(Option[net.psforever.objects.Vehicle],Option[Int])"></a><a id="GetKnownVehicleAndSeat():(Option[Vehicle],Option[Int])"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#GetKnownVehicleAndSeat():(Option[net.psforever.objects.Vehicle],Option[Int])" 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">GetKnownVehicleAndSeat</span><span class="params">()</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a>], <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>])</span></span><p class="shortcomment cmt">If the player is seated in a vehicle, find that vehicle and get the seat index number at which the player is sat.<br>
|
|
<br>
|
|
For special purposes involved in zone transfers,
|
|
where the vehicle may or may not exist in either of the zones (yet),
|
|
the value of <code>interstellarFerry</code> is also polled.</p><div class="fullcomment"><div class="comment cmt"><p>If the player is seated in a vehicle, find that vehicle and get the seat index number at which the player is sat.<br>
|
|
<br>
|
|
For special purposes involved in zone transfers,
|
|
where the vehicle may or may not exist in either of the zones (yet),
|
|
the value of <code>interstellarFerry</code> is also polled.
|
|
Making certain this field is blanked after the transfer is completed is important
|
|
to avoid inspecting the wrong vehicle and failing simple vehicle checks where this function may be employed.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>a tuple consisting of a vehicle reference and a seat index
|
|
if and only if the vehicle is known to this client and the <code>WorldSessioNActor</code>-global <code>player</code> occupies it;
|
|
<code>(None, None)</code>, otherwise (even if the vehicle can be determined)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GetMountableAndSeat</code></p></span><span class="cmt"><p><code>interstellarFerry</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#GetMountableAndSeat" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetMountableAndSeat(direct:Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.mount.Mountable],occupant:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone):(Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.mount.Mountable],Option[Int])"></a><a id="GetMountableAndSeat(Option[PlanetSideGameObjectwithMountable],Player,Zone):(Option[PlanetSideGameObjectwithMountable],Option[Int])"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#GetMountableAndSeat(direct:Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.mount.Mountable],occupant:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone):(Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.mount.Mountable],Option[Int])" 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">GetMountableAndSeat</span><span class="params">(<span name="direct">direct: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/serverobject/mount/Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a>]</span>, <span name="occupant">occupant: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>)</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/serverobject/mount/Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a>], <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>])</span></span><p class="shortcomment cmt">If the player is mounted in some entity, find that entity and get the seat index number at which the player is sat.</p><div class="fullcomment"><div class="comment cmt"><p>If the player is mounted in some entity, find that entity and get the seat index number at which the player is sat.
|
|
The priority of object confirmation is <code>direct</code> then <code>occupant.VehicleSeated</code>.
|
|
Once an object is found, the remainder are ignored.</p></div><dl class="paramcmts block"><dt class="param">direct</dt><dd class="cmt"><p>a game object in which the player may be sat</p></dd><dt class="param">occupant</dt><dd class="cmt"><p>the player who is sat and may have specified the game object in which mounted</p></dd><dt>returns</dt><dd class="cmt"><p>a tuple consisting of a vehicle reference and a seat index
|
|
if and only if the vehicle is known to this client and the <code>WorldSessioNActor</code>-global <code>player</code> occupies it;
|
|
<code>(None, None)</code>, otherwise (even if the vehicle can be determined)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#GetVehicleAndSeat" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetVehicleAndSeat():(Option[net.psforever.objects.Vehicle],Option[Int])"></a><a id="GetVehicleAndSeat():(Option[Vehicle],Option[Int])"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#GetVehicleAndSeat():(Option[net.psforever.objects.Vehicle],Option[Int])" 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">GetVehicleAndSeat</span><span class="params">()</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a>], <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>])</span></span><p class="shortcomment cmt">If the player is seated in a vehicle, find that vehicle and get the seat index number at which the player is sat.</p><div class="fullcomment"><div class="comment cmt"><p>If the player is seated in a vehicle, find that vehicle and get the seat index number at which the player is sat.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>a tuple consisting of a vehicle reference and a seat index
|
|
if and only if the vehicle is known to this client and the <code>WorldSessioNActor</code>-global <code>player</code> occupies it;
|
|
<code>(None, None)</code>, otherwise (even if the vehicle can be determined)</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GetMountableAndSeat</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#GiveSquadColorsInZone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GiveSquadColorsInZone(members:Iterable[Long],value:Long):Unit"></a><a id="GiveSquadColorsInZone(Iterable[Long],Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#GiveSquadColorsInZone(members:Iterable[Long],value:Long):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">GiveSquadColorsInZone</span><span class="params">(<span name="members">members: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>, <span name="value">value: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Allocate the listed squad members in zone and give their nameplates and their marquees the appropriate squad color.</p><div class="fullcomment"><div class="comment cmt"><p>Allocate the listed squad members in zone and give their nameplates and their marquees the appropriate squad color.</p></div><dl class="paramcmts block"><dt class="param">members</dt><dd class="cmt"><p>members of the squad to target</p></dd><dt class="param">value</dt><dd class="cmt"><p>the assignment value</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>PlanetsideAttributeMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#GiveSquadColorsInZone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GiveSquadColorsInZone(members:Iterable[Long]):Unit"></a><a id="GiveSquadColorsInZone(Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#GiveSquadColorsInZone(members:Iterable[Long]):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">GiveSquadColorsInZone</span><span class="params">(<span name="members">members: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Allocate the listed squad members in zone and give their nameplates and their marquees the appropriate squad color.</p><div class="fullcomment"><div class="comment cmt"><p>Allocate the listed squad members in zone and give their nameplates and their marquees the appropriate squad color.</p></div><dl class="paramcmts block"><dt class="param">members</dt><dd class="cmt"><p>members of the squad to target</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#GiveSquadColorsInZone" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="GiveSquadColorsInZone():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#GiveSquadColorsInZone():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">GiveSquadColorsInZone</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Allocate all squad members in zone and give their nameplates and their marquees the appropriate squad color.</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#GoToDeploymentMap" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GoToDeploymentMap():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#GoToDeploymentMap():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">GoToDeploymentMap</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Make this client display the deployment map, and all its available destination spawn points.</p><div class="fullcomment"><div class="comment cmt"><p>Make this client display the deployment map, and all its available destination spawn points.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AvatarDeadStateMessage</code></p></span><span class="cmt"><p><code>DeadState.Release</code></p></span><span class="cmt"><p><code>Player.Release</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HackCaptureTerminal" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HackCaptureTerminal(target_guid:net.psforever.types.PlanetSideGUID,unk1:Long,unk2:Long,isResecured:Boolean):Unit"></a><a id="HackCaptureTerminal(PlanetSideGUID,Long,Long,Boolean):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HackCaptureTerminal(target_guid:net.psforever.types.PlanetSideGUID,unk1:Long,unk2:Long,isResecured:Boolean):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">HackCaptureTerminal</span><span class="params">(<span name="target_guid">target_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="unk1">unk1: <span name="scala.Long" class="extype">Long</span></span>, <span name="unk2">unk2: <span name="scala.Long" class="extype">Long</span></span>, <span name="isResecured">isResecured: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">target_guid</dt><dd class="cmt"><p>na</p></dd><dt class="param">unk1</dt><dd class="cmt"><p>na</p></dd><dt class="param">unk2</dt><dd class="cmt"><p>na</p></dd><dt class="param">isResecured</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HackObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HackObject(target_guid:net.psforever.types.PlanetSideGUID,unk1:Long,unk2:Long):Unit"></a><a id="HackObject(PlanetSideGUID,Long,Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HackObject(target_guid:net.psforever.types.PlanetSideGUID,unk1:Long,unk2:Long):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">HackObject</span><span class="params">(<span name="target_guid">target_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="unk1">unk1: <span name="scala.Long" class="extype">Long</span></span>, <span name="unk2">unk2: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">target_guid</dt><dd class="cmt"><p>na</p></dd><dt class="param">unk1</dt><dd class="cmt"><p>na</p></dd><dt class="param">unk2</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleAvatarServiceResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleAvatarServiceResponse(toChannel:String,guid:net.psforever.types.PlanetSideGUID,reply:net.psforever.services.avatar.AvatarResponse.Response):Unit"></a><a id="HandleAvatarServiceResponse(String,PlanetSideGUID,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleAvatarServiceResponse(toChannel:String,guid:net.psforever.types.PlanetSideGUID,reply:net.psforever.services.avatar.AvatarResponse.Response):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">HandleAvatarServiceResponse</span><span class="params">(<span name="toChannel">toChannel: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="reply">reply: <a href="../../services/avatar/AvatarResponse$$Response.html" name="net.psforever.services.avatar.AvatarResponse.Response" id="net.psforever.services.avatar.AvatarResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">toChannel</dt><dd class="cmt"><p>na</p></dd><dt class="param">guid</dt><dd class="cmt"><p>na</p></dd><dt class="param">reply</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleDealingDamage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleDealingDamage(target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.vital.Vitality,data:net.psforever.objects.ballistics.ResolvedProjectile):Unit"></a><a id="HandleDealingDamage(PlanetSideGameObjectwithVitality,ResolvedProjectile):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleDealingDamage(target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.vital.Vitality,data:net.psforever.objects.ballistics.ResolvedProjectile):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">HandleDealingDamage</span><span class="params">(<span name="target">target: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a></span>, <span name="data">data: <a href="../../objects/ballistics/ResolvedProjectile.html" name="net.psforever.objects.ballistics.ResolvedProjectile" id="net.psforever.objects.ballistics.ResolvedProjectile" class="extype">ResolvedProjectile</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Calculate the amount of damage to be dealt to an active <code>target</code>
|
|
using the information reconstructed from a <code>Resolvedprojectile</code>
|
|
and affect the <code>target</code> in a synchronized manner.</p><div class="fullcomment"><div class="comment cmt"><p>Calculate the amount of damage to be dealt to an active <code>target</code>
|
|
using the information reconstructed from a <code>Resolvedprojectile</code>
|
|
and affect the <code>target</code> in a synchronized manner.
|
|
The active <code>target</code> and the target of the <code>ResolvedProjectile</code> do not have be the same.
|
|
While the "tell" for being able to sustain damage is an entity of type <code>Vitality</code>,
|
|
only specific <code>Vitality</code> entity types are being screened for sustaining damage.</p></div><dl class="paramcmts block"><dt class="param">target</dt><dd class="cmt"><p>a valid game object that is known to the server</p></dd><dt class="param">data</dt><dd class="cmt"><p>a projectile that will affect the target</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>DamageResistanceModel</code></p></span><span class="cmt"><p><code>Vitality</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleLocalServiceResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleLocalServiceResponse(toChannel:String,guid:net.psforever.types.PlanetSideGUID,reply:net.psforever.services.local.LocalResponse.Response):Unit"></a><a id="HandleLocalServiceResponse(String,PlanetSideGUID,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleLocalServiceResponse(toChannel:String,guid:net.psforever.types.PlanetSideGUID,reply:net.psforever.services.local.LocalResponse.Response):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">HandleLocalServiceResponse</span><span class="params">(<span name="toChannel">toChannel: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="reply">reply: <a href="../../services/local/LocalResponse$$Response.html" name="net.psforever.services.local.LocalResponse.Response" id="net.psforever.services.local.LocalResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">toChannel</dt><dd class="cmt"><p>na</p></dd><dt class="param">guid</dt><dd class="cmt"><p>na</p></dd><dt class="param">reply</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleMountMessages" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleMountMessages(tplayer:net.psforever.objects.Player,reply:net.psforever.objects.serverobject.mount.Mountable.Exchange):Unit"></a><a id="HandleMountMessages(Player,Exchange):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleMountMessages(tplayer:net.psforever.objects.Player,reply:net.psforever.objects.serverobject.mount.Mountable.Exchange):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">HandleMountMessages</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="reply">reply: <a href="../../objects/serverobject/mount/Mountable$$Exchange.html" name="net.psforever.objects.serverobject.mount.Mountable.Exchange" id="net.psforever.objects.serverobject.mount.Mountable.Exchange" class="extype">Exchange</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>na</p></dd><dt class="param">reply</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleProgressChange" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleProgressChange(delta:Float,completionAction:()=>Unit,tickAction:Float=>Boolean,tick:Long):Unit"></a><a id="HandleProgressChange(Float,()=>Unit,(Float)=>Boolean,Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleProgressChange(delta:Float,completionAction:()=>Unit,tickAction:Float=>Boolean,tick:Long):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">HandleProgressChange</span><span class="params">(<span name="delta">delta: <span name="scala.Float" class="extype">Float</span></span>, <span name="completionAction">completionAction: () => <span name="scala.Unit" class="extype">Unit</span></span>, <span name="tickAction">tickAction: (<span name="scala.Float" class="extype">Float</span>) => <span name="scala.Boolean" class="extype">Boolean</span></span>, <span name="tick">tick: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Handle the message that indicates the level of completion of a process.</p><div class="fullcomment"><div class="comment cmt"><p>Handle the message that indicates the level of completion of a process.
|
|
The process is any form of user-driven activity with a certain eventual outcome
|
|
but indeterminate progress feedback per cycle.<br>
|
|
<br>
|
|
This task is broken down into the "progression" from its initial state to the eventual outcome
|
|
as is reported back to the player through some means of messaging window feedback.
|
|
Though common in practice, this is not a requirement
|
|
and the progress can accumulate without a user reportable method.
|
|
To ensure that completion is reported properly,
|
|
an exception is made that 99% completion is accounted uniquely
|
|
before the final 100% is achieved.
|
|
If the background process recording value is never set before running the initial operation
|
|
or gets unset by failing a <code>tickAction</code> check
|
|
the process is stopped.
|
|
</p></div><dl class="paramcmts block"><dt class="param">delta</dt><dd class="cmt"><p>how much the progress changes each tick</p></dd><dt class="param">completionAction</dt><dd class="cmt"><p>a custom action performed once the process is completed</p></dd><dt class="param">tickAction</dt><dd class="cmt"><p>an optional action is is performed for each tick of progress;
|
|
also performs a continuity check to determine if the process has been disrupted</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>progressBarUpdate</code></p></span><span class="cmt"><p><code>progressBarValue</code></p></span><span class="cmt"><p><code>WorldSessionActor.Progress</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleProximityTerminalUse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleProximityTerminalUse(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit):Unit"></a><a id="HandleProximityTerminalUse(TerminalwithProximityUnit):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleProximityTerminalUse(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit):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">HandleProximityTerminalUse</span><span class="params">(<span name="terminal">terminal: <a href="../../objects/serverobject/terminals/Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a> with <a href="../../objects/serverobject/terminals/ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">terminal</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleReleaseAvatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleReleaseAvatar(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone):Unit"></a><a id="HandleReleaseAvatar(Player,Zone):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleReleaseAvatar(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone):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">HandleReleaseAvatar</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>na</p></dd><dt class="param">zone</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleSetCurrentAvatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleSetCurrentAvatar(tplayer:net.psforever.objects.Player):Unit"></a><a id="HandleSetCurrentAvatar(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleSetCurrentAvatar(tplayer:net.psforever.objects.Player):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">HandleSetCurrentAvatar</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Instruct the client to treat this player as the avatar.</p><div class="fullcomment"><div class="comment cmt"><p>Instruct the client to treat this player as the avatar.
|
|
Initialize all client-specific data that is dependent on some player being declared the "avatar".</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the target player</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleTerminalMessage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleTerminalMessage(tplayer:net.psforever.objects.Player,msg:net.psforever.packet.game.ItemTransactionMessage,order:net.psforever.objects.serverobject.terminals.Terminal.Exchange):Unit"></a><a id="HandleTerminalMessage(Player,ItemTransactionMessage,Exchange):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleTerminalMessage(tplayer:net.psforever.objects.Player,msg:net.psforever.packet.game.ItemTransactionMessage,order:net.psforever.objects.serverobject.terminals.Terminal.Exchange):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">HandleTerminalMessage</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="msg">msg: <a href="../../packet/game/ItemTransactionMessage.html" name="net.psforever.packet.game.ItemTransactionMessage" id="net.psforever.packet.game.ItemTransactionMessage" class="extype">ItemTransactionMessage</a></span>, <span name="order">order: <a href="../../objects/serverobject/terminals/Terminal$$Exchange.html" name="net.psforever.objects.serverobject.terminals.Terminal.Exchange" id="net.psforever.objects.serverobject.terminals.Terminal.Exchange" class="extype">Exchange</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>na</p></dd><dt class="param">msg</dt><dd class="cmt"><p>na</p></dd><dt class="param">order</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleVehicleServiceResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HandleVehicleServiceResponse(toChannel:String,guid:net.psforever.types.PlanetSideGUID,reply:net.psforever.services.vehicle.VehicleResponse.Response):Unit"></a><a id="HandleVehicleServiceResponse(String,PlanetSideGUID,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleVehicleServiceResponse(toChannel:String,guid:net.psforever.types.PlanetSideGUID,reply:net.psforever.services.vehicle.VehicleResponse.Response):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">HandleVehicleServiceResponse</span><span class="params">(<span name="toChannel">toChannel: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="reply">reply: <a href="../../services/vehicle/VehicleResponse$$Response.html" name="net.psforever.services.vehicle.VehicleResponse.Response" id="net.psforever.services.vehicle.VehicleResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">toChannel</dt><dd class="cmt"><p>na</p></dd><dt class="param">guid</dt><dd class="cmt"><p>na</p></dd><dt class="param">reply</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleWeaponFire" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="HandleWeaponFire(weaponGUID:net.psforever.types.PlanetSideGUID,projectileGUID:net.psforever.types.PlanetSideGUID,shotOrigin:net.psforever.types.Vector3):Unit"></a><a id="HandleWeaponFire(PlanetSideGUID,PlanetSideGUID,Vector3):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleWeaponFire(weaponGUID:net.psforever.types.PlanetSideGUID,projectileGUID:net.psforever.types.PlanetSideGUID,shotOrigin:net.psforever.types.Vector3):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">HandleWeaponFire</span><span class="params">(<span name="weaponGUID">weaponGUID: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="projectileGUID">projectileGUID: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="shotOrigin">shotOrigin: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HandleWeaponFireAccountability" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="HandleWeaponFireAccountability(weaponGUID:net.psforever.types.PlanetSideGUID,projectileGUID:net.psforever.types.PlanetSideGUID):(Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container],Option[net.psforever.objects.Tool])"></a><a id="HandleWeaponFireAccountability(PlanetSideGUID,PlanetSideGUID):(Option[PlanetSideGameObjectwithContainer],Option[Tool])"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HandleWeaponFireAccountability(weaponGUID:net.psforever.types.PlanetSideGUID,projectileGUID:net.psforever.types.PlanetSideGUID):(Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container],Option[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">HandleWeaponFireAccountability</span><span class="params">(<span name="weaponGUID">weaponGUID: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="projectileGUID">projectileGUID: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: (<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a>], <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a>])</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HealAction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HealAction(tplayer:net.psforever.objects.Player,healValue:Int):Boolean"></a><a id="HealAction(Player,Int):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HealAction(tplayer:net.psforever.objects.Player,healValue:Int):Boolean" 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">HealAction</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="healValue">healValue: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">10</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Restore, at most, a specific amount of health points on a player.</p><div class="fullcomment"><div class="comment cmt"><p>Restore, at most, a specific amount of health points on a player.
|
|
Send messages to connected client and to events system.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd><dt class="param">healValue</dt><dd class="cmt"><p>the amount to heal;
|
|
10 by default</p></dd><dt>returns</dt><dd class="cmt"><p>whether the player can be repaired for any more health points</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HealthAndArmorTerminal" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HealthAndArmorTerminal(unit:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit,target:net.psforever.objects.Player):Unit"></a><a id="HealthAndArmorTerminal(TerminalwithProximityUnit,Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HealthAndArmorTerminal(unit:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit,target:net.psforever.objects.Player):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">HealthAndArmorTerminal</span><span class="params">(<span name="unit">unit: <a href="../../objects/serverobject/terminals/Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a> with <a href="../../objects/serverobject/terminals/ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></span>, <span name="target">target: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">When standing on the platform of a(n advanced) medical terminal,
|
|
resotre the player's health and armor points (when they need their health and armor points restored).</p><div class="fullcomment"><div class="comment cmt"><p>When standing on the platform of a(n advanced) medical terminal,
|
|
resotre the player's health and armor points (when they need their health and armor points restored).
|
|
If the player is both fully healed and fully repaired, stop using the terminal.</p></div><dl class="paramcmts block"><dt class="param">unit</dt><dd class="cmt"><p>the medical terminal</p></dd><dt class="param">target</dt><dd class="cmt"><p>the player being healed</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#HideContainerContents" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HideContainerContents(items:List[net.psforever.objects.inventory.InventoryItem]):Unit"></a><a id="HideContainerContents(List[InventoryItem]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#HideContainerContents(items:List[net.psforever.objects.inventory.InventoryItem]):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">HideContainerContents</span><span class="params">(<span name="items">items: <span name="scala.List" class="extype">List</span>[<a href="../../objects/inventory/InventoryItem.html" name="net.psforever.objects.inventory.InventoryItem" id="net.psforever.objects.inventory.InventoryItem" class="extype">InventoryItem</a>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Forget the contents of a container by deleting that content from the local client.</p><div class="fullcomment"><div class="comment cmt"><p>Forget the contents of a container by deleting that content from the local client.</p></div><dl class="paramcmts block"><dt class="param">items</dt><dd class="cmt"><p>a list of the entities to be depicted</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>InventoryItem</code></p></span><span class="cmt"><p><code>ObjectDeleteMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ImmediateDisconnect" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ImmediateDisconnect():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ImmediateDisconnect():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">ImmediateDisconnect</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#KeepAlivePersistence" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="KeepAlivePersistence():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#KeepAlivePersistence():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">KeepAlivePersistence</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The atypical response to receiving a <code>KeepAliveMessage</code> packet from the client.<br>
|
|
<br>
|
|
<code>KeepAliveMessage</code> packets are the primary vehicle for persistence due to client reporting
|
|
in the case where the player's avatar is riding in a vehicle in a seat with no vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>The atypical response to receiving a <code>KeepAliveMessage</code> packet from the client.<br>
|
|
<br>
|
|
<code>KeepAliveMessage</code> packets are the primary vehicle for persistence due to client reporting
|
|
in the case where the player's avatar is riding in a vehicle in a seat with no vehicle.</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>KeepAliveMessage</code></p></span><span class="cmt"><p><code>keepAliveFunc</code></p></span><span class="cmt"><p><code>turnCounterFunc</code></p></span><span class="cmt"><p><code>persist</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#KickedByAdministration" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="KickedByAdministration():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#KickedByAdministration():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">KickedByAdministration</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LinkRemoteTelepad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LinkRemoteTelepad(telepadGUID:net.psforever.types.PlanetSideGUID):Unit"></a><a id="LinkRemoteTelepad(PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LinkRemoteTelepad(telepadGUID:net.psforever.types.PlanetSideGUID):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">LinkRemoteTelepad</span><span class="params">(<span name="telepadGUID">telepadGUID: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">telepadGUID</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LinkRouterToRemoteTelepad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LinkRouterToRemoteTelepad(router:net.psforever.objects.Vehicle,internalTelepad:net.psforever.objects.vehicles.Utility.InternalTelepad,remoteTelepad:net.psforever.objects.TelepadDeployable):Unit"></a><a id="LinkRouterToRemoteTelepad(Vehicle,InternalTelepad,TelepadDeployable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LinkRouterToRemoteTelepad(router:net.psforever.objects.Vehicle,internalTelepad:net.psforever.objects.vehicles.Utility.InternalTelepad,remoteTelepad:net.psforever.objects.TelepadDeployable):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">LinkRouterToRemoteTelepad</span><span class="params">(<span name="router">router: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="internalTelepad">internalTelepad: <a href="../../objects/vehicles/Utility$$InternalTelepad.html" name="net.psforever.objects.vehicles.Utility.InternalTelepad" id="net.psforever.objects.vehicles.Utility.InternalTelepad" class="extype">InternalTelepad</a></span>, <span name="remoteTelepad">remoteTelepad: <a href="../../objects/TelepadDeployable.html" name="net.psforever.objects.TelepadDeployable" id="net.psforever.objects.TelepadDeployable" class="extype">TelepadDeployable</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Link the router teleport system using the provided terminal information.</p><div class="fullcomment"><div class="comment cmt"><p>Link the router teleport system using the provided terminal information.
|
|
The internal telepad is made known of the remote telepad, creating the link.</p></div><dl class="paramcmts block"><dt class="param">router</dt><dd class="cmt"><p>the vehicle that houses one end of the teleportation system (the <code>internalTelepad</code>)</p></dd><dt class="param">internalTelepad</dt><dd class="cmt"><p>the endpoint of the teleportation system housed by the router</p></dd><dt class="param">remoteTelepad</dt><dd class="cmt"><p>the endpoint of the teleportation system that exists in the environment</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LoadZoneAsPlayer" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadZoneAsPlayer(targetPlayer:net.psforever.objects.Player,zoneId:String):Unit"></a><a id="LoadZoneAsPlayer(Player,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LoadZoneAsPlayer(targetPlayer:net.psforever.objects.Player,zoneId:String):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">LoadZoneAsPlayer</span><span class="params">(<span name="targetPlayer">targetPlayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="zoneId">zoneId: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Deal with a target player as free-standing infantry in the course of a redeployment action to a target continent
|
|
whether that action is the result of a deconstruction (reconstruction), a death (respawning),
|
|
or other position shifting action handled directly by the server.</p><div class="fullcomment"><div class="comment cmt"><p>Deal with a target player as free-standing infantry in the course of a redeployment action to a target continent
|
|
whether that action is the result of a deconstruction (reconstruction), a death (respawning),
|
|
or other position shifting action handled directly by the server.</p><p>The two important vectors are still whether the zone being transported to is the same or is different
|
|
and whether the target player is alive or released (note: not just "dead" ...).
|
|
</p></div><dl class="paramcmts block"><dt class="param">targetPlayer</dt><dd class="cmt"><p>the target player being moved around;
|
|
not necessarily the same player as the <code>WorldSessionActor</code>-global <code>player</code></p></dd><dt class="param">zoneId</dt><dd class="cmt"><p>the zone in which the player will be placed</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LoadZoneCommonTransferActivity" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadZoneCommonTransferActivity():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LoadZoneCommonTransferActivity():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">LoadZoneCommonTransferActivity</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common behavior when transferring between zones
|
|
encompassing actions that disassociate the player with entities they left (will leave) in the previous zone.</p><div class="fullcomment"><div class="comment cmt"><p>Common behavior when transferring between zones
|
|
encompassing actions that disassociate the player with entities they left (will leave) in the previous zone.
|
|
It also sets up actions for the new zone loading process.
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LoadZoneInVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadZoneInVehicle(vehicle:net.psforever.objects.Vehicle,pos:net.psforever.types.Vector3,ori:net.psforever.types.Vector3,zone_id:String):Unit"></a><a id="LoadZoneInVehicle(Vehicle,Vector3,Vector3,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LoadZoneInVehicle(vehicle:net.psforever.objects.Vehicle,pos:net.psforever.types.Vector3,ori:net.psforever.types.Vector3,zone_id:String):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">LoadZoneInVehicle</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="ori">ori: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="zone_id">zone_id: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Deal with a target player as a vehicle occupant in the course of a redeployment action to a target continent
|
|
whether that action is the result of a deconstruction (reconstruction)
|
|
or other position shifting action handled directly by the server.<br>
|
|
<br>
|
|
The original target player must be alive and the only consideration is in what position the player is mounted in the vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Deal with a target player as a vehicle occupant in the course of a redeployment action to a target continent
|
|
whether that action is the result of a deconstruction (reconstruction)
|
|
or other position shifting action handled directly by the server.<br>
|
|
<br>
|
|
The original target player must be alive and the only consideration is in what position the player is mounted in the vehicle.
|
|
Any seated position that isn't the driver is a passenger.
|
|
The most important role performed in this function is to declare a reference to the vehicle itsself
|
|
since no other connection from the player to the vehicle is guaranteed to persist in a meaningful way during the transfer.
|
|
</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the target vehicle being moved around;
|
|
WILL necessarily be the same vehicles as is controlled by the <code>WorldSessionActor</code>-global <code>player</code></p></dd><dt class="param">pos</dt><dd class="cmt"><p>the game world coordinates where the vehicle will be positioned</p></dd><dt class="param">ori</dt><dd class="cmt"><p>the direction in which the vehicle will be oriented</p></dd><dt class="param">zone_id</dt><dd class="cmt"><p>the zone in which the vehicle and driver will be placed,
|
|
or in which the vehicle has already been placed</p></dd><dt>returns</dt><dd class="cmt"><p>a tuple composed of an <code>ActorRef</code> destination and a message to send to that destination</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LoadZoneInVehicleAsDriver" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadZoneInVehicleAsDriver(vehicle:net.psforever.objects.Vehicle,zoneId:String):Unit"></a><a id="LoadZoneInVehicleAsDriver(Vehicle,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LoadZoneInVehicleAsDriver(vehicle:net.psforever.objects.Vehicle,zoneId:String):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">LoadZoneInVehicleAsDriver</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="zoneId">zoneId: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Deal with a target player as a vehicle driver in the course of a redeployment action to a target continent
|
|
whether that action is the result of a deconstruction (reconstruction)
|
|
or other position shifting action handled directly by the server.<br>
|
|
<br>
|
|
During a vehicle transfer, whether to the same zone or to a different zone,
|
|
the driver has the important task of ensuring the certain safety of his passengers during transport.</p><div class="fullcomment"><div class="comment cmt"><p>Deal with a target player as a vehicle driver in the course of a redeployment action to a target continent
|
|
whether that action is the result of a deconstruction (reconstruction)
|
|
or other position shifting action handled directly by the server.<br>
|
|
<br>
|
|
During a vehicle transfer, whether to the same zone or to a different zone,
|
|
the driver has the important task of ensuring the certain safety of his passengers during transport.
|
|
The driver must modify the conditions of the vehicle's passengers common communication channel
|
|
originally determined entirely by the vehicle's soon-to-be blanked internal <code>Actor</code> object.
|
|
Any cargo vehicles under the control of the target vehicle must also be made aware of the current state of the process.
|
|
In the case of a series of ferrying vehicles and cargo vehicles,
|
|
the vehicle to be deleted might not be the one immediately mounted.
|
|
A reference to the top-level ferrying vehicle's former globally unique identifier has been retained for this purpose.
|
|
This vehicle can be deleted for everyone if no more work can be detected.
|
|
</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the target vehicle being moved around;
|
|
WILL necessarily be the same vehicles as is controlled by the <code>WorldSessionActor</code>-global <code>player</code></p></dd><dt class="param">zoneId</dt><dd class="cmt"><p>the zone in which the vehicle and driver will be placed,
|
|
or in which the vehicle has already been placed</p></dd><dt>returns</dt><dd class="cmt"><p>a tuple composed of an <code>ActorRef</code> destination and a message to send to that destination</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LoadZoneInVehicleAsPassenger" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadZoneInVehicleAsPassenger(vehicle:net.psforever.objects.Vehicle,zoneId:String):Unit"></a><a id="LoadZoneInVehicleAsPassenger(Vehicle,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LoadZoneInVehicleAsPassenger(vehicle:net.psforever.objects.Vehicle,zoneId:String):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">LoadZoneInVehicleAsPassenger</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="zoneId">zoneId: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Deal with a target player as a vehicle passenger in the course of a redeployment action to a target continent
|
|
whether that action is the result of a deconstruction (reconstruction)
|
|
or other position shifting action handled directly by the server.<br>
|
|
<br>
|
|
The way a vehicle is handled in reference to being a passenger
|
|
is very similar to how an infantry player is handled in the same process.</p><div class="fullcomment"><div class="comment cmt"><p>Deal with a target player as a vehicle passenger in the course of a redeployment action to a target continent
|
|
whether that action is the result of a deconstruction (reconstruction)
|
|
or other position shifting action handled directly by the server.<br>
|
|
<br>
|
|
The way a vehicle is handled in reference to being a passenger
|
|
is very similar to how an infantry player is handled in the same process.
|
|
If this player is the last person who requires a zone change
|
|
which is the concluding zone transfer of what might have been a long chain of vehicle and passengers
|
|
then that player is responsible for deleting the vehicle for other players of the previous zone.
|
|
In the case of a series of ferrying vehicles and cargo vehicles,
|
|
the vehicle to be deleted might not be the one immediately mounted.
|
|
A reference to the top-level ferrying vehicle's former globally unique identifier has been retained for this purpose.
|
|
This vehicle can be deleted for everyone if no more work can be detected.
|
|
</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the target vehicle being moved around</p></dd><dt class="param">zoneId</dt><dd class="cmt"><p>the zone in which the vehicle and driver will be placed</p></dd><dt>returns</dt><dd class="cmt"><p>a tuple composed of an <code>ActorRef</code> destination and a message to send to that destination</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GUIDTask.UnregisterPlayer</code></p></span><span class="cmt"><p><code>LoadZoneCommonTransferActivity</code></p></span><span class="cmt"><p><code>Vehicles.AllGatedOccupantsInSameZone</code></p></span><span class="cmt"><p><code>PlayerLoaded</code></p></span><span class="cmt"><p><code>TaskBeforeZoneChange</code></p></span><span class="cmt"><p><code>UnaccessContainer</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LoadZonePhysicalSpawnPoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadZonePhysicalSpawnPoint(zoneId:String,pos:net.psforever.types.Vector3,ori:net.psforever.types.Vector3,respawnTime:scala.concurrent.duration.FiniteDuration):Unit"></a><a id="LoadZonePhysicalSpawnPoint(String,Vector3,Vector3,FiniteDuration):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LoadZonePhysicalSpawnPoint(zoneId:String,pos:net.psforever.types.Vector3,ori:net.psforever.types.Vector3,respawnTime:scala.concurrent.duration.FiniteDuration):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">LoadZonePhysicalSpawnPoint</span><span class="params">(<span name="zoneId">zoneId: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="ori">ori: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="respawnTime">respawnTime: <span name="scala.concurrent.duration.FiniteDuration" class="extype">FiniteDuration</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The starting point of behavior for a player who:
|
|
is dead and is respawning;
|
|
is deconstructing at a spawn tube and is respawning;
|
|
is using a warp gate; or,
|
|
any or none of the previous conditions, but the final result involves changing what zone the player occupies.</p><div class="fullcomment"><div class="comment cmt"><p>The starting point of behavior for a player who:
|
|
is dead and is respawning;
|
|
is deconstructing at a spawn tube and is respawning;
|
|
is using a warp gate; or,
|
|
any or none of the previous conditions, but the final result involves changing what zone the player occupies.
|
|
This route is not taken when first spawning in the game world, unless special conditions need to be satisfied.
|
|
The visible result will be apparent by the respawn timer being displayed to the client over the deployment map.<br>
|
|
<br>
|
|
Two choices must be independently made to complete this part of the process.
|
|
The first choice ivolves the state of the player who is spawning
|
|
as the known entry state involve either being alive or being dead.
|
|
A dead player (technically, a "corpse" that can no longer be revived) is embodied
|
|
in a completely new player with a new globally unique identifier and a whole new inventory.
|
|
A player who is transferring continents also satisfies the requirements
|
|
for obtaining a completely new globally unique identifier,
|
|
though the new identifier belongs to the new zone rather than the previous (still current) one.
|
|
The second choice is satisfied by respawning in the same zone while still in a state of still being alive.
|
|
In this singular case, the player retains his previous globally unique identifier.
|
|
In all other cases, as indicated, a new globally unique identifier is selected.<br>
|
|
<br>
|
|
If the player is alive and mounted in a vehicle, a different can of worms is produced.
|
|
The ramifications of these conditions are not fully satisfied until the player loads into the new zone.
|
|
Even then, the conclusion becomes delayed while a slightly lagged mechanism hoists players between zones.
|
|
</p></div><dl class="paramcmts block"><dt class="param">zoneId</dt><dd class="cmt"><p>the zone in which the player will be placed</p></dd><dt class="param">pos</dt><dd class="cmt"><p>the game world coordinates where the player will be positioned</p></dd><dt class="param">ori</dt><dd class="cmt"><p>the direction in which the player will be oriented</p></dd><dt class="param">respawnTime</dt><dd class="cmt"><p>the character downtime spent respawning, as clocked on the redeployment screen;
|
|
does not factor in any time required for loading zone or game objects</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#LoadZoneTransferPassengerMessages" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LoadZoneTransferPassengerMessages(player_guid:net.psforever.types.PlanetSideGUID,toZoneId:String,vehicle:net.psforever.objects.Vehicle):Unit"></a><a id="LoadZoneTransferPassengerMessages(PlanetSideGUID,String,Vehicle):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#LoadZoneTransferPassengerMessages(player_guid:net.psforever.types.PlanetSideGUID,toZoneId:String,vehicle:net.psforever.objects.Vehicle):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">LoadZoneTransferPassengerMessages</span><span class="params">(<span name="player_guid">player_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="toZoneId">toZoneId: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Dispatch messages to all target players in immediate passenger and gunner seats
|
|
and to the driver of all vehicles in cargo holds
|
|
that their current ferrying vehicle is being transported from one zone to the next
|
|
and that they should follow after it.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch messages to all target players in immediate passenger and gunner seats
|
|
and to the driver of all vehicles in cargo holds
|
|
that their current ferrying vehicle is being transported from one zone to the next
|
|
and that they should follow after it.
|
|
The messages address the avatar of their recipient <code>WorldSessionActor</code> objects.</p></div><dl class="paramcmts block"><dt class="param">player_guid</dt><dd class="cmt"><p>the driver of the target vehicle</p></dd><dt class="param">toZoneId</dt><dd class="cmt"><p>the zone where the target vehicle will be moved</p></dd><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle (object)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#MountingAction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MountingAction(tplayer:net.psforever.objects.Player,obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.mount.Mountable,seatNum:Int):Unit"></a><a id="MountingAction(Player,PlanetSideGameObjectwithMountable,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#MountingAction(tplayer:net.psforever.objects.Player,obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.mount.Mountable,seatNum:Int):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">MountingAction</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="obj">obj: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/serverobject/mount/Mountable.html" name="net.psforever.objects.serverobject.mount.Mountable" id="net.psforever.objects.serverobject.mount.Mountable" class="extype">Mountable</a></span>, <span name="seatNum">seatNum: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common activities/procedure when a player mounts a valid object.</p><div class="fullcomment"><div class="comment cmt"><p>Common activities/procedure when a player mounts a valid object.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd><dt class="param">obj</dt><dd class="cmt"><p>the mountable object</p></dd><dt class="param">seatNum</dt><dd class="cmt"><p>the seat into which the player is mounting</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#NewItemDrop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NewItemDrop(obj:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,zone:net.psforever.objects.zones.Zone)(item:net.psforever.objects.equipment.Equipment):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="NewItemDrop(PlanetSideServerObjectwithContainer,Zone)(Equipment):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#NewItemDrop(obj:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,zone:net.psforever.objects.zones.Zone)(item:net.psforever.objects.equipment.Equipment):net.psforever.objects.guid.TaskResolver.GiveTask" 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">NewItemDrop</span><span class="params">(<span name="obj">obj: <a href="../../objects/serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>, <span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>)</span><span class="params">(<span name="item">item: <a href="../../objects/equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span><p class="shortcomment cmt">Register an <code>Equipment</code> item and then drop it on the ground.</p><div class="fullcomment"><div class="comment cmt"><p>Register an <code>Equipment</code> item and then drop it on the ground.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>a <code>Container</code> object that represents where the item will be dropped;
|
|
curried for callback</p></dd><dt class="param">zone</dt><dd class="cmt"><p>the continent in which the item is being dropped;
|
|
curried for callback</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>NormalItemDrop</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#NextConstructionItemFireMode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NextConstructionItemFireMode(obj:net.psforever.objects.ConstructionItem,originalModeIndex:Int):net.psforever.objects.definition.ConstructionFireMode"></a><a id="NextConstructionItemFireMode(ConstructionItem,Int):ConstructionFireMode"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#NextConstructionItemFireMode(obj:net.psforever.objects.ConstructionItem,originalModeIndex:Int):net.psforever.objects.definition.ConstructionFireMode" 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">NextConstructionItemFireMode</span><span class="params">(<span name="obj">obj: <a href="../../objects/ConstructionItem.html" name="net.psforever.objects.ConstructionItem" id="net.psforever.objects.ConstructionItem" class="extype">ConstructionItem</a></span>, <span name="originalModeIndex">originalModeIndex: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <a href="../../objects/definition/ConstructionFireMode.html" name="net.psforever.objects.definition.ConstructionFireMode" id="net.psforever.objects.definition.ConstructionFireMode" class="extype">ConstructionFireMode</a></span></span><p class="shortcomment cmt">The custom behavior responding to the message <code>ChangeFireModeMessage</code> for <code>ConstructionItem</code> game objects.</p><div class="fullcomment"><div class="comment cmt"><p>The custom behavior responding to the message <code>ChangeFireModeMessage</code> for <code>ConstructionItem</code> game objects.
|
|
Each fire mode has sub-modes corresponding to a type of "deployable" as ammunition
|
|
and each of these sub-modes have certification requirements that must be met before they can be used.
|
|
Additional effort is exerted to ensure that the requirements for the given mode and given sub-mode are satisfied.
|
|
If no satisfactory combination is achieved, the original state will be restored.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>ConstructionItem</code> object</p></dd><dt class="param">originalModeIndex</dt><dd class="cmt"><p>the starting point fire mode index</p></dd><dt>returns</dt><dd class="cmt"><p>the changed fire mode</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>FireModeSwitch.NextFireMode</code></p></span><span class="cmt"><p><code>PerformConstructionItemAmmoChange</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#NoPersistence" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="NoPersistence():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#NoPersistence():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">NoPersistence</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Do not update this player avatar for persistence.</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#NoSquadUpdates" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="NoSquadUpdates():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#NoSquadUpdates():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">NoSquadUpdates</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#NormalItemDrop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NormalItemDrop(obj:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,zone:net.psforever.objects.zones.Zone)(item:net.psforever.objects.equipment.Equipment):Unit"></a><a id="NormalItemDrop(PlanetSideServerObjectwithContainer,Zone)(Equipment):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#NormalItemDrop(obj:net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.inventory.Container,zone:net.psforever.objects.zones.Zone)(item:net.psforever.objects.equipment.Equipment):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">NormalItemDrop</span><span class="params">(<span name="obj">obj: <a href="../../objects/serverobject/PlanetSideServerObject.html" name="net.psforever.objects.serverobject.PlanetSideServerObject" id="net.psforever.objects.serverobject.PlanetSideServerObject" class="extype">PlanetSideServerObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>, <span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>)</span><span class="params">(<span name="item">item: <a href="../../objects/equipment/Equipment.html" name="net.psforever.objects.equipment.Equipment" id="net.psforever.objects.equipment.Equipment" class="extype">Equipment</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Drop an <code>Equipment</code> item onto the ground.</p><div class="fullcomment"><div class="comment cmt"><p>Drop an <code>Equipment</code> item onto the ground.
|
|
Specifically, instruct the item where it will appear,
|
|
add it to the list of items that are visible to multiple users,
|
|
and then inform others that the item has been dropped.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>a <code>Container</code> object that represents where the item will be dropped;
|
|
curried for callback</p></dd><dt class="param">zone</dt><dd class="cmt"><p>the continent in which the item is being dropped;
|
|
curried for callback</p></dd><dt class="param">item</dt><dd class="cmt"><p>the item</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#NormalKeepAlive" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NormalKeepAlive():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#NormalKeepAlive():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">NormalKeepAlive</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The normal response to receiving a <code>KeepAliveMessage</code> packet from the client.<br>
|
|
<br>
|
|
Even though receiving a <code>KeepAliveMessage</code> outside of zoning is uncommon,
|
|
the behavior should be configured to maintain a neutral action.</p><div class="fullcomment"><div class="comment cmt"><p>The normal response to receiving a <code>KeepAliveMessage</code> packet from the client.<br>
|
|
<br>
|
|
Even though receiving a <code>KeepAliveMessage</code> outside of zoning is uncommon,
|
|
the behavior should be configured to maintain a neutral action.
|
|
</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>KeepAliveMessage</code></p></span><span class="cmt"><p><code>keepAliveFunc</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#NormalTurnCounter" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NormalTurnCounter(p:net.psforever.types.PlanetSideGUID):Unit"></a><a id="NormalTurnCounter(PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#NormalTurnCounter(p:net.psforever.types.PlanetSideGUID):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">NormalTurnCounter</span><span class="params">(<span name="p">p: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The upstream counter accumulates when the server receives specific messages from the client.</p><div class="fullcomment"><div class="comment cmt"><p>The upstream counter accumulates when the server receives specific messages from the client.
|
|
It counts upwards until it reach maximum value, and then starts over.
|
|
When it starts over, which should take an exceptionally long time to achieve,
|
|
it starts counting at one rather than zero.</p></div><dl class="paramcmts block"><dt class="param">p</dt><dd class="cmt"><p>the player's globally unique identifier number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#PerformConstructionItemAmmoChange" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PerformConstructionItemAmmoChange(obj:net.psforever.objects.ConstructionItem,originalAmmoIndex:Int):Unit"></a><a id="PerformConstructionItemAmmoChange(ConstructionItem,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#PerformConstructionItemAmmoChange(obj:net.psforever.objects.ConstructionItem,originalAmmoIndex:Int):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">PerformConstructionItemAmmoChange</span><span class="params">(<span name="obj">obj: <a href="../../objects/ConstructionItem.html" name="net.psforever.objects.ConstructionItem" id="net.psforever.objects.ConstructionItem" class="extype">ConstructionItem</a></span>, <span name="originalAmmoIndex">originalAmmoIndex: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The custom behavior responding to the message <code>ChangeAmmoMessage</code> for <code>ConstructionItem</code> game objects.</p><div class="fullcomment"><div class="comment cmt"><p>The custom behavior responding to the message <code>ChangeAmmoMessage</code> for <code>ConstructionItem</code> game objects.
|
|
Iterate through sub-modes corresponding to a type of "deployable" as ammunition for this fire mode
|
|
and check each of these sub-modes for their certification requirements to be met before they can be used.
|
|
Additional effort is exerted to ensure that the requirements for the given ammunition are satisfied.
|
|
If no satisfactory combination is achieved, the original state will be restored.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>ConstructionItem</code> object</p></dd><dt class="param">originalAmmoIndex</dt><dd class="cmt"><p>the starting point ammunition type mode index</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#PerformToolAmmoChange" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PerformToolAmmoChange(tool:net.psforever.objects.Tool,obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container):Unit"></a><a id="PerformToolAmmoChange(Tool,PlanetSideGameObjectwithContainer):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#PerformToolAmmoChange(tool:net.psforever.objects.Tool,obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container):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">PerformToolAmmoChange</span><span class="params">(<span name="tool">tool: <a href="../../objects/Tool.html" name="net.psforever.objects.Tool" id="net.psforever.objects.Tool" class="extype">Tool</a></span>, <span name="obj">obj: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">tool</dt><dd class="cmt"><p>na</p></dd><dt class="param">obj</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#PeriodicUpdatesWhenEnrolledInSquad" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PeriodicUpdatesWhenEnrolledInSquad():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#PeriodicUpdatesWhenEnrolledInSquad():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">PeriodicUpdatesWhenEnrolledInSquad</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#PlayerActionsToCancel" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PlayerActionsToCancel():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#PlayerActionsToCancel():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">PlayerActionsToCancel</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">An event has occurred that would cause the player character to stop certain stateful activities.</p><div class="fullcomment"><div class="comment cmt"><p>An event has occurred that would cause the player character to stop certain stateful activities.
|
|
These activities include shooting, the weapon being drawn, hacking, accessing (a container), flying, and running.
|
|
Other players in the same zone must be made aware that the player has stopped as well.<br>
|
|
<br>
|
|
Things whose configuration should not be changed:<br>
|
|
- if the player is seated<br>
|
|
- if the player is anchored<br>
|
|
This is not a complete list but, for the purpose of enforcement, some pointers will be documented here.
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#PrepareToTurnPlayerIntoCorpse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PrepareToTurnPlayerIntoCorpse(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone):Unit"></a><a id="PrepareToTurnPlayerIntoCorpse(Player,Zone):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#PrepareToTurnPlayerIntoCorpse(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone):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">PrepareToTurnPlayerIntoCorpse</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Creates a player that has the characteristics of a corpse
|
|
so long as the player has items in their knapsack or their holsters.</p><div class="fullcomment"><div class="comment cmt"><p>Creates a player that has the characteristics of a corpse
|
|
so long as the player has items in their knapsack or their holsters.
|
|
If the player has no items stored, the clean solution is to remove the player from the game.
|
|
To the game, that is a backpack (or some pastry, festive graphical modification allowing).</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AvatarAction.ObjectDelete</code></p></span><span class="cmt"><p><code>AvatarAction.Release</code></p></span><span class="cmt"><p><code>AvatarServiceMessage</code></p></span><span class="cmt"><p><code>FriskDeadBody</code></p></span><span class="cmt"><p><code>GUIDTask.UnregisterPlayer</code></p></span><span class="cmt"><p><code>ObjectDeleteMessage</code></p></span><span class="cmt"><p><code>WellLootedDeadBody</code></p></span><span class="cmt"><p><code>Zone.Corpse.Add</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RedrawDeployableIcons" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RedrawDeployableIcons(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable):Unit"></a><a id="RedrawDeployableIcons(PlanetSideGameObjectwithDeployable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RedrawDeployableIcons(obj:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable):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">RedrawDeployableIcons</span><span class="params">(<span name="obj">obj: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/Deployable.html" name="net.psforever.objects.ce.Deployable" id="net.psforever.objects.ce.Deployable" class="extype">Deployable</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Draw the icon for this deployable object.<br>
|
|
<br>
|
|
When a client first joins a zone, all deployables are drawn on the continent map once.</p><div class="fullcomment"><div class="comment cmt"><p>Draw the icon for this deployable object.<br>
|
|
<br>
|
|
When a client first joins a zone, all deployables are drawn on the continent map once.
|
|
Should the player place any deployables, those deployables belong to that player.
|
|
Ownership causes icon to be drawn in yellow to the player (as opposed to a white icon)
|
|
and that signifies a certain level of control over the deployable, at least the ability to quietly deconstruct it.
|
|
Under normal death/respawn cycles while the player is in a given zone,
|
|
the map icons for owned deployables ramin manipulable to that given user.
|
|
They do not havwe to be redrawn to stay accurate.
|
|
Upon leaving a zone, where the icons are erased, and returning back to the zone, where they are drawn again,
|
|
the deployables that a player owned should be restored in terms of their map icon visibility.
|
|
This control can not be recovered, however, until they are updated with the player's globally unique identifier.
|
|
Since the player does not need to redraw his own deployable icons each time he respawns,
|
|
but will not possess a valid GUID for that zone until he spawns in it at least once,
|
|
this function is swapped with another after the first spawn in any given zone.
|
|
This function is restored upon transferring zones.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>a <code>Deployable</code> object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>DontRedrawIcons</code></p></span><span class="cmt"><p><code>SetCurrentAvatar</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RegisterDrivenVehicle" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="RegisterDrivenVehicle(obj:net.psforever.objects.Vehicle,driver:net.psforever.objects.Player):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="RegisterDrivenVehicle(Vehicle,Player):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RegisterDrivenVehicle(obj:net.psforever.objects.Vehicle,driver:net.psforever.objects.Player):net.psforever.objects.guid.TaskResolver.GiveTask" 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">RegisterDrivenVehicle</span><span class="params">(<span name="obj">obj: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="driver">driver: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RegisterDroppod" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RegisterDroppod(vehicle:net.psforever.objects.Vehicle,tplayer:net.psforever.objects.Player):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="RegisterDroppod(Vehicle,Player):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RegisterDroppod(vehicle:net.psforever.objects.Vehicle,tplayer:net.psforever.objects.Player):net.psforever.objects.guid.TaskResolver.GiveTask" 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">RegisterDroppod</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span><p class="shortcomment cmt">Use this function to facilitate registering a droppod for a globally unique identifier
|
|
in the event that the user has instigated an instant action event to a destination within the current zone.<br>
|
|
<br>
|
|
If going to another zone instead,
|
|
this is uneccessary as the normal vehicle gating protocol is partially intersected for droppod operation,
|
|
and will properly register the droppod before introducing it into the new zone without additional concern.</p><div class="fullcomment"><div class="comment cmt"><p>Use this function to facilitate registering a droppod for a globally unique identifier
|
|
in the event that the user has instigated an instant action event to a destination within the current zone.<br>
|
|
<br>
|
|
If going to another zone instead,
|
|
this is uneccessary as the normal vehicle gating protocol is partially intersected for droppod operation,
|
|
and will properly register the droppod before introducing it into the new zone without additional concern.
|
|
The droppod should actually not be completely unregistered.
|
|
If inquired, it will act like a GUID had already been assigned to it, but it was invalidated.
|
|
This condition is artificial, but it necessary to pass certain operations related to vehicle gating.
|
|
Additionally, the driver is only partially associated with the vehicle at this time.
|
|
<code>interstellarFerry</code> is properly keeping track of the vehicle during the transition
|
|
and the user who is the driver (second param) is properly seated
|
|
but the said driver does not know about the vehicle through his usual convention - <code>VehicleSeated</code> - yet.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the unregistered droppod</p></dd><dt class="param">tplayer</dt><dd class="cmt"><p>the player using the droppod for instant action;
|
|
should already be the driver of the droppod</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>TaskResolver.GiveTask</code> message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>GlobalDefinitions.droppod</code></p></span><span class="cmt"><p><code>GUIDTask.RegisterObjectTask</code></p></span><span class="cmt"><p><code>interstellarFerry</code></p></span><span class="cmt"><p><code>Player.VehicleSeated</code></p></span><span class="cmt"><p><code>PlayerLoaded</code></p></span><span class="cmt"><p><code>TaskResolver.GiveTask</code></p></span><span class="cmt"><p><code>Vehicles.Own</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RegisterProjectile" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RegisterProjectile(obj:net.psforever.objects.ballistics.Projectile):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="RegisterProjectile(Projectile):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RegisterProjectile(obj:net.psforever.objects.ballistics.Projectile):net.psforever.objects.guid.TaskResolver.GiveTask" 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">RegisterProjectile</span><span class="params">(<span name="obj">obj: <a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span><p class="shortcomment cmt">Construct tasking that adds a completed but unregistered projectile into the scene.</p><div class="fullcomment"><div class="comment cmt"><p>Construct tasking that adds a completed but unregistered projectile into the scene.
|
|
After the projectile is registered to the curent zone's global unique identifier system,
|
|
all connected clients save for the one that registered it will be informed about the projectile's "creation."</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the projectile to be registered</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>TaskResolver.GiveTask</code> message</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RegisterVehicle" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RegisterVehicle(vehicle:net.psforever.objects.Vehicle):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="RegisterVehicle(Vehicle):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RegisterVehicle(vehicle:net.psforever.objects.Vehicle):net.psforever.objects.guid.TaskResolver.GiveTask" 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">RegisterVehicle</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span><p class="shortcomment cmt">Construct tasking that adds a completed and registered vehicle into the scene.</p><div class="fullcomment"><div class="comment cmt"><p>Construct tasking that adds a completed and registered vehicle into the scene.
|
|
Use this function to renew the globally unique identifiers on a vehicle that has already been added to the scene once.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the <code>Vehicle</code> object</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>TaskResolver.GiveTask</code> message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RegisterVehicleFromSpawnPad</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RegisterVehicleFromSpawnPad" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RegisterVehicleFromSpawnPad(obj:net.psforever.objects.Vehicle,pad:net.psforever.objects.serverobject.pad.VehicleSpawnPad):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="RegisterVehicleFromSpawnPad(Vehicle,VehicleSpawnPad):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RegisterVehicleFromSpawnPad(obj:net.psforever.objects.Vehicle,pad:net.psforever.objects.serverobject.pad.VehicleSpawnPad):net.psforever.objects.guid.TaskResolver.GiveTask" 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">RegisterVehicleFromSpawnPad</span><span class="params">(<span name="obj">obj: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="pad">pad: <a href="../../objects/serverobject/pad/VehicleSpawnPad.html" name="net.psforever.objects.serverobject.pad.VehicleSpawnPad" id="net.psforever.objects.serverobject.pad.VehicleSpawnPad" class="extype">VehicleSpawnPad</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span><p class="shortcomment cmt">Construct tasking that adds a completed and registered vehicle into the scene.</p><div class="fullcomment"><div class="comment cmt"><p>Construct tasking that adds a completed and registered vehicle into the scene.
|
|
The major difference between <code>RegisterVehicle</code> and <code>RegisterVehicleFromSpawnPad</code> is the assumption that this vehicle lacks an internal <code>Actor</code>.
|
|
Before being finished, that vehicle is supplied an <code>Actor</code> such that it may function properly.
|
|
This function wraps around <code>RegisterVehicle</code> and is used in case, prior to this event,
|
|
the vehicle is being brought into existence from scratch and was never a member of any <code>Zone</code>.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the <code>Vehicle</code> object</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>TaskResolver.GiveTask</code> message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RegisterVehicle</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RemoveBoomerTriggersFromInventory" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemoveBoomerTriggersFromInventory():List[net.psforever.objects.BoomerTrigger]"></a><a id="RemoveBoomerTriggersFromInventory():List[BoomerTrigger]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RemoveBoomerTriggersFromInventory():List[net.psforever.objects.BoomerTrigger]" 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">RemoveBoomerTriggersFromInventory</span><span class="params">()</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../objects/BoomerTrigger.html" name="net.psforever.objects.BoomerTrigger" id="net.psforever.objects.BoomerTrigger" class="extype">BoomerTrigger</a>]</span></span><p class="shortcomment cmt">Search through the player's holsters and their inventory space
|
|
and remove all <code>BoomerTrigger</code> objects, both functionally and visually.</p><div class="fullcomment"><div class="comment cmt"><p>Search through the player's holsters and their inventory space
|
|
and remove all <code>BoomerTrigger</code> objects, both functionally and visually.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>all discovered <code>BoomTrigger</code> objects</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RequestSanctuaryZoneSpawn" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RequestSanctuaryZoneSpawn(tplayer:net.psforever.objects.Player,currentZone:Int):Unit"></a><a id="RequestSanctuaryZoneSpawn(Player,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RequestSanctuaryZoneSpawn(tplayer:net.psforever.objects.Player,currentZone:Int):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">RequestSanctuaryZoneSpawn</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="currentZone">currentZone: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Attempt to tranfer to the player's faction-specific sanctuary continent.</p><div class="fullcomment"><div class="comment cmt"><p>Attempt to tranfer to the player's faction-specific sanctuary continent.
|
|
If the server thinks the player is already on his sanctuary continent, and dead,
|
|
it will disconnect the player under the assumption that an error has occurred.
|
|
Eventually, this functionality should support better error-handling before it jumps to the conclusion:
|
|
"Disconnecting the client is the safest option."</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd><dt class="param">currentZone</dt><dd class="cmt"><p>the current zone number</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Zones.SanctuaryZoneNumber</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ReregisterProjectile" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ReregisterProjectile(obj:net.psforever.objects.ballistics.Projectile):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="ReregisterProjectile(Projectile):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ReregisterProjectile(obj:net.psforever.objects.ballistics.Projectile):net.psforever.objects.guid.TaskResolver.GiveTask" 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">ReregisterProjectile</span><span class="params">(<span name="obj">obj: <a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span><p class="shortcomment cmt">If the projectile object is unregistered, register it.</p><div class="fullcomment"><div class="comment cmt"><p>If the projectile object is unregistered, register it.
|
|
If the projectile object is already registered, unregister it and then register it again.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the projectile to be registered (a second time?)</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>TaskResolver.GiveTask</code> message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>RegisterProjectile(Projectile)</code></p></span><span class="cmt"><p><code>UnregisterProjectile(Projectile)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ResolveProjectileEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ResolveProjectileEntry(projectile:net.psforever.objects.ballistics.Projectile,resolution:net.psforever.objects.ballistics.ProjectileResolution.Value,target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinitywithnet.psforever.objects.vital.Vitality,pos:net.psforever.types.Vector3):Option[net.psforever.objects.ballistics.ResolvedProjectile]"></a><a id="ResolveProjectileEntry(Projectile,objects.ballistics.ProjectileResolution.Value,PlanetSideGameObjectwithFactionAffinitywithVitality,Vector3):Option[ResolvedProjectile]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ResolveProjectileEntry(projectile:net.psforever.objects.ballistics.Projectile,resolution:net.psforever.objects.ballistics.ProjectileResolution.Value,target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinitywithnet.psforever.objects.vital.Vitality,pos:net.psforever.types.Vector3):Option[net.psforever.objects.ballistics.ResolvedProjectile]" 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">ResolveProjectileEntry</span><span class="params">(<span name="projectile">projectile: <a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a></span>, <span name="resolution">resolution: <a href="../../objects/ballistics/ProjectileResolution$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.ballistics.ProjectileResolution.Value" id="net.psforever.objects.ballistics.ProjectileResolution.Value" class="extmbr">objects.ballistics.ProjectileResolution.Value</a></span>, <span name="target">target: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a> with <a href="../../objects/vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/ballistics/ResolvedProjectile.html" name="net.psforever.objects.ballistics.ResolvedProjectile" id="net.psforever.objects.ballistics.ResolvedProjectile" class="extype">ResolvedProjectile</a>]</span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">projectile</dt><dd class="cmt"><p>the projectile object</p></dd><dt class="param">resolution</dt><dd class="cmt"><p>the resolution status to promote the projectile</p></dd><dt>returns</dt><dd class="cmt"><p>a copy of the projectile</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ResolveProjectileEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ResolveProjectileEntry(projectile:net.psforever.objects.ballistics.Projectile,index:Int,resolution:net.psforever.objects.ballistics.ProjectileResolution.Value,target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinitywithnet.psforever.objects.vital.Vitality,pos:net.psforever.types.Vector3):Option[net.psforever.objects.ballistics.ResolvedProjectile]"></a><a id="ResolveProjectileEntry(Projectile,Int,objects.ballistics.ProjectileResolution.Value,PlanetSideGameObjectwithFactionAffinitywithVitality,Vector3):Option[ResolvedProjectile]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ResolveProjectileEntry(projectile:net.psforever.objects.ballistics.Projectile,index:Int,resolution:net.psforever.objects.ballistics.ProjectileResolution.Value,target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinitywithnet.psforever.objects.vital.Vitality,pos:net.psforever.types.Vector3):Option[net.psforever.objects.ballistics.ResolvedProjectile]" 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">ResolveProjectileEntry</span><span class="params">(<span name="projectile">projectile: <a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a></span>, <span name="index">index: <span name="scala.Int" class="extype">Int</span></span>, <span name="resolution">resolution: <a href="../../objects/ballistics/ProjectileResolution$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.ballistics.ProjectileResolution.Value" id="net.psforever.objects.ballistics.ProjectileResolution.Value" class="extmbr">objects.ballistics.ProjectileResolution.Value</a></span>, <span name="target">target: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a> with <a href="../../objects/vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/ballistics/ResolvedProjectile.html" name="net.psforever.objects.ballistics.ResolvedProjectile" id="net.psforever.objects.ballistics.ResolvedProjectile" class="extype">ResolvedProjectile</a>]</span></span><p class="shortcomment cmt">Find a projectile with the given globally unique identifier and mark it as a resolved shot.</p><div class="fullcomment"><div class="comment cmt"><p>Find a projectile with the given globally unique identifier and mark it as a resolved shot.</p></div><dl class="paramcmts block"><dt class="param">projectile</dt><dd class="cmt"><p>the projectile object</p></dd><dt class="param">index</dt><dd class="cmt"><p>where the projectile was found</p></dd><dt class="param">resolution</dt><dd class="cmt"><p>the resolution status to promote the projectile</p></dd><dt>returns</dt><dd class="cmt"><p>a copy of the projectile</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ResolveProjectileEntry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ResolveProjectileEntry(projectile_guid:net.psforever.types.PlanetSideGUID,resolution:net.psforever.objects.ballistics.ProjectileResolution.Value,target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinitywithnet.psforever.objects.vital.Vitality,pos:net.psforever.types.Vector3):Option[net.psforever.objects.ballistics.ResolvedProjectile]"></a><a id="ResolveProjectileEntry(PlanetSideGUID,objects.ballistics.ProjectileResolution.Value,PlanetSideGameObjectwithFactionAffinitywithVitality,Vector3):Option[ResolvedProjectile]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ResolveProjectileEntry(projectile_guid:net.psforever.types.PlanetSideGUID,resolution:net.psforever.objects.ballistics.ProjectileResolution.Value,target:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.serverobject.affinity.FactionAffinitywithnet.psforever.objects.vital.Vitality,pos:net.psforever.types.Vector3):Option[net.psforever.objects.ballistics.ResolvedProjectile]" 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">ResolveProjectileEntry</span><span class="params">(<span name="projectile_guid">projectile_guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="resolution">resolution: <a href="../../objects/ballistics/ProjectileResolution$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.ballistics.ProjectileResolution.Value" id="net.psforever.objects.ballistics.ProjectileResolution.Value" class="extmbr">objects.ballistics.ProjectileResolution.Value</a></span>, <span name="target">target: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/serverobject/affinity/FactionAffinity.html" name="net.psforever.objects.serverobject.affinity.FactionAffinity" id="net.psforever.objects.serverobject.affinity.FactionAffinity" class="extype">FactionAffinity</a> with <a href="../../objects/vital/Vitality.html" name="net.psforever.objects.vital.Vitality" id="net.psforever.objects.vital.Vitality" class="extype">Vitality</a></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/ballistics/ResolvedProjectile.html" name="net.psforever.objects.ballistics.ResolvedProjectile" id="net.psforever.objects.ballistics.ResolvedProjectile" class="extype">ResolvedProjectile</a>]</span></span><p class="shortcomment cmt">Find a projectile with the given globally unique identifier and mark it as a resolved shot.</p><div class="fullcomment"><div class="comment cmt"><p>Find a projectile with the given globally unique identifier and mark it as a resolved shot.
|
|
A <code>Resolved</code> shot has either encountered an obstacle or is being cleaned up for not finding an obstacle.</p></div><dl class="paramcmts block"><dt class="param">projectile_guid</dt><dd class="cmt"><p>the projectile GUID</p></dd><dt class="param">resolution</dt><dd class="cmt"><p>the resolution status to promote the projectile</p></dd><dt>returns</dt><dd class="cmt"><p>the projectile</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RespawnClone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RespawnClone(tplayer:net.psforever.objects.Player):net.psforever.objects.Player"></a><a id="RespawnClone(Player):Player"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RespawnClone(tplayer:net.psforever.objects.Player):net.psforever.objects.Player" 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">RespawnClone</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span></span><p class="shortcomment cmt">Produce a clone of the player that is equipped with the default infantry loadout.</p><div class="fullcomment"><div class="comment cmt"><p>Produce a clone of the player that is equipped with the default infantry loadout.
|
|
The loadout is hardcoded.
|
|
The player is expected to be in a Standard Exo-Suit.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the original player</p></dd><dt>returns</dt><dd class="cmt"><p>the duplication of the player, in Standard Exo-Suit and with default equipment loadout</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#RespawnSquadSetup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RespawnSquadSetup():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#RespawnSquadSetup():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">RespawnSquadSetup</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">These messages are used during each subsequent respawn to reset the squad colors on player nameplates and marquees.</p><div class="fullcomment"><div class="comment cmt"><p>These messages are used during each subsequent respawn to reset the squad colors on player nameplates and marquees.
|
|
By using <code>squadUI</code> to maintain relevant information about squad members,
|
|
especially the unique character identifier number,
|
|
only the zone-specific squad members will receive the important messages about their squad member's spawn.
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#SafelyRemoveConstructionItemFromSlot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SafelyRemoveConstructionItemFromSlot(tool:net.psforever.objects.ConstructionItem,index:Int,logDecorator:String):Boolean"></a><a id="SafelyRemoveConstructionItemFromSlot(ConstructionItem,Int,String):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#SafelyRemoveConstructionItemFromSlot(tool:net.psforever.objects.ConstructionItem,index:Int,logDecorator:String):Boolean" 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">SafelyRemoveConstructionItemFromSlot</span><span class="params">(<span name="tool">tool: <a href="../../objects/ConstructionItem.html" name="net.psforever.objects.ConstructionItem" id="net.psforever.objects.ConstructionItem" class="extype">ConstructionItem</a></span>, <span name="index">index: <span name="scala.Int" class="extype">Int</span></span>, <span name="logDecorator">logDecorator: <span name="scala.Predef.String" class="extype">String</span> = <span class="defval">"SafelyRemoveConstructionItemFromSlot"</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Find the target <code>ConstructionTool</code> object, either at the suggested slot or wherever it is on the <code>player</code>,
|
|
and remove it from the game world visually.<br>
|
|
<br>
|
|
Not finding the target object at its intended slot is an entirely recoverable situation
|
|
as long as the target object is discovered to be somewhere else in the player's holsters or inventory space.</p><div class="fullcomment"><div class="comment cmt"><p>Find the target <code>ConstructionTool</code> object, either at the suggested slot or wherever it is on the <code>player</code>,
|
|
and remove it from the game world visually.<br>
|
|
<br>
|
|
Not finding the target object at its intended slot is an entirely recoverable situation
|
|
as long as the target object is discovered to be somewhere else in the player's holsters or inventory space.
|
|
If found after a more thorough search, merely log the discrepancy as a warning.
|
|
If the discrepancy becomes common, the developer messed up the function call
|
|
or he should not be using this function.</p></div><dl class="paramcmts block"><dt class="param">tool</dt><dd class="cmt"><p>the <code>ConstructionItem</code> object currently in the slot (checked)</p></dd><dt class="param">index</dt><dd class="cmt"><p>the slot index</p></dd><dt class="param">logDecorator</dt><dd class="cmt"><p>what kind of designation to give any log entires originating from this function;
|
|
defaults to its own function name</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the target object was found and removed;
|
|
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#SelectProximityUnitBehavior" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SelectProximityUnitBehavior(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit,target:net.psforever.objects.PlanetSideGameObject):Unit"></a><a id="SelectProximityUnitBehavior(TerminalwithProximityUnit,PlanetSideGameObject):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#SelectProximityUnitBehavior(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit,target:net.psforever.objects.PlanetSideGameObject):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">SelectProximityUnitBehavior</span><span class="params">(<span name="terminal">terminal: <a href="../../objects/serverobject/terminals/Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a> with <a href="../../objects/serverobject/terminals/ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></span>, <span name="target">target: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Determine which functionality to pursue by a generic proximity-functional unit given the target for its activity.</p><div class="fullcomment"><div class="comment cmt"><p>Determine which functionality to pursue by a generic proximity-functional unit given the target for its activity.</p></div><dl class="paramcmts block"><dt class="param">terminal</dt><dd class="cmt"><p>the proximity-based unit</p></dd><dt class="param">target</dt><dd class="cmt"><p>the object being affected by the unit</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>VehicleService:receive, ProximityUnit.Action</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ServerVehicleLock" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ServerVehicleLock(vehicle:net.psforever.objects.Vehicle):Unit"></a><a id="ServerVehicleLock(Vehicle):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ServerVehicleLock(vehicle:net.psforever.objects.Vehicle):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">ServerVehicleLock</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Lock all applicable controls of the current vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Lock all applicable controls of the current vehicle.
|
|
This includes forward motion, turning, and, if applicable, strafing.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle being controlled</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ServerVehicleLockReverse" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ServerVehicleLockReverse():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ServerVehicleLockReverse():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">ServerVehicleLockReverse</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">This function is applied to vehicles that are leaving a cargo vehicle's cargo hold to auto reverse them out
|
|
Lock all applicable controls of the current vehicle
|
|
Set the vehicle to move in reverse
|
|
</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ServerVehicleLockStrafeLeft" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ServerVehicleLockStrafeLeft():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ServerVehicleLockStrafeLeft():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">ServerVehicleLockStrafeLeft</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">This function is applied to vehicles that are leaving a cargo vehicle's cargo hold to strafe left out of the cargo hold for vehicles that are mounted sideways e.g.</p><div class="fullcomment"><div class="comment cmt"><p>This function is applied to vehicles that are leaving a cargo vehicle's cargo hold to strafe left out of the cargo hold for vehicles that are mounted sideways e.g. router/BFR
|
|
Lock all applicable controls of the current vehicle
|
|
Set the vehicle to strafe left
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ServerVehicleLockStrafeRight" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ServerVehicleLockStrafeRight():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ServerVehicleLockStrafeRight():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">ServerVehicleLockStrafeRight</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">This function is applied to vehicles that are leaving a cargo vehicle's cargo hold to strafe right out of the cargo hold for vehicles that are mounted sideways e.g.</p><div class="fullcomment"><div class="comment cmt"><p>This function is applied to vehicles that are leaving a cargo vehicle's cargo hold to strafe right out of the cargo hold for vehicles that are mounted sideways e.g. router/BFR
|
|
Lock all applicable controls of the current vehicle
|
|
Set the vehicle to strafe right
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ServerVehicleOverride" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ServerVehicleOverride(vehicle:net.psforever.objects.Vehicle,speed:Int,flight:Int):Unit"></a><a id="ServerVehicleOverride(Vehicle,Int,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ServerVehicleOverride(vehicle:net.psforever.objects.Vehicle,speed:Int,flight:Int):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">ServerVehicleOverride</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="speed">speed: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">0</span></span>, <span name="flight">flight: <span name="scala.Int" class="extype">Int</span> = <span class="symbol">0</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Place the current vehicle under the control of the server's commands.</p><div class="fullcomment"><div class="comment cmt"><p>Place the current vehicle under the control of the server's commands.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle</p></dd><dt class="param">speed</dt><dd class="cmt"><p>how fast the vehicle is moving forward</p></dd><dt class="param">flight</dt><dd class="cmt"><p>whether the vehicle is ascending or not, if the vehicle is an applicable type</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#SetCurrentAvatarNormally" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SetCurrentAvatarNormally(tplayer:net.psforever.objects.Player):Unit"></a><a id="SetCurrentAvatarNormally(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#SetCurrentAvatarNormally(tplayer:net.psforever.objects.Player):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">SetCurrentAvatarNormally</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Instruct the client to treat this player as the avatar.</p><div class="fullcomment"><div class="comment cmt"><p>Instruct the client to treat this player as the avatar.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the target player</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SetCurrentAvatar</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#SquadMembersInZone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SquadMembersInZone(members:Iterable[Long]):Iterable[net.psforever.objects.Player]"></a><a id="SquadMembersInZone(Iterable[Long]):Iterable[Player]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#SquadMembersInZone(members:Iterable[Long]):Iterable[net.psforever.objects.Player]" 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">SquadMembersInZone</span><span class="params">(<span name="members">members: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Iterable" class="extype">Iterable</span>[<a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>]</span></span><p class="shortcomment cmt">For the listed squad member unique character identifier numbers,
|
|
find and return all squad members in the current zone.</p><div class="fullcomment"><div class="comment cmt"><p>For the listed squad member unique character identifier numbers,
|
|
find and return all squad members in the current zone.</p></div><dl class="paramcmts block"><dt class="param">members</dt><dd class="cmt"><p>members of the squad to target</p></dd><dt>returns</dt><dd class="cmt"><p>a list of <code>Player</code> objects</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#SquadUpdates" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SquadUpdates():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#SquadUpdates():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">SquadUpdates</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#StartUsingProximityUnit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartUsingProximityUnit(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit,target:net.psforever.objects.PlanetSideGameObject):Unit"></a><a id="StartUsingProximityUnit(TerminalwithProximityUnit,PlanetSideGameObject):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#StartUsingProximityUnit(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit,target:net.psforever.objects.PlanetSideGameObject):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">StartUsingProximityUnit</span><span class="params">(<span name="terminal">terminal: <a href="../../objects/serverobject/terminals/Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a> with <a href="../../objects/serverobject/terminals/ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></span>, <span name="target">target: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Queue a proximity-base service.</p><div class="fullcomment"><div class="comment cmt"><p>Queue a proximity-base service.</p></div><dl class="paramcmts block"><dt class="param">terminal</dt><dd class="cmt"><p>the proximity-based unit</p></dd><dt class="param">target</dt><dd class="cmt"><p>the entity that is being considered for terminal operation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#StopUsingProximityUnit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StopUsingProximityUnit(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit):Unit"></a><a id="StopUsingProximityUnit(TerminalwithProximityUnit):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#StopUsingProximityUnit(terminal:net.psforever.objects.serverobject.terminals.Terminalwithnet.psforever.objects.serverobject.terminals.ProximityUnit):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">StopUsingProximityUnit</span><span class="params">(<span name="terminal">terminal: <a href="../../objects/serverobject/terminals/Terminal.html" name="net.psforever.objects.serverobject.terminals.Terminal" id="net.psforever.objects.serverobject.terminals.Terminal" class="extype">Terminal</a> with <a href="../../objects/serverobject/terminals/ProximityUnit.html" name="net.psforever.objects.serverobject.terminals.ProximityUnit" id="net.psforever.objects.serverobject.terminals.ProximityUnit" class="extype">ProximityUnit</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Stop using a proximity-base service.</p><div class="fullcomment"><div class="comment cmt"><p>Stop using a proximity-base service.
|
|
Special note is warranted when determining the identity of the proximity terminal.
|
|
Medical terminals of both varieties can be cancelled by movement.
|
|
Other sorts of proximity-based units are put on a timer.</p></div><dl class="paramcmts block"><dt class="param">terminal</dt><dd class="cmt"><p>the proximity-based unit</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#SwapSquadUIElements" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SwapSquadUIElements(squad:net.psforever.objects.teamwork.Squad,fromIndex:Int,toIndex:Int):Unit"></a><a id="SwapSquadUIElements(Squad,Int,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#SwapSquadUIElements(squad:net.psforever.objects.teamwork.Squad,fromIndex:Int,toIndex:Int):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">SwapSquadUIElements</span><span class="params">(<span name="squad">squad: <a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a></span>, <span name="fromIndex">fromIndex: <span name="scala.Int" class="extype">Int</span></span>, <span name="toIndex">toIndex: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ToggleMaxSpecialState" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ToggleMaxSpecialState(enable:Boolean):Unit"></a><a id="ToggleMaxSpecialState(Boolean):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ToggleMaxSpecialState(enable:Boolean):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">ToggleMaxSpecialState</span><span class="params">(<span name="enable">enable: <span name="scala.Boolean" class="extype">Boolean</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ToggleTeleportSystem" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ToggleTeleportSystem(router:net.psforever.objects.Vehicle,systemPlan:Option[(net.psforever.objects.vehicles.Utility.InternalTelepad,net.psforever.objects.TelepadDeployable)]):Unit"></a><a id="ToggleTeleportSystem(Vehicle,Option[(InternalTelepad,TelepadDeployable)]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ToggleTeleportSystem(router:net.psforever.objects.Vehicle,systemPlan:Option[(net.psforever.objects.vehicles.Utility.InternalTelepad,net.psforever.objects.TelepadDeployable)]):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">ToggleTeleportSystem</span><span class="params">(<span name="router">router: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="systemPlan">systemPlan: <span name="scala.Option" class="extype">Option</span>[(<a href="../../objects/vehicles/Utility$$InternalTelepad.html" name="net.psforever.objects.vehicles.Utility.InternalTelepad" id="net.psforever.objects.vehicles.Utility.InternalTelepad" class="extype">InternalTelepad</a>, <a href="../../objects/TelepadDeployable.html" name="net.psforever.objects.TelepadDeployable" id="net.psforever.objects.TelepadDeployable" class="extype">TelepadDeployable</a>)]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Attempt to link the router teleport system using the provided terminal information.</p><div class="fullcomment"><div class="comment cmt"><p>Attempt to link the router teleport system using the provided terminal information.
|
|
Although additional states are necessary to properly use the teleportation system,
|
|
e.g., deployment state, active state of the endpoints, etc.,
|
|
this decision is not made factoring those other conditions.</p></div><dl class="paramcmts block"><dt class="param">router</dt><dd class="cmt"><p>the vehicle that houses one end of the teleportation system (the <code>InternalTelepad</code> object)</p></dd><dt class="param">systemPlan</dt><dd class="cmt"><p>specific object identification of the two endpoints of the teleportation system;
|
|
if absent, the knowable endpoint is deleted from the client reflexively</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#TotalDriverVehicleControl" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TotalDriverVehicleControl(vehicle:net.psforever.objects.Vehicle):Unit"></a><a id="TotalDriverVehicleControl(Vehicle):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#TotalDriverVehicleControl(vehicle:net.psforever.objects.Vehicle):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">TotalDriverVehicleControl</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Place the current vehicle under the control of the driver's commands,
|
|
but leave it in a cancellable auto-drive.</p><div class="fullcomment"><div class="comment cmt"><p>Place the current vehicle under the control of the driver's commands,
|
|
but leave it in a cancellable auto-drive.
|
|
Stop all movement entirely.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#TryDisposeOfLootedCorpse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryDisposeOfLootedCorpse(obj:net.psforever.objects.Player):Boolean"></a><a id="TryDisposeOfLootedCorpse(Player):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#TryDisposeOfLootedCorpse(obj:net.psforever.objects.Player):Boolean" 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">TryDisposeOfLootedCorpse</span><span class="params">(<span name="obj">obj: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">If the corpse has been well-looted, remove it from the ground.</p><div class="fullcomment"><div class="comment cmt"><p>If the corpse has been well-looted, remove it from the ground.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the corpse</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the <code>obj</code> is actually a corpse and has no objects in its holsters or backpack;
|
|
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#TryDropFDU" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TryDropFDU(tool:net.psforever.objects.ConstructionItem,index:Int,pos:net.psforever.types.Vector3):Unit"></a><a id="TryDropFDU(ConstructionItem,Int,Vector3):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#TryDropFDU(tool:net.psforever.objects.ConstructionItem,index:Int,pos:net.psforever.types.Vector3):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">TryDropFDU</span><span class="params">(<span name="tool">tool: <a href="../../objects/ConstructionItem.html" name="net.psforever.objects.ConstructionItem" id="net.psforever.objects.ConstructionItem" class="extype">ConstructionItem</a></span>, <span name="index">index: <span name="scala.Int" class="extype">Int</span></span>, <span name="pos">pos: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">If the tool is a form of field deployment unit (FDU, also called an <code>advanced_ace</code>),
|
|
completely remove the object from its current position and place it on the ground.</p><div class="fullcomment"><div class="comment cmt"><p>If the tool is a form of field deployment unit (FDU, also called an <code>advanced_ace</code>),
|
|
completely remove the object from its current position and place it on the ground.
|
|
In the case of a botched deployable construction, dropping the FDU is visually consistent
|
|
as it should already be depicted as on the ground as a part of its animation cycle.</p></div><dl class="paramcmts block"><dt class="param">tool</dt><dd class="cmt"><p>the <code>ConstructionItem</code> object currently in the slot (checked)</p></dd><dt class="param">index</dt><dd class="cmt"><p>the slot index</p></dd><dt class="param">pos</dt><dd class="cmt"><p>where to drop the object in the game world</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#TurnCounterDuringInterim" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TurnCounterDuringInterim(guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="TurnCounterDuringInterim(PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#TurnCounterDuringInterim(guid:net.psforever.types.PlanetSideGUID):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">TurnCounterDuringInterim</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">During the interim period between the avatar being in one place/zone
|
|
and completing the process of transitioning to another place/zone,
|
|
the upstream message counter is zero'd
|
|
awaiting new activity from the client.</p><div class="fullcomment"><div class="comment cmt"><p>During the interim period between the avatar being in one place/zone
|
|
and completing the process of transitioning to another place/zone,
|
|
the upstream message counter is zero'd
|
|
awaiting new activity from the client.
|
|
Until new upstream messages that pass some tests against their data start being reported,
|
|
the counter does not accumulate properly.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the player's globally unique identifier number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#TurnCounterDuringInterimWhileInPassengerSeat" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TurnCounterDuringInterimWhileInPassengerSeat(guid:net.psforever.types.PlanetSideGUID):Unit"></a><a id="TurnCounterDuringInterimWhileInPassengerSeat(PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#TurnCounterDuringInterimWhileInPassengerSeat(guid:net.psforever.types.PlanetSideGUID):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">TurnCounterDuringInterimWhileInPassengerSeat</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">During the interim period between the avatar being in one place/zone
|
|
and completing the process of transitioning to another place/zone,
|
|
the upstream message counter is zero'd
|
|
awaiting new activity from the client.</p><div class="fullcomment"><div class="comment cmt"><p>During the interim period between the avatar being in one place/zone
|
|
and completing the process of transitioning to another place/zone,
|
|
the upstream message counter is zero'd
|
|
awaiting new activity from the client.
|
|
Until new upstream messages that pass some tests against their data start being reported,
|
|
the counter does not accumulate properly.<br>
|
|
<br>
|
|
In the case that the transitioning player is seated in a vehicle seat
|
|
that is not the driver and does not have a mounted weapon under its control,
|
|
no obvious feedback will be provided by the client.
|
|
For example, when as infantry, a <code>PlayerStateMessageUpstream</code> packet is dispatched by the client.
|
|
For example, when in the driver seat, a <code>VehicleStateMessage</code> is dispatched by the client.
|
|
In the given case, the only packet that indicates the player is seated is a <code>KeepAliveMessage</code>.
|
|
Detection of this <code>KeepALiveMessage</code>, for the purpose of transitioning logic,
|
|
can not be instantaneous to the zoning process or other checks for proper zoning conditions that will be disrupted.
|
|
To avoid complications, the player in such a seat is initially spawned as infantry on their own client,
|
|
realizes the state transition confirmation for infantry (turn counter),
|
|
and is forced to transition into being seated,
|
|
and only at that time will begin registering <code>KeepAliveMessage</code> to mark the end of their interim period.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the player's globally unique identifier number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#TurnPlayerIntoCorpse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TurnPlayerIntoCorpse(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone):Unit"></a><a id="TurnPlayerIntoCorpse(Player,Zone):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#TurnPlayerIntoCorpse(tplayer:net.psforever.objects.Player,zone:net.psforever.objects.zones.Zone):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">TurnPlayerIntoCorpse</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>, <span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Creates a player that has the characteristics of a corpse.</p><div class="fullcomment"><div class="comment cmt"><p>Creates a player that has the characteristics of a corpse.
|
|
To the game, that is a backpack (or some pastry, festive graphical modification allowing).
|
|
A player who has been kicked may not turn into a corpse.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>AvatarAction.Release</code></p></span><span class="cmt"><p><code>AvatarServiceMessage</code></p></span><span class="cmt"><p><code>CorpseConverter.converter</code></p></span><span class="cmt"><p><code>DepictPlayerAsCorpse</code></p></span><span class="cmt"><p><code>Player.Release</code></p></span><span class="cmt"><p><code>Zone.AvatarEvents</code></p></span><span class="cmt"><p><code>Zone.Corpse.Add</code></p></span><span class="cmt"><p><code>Zone.Population</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UnaccessContainer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UnaccessContainer(container:net.psforever.objects.inventory.Container):Unit"></a><a id="UnaccessContainer(Container):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UnaccessContainer(container:net.psforever.objects.inventory.Container):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">UnaccessContainer</span><span class="params">(<span name="container">container: <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">For the target container, initiate protocol to release it from "access".</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UnaccessContainer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UnaccessContainer():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UnaccessContainer():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">UnaccessContainer</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">For whatever conatiner the character considers itself accessing,
|
|
initiate protocol to release it from "access".</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UnaccessContainerChannel" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UnaccessContainerChannel(events:akka.actor.ActorRef,channel:String):Unit"></a><a id="UnaccessContainerChannel(ActorRef,String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UnaccessContainerChannel(events:akka.actor.ActorRef,channel:String):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">UnaccessContainerChannel</span><span class="params">(<span name="events">events: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="channel">channel: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Leave an entity-specific group for shared updates.</p><div class="fullcomment"><div class="comment cmt"><p>Leave an entity-specific group for shared updates.</p></div><dl class="paramcmts block"><dt class="param">events</dt><dd class="cmt"><p>the event system bus to which to subscribe</p></dd><dt class="param">channel</dt><dd class="cmt"><p>the channel name</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UnaccessCorpseContainer" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UnaccessCorpseContainer(tplayer:net.psforever.objects.Player):Unit"></a><a id="UnaccessCorpseContainer(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UnaccessCorpseContainer(tplayer:net.psforever.objects.Player):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">UnaccessCorpseContainer</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common preparation for disengaging from a corpse.</p><div class="fullcomment"><div class="comment cmt"><p>Common preparation for disengaging from a corpse.
|
|
Leave the corpse-specific group that was used for shared updates.
|
|
Deconstruct every object in the backpack's inventory.</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UnaccessGenericContainer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UnaccessGenericContainer(container:net.psforever.objects.inventory.Container):Unit"></a><a id="UnaccessGenericContainer(Container):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UnaccessGenericContainer(container:net.psforever.objects.inventory.Container):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">UnaccessGenericContainer</span><span class="params">(<span name="container">container: <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UnaccessVehicleContainer" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UnaccessVehicleContainer(vehicle:net.psforever.objects.Vehicle):Unit"></a><a id="UnaccessVehicleContainer(Vehicle):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UnaccessVehicleContainer(vehicle:net.psforever.objects.Vehicle):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">UnaccessVehicleContainer</span><span class="params">(<span name="vehicle">vehicle: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Common preparation for disengaging from a vehicle.</p><div class="fullcomment"><div class="comment cmt"><p>Common preparation for disengaging from a vehicle.
|
|
Leave the vehicle-specific group that was used for shared updates.
|
|
Deconstruct every object in the vehicle's inventory.</p></div><dl class="paramcmts block"><dt class="param">vehicle</dt><dd class="cmt"><p>the vehicle</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UnregisterDrivenVehicle" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UnregisterDrivenVehicle(obj:net.psforever.objects.Vehicle,driver:net.psforever.objects.Player):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="UnregisterDrivenVehicle(Vehicle,Player):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UnregisterDrivenVehicle(obj:net.psforever.objects.Vehicle,driver:net.psforever.objects.Player):net.psforever.objects.guid.TaskResolver.GiveTask" 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">UnregisterDrivenVehicle</span><span class="params">(<span name="obj">obj: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="driver">driver: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UnregisterProjectile" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UnregisterProjectile(obj:net.psforever.objects.ballistics.Projectile):net.psforever.objects.guid.TaskResolver.GiveTask"></a><a id="UnregisterProjectile(Projectile):GiveTask"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UnregisterProjectile(obj:net.psforever.objects.ballistics.Projectile):net.psforever.objects.guid.TaskResolver.GiveTask" 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">UnregisterProjectile</span><span class="params">(<span name="obj">obj: <a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a></span>)</span><span class="result">: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span></span><p class="shortcomment cmt">Construct tasking that removes a formerly complete and currently registered projectile from the scene.</p><div class="fullcomment"><div class="comment cmt"><p>Construct tasking that removes a formerly complete and currently registered projectile from the scene.
|
|
After the projectile is unregistered from the curent zone's global unique identifier system,
|
|
all connected clients save for the one that registered it will be informed about the projectile's "destruction."</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the projectile to be unregistered</p></dd><dt>returns</dt><dd class="cmt"><p>a <code>TaskResolver.GiveTask</code> message</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UpdateDeployableUIElements" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateDeployableUIElements(list:List[(Int,Int,Int,Int)]):Unit"></a><a id="UpdateDeployableUIElements(List[(Int,Int,Int,Int)]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UpdateDeployableUIElements(list:List[(Int,Int,Int,Int)]):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">UpdateDeployableUIElements</span><span class="params">(<span name="list">list: <span name="scala.List" class="extype">List</span>[(<span name="scala.Int" class="extype">Int</span>, <span name="scala.Int" class="extype">Int</span>, <span name="scala.Int" class="extype">Int</span>, <span name="scala.Int" class="extype">Int</span>)]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Initialize the deployables user interface elements.<br>
|
|
<br>
|
|
All element initializations require both the maximum deployable amount and the current deployables active counts.</p><div class="fullcomment"><div class="comment cmt"><p>Initialize the deployables user interface elements.<br>
|
|
<br>
|
|
All element initializations require both the maximum deployable amount and the current deployables active counts.
|
|
Until initialized, all elements will be RED 0/0 as if the corresponding certification were not <code>learn</code>ed.
|
|
The respective element will become a pair of numbers, the second always being non-zero, when properly initialized.
|
|
The numbers will appear GREEN when more deployables of that type can be placed.
|
|
The numbers will appear RED if the player can not place any more of that type of deployable.
|
|
The numbers will appear YELLOW if the current deployable count is greater than the maximum count of that type
|
|
such as may be the case when a player <code>forget</code>s a certification.</p></div><dl class="paramcmts block"><dt class="param">list</dt><dd class="cmt"><p>a tuple of each UI element with four numbers;
|
|
even numbers are attribute ids;
|
|
odd numbers are quantities;
|
|
first pair is current quantity;
|
|
second pair is maximum quantity</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UpdatePersistence" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdatePersistence(persistRef:akka.actor.ActorRef)():Unit"></a><a id="UpdatePersistence(ActorRef)():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UpdatePersistence(persistRef:akka.actor.ActorRef)():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">UpdatePersistence</span><span class="params">(<span name="persistRef">persistRef: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>)</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Update this player avatar for persistence.</p><div class="fullcomment"><div class="comment cmt"><p>Update this player avatar for persistence.</p></div><dl class="paramcmts block"><dt class="param">persistRef</dt><dd class="cmt"><p>reference to the persistence monitor</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UpdateWeaponAtSeatPosition" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateWeaponAtSeatPosition(objWithSeat:net.psforever.objects.vehicles.MountedWeapons,seatNum:Int):Unit"></a><a id="UpdateWeaponAtSeatPosition(MountedWeapons,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UpdateWeaponAtSeatPosition(objWithSeat:net.psforever.objects.vehicles.MountedWeapons,seatNum:Int):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">UpdateWeaponAtSeatPosition</span><span class="params">(<span name="objWithSeat">objWithSeat: <a href="../../objects/vehicles/MountedWeapons.html" name="net.psforever.objects.vehicles.MountedWeapons" id="net.psforever.objects.vehicles.MountedWeapons" class="extype">MountedWeapons</a></span>, <span name="seatNum">seatNum: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">From a seat, find the weapon controlled from it, and update the ammunition counts for that weapon's magazines.</p><div class="fullcomment"><div class="comment cmt"><p>From a seat, find the weapon controlled from it, and update the ammunition counts for that weapon's magazines.</p></div><dl class="paramcmts block"><dt class="param">objWithSeat</dt><dd class="cmt"><p>the object that owns seats (and weaponry)</p></dd><dt class="param">seatNum</dt><dd class="cmt"><p>the seat</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UseRouterTelepadEffect" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UseRouterTelepadEffect(playerGUID:net.psforever.types.PlanetSideGUID,srcGUID:net.psforever.types.PlanetSideGUID,destGUID:net.psforever.types.PlanetSideGUID):Unit"></a><a id="UseRouterTelepadEffect(PlanetSideGUID,PlanetSideGUID,PlanetSideGUID):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UseRouterTelepadEffect(playerGUID:net.psforever.types.PlanetSideGUID,srcGUID:net.psforever.types.PlanetSideGUID,destGUID:net.psforever.types.PlanetSideGUID):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">UseRouterTelepadEffect</span><span class="params">(<span name="playerGUID">playerGUID: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="srcGUID">srcGUID: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="destGUID">destGUID: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Animate(?) a player using a fully-linked Router teleportation system.</p><div class="fullcomment"><div class="comment cmt"><p>Animate(?) a player using a fully-linked Router teleportation system.
|
|
In reality, this seems to do nothing visually?</p></div><dl class="paramcmts block"><dt class="param">playerGUID</dt><dd class="cmt"><p>the player being teleported</p></dd><dt class="param">srcGUID</dt><dd class="cmt"><p>the origin of the teleportation</p></dd><dt class="param">destGUID</dt><dd class="cmt"><p>the destination of the teleportation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#UseRouterTelepadSystem" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UseRouterTelepadSystem(router:net.psforever.objects.Vehicle,internalTelepad:net.psforever.objects.vehicles.Utility.InternalTelepad,remoteTelepad:net.psforever.objects.TelepadDeployable,src:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.TelepadLike,dest:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.TelepadLike):Unit"></a><a id="UseRouterTelepadSystem(Vehicle,InternalTelepad,TelepadDeployable,PlanetSideGameObjectwithTelepadLike,PlanetSideGameObjectwithTelepadLike):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#UseRouterTelepadSystem(router:net.psforever.objects.Vehicle,internalTelepad:net.psforever.objects.vehicles.Utility.InternalTelepad,remoteTelepad:net.psforever.objects.TelepadDeployable,src:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.TelepadLike,dest:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.TelepadLike):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">UseRouterTelepadSystem</span><span class="params">(<span name="router">router: <a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a></span>, <span name="internalTelepad">internalTelepad: <a href="../../objects/vehicles/Utility$$InternalTelepad.html" name="net.psforever.objects.vehicles.Utility.InternalTelepad" id="net.psforever.objects.vehicles.Utility.InternalTelepad" class="extype">InternalTelepad</a></span>, <span name="remoteTelepad">remoteTelepad: <a href="../../objects/TelepadDeployable.html" name="net.psforever.objects.TelepadDeployable" id="net.psforever.objects.TelepadDeployable" class="extype">TelepadDeployable</a></span>, <span name="src">src: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/TelepadLike.html" name="net.psforever.objects.ce.TelepadLike" id="net.psforever.objects.ce.TelepadLike" class="extype">TelepadLike</a></span>, <span name="dest">dest: <a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/TelepadLike.html" name="net.psforever.objects.ce.TelepadLike" id="net.psforever.objects.ce.TelepadLike" class="extype">TelepadLike</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">A player uses a fully-linked Router teleportation system.</p><div class="fullcomment"><div class="comment cmt"><p>A player uses a fully-linked Router teleportation system.</p></div><dl class="paramcmts block"><dt class="param">router</dt><dd class="cmt"><p>the Router vehicle</p></dd><dt class="param">internalTelepad</dt><dd class="cmt"><p>the internal telepad within the Router vehicle</p></dd><dt class="param">remoteTelepad</dt><dd class="cmt"><p>the remote telepad that is currently associated with this Router</p></dd><dt class="param">src</dt><dd class="cmt"><p>the origin of the teleportation (where the player starts)</p></dd><dt class="param">dest</dt><dd class="cmt"><p>the destination of the teleportation (where the player is going)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ValidObject" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ValidObject(id:Option[net.psforever.types.PlanetSideGUID]):Option[net.psforever.objects.PlanetSideGameObject]"></a><a id="ValidObject(Option[PlanetSideGUID]):Option[PlanetSideGameObject]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ValidObject(id:Option[net.psforever.types.PlanetSideGUID]):Option[net.psforever.objects.PlanetSideGameObject]" 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">ValidObject</span><span class="params">(<span name="id">id: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>]</span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ValidObject" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ValidObject(id:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.PlanetSideGameObject]"></a><a id="ValidObject(PlanetSideGUID):Option[PlanetSideGameObject]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ValidObject(id:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.PlanetSideGameObject]" 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">ValidObject</span><span class="params">(<span name="id">id: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ValidObject" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ValidObject(id:Int):Option[net.psforever.objects.PlanetSideGameObject]"></a><a id="ValidObject(Int):Option[PlanetSideGameObject]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ValidObject(id:Int):Option[net.psforever.objects.PlanetSideGameObject]" 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">ValidObject</span><span class="params">(<span name="id">id: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#WellLootedDeadBody" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WellLootedDeadBody(obj:net.psforever.objects.Player):Boolean"></a><a id="WellLootedDeadBody(Player):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#WellLootedDeadBody(obj:net.psforever.objects.Player):Boolean" 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">WellLootedDeadBody</span><span class="params">(<span name="obj">obj: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">If the corpse has been well-looted, it has no items in its primary holsters nor any items in its inventory.</p><div class="fullcomment"><div class="comment cmt"><p>If the corpse has been well-looted, it has no items in its primary holsters nor any items in its inventory.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>the corpse</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the <code>obj</code> is actually a corpse and has no objects in its holsters or backpack;
|
|
<code>false</code>, otherwise</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#YouCantInstantActionUsingDroppod" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="YouCantInstantActionUsingDroppod(zone:net.psforever.objects.zones.Zone,hotspotPosition:net.psforever.types.Vector3,spawnPosition:net.psforever.types.Vector3):Unit"></a><a id="YouCantInstantActionUsingDroppod(Zone,Vector3,Vector3):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#YouCantInstantActionUsingDroppod(zone:net.psforever.objects.zones.Zone,hotspotPosition:net.psforever.types.Vector3,spawnPosition:net.psforever.types.Vector3):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">YouCantInstantActionUsingDroppod</span><span class="params">(<span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>, <span name="hotspotPosition">hotspotPosition: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>, <span name="spawnPosition">spawnPosition: <a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">You can't instant action to respond to some activity using a droppod!
|
|
You can't.</p><div class="fullcomment"><div class="comment cmt"><p>You can't instant action to respond to some activity using a droppod!
|
|
You can't.
|
|
You just can't.</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>the destination zone</p></dd><dt class="param">hotspotPosition</dt><dd class="cmt"><p>where is the hotspot that is being addressed</p></dd><dt class="param">spawnPosition</dt><dd class="cmt"><p>the destination spawn position (may not be related to a literal <code>SpawnPoint</code> entity)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ZoneChangeSquadSetup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ZoneChangeSquadSetup():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ZoneChangeSquadSetup():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">ZoneChangeSquadSetup</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">These messages are used during each subsequent respawn to reset the squad colors on player nameplates and marquees.</p><div class="fullcomment"><div class="comment cmt"><p>These messages are used during each subsequent respawn to reset the squad colors on player nameplates and marquees.
|
|
During a zone change,
|
|
on top of other squad mates in the zone needing to have their knowledge of this player's squad colors changed,
|
|
the player must also set squad colors for each other squad members.
|
|
Default respawn functionality may resume afterwards.
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#ZoningStartInitialMessageAndTimer" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ZoningStartInitialMessageAndTimer():(Int,String)"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ZoningStartInitialMessageAndTimer():(Int,String)" 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">ZoningStartInitialMessageAndTimer</span><span class="params">()</span><span class="result">: (<span name="scala.Int" class="extype">Int</span>, <span name="scala.Predef.String" class="extype">String</span>)</span></span><p class="shortcomment cmt">The primary method of determination involves the faction affinity of the most favorable available region subset,
|
|
e.g., in the overlapping sphere of influences of a friendly field tower and an enemy major facility,
|
|
the time representative of the the tower has priority.</p><div class="fullcomment"><div class="comment cmt"><p>The primary method of determination involves the faction affinity of the most favorable available region subset,
|
|
e.g., in the overlapping sphere of influences of a friendly field tower and an enemy major facility,
|
|
the time representative of the the tower has priority.
|
|
When no spheres of influence are being encroached, one is considered "in the wilderness".
|
|
The messaging is different but the location is normally treated the same as if in a neutral sphere of influence.
|
|
Being anywhere in one's faction's own sanctuary is a special case.</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>a <code>Tuple</code> composed of the initial countdown time and the descriptor for message composition</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#_session" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="_session:net.psforever.objects.Session"></a><a id="_session:Session"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#_session:net.psforever.objects.Session" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">_session</span><span class="result">: <a href="../../objects/Session.html" name="net.psforever.objects.Session" id="net.psforever.objects.Session" class="extype">Session</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#accessedContainer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="accessedContainer:Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container]"></a><a id="accessedContainer:Option[PlanetSideGameObjectwithContainer]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#accessedContainer:Option[net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.inventory.Container]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">accessedContainer</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/inventory/Container.html" name="net.psforever.objects.inventory.Container" id="net.psforever.objects.inventory.Container" class="extype">Container</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#account" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="account:net.psforever.objects.Account"></a><a id="account:Account"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#account:net.psforever.objects.Account" 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">account</span><span class="result">: <a href="../../objects/Account.html" name="net.psforever.objects.Account" id="net.psforever.objects.Account" class="extype">Account</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#accountIntermediary" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="accountIntermediary:akka.actor.ActorRef"></a><a id="accountIntermediary:ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#accountIntermediary:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">accountIntermediary</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#accountPersistence" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="accountPersistence:akka.actor.ActorRef"></a><a id="accountPersistence:ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#accountPersistence:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">accountPersistence</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#amsSpawnPoints" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="amsSpawnPoints:List[net.psforever.objects.SpawnPoint]"></a><a id="amsSpawnPoints:List[SpawnPoint]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#amsSpawnPoints:List[net.psforever.objects.SpawnPoint]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">amsSpawnPoints</span><span class="result">: <span name="scala.List" class="extype">List</span>[<a href="../../objects/SpawnPoint.html" name="net.psforever.objects.SpawnPoint" id="net.psforever.objects.SpawnPoint" class="extype">SpawnPoint</a>]</span></span></li><li class="indented0 " name="akka.actor.Actor#aroundPostRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostRestart(reason:Throwable):Unit"></a><a id="aroundPostRestart(Throwable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#aroundPostRestart(reason:Throwable):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">aroundPostRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPostStop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPostStop():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#aroundPostStop():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">aroundPostStop</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreRestart(reason:Throwable,message:Option[Any]):Unit"></a><a id="aroundPreRestart(Throwable,Option[Any]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#aroundPreRestart(reason:Throwable,message:Option[Any]):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">aroundPreRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>, <span name="message">message: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#aroundPreStart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundPreStart():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#aroundPreStart():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">aroundPreStart</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@InternalApi</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.MDCContextAware#aroundReceive" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="aroundReceive(receive:akka.actor.Actor.Receive,msg:Any):Unit"></a><a id="aroundReceive(akka.actor.Actor.Receive,Any):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#aroundReceive(receive:akka.actor.Actor.Receive,msg:Any):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">aroundReceive</span><span class="params">(<span name="receive">receive: <span name="akka.actor.Actor.Receive" class="extype">akka.actor.Actor.Receive</span></span>, <span name="msg">msg: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<a href="../../../../akka/index.html" name="akka" id="akka" class="extype">akka</a>] </dd><dt>Definition Classes</dt><dd><a href="../../../../akka/actor/MDCContextAware.html" name="akka.actor.MDCContextAware" id="akka.actor.MDCContextAware" class="extype">MDCContextAware</a> → Actor</dd></dl></div></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/actors/session/SessionActor.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="net.psforever.actors.session.SessionActor#avatar" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="avatar:net.psforever.objects.avatar.Avatar"></a><a id="avatar:Avatar"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#avatar:net.psforever.objects.avatar.Avatar" 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">avatar</span><span class="result">: <a href="../../objects/avatar/Avatar.html" name="net.psforever.objects.avatar.Avatar" id="net.psforever.objects.avatar.Avatar" class="extype">Avatar</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#avatarActor" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="avatarActor:akka.actor.typed.ActorRef[net.psforever.actors.session.AvatarActor.Command]"></a><a id="avatarActor:ActorRef[Command]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#avatarActor:akka.actor.typed.ActorRef[net.psforever.actors.session.AvatarActor.Command]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">avatarActor</span><span class="result">: <span name="akka.actor.typed.ActorRef" class="extype">ActorRef</span>[<a href="AvatarActor$$Command.html" name="net.psforever.actors.session.AvatarActor.Command" id="net.psforever.actors.session.AvatarActor.Command" class="extype">Command</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#beginZoningCountdown" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="beginZoningCountdown(runnable:Runnable):Unit"></a><a id="beginZoningCountdown(Runnable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#beginZoningCountdown(runnable:Runnable):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">beginZoningCountdown</span><span class="params">(<span name="runnable">runnable: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html#java.lang.Runnable" name="java.lang.Runnable" id="java.lang.Runnable" class="extype">Runnable</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">A zoning message was received.</p><div class="fullcomment"><div class="comment cmt"><p>A zoning message was received.
|
|
That doesn't matter.
|
|
In what stage of the zoning determination process is the client, and what is the next stage.<br>
|
|
<br>
|
|
To perform any actions involving zoning, an initial request must have been dispatched and marked as dispatched.
|
|
When invoked after, the process will switch over to a countdown of time until the zoning actually occurs.
|
|
The origin will be evaluated based on comparison of faction affinity with the client's player
|
|
and from that an initial time and a message will be generated.
|
|
Afterwards, the process will queue another inquiry for another zoning response.
|
|
Each time 5s of the countdown passes, another message will be sent and received;
|
|
and, this is another pass of the countdown.<br>
|
|
<br>
|
|
Once the countdown reaches 0, the transportation that has been promised by the zoning attempt may begin.
|
|
</p></div><dl class="paramcmts block"><dt class="param">runnable</dt><dd class="cmt"><p>execute for the next step of the zoning process</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#chatActor" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="chatActor:akka.actor.typed.ActorRef[net.psforever.actors.session.ChatActor.Command]"></a><a id="chatActor:ActorRef[Command]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#chatActor:akka.actor.typed.ActorRef[net.psforever.actors.session.ChatActor.Command]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">chatActor</span><span class="result">: <span name="akka.actor.typed.ActorRef" class="extype">ActorRef</span>[<a href="ChatActor$$Command.html" name="net.psforever.actors.session.ChatActor.Command" id="net.psforever.actors.session.ChatActor.Command" class="extype">Command</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#clientKeepAlive" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="clientKeepAlive:akka.actor.Cancellable"></a><a id="clientKeepAlive:Cancellable"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#clientKeepAlive:akka.actor.Cancellable" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">clientKeepAlive</span><span class="result">: <span name="akka.actor.Cancellable" class="extype">Cancellable</span></span></span></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/actors/session/SessionActor.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.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#cluster" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="cluster:akka.actor.typed.ActorRef[net.psforever.services.InterstellarClusterService.Command]"></a><a id="cluster:ActorRef[Command]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#cluster:akka.actor.typed.ActorRef[net.psforever.services.InterstellarClusterService.Command]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">cluster</span><span class="result">: <span name="akka.actor.typed.ActorRef" class="extype">ActorRef</span>[<a href="../../services/InterstellarClusterService$$Command.html" name="net.psforever.services.InterstellarClusterService.Command" id="net.psforever.services.InterstellarClusterService.Command" class="extype">Command</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#configAmenityAsDestroyed" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="configAmenityAsDestroyed(amenity:net.psforever.objects.serverobject.structures.Amenity):Unit"></a><a id="configAmenityAsDestroyed(Amenity):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#configAmenityAsDestroyed(amenity:net.psforever.objects.serverobject.structures.Amenity):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">configAmenityAsDestroyed</span><span class="params">(<span name="amenity">amenity: <a href="../../objects/serverobject/structures/Amenity.html" name="net.psforever.objects.serverobject.structures.Amenity" id="net.psforever.objects.serverobject.structures.Amenity" class="extype">Amenity</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Configure the specific destroyed amenity by sending the client packets.</p><div class="fullcomment"><div class="comment cmt"><p>Configure the specific destroyed amenity by sending the client packets.
|
|
These actions are performed during the loading of a zone.</p></div><dl class="paramcmts block"><dt class="param">amenity</dt><dd class="cmt"><p>the facility object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Generator</code></p></span><span class="cmt"><p><code>ImplantTerminalMech</code></p></span><span class="cmt"><p><code>PlanetsideAttributeMessage</code></p></span><span class="cmt"><p><code>PlanetSideGameObject.Destroyed</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#configAmenityAsWorking" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="configAmenityAsWorking(amenity:net.psforever.objects.serverobject.structures.Amenity):Unit"></a><a id="configAmenityAsWorking(Amenity):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#configAmenityAsWorking(amenity:net.psforever.objects.serverobject.structures.Amenity):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">configAmenityAsWorking</span><span class="params">(<span name="amenity">amenity: <a href="../../objects/serverobject/structures/Amenity.html" name="net.psforever.objects.serverobject.structures.Amenity" id="net.psforever.objects.serverobject.structures.Amenity" class="extype">Amenity</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Configure the specific working amenity by sending the client packets.</p><div class="fullcomment"><div class="comment cmt"><p>Configure the specific working amenity by sending the client packets.
|
|
Amenities that are not <code>Damageable</code> are also included.
|
|
These actions are performed during the loading of a zone.</p></div><dl class="paramcmts block"><dt class="param">amenity</dt><dd class="cmt"><p>the facility object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Door</code></p></span><span class="cmt"><p><code>GenericObjectStateMsg</code></p></span><span class="cmt"><p><code>Hackable</code></p></span><span class="cmt"><p><code>HackCaptureTerminal</code></p></span><span class="cmt"><p><code>HackObject</code></p></span><span class="cmt"><p><code>PlanetsideAttributeMessage</code></p></span><span class="cmt"><p><code>ResourceSilo</code></p></span><span class="cmt"><p><code>SetEmpireMessage</code></p></span><span class="cmt"><p><code>VitalityDefinition.Damageable</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#configZone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="configZone(zone:net.psforever.objects.zones.Zone):Unit"></a><a id="configZone(Zone):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#configZone(zone:net.psforever.objects.zones.Zone):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">configZone</span><span class="params">(<span name="zone">zone: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Configure the buildings and each specific amenity for that building in a given zone by sending the client packets.</p><div class="fullcomment"><div class="comment cmt"><p>Configure the buildings and each specific amenity for that building in a given zone by sending the client packets.
|
|
These actions are performed during the loading of a zone.</p></div><dl class="paramcmts block"><dt class="param">zone</dt><dd class="cmt"><p>the zone being loaded</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SetEmpireMessage</code><br>
|
|
<code>PlanetsideAttributeMessage</code><br>
|
|
<code>HackMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#connectionState" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="connectionState:Int"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#connectionState:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">connectionState</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="akka.actor.Actor#context" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="context:akka.actor.ActorContext"></a><a id="context:ActorContext"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#context:akka.actor.ActorContext" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">implicit </span> <span class="kind">val</span></span> <span class="symbol"><span class="name">context</span><span class="result">: <span name="akka.actor.ActorContext" class="extype">ActorContext</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#continent" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="continent:net.psforever.objects.zones.Zone"></a><a id="continent:Zone"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#continent:net.psforever.objects.zones.Zone" 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">continent</span><span class="result">: <a href="../../objects/zones/Zone.html" name="net.psforever.objects.zones.Zone" id="net.psforever.objects.zones.Zone" class="extype">Zone</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#controlled" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="controlled:Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#controlled:Option[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">controlled</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#deadState" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="deadState:net.psforever.packet.game.DeadState.Value"></a><a id="deadState:packet.game.DeadState.Value"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#deadState:net.psforever.packet.game.DeadState.Value" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">deadState</span><span class="result">: <a href="../../packet/game/DeadState$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.packet.game.DeadState.Value" id="net.psforever.packet.game.DeadState.Value" class="extmbr">packet.game.DeadState.Value</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#drawDeloyableIcon" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="drawDeloyableIcon:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable=>Unit"></a><a id="drawDeloyableIcon:(PlanetSideGameObjectwithDeployable)=>Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#drawDeloyableIcon:net.psforever.objects.PlanetSideGameObjectwithnet.psforever.objects.ce.Deployable=>Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">drawDeloyableIcon</span><span class="result">: (<a href="../../objects/PlanetSideGameObject.html" name="net.psforever.objects.PlanetSideGameObject" id="net.psforever.objects.PlanetSideGameObject" class="extype">PlanetSideGameObject</a> with <a href="../../objects/ce/Deployable.html" name="net.psforever.objects.ce.Deployable" id="net.psforever.objects.ce.Deployable" class="extype">Deployable</a>) => <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#eq(x$1:AnyRef):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">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</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</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#equals(x$1:Object):Boolean" 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">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</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.actors.session.SessionActor#failWithError" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="failWithError(error:String):Unit"></a><a id="failWithError(String):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#failWithError(error:String):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">failWithError</span><span class="params">(<span name="error">error: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#finalize():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">finalize</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</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="symbol">classOf[java.lang.Throwable]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#flying" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="flying:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#flying:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">flying</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#galaxyService" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="galaxyService:akka.actor.ActorRef"></a><a id="galaxyService:ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#galaxyService:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">galaxyService</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_<:AnyRef]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#getClass():Class[_]" 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">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.Class" name="java.lang.Class" id="java.lang.Class" class="extype">Class</a>[_ <: <span name="scala.AnyRef" class="extype">AnyRef</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#handleGamePkt" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="handleGamePkt(pkt:net.psforever.packet.PlanetSideGamePacket):Any"></a><a id="handleGamePkt(PlanetSideGamePacket):Any"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#handleGamePkt(pkt:net.psforever.packet.PlanetSideGamePacket):Any" 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">handleGamePkt</span><span class="params">(<span name="pkt">pkt: <a href="../../packet/PlanetSideGamePacket.html" name="net.psforever.packet.PlanetSideGamePacket" id="net.psforever.packet.PlanetSideGamePacket" class="extype">PlanetSideGamePacket</a></span>)</span><span class="result">: <span name="scala.Any" class="extype">Any</span></span></span></li><li class="indented0 " name="scala.AnyRef#hashCode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hashCode():Int"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#hashCode():Int" 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">hashCode</span><span class="params">()</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><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#initBuilding" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="initBuilding(continentNumber:Int,buildingNumber:Int,building:net.psforever.objects.serverobject.structures.Building):Unit"></a><a id="initBuilding(Int,Int,Building):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#initBuilding(continentNumber:Int,buildingNumber:Int,building:net.psforever.objects.serverobject.structures.Building):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">initBuilding</span><span class="params">(<span name="continentNumber">continentNumber: <span name="scala.Int" class="extype">Int</span></span>, <span name="buildingNumber">buildingNumber: <span name="scala.Int" class="extype">Int</span></span>, <span name="building">building: <a href="../../objects/serverobject/structures/Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">For a given continental structure, determine the method of generating server-join client configuration packets.</p><div class="fullcomment"><div class="comment cmt"><p>For a given continental structure, determine the method of generating server-join client configuration packets.</p></div><dl class="paramcmts block"><dt class="param">continentNumber</dt><dd class="cmt"><p>the zone id</p></dd><dt class="param">buildingNumber</dt><dd class="cmt"><p>the building id</p></dd><dt class="param">building</dt><dd class="cmt"><p>the building object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#initFacility" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="initFacility(continentNumber:Int,buildingNumber:Int,building:net.psforever.objects.serverobject.structures.Building):Unit"></a><a id="initFacility(Int,Int,Building):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#initFacility(continentNumber:Int,buildingNumber:Int,building:net.psforever.objects.serverobject.structures.Building):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">initFacility</span><span class="params">(<span name="continentNumber">continentNumber: <span name="scala.Int" class="extype">Int</span></span>, <span name="buildingNumber">buildingNumber: <span name="scala.Int" class="extype">Int</span></span>, <span name="building">building: <a href="../../objects/serverobject/structures/Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">For a given facility structure, configure a client by dispatching the appropriate packets.</p><div class="fullcomment"><div class="comment cmt"><p>For a given facility structure, configure a client by dispatching the appropriate packets.
|
|
Pay special attention to the details of <code>BuildingInfoUpdateMessage</code> when preparing this packet.<br>
|
|
<br>
|
|
24 Janurtay 2019:<br>
|
|
Manual <code>BIUM</code> construction to alleviate player login.</p></div><dl class="paramcmts block"><dt class="param">continentNumber</dt><dd class="cmt"><p>the zone id</p></dd><dt class="param">buildingNumber</dt><dd class="cmt"><p>the building id</p></dd><dt class="param">building</dt><dd class="cmt"><p>the building object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>BuildingInfoUpdateMessage</code></p></span><span class="cmt"><p><code>DensityLevelUpdateMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#initGate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="initGate(continentNumber:Int,buildingNumber:Int,building:net.psforever.objects.serverobject.structures.Building):Unit"></a><a id="initGate(Int,Int,Building):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#initGate(continentNumber:Int,buildingNumber:Int,building:net.psforever.objects.serverobject.structures.Building):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">initGate</span><span class="params">(<span name="continentNumber">continentNumber: <span name="scala.Int" class="extype">Int</span></span>, <span name="buildingNumber">buildingNumber: <span name="scala.Int" class="extype">Int</span></span>, <span name="building">building: <a href="../../objects/serverobject/structures/Building.html" name="net.psforever.objects.serverobject.structures.Building" id="net.psforever.objects.serverobject.structures.Building" class="extype">Building</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">For a given lattice warp gate structure, configure a client by dispatching the appropriate packets.</p><div class="fullcomment"><div class="comment cmt"><p>For a given lattice warp gate structure, configure a client by dispatching the appropriate packets.
|
|
Unlike other facilities, gates do not have complicated <code>BuildingInfoUpdateMessage</code> packets.
|
|
Also unlike facilities, gates have an additional packet.</p></div><dl class="paramcmts block"><dt class="param">continentNumber</dt><dd class="cmt"><p>the zone id</p></dd><dt class="param">buildingNumber</dt><dd class="cmt"><p>the building id</p></dd><dt class="param">building</dt><dd class="cmt"><p>the building object</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>BuildingInfoUpdateMessage</code></p></span><span class="cmt"><p><code>DensityLevelUpdateMessage</code></p></span><span class="cmt"><p><code>BroadcastWarpgateUpdateMessage</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#instantActionFallbackDestination" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="instantActionFallbackDestination:Option[net.psforever.objects.zones.Zoning.InstantAction.Located]"></a><a id="instantActionFallbackDestination:Option[Located]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#instantActionFallbackDestination:Option[net.psforever.objects.zones.Zoning.InstantAction.Located]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">instantActionFallbackDestination</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/zones/Zoning$$InstantAction$$Located.html" name="net.psforever.objects.zones.Zoning.InstantAction.Located" id="net.psforever.objects.zones.Zoning.InstantAction.Located" class="extype">Located</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#interimUngunnedVehicle" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="interimUngunnedVehicle:Option[net.psforever.types.PlanetSideGUID]"></a><a id="interimUngunnedVehicle:Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#interimUngunnedVehicle:Option[net.psforever.types.PlanetSideGUID]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">interimUngunnedVehicle</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#interimUngunnedVehicleSeat" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="interimUngunnedVehicleSeat:Option[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#interimUngunnedVehicleSeat:Option[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">interimUngunnedVehicleSeat</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Int" class="extype">Int</span>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#interstellarFerry" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="interstellarFerry:Option[net.psforever.objects.Vehicle]"></a><a id="interstellarFerry:Option[Vehicle]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#interstellarFerry:Option[net.psforever.objects.Vehicle]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">interstellarFerry</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../objects/Vehicle.html" name="net.psforever.objects.Vehicle" id="net.psforever.objects.Vehicle" class="extype">Vehicle</a>]</span></span><p class="shortcomment cmt">used during zone transfers to maintain reference to seated vehicle (which does not yet exist in the new zone)
|
|
used during intrazone gate transfers, but not in a way distinct from prior zone transfer procedures
|
|
should only be set during the transient period when moving between one spawn point and the next
|
|
leaving set prior to a subsequent transfers may cause unstable vehicle associations, with memory leak potential
|
|
</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#interstellarFerryTopLevelGUID" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="interstellarFerryTopLevelGUID:Option[net.psforever.types.PlanetSideGUID]"></a><a id="interstellarFerryTopLevelGUID:Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#interstellarFerryTopLevelGUID:Option[net.psforever.types.PlanetSideGUID]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">interstellarFerryTopLevelGUID</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>]</span></span><p class="shortcomment cmt">used during zone transfers for cleanup to refer to the vehicle that instigated a transfer
|
|
"top level" is the carrier in a carrier/ferried association or a projected carrier/(ferried carrier)/ferried association
|
|
inherited from parent (carrier) to child (ferried) through the <code>TransferPassenger</code> message
|
|
the old-zone unique identifier for the carrier
|
|
no harm should come from leaving the field set to an old unique identifier value after the transfer period
|
|
</p></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#isInstanceOf[T0]: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">isInstanceOf</span><span class="tparams">[<span name="T0">T0</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>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#keepAliveFunc" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="keepAliveFunc:()=>Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#keepAliveFunc:()=>Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">keepAliveFunc</span><span class="result">: () => <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#lastTerminalOrderFulfillment" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="lastTerminalOrderFulfillment:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#lastTerminalOrderFulfillment:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">lastTerminalOrderFulfillment</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#lfsm" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="lfsm:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#lfsm:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">lfsm</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">When joining or creating a squad, the original state of the avatar's internal LFS variable is blanked.</p><div class="fullcomment"><div class="comment cmt"><p>When joining or creating a squad, the original state of the avatar's internal LFS variable is blanked.
|
|
This <code>WorldSessionActor</code>-local variable is then used to indicate the ongoing state of the LFS UI component,
|
|
now called "Looking for Squad Member."
|
|
Only the squad leader may toggle the LFSM marquee.
|
|
Upon leaving or disbanding a squad, this value is made false.
|
|
Control switching between the <code>Avatar</code>-local and the <code>WorldSessionActor</code>-local variable is contingent on <code>squadUI</code> being populated.
|
|
</p></div></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#loadConfZone" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="loadConfZone:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#loadConfZone:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">loadConfZone</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="akka.actor.ActorLogging#log" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="log:akka.event.LoggingAdapter"></a><a id="log:LoggingAdapter"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#log:akka.event.LoggingAdapter" 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">log</span><span class="result">: <span name="akka.event.LoggingAdapter" class="extype">LoggingAdapter</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>ActorLogging</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#ne" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#ne(x$1:AnyRef):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">ne</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</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</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#noSpawnPointHere" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="noSpawnPointHere:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#noSpawnPointHere:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">noSpawnPointHere</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="scala.AnyRef#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#notify():Unit" 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">notify</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#notifyAll():Unit" 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">notifyAll</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#persist" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="persist:()=>Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#persist:()=>Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">persist</span><span class="result">: () => <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#player" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="player:net.psforever.objects.Player"></a><a id="player:Player"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#player:net.psforever.objects.Player" 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">player</span><span class="result">: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span></span></li><li class="indented0 " name="akka.actor.Actor#postRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="postRestart(reason:Throwable):Unit"></a><a id="postRestart(Throwable):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#postRestart(reason:Throwable):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">postRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Exception]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#postStop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="postStop():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#postStop():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">postStop</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.actors.session.SessionActor" id="net.psforever.actors.session.SessionActor" class="extype">SessionActor</a> → Actor</dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#preRestart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="preRestart(reason:Throwable,message:Option[Any]):Unit"></a><a id="preRestart(Throwable,Option[Any]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#preRestart(reason:Throwable,message:Option[Any]):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">preRestart</span><span class="params">(<span name="reason">reason: <span name="scala.Throwable" class="extype">Throwable</span></span>, <span name="message">message: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Any" class="extype">Any</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Exception]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#preStart" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="preStart():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#preStart():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">preStart</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Exception]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#prefire" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="prefire:Option[net.psforever.types.PlanetSideGUID]"></a><a id="prefire:Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#prefire:Option[net.psforever.types.PlanetSideGUID]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">prefire</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#progressBarUpdate" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="progressBarUpdate:akka.actor.Cancellable"></a><a id="progressBarUpdate:Cancellable"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#progressBarUpdate:akka.actor.Cancellable" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">progressBarUpdate</span><span class="result">: <span name="akka.actor.Cancellable" class="extype">Cancellable</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#progressBarValue" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="progressBarValue:Option[Float]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#progressBarValue:Option[Float]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">progressBarValue</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Float" class="extype">Float</span>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#projectiles" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="projectiles:Array[Option[net.psforever.objects.ballistics.Projectile]]"></a><a id="projectiles:Array[Option[Projectile]]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#projectiles:Array[Option[net.psforever.objects.ballistics.Projectile]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">projectiles</span><span class="result">: <span name="scala.Array" class="extype">Array</span>[<span name="scala.Option" class="extype">Option</span>[<a href="../../objects/ballistics/Projectile.html" name="net.psforever.objects.ballistics.Projectile" id="net.psforever.objects.ballistics.Projectile" class="extype">Projectile</a>]]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#projectilesToCleanUp" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="projectilesToCleanUp:Array[Boolean]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#projectilesToCleanUp:Array[Boolean]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">projectilesToCleanUp</span><span class="result">: <span name="scala.Array" class="extype">Array</span>[<span name="scala.Boolean" class="extype">Boolean</span>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#propertyOverrideManager" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="propertyOverrideManager:akka.actor.ActorRef"></a><a id="propertyOverrideManager:ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#propertyOverrideManager:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">propertyOverrideManager</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#queuedSquadActions" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="queuedSquadActions:Seq[()=>Unit]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#queuedSquadActions:Seq[()=>Unit]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">queuedSquadActions</span><span class="result">: <span name="scala.Seq" class="extype">Seq</span>[() => <span name="scala.Unit" class="extype">Unit</span>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#receive" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="receive:SessionActor.this.Receive"></a><a id="receive:Receive"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#receive:SessionActor.this.Receive" 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">receive</span><span class="result">: <a href="#Receive=akka.actor.Actor.Receive" name="net.psforever.actors.session.SessionActor.Receive" id="net.psforever.actors.session.SessionActor.Receive" class="extmbr">Receive</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="" name="net.psforever.actors.session.SessionActor" id="net.psforever.actors.session.SessionActor" class="extype">SessionActor</a> → Actor</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#recentTeleportAttempt" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="recentTeleportAttempt:Long"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#recentTeleportAttempt:Long" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">recentTeleportAttempt</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#respawnTimer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="respawnTimer:akka.actor.Cancellable"></a><a id="respawnTimer:Cancellable"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#respawnTimer:akka.actor.Cancellable" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">respawnTimer</span><span class="result">: <span name="akka.actor.Cancellable" class="extype">Cancellable</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#reviveTimer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="reviveTimer:akka.actor.Cancellable"></a><a id="reviveTimer:Cancellable"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#reviveTimer:akka.actor.Cancellable" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">reviveTimer</span><span class="result">: <span name="akka.actor.Cancellable" class="extype">Cancellable</span></span></span></li><li class="indented0 " name="akka.actor.Actor#self" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="self:akka.actor.ActorRef"></a><a id="self:ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#self:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">implicit final </span> <span class="kind">val</span></span> <span class="symbol"><span class="name">self</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#sendResponse" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="sendResponse(packet:net.psforever.packet.PlanetSidePacket):Unit"></a><a id="sendResponse(PlanetSidePacket):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#sendResponse(packet:net.psforever.packet.PlanetSidePacket):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">sendResponse</span><span class="params">(<span name="packet">packet: <a href="../../packet/PlanetSidePacket.html" name="net.psforever.packet.PlanetSidePacket" id="net.psforever.packet.PlanetSidePacket" class="extype">PlanetSidePacket</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="akka.actor.Actor#sender" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="sender():akka.actor.ActorRef"></a><a id="sender():ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#sender():akka.actor.ActorRef" 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">sender</span><span class="params">()</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#serverTime" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="serverTime:Long"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#serverTime:Long" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">serverTime</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#serviceManager" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="serviceManager:akka.actor.ActorRef"></a><a id="serviceManager:ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#serviceManager:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">serviceManager</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#session" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="session:net.psforever.objects.Session"></a><a id="session:Session"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#session:net.psforever.objects.Session" 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">session</span><span class="result">: <a href="../../objects/Session.html" name="net.psforever.objects.Session" id="net.psforever.objects.Session" class="extype">Session</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#session_=" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="session_=(session:net.psforever.objects.Session):Unit"></a><a id="session_=(Session):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#session_=(session:net.psforever.objects.Session):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" title="gt4s: session_$eq">session_=</span><span class="params">(<span name="session">session: <a href="../../objects/Session.html" name="net.psforever.objects.Session" id="net.psforever.objects.Session" class="extype">Session</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#setAvatar" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="setAvatar:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#setAvatar:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">setAvatar</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#setCurrentAvatarFunc" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="setCurrentAvatarFunc:net.psforever.objects.Player=>Unit"></a><a id="setCurrentAvatarFunc:(Player)=>Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#setCurrentAvatarFunc:net.psforever.objects.Player=>Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">setCurrentAvatarFunc</span><span class="result">: (<a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a>) => <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#setupAvatarFunc" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="setupAvatarFunc:()=>Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#setupAvatarFunc:()=>Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">setupAvatarFunc</span><span class="result">: () => <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#shiftOrientation" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="shiftOrientation:Option[net.psforever.types.Vector3]"></a><a id="shiftOrientation:Option[Vector3]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#shiftOrientation:Option[net.psforever.types.Vector3]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">shiftOrientation</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#shiftPosition" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="shiftPosition:Option[net.psforever.types.Vector3]"></a><a id="shiftPosition:Option[Vector3]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#shiftPosition:Option[net.psforever.types.Vector3]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">shiftPosition</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/Vector3.html" name="net.psforever.types.Vector3" id="net.psforever.types.Vector3" class="extype">Vector3</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#shooting" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="shooting:Option[net.psforever.types.PlanetSideGUID]"></a><a id="shooting:Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#shooting:Option[net.psforever.types.PlanetSideGUID]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">shooting</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#shootingStart" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="shootingStart:Long"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#shootingStart:Long" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">shootingStart</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#shootingStop" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="shootingStop:Long"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#shootingStop:Long" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">shootingStop</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#shotsWhileDead" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="shotsWhileDead:Int"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#shotsWhileDead:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">shotsWhileDead</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#squadService" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="squadService:akka.actor.ActorRef"></a><a id="squadService:ActorRef"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#squadService:akka.actor.ActorRef" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">squadService</span><span class="result">: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#squadSetup" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="squadSetup:()=>Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#squadSetup:()=>Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">squadSetup</span><span class="result">: () => <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#squadUI" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="squadUI:scala.collection.mutable.LongMap[net.psforever.actors.session.SessionActor.SquadUIElement]"></a><a id="squadUI:LongMap[SquadUIElement]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#squadUI:scala.collection.mutable.LongMap[net.psforever.actors.session.SessionActor.SquadUIElement]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">squadUI</span><span class="result">: <span name="scala.collection.mutable.LongMap" class="extype">LongMap</span>[<a href="SessionActor$$SquadUIElement.html" name="net.psforever.actors.session.SessionActor.SquadUIElement" id="net.psforever.actors.session.SessionActor.SquadUIElement" class="extype">SquadUIElement</a>]</span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#squadUpdateCounter" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="squadUpdateCounter:Int"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#squadUpdateCounter:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">squadUpdateCounter</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#squad_supplement_id" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="squad_supplement_id:Int"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#squad_supplement_id:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">squad_supplement_id</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#suicide" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="suicide(tplayer:net.psforever.objects.Player):Unit"></a><a id="suicide(Player):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#suicide(tplayer:net.psforever.objects.Player):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">suicide</span><span class="params">(<span name="tplayer">tplayer: <a href="../../objects/Player.html" name="net.psforever.objects.Player" id="net.psforever.objects.Player" class="extype">Player</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">The player has lost the will to live and must be killed.</p><div class="fullcomment"><div class="comment cmt"><p>The player has lost the will to live and must be killed.</p></div><dl class="paramcmts block"><dt class="param">tplayer</dt><dd class="cmt"><p>the player to be killed</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Vitality</code><br>
|
|
<code>PlayerSuicide</code></p></span></dd></dl></div></li><li class="indented0 " name="akka.actor.Actor#supervisorStrategy" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="supervisorStrategy:akka.actor.SupervisorStrategy"></a><a id="supervisorStrategy:SupervisorStrategy"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#supervisorStrategy:akka.actor.SupervisorStrategy" 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">supervisorStrategy</span><span class="result">: <span name="akka.actor.SupervisorStrategy" class="extype">SupervisorStrategy</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=>T0):T0"></a><a id="synchronized[T0](=>T0):T0"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#synchronized[T0](x$1:=>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">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: => <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#taskThenZoneChange" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="taskThenZoneChange(task:net.psforever.objects.guid.TaskResolver.GiveTask,zoneMessage:net.psforever.services.InterstellarClusterService.FindZone):Unit"></a><a id="taskThenZoneChange(GiveTask,FindZone):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#taskThenZoneChange(task:net.psforever.objects.guid.TaskResolver.GiveTask,zoneMessage:net.psforever.services.InterstellarClusterService.FindZone):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">taskThenZoneChange</span><span class="params">(<span name="task">task: <a href="../../objects/guid/TaskResolver$$GiveTask.html" name="net.psforever.objects.guid.TaskResolver.GiveTask" id="net.psforever.objects.guid.TaskResolver.GiveTask" class="extype">GiveTask</a></span>, <span name="zoneMessage">zoneMessage: <a href="../../services/InterstellarClusterService$$FindZone.html" name="net.psforever.services.InterstellarClusterService.FindZone" id="net.psforever.services.InterstellarClusterService.FindZone" class="extype">FindZone</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Before changing zones, perform the following task (which can be a nesting of subtasks).</p></li><li class="indented0 " name="scala.AnyRef#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#toString():String" 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">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></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.actors.session.SessionActor#turnCounterFunc" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="turnCounterFunc:net.psforever.types.PlanetSideGUID=>Unit"></a><a id="turnCounterFunc:(PlanetSideGUID)=>Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#turnCounterFunc:net.psforever.types.PlanetSideGUID=>Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">turnCounterFunc</span><span class="result">: (<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>) => <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="akka.actor.Actor#unhandled" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unhandled(message:Any):Unit"></a><a id="unhandled(Any):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#unhandled(message:Any):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">unhandled</span><span class="params">(<span name="message">message: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Actor</dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#unsignedIntMaxValue" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="unsignedIntMaxValue:Long"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#unsignedIntMaxValue:Long" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">lazy val</span></span> <span class="symbol"><span class="name">unsignedIntMaxValue</span><span class="result">: <span name="scala.Long" class="extype">Long</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#updateSquad" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="updateSquad:()=>Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#updateSquad:()=>Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">updateSquad</span><span class="result">: () => <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#upstreamMessageCount" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="upstreamMessageCount:Int"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#upstreamMessageCount:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">upstreamMessageCount</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><p class="shortcomment cmt">Upstream message counter<br>
|
|
Checks for server acknowledgement of the following messages in the following conditions:<br>
|
|
<code>PlayerStateMessageUpstream</code> (infantry)<br>
|
|
<code>VehicleStateMessage</code> (driver seat only)<br>
|
|
<code>ChildObjectStateMessage</code> (any gunner seat that is not the driver)<br>
|
|
<code>KeepAliveMessage</code> (any passenger seat that is not the driver)<br>
|
|
As they should arrive roughly every 250 milliseconds this allows for a very crude method of scheduling tasks up to four times per second
|
|
</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#usingMedicalTerminal" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="usingMedicalTerminal:Option[net.psforever.types.PlanetSideGUID]"></a><a id="usingMedicalTerminal:Option[PlanetSideGUID]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#usingMedicalTerminal:Option[net.psforever.types.PlanetSideGUID]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">usingMedicalTerminal</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a>]</span></span></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#wait():Unit" 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">wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><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.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#wait(x$1:Long,x$2:Int):Unit" 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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><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.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#wait(x$1:Long):Unit" 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">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><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.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#zoneLoaded" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="zoneLoaded:Option[Boolean]"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#zoneLoaded:Option[Boolean]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">zoneLoaded</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Boolean" class="extype">Boolean</span>]</span></span><p class="shortcomment cmt">a flag for the zone having finished loading during zoning
|
|
<code>None</code> when no zone is loaded
|
|
<code>Some(true)</code> when a zone has successfully loaded
|
|
<code>Some(false)</code> when the loading process has failed or was executed but did not complete for some reason
|
|
</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#zoneReload" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="zoneReload:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#zoneReload:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">zoneReload</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">a flag that forces the current zone to reload itself during a zoning operation</p></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#zoningChatMessageType" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="zoningChatMessageType:net.psforever.types.ChatMessageType"></a><a id="zoningChatMessageType:ChatMessageType"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#zoningChatMessageType:net.psforever.types.ChatMessageType" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">zoningChatMessageType</span><span class="result">: <a href="../../types/ChatMessageType.html" name="net.psforever.types.ChatMessageType" id="net.psforever.types.ChatMessageType" class="extype">ChatMessageType</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#zoningCounter" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="zoningCounter:Int"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#zoningCounter:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">zoningCounter</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#zoningStatus" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="zoningStatus:net.psforever.objects.zones.Zoning.Status.Value"></a><a id="zoningStatus:objects.zones.Zoning.Status.Value"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#zoningStatus:net.psforever.objects.zones.Zoning.Status.Value" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">zoningStatus</span><span class="result">: <a href="../../objects/zones/Zoning$$Status$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.zones.Zoning.Status.Value" id="net.psforever.objects.zones.Zoning.Status.Value" class="extmbr">objects.zones.Zoning.Status.Value</a></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#zoningTimer" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="zoningTimer:akka.actor.Cancellable"></a><a id="zoningTimer:Cancellable"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#zoningTimer:akka.actor.Cancellable" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">zoningTimer</span><span class="result">: <span name="akka.actor.Cancellable" class="extype">Cancellable</span></span></span></li><li class="indented0 " name="net.psforever.actors.session.SessionActor#zoningType" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="zoningType:net.psforever.objects.zones.Zoning.Method.Value"></a><a id="zoningType:objects.zones.Zoning.Method.Value"></a> <span class="permalink"><a href="../../../../net/psforever/actors/session/SessionActor.html#zoningType:net.psforever.objects.zones.Zoning.Method.Value" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">var</span></span> <span class="symbol"><span class="name">zoningType</span><span class="result">: <a href="../../objects/zones/Zoning$$Method$.html#ValueextendsOrdered[Enumeration.this.Value]withSerializable" name="net.psforever.objects.zones.Zoning.Method.Value" id="net.psforever.objects.zones.Zoning.Method.Value" class="extmbr">objects.zones.Zoning.Method.Value</a></span></span></li></ol></div></div><div id="inheritedMembers"><div name="akka.actor.MDCContextAware" class="parent"><h3>Inherited from <a href="../../../../akka/actor/MDCContextAware.html" name="akka.actor.MDCContextAware" id="akka.actor.MDCContextAware" class="extype">MDCContextAware</a></h3></div><div name="akka.actor.ActorLogging" class="parent"><h3>Inherited from <span name="akka.actor.ActorLogging" class="extype">ActorLogging</span></h3></div><div name="akka.actor.Actor" class="parent"><h3>Inherited from <span name="akka.actor.Actor" class="extype">Actor</span></h3></div><div name="scala.AnyRef" class="parent"><h3>Inherited from <span name="scala.AnyRef" class="extype">AnyRef</span></h3></div><div name="scala.Any" class="parent"><h3>Inherited from <span name="scala.Any" class="extype">Any</span></h3></div></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
|