PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-13 03:33:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/serverobject/aura/AuraEffectBehavior.html

12 lines
42 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ de87845bfee16adddce765f6b06e3aad94b78749 🚀
2020-08-28 04:36:33 +00:00
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.serverobject.aura.AuraEffectBehavior</title><meta content="PSF - LoginServer - master - net.psforever.objects.serverobject.aura.AuraEffectBehavior" name="description"/><meta content="PSF LoginServer master net.psforever.objects.serverobject.aura.AuraEffectBehavior" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../../lib/index.js"></script><script type="text/javascript" src="../../../../../index.js"></script><script type="text/javascript" src="../../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.serverobject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="serverobject"></a><a id="serverobject:serverobject"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/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
on a target with control agency.</p></div><dl class="attributes block"><dt>Self Type</dt><dd><a href="" name="net.psforever.objects.serverobject.aura.AuraEffectBehavior" id="net.psforever.objects.serverobject.aura.AuraEffectBehavior" class="extype">AuraEffectBehavior</a> with <span name="akka.actor.Actor" class="extype">Actor</span></dd><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/objects/serverobject/aura/AuraEffectBehavior.scala" target="_blank">AuraEffectBehavior.scala</a></dd><dt>See also</dt><dd><span class="cmt"><p><code>Aura</code></p></span><span class="cmt"><p><code>AuraContainer</code></p></span><span class="cmt"><p><code>PlayerControl</code></p></span></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div><div class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="../../avatar/PlayerControl.html" name="net.psforever.objects.avatar.PlayerControl" id="net.psforever.objects.avatar.PlayerControl" class="extype">PlayerControl</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.objects.serverobject.aura.AuraEffectBehavior"><span>AuraEffectBehavior</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 class="values members"><h3>Abstract Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.serverobject.aura.AuraEffectBehavior#AuraTargetObject" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="AuraTargetObject:net.psforever.objects.serverobject.aura.AuraEffectBehavior.Target"></a><a id="AuraTargetObject:Target"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/aura/AuraEffectBehavior.html#AuraTargetObject:net.psforever.objects.serverobject.aura.AuraEffectBehavior.Target" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">AuraTargetObject</span><span class="result">: <a href="AuraEffectBehavior$.html#Target=net.psforever.objects.serverobject.PlanetSideServerObjectwithnet.psforever.objects.serverobject.aura.AuraContainer" name="net.psforever.objects.serverobject.aura.AuraEffectBehavior.Target" id="net.psforever.objects.serverobject.aura.AuraEffectBehavior.Target" class="extmbr">Target</a></span></span></li><li class="indented0 " name="net.psforever.objects.serverobject.aura.AuraEffectBehavior#UpdateAuraEffect" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="UpdateAuraEffect(target:net.psforever.objects.serverobject.aura.AuraEffectBehavior.Target):Unit"></a><a id="UpdateAuraEffect(Target):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/obje
Animate the new particle effect state.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.aura.AuraEffectBehavior#EndAuraEffect" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EndAuraEffect(effect:net.psforever.objects.serverobject.aura.Aura):Boolean"></a><a id="EndAuraEffect(Aura):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/aura/AuraEffectBehavior.html#EndAuraEffect(effect:net.psforever.objects.serverobject.aura.Aura):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">EndAuraEffect</span><span class="params">(<span name="effect">effect: <a href="Aura.html" name="net.psforever.objects.serverobject.aura.Aura" id="net.psforever.objects.serverobject.aura.Aura" class="extype">Aura</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Stop the target entity from emitting the aura particle effect, if it currently is.</p><div class="fullcomment"><div class="comment cmt"><p>Stop the target entity from emitting the aura particle effect, if it currently is.</p></div><dl class="paramcmts block"><dt class="param">effect</dt><dd class="cmt"><p>the target effect</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the effect was being emitted but has been stopped
<code>false</code>, if the effect was not approved or is not being emitted</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.aura.AuraEffectBehavior#EndAuraEffectAndUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EndAuraEffectAndUpdate(effect:net.psforever.objects.serverobject.aura.Aura):Unit"></a><a id="EndAuraEffectAndUpdate(Aura):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/aura/AuraEffectBehavior.html#EndAuraEffectAndUpdate(effect:net.psforever.objects.serverobject.aura.Aura):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">EndAuraEffectAndUpdate</span><span class="params">(<span name="effect">effect: <a href="Aura.html" name="net.psforever.objects.serverobject.aura.Aura" id="net.psforever.objects.serverobject.aura.Aura" class="extype">Aura</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Stop the target entity from emitting the aura particle effect, if it currently is.</p><div class="fullcomment"><div class="comment cmt"><p>Stop the target entity from emitting the aura particle effect, if it currently is.
If the effect has been stopped, animate the new particle effect state.
</p></div></div></li><li class="indented0 " name="net.psforever.objects.serverobject.aura.AuraEffectBehavior#StartAuraEffect" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StartAuraEffect(effect:net.psforever.objects.serverobject.aura.Aura,duration:Long):Unit"></a><a id="StartAuraEffect(Aura,Long):Unit"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/aura/AuraEffectBehavior.html#StartAuraEffect(effect:net.psforever.objects.serverobject.aura.Aura,duration: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">StartAuraEffect</span><span class="params">(<span name="effect">effect: <a href="Aura.html" name="net.psforever.objects.serverobject.aura.Aura" id="net.psforever.objects.serverobject.aura.Aura" class="extype">Aura</a></span>, <span name="duration">duration: <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">An aura particle effect is to be emitted by the target.</p><div class="fullcomment"><div class="comment cmt"><p>An aura particle effect is to be emitted by the target.
If the effect was not previously applied to the target in an ongoing manner,
animate it appropriately.</p></div><dl class="paramcmts block"><dt class="param">effect</dt><dd class="cmt"><p>the effect to be emitted</p></dd><dt class="param">duration</dt><dd class="cmt"><p>for how long the effect will be emitted</p></dd><dt>returns</dt><dd class="cmt"><p>the active effect index number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.serverobject.aura.AuraEffectBehavior#TestForEffect" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TestForEffect(effect:net.psforever.objects.serverobject.aura.Aura):Boolean"></a><a id="TestForEffect(Aura):Boolean"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/aura/AuraEffectBehavior.html#TestForEffect(effect:net.psforever.objects.serverobject.aura.Aura):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">TestForEffect</span><span class="params">(<span name="effect">effect: <a href="Aura.html" name="net.psforever.objects.serverobject.aura.Aura" id="net.psforever.objects.serverobject.aura.Aura" class="extype">Aura</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Is the target entity emitting the aura effect?</p><div class="fullcomment"><div class="comment cmt"><p>Is the target entity emitting the aura effect?</p></div><dl class="paramcmts block"><dt class="param">effect</dt><dd class="cmt"><p>the effect being tested</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the effect is currently being emitted;
<code>false</code>, otherwise</p></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/objects/serverobject/aura/AuraEffectBehavior.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.objects.serverobject.aura.AuraEffectBehavior#auraBehavior" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="auraBehavior:AuraEffectBehavior.this.Receive"></a><a id="auraBehavior:(AuraEffectBehavior.this)#Receive"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/serverobject/aura/AuraEffectBehavior.html#auraBehavior:AuraEffectBehavior.this.Receive" 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">auraBehavior</span><span class="result">: (<a href="" name="net.psforever.objects.serverobject.aura.AuraEffectBehavior" id="net.psforever.objects.serverobject.aura.AuraEffectBehavior" class="extype">AuraEffectBehavior</a>.this)#<span name="akka.actor.Actor.Receive" class="extype">Receive</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/objects/serverobject/aura/AuraEffectBehavior.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="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/objects/serverobject/aura/AuraEffectBehavior.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/objects/serverobject/aura/AuraEffectBehavior.html#equals(x$1:Object):Boolean" title="Permalink"><i class="material-icons"></i
Reference in a new issue Copy permalink