Files
CustomNPC-Plus/experimental/dev/noppes/npcs/api/ITelegraph.html
T
2026-03-13 21:21:55 +00:00

882 lines
32 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ITelegraph (CustomNPC-Plus 1.11.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../javadoc-theme.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ITelegraph (CustomNPC-Plus 1.11.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><div id="javadoc-header"> <a href="/CustomNPC-Plus/" class="header-brand"> <div class="header-title"> CustomNPC+ <span>Javadoc Reference</span> </div> </a> <a href="/CustomNPC-Plus/" class="header-back"> Back to Index </a> </div></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">noppes.npcs.api</a></div>
<h2 title="Interface ITelegraph" class="title">Interface ITelegraph</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">ITelegraph</span></pre>
<div class="block">A telegraph is a visual warning indicator that displays on the ground.
Telegraphs are commonly used to warn players of incoming attacks or mark areas of effect.
<p>
To create a telegraph:
<pre>
var telegraph = API.getTelegraphs().createCircle(5.0);
telegraph.setDuration(60); // 3 seconds
telegraph.setColor(0x80FF0000); // Semi-transparent red
var instance = telegraph.spawn(world, x, y, z);
</pre>
<p>
Telegraph types:
<ul>
<li>CIRCLE - A filled circle with a radius</li>
<li>RING - A ring with inner and outer radius</li>
<li>LINE - A rectangular line in a direction</li>
<li>CONE - A cone/arc shape</li>
<li>SQUARE - A square shape</li>
<li>POINT - A small point marker</li>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAngle()">getAngle</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the angle in degrees (for CONE type).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getColor()">getColor</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the primary color in ARGB format.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDuration()">getDuration</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the duration in ticks.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeightOffset()">getHeightOffset</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the height offset from ground level.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInnerRadius()">getInnerRadius</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the inner radius (for RING type).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLength()">getLength</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the length (for LINE and CONE types).</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRadius()">getRadius</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the radius (for CIRCLE, SQUARE and RING types).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the telegraph type.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWarningColor()">getWarningColor</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the warning phase color in ARGB format.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWarningStartTick()">getWarningStartTick</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the tick at which warning phase begins.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWidth()">getWidth</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the width (for LINE type).</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAnimated()">isAnimated</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if pulsing animation is enabled.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAngle(float)">setAngle</a></span>&#8203;(float&nbsp;angle)</code></th>
<td class="colLast">
<div class="block">Set the angle in degrees (for CONE type).</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAnimated(boolean)">setAnimated</a></span>&#8203;(boolean&nbsp;animated)</code></th>
<td class="colLast">
<div class="block">Enable or disable pulsing animation.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setColor(int)">setColor</a></span>&#8203;(int&nbsp;argb)</code></th>
<td class="colLast">
<div class="block">Set the primary color in ARGB format.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDuration(int)">setDuration</a></span>&#8203;(int&nbsp;ticks)</code></th>
<td class="colLast">
<div class="block">Set the duration in ticks (20 ticks = 1 second).</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHeightOffset(float)">setHeightOffset</a></span>&#8203;(float&nbsp;offset)</code></th>
<td class="colLast">
<div class="block">Set the height offset from ground level.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInnerRadius(float)">setInnerRadius</a></span>&#8203;(float&nbsp;innerRadius)</code></th>
<td class="colLast">
<div class="block">Set the inner radius (for RING type).</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLength(float)">setLength</a></span>&#8203;(float&nbsp;length)</code></th>
<td class="colLast">
<div class="block">Set the length (for LINE and CONE types).</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRadius(float)">setRadius</a></span>&#8203;(float&nbsp;radius)</code></th>
<td class="colLast">
<div class="block">Set the radius (for CIRCLE, SQUARE and RING types).</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setType(java.lang.String)">setType</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Set the telegraph type.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWarningColor(int)">setWarningColor</a></span>&#8203;(int&nbsp;argb)</code></th>
<td class="colLast">
<div class="block">Set the warning phase color in ARGB format.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWarningStartTick(int)">setWarningStartTick</a></span>&#8203;(int&nbsp;tick)</code></th>
<td class="colLast">
<div class="block">Set the tick at which warning phase begins.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWidth(float)">setWidth</a></span>&#8203;(float&nbsp;width)</code></th>
<td class="colLast">
<div class="block">Set the width (for LINE type).</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="ITelegraphInstance.html" title="interface in noppes.npcs.api">ITelegraphInstance</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#spawn(noppes.npcs.api.entity.IEntity)">spawn</a></span>&#8203;(<a href="entity/IEntity.html" title="interface in noppes.npcs.api.entity">IEntity</a>&nbsp;entity)</code></th>
<td class="colLast">
<div class="block">Spawn this telegraph following an entity.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="ITelegraphInstance.html" title="interface in noppes.npcs.api">ITelegraphInstance</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#spawn(noppes.npcs.api.entity.IEntity,float)">spawn</a></span>&#8203;(<a href="entity/IEntity.html" title="interface in noppes.npcs.api.entity">IEntity</a>&nbsp;entity,
float&nbsp;yaw)</code></th>
<td class="colLast">
<div class="block">Spawn this telegraph following an entity with rotation.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="ITelegraphInstance.html" title="interface in noppes.npcs.api">ITelegraphInstance</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#spawn(noppes.npcs.api.IWorld,double,double,double)">spawn</a></span>&#8203;(<a href="IWorld.html" title="interface in noppes.npcs.api">IWorld</a>&nbsp;world,
double&nbsp;x,
double&nbsp;y,
double&nbsp;z)</code></th>
<td class="colLast">
<div class="block">Spawn this telegraph at a position.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="ITelegraphInstance.html" title="interface in noppes.npcs.api">ITelegraphInstance</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#spawn(noppes.npcs.api.IWorld,double,double,double,float)">spawn</a></span>&#8203;(<a href="IWorld.html" title="interface in noppes.npcs.api">IWorld</a>&nbsp;world,
double&nbsp;x,
double&nbsp;y,
double&nbsp;z,
float&nbsp;yaw)</code></th>
<td class="colLast">
<div class="block">Spawn this telegraph at a position with rotation.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getType()</pre>
<div class="block">Get the telegraph type.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Type name: "CIRCLE", "RING", "LINE", "CONE", "SQUARE", or "POINT"</dd>
</dl>
</li>
</ul>
<a id="setType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setType</h4>
<pre class="methodSignature">void&nbsp;setType&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;type)</pre>
<div class="block">Set the telegraph type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Type name: "circle", "ring", "line", "cone", "square", or "point" (case insensitive)</dd>
</dl>
</li>
</ul>
<a id="getRadius()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRadius</h4>
<pre class="methodSignature">float&nbsp;getRadius()</pre>
<div class="block">Get the radius (for CIRCLE, SQUARE and RING types).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the circle/ring radius in blocks</dd>
</dl>
</li>
</ul>
<a id="setRadius(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRadius</h4>
<pre class="methodSignature">void&nbsp;setRadius&#8203;(float&nbsp;radius)</pre>
<div class="block">Set the radius (for CIRCLE, SQUARE and RING types).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>radius</code> - circle/ring radius in blocks</dd>
</dl>
</li>
</ul>
<a id="getInnerRadius()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInnerRadius</h4>
<pre class="methodSignature">float&nbsp;getInnerRadius()</pre>
<div class="block">Get the inner radius (for RING type).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the inner radius for RING type in blocks</dd>
</dl>
</li>
</ul>
<a id="setInnerRadius(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInnerRadius</h4>
<pre class="methodSignature">void&nbsp;setInnerRadius&#8203;(float&nbsp;innerRadius)</pre>
<div class="block">Set the inner radius (for RING type).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>innerRadius</code> - inner radius for RING type in blocks</dd>
</dl>
</li>
</ul>
<a id="getLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLength</h4>
<pre class="methodSignature">float&nbsp;getLength()</pre>
<div class="block">Get the length (for LINE and CONE types).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the length for LINE/CONE types in blocks</dd>
</dl>
</li>
</ul>
<a id="setLength(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLength</h4>
<pre class="methodSignature">void&nbsp;setLength&#8203;(float&nbsp;length)</pre>
<div class="block">Set the length (for LINE and CONE types).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>length</code> - length for LINE/CONE types in blocks</dd>
</dl>
</li>
</ul>
<a id="getWidth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidth</h4>
<pre class="methodSignature">float&nbsp;getWidth()</pre>
<div class="block">Get the width (for LINE type).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the width for LINE type in blocks</dd>
</dl>
</li>
</ul>
<a id="setWidth(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWidth</h4>
<pre class="methodSignature">void&nbsp;setWidth&#8203;(float&nbsp;width)</pre>
<div class="block">Set the width (for LINE type).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>width</code> - width for LINE type in blocks</dd>
</dl>
</li>
</ul>
<a id="getAngle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAngle</h4>
<pre class="methodSignature">float&nbsp;getAngle()</pre>
<div class="block">Get the angle in degrees (for CONE type).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the arc angle for CONE type in degrees</dd>
</dl>
</li>
</ul>
<a id="setAngle(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAngle</h4>
<pre class="methodSignature">void&nbsp;setAngle&#8203;(float&nbsp;angle)</pre>
<div class="block">Set the angle in degrees (for CONE type).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>angle</code> - arc angle for CONE type in degrees</dd>
</dl>
</li>
</ul>
<a id="getDuration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDuration</h4>
<pre class="methodSignature">int&nbsp;getDuration()</pre>
<div class="block">Get the duration in ticks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>duration in ticks (20 ticks = 1 second)</dd>
</dl>
</li>
</ul>
<a id="setDuration(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDuration</h4>
<pre class="methodSignature">void&nbsp;setDuration&#8203;(int&nbsp;ticks)</pre>
<div class="block">Set the duration in ticks (20 ticks = 1 second).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ticks</code> - duration in ticks (20 ticks = 1 second)</dd>
</dl>
</li>
</ul>
<a id="getColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColor</h4>
<pre class="methodSignature">int&nbsp;getColor()</pre>
<div class="block">Get the primary color in ARGB format.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the primary color in ARGB format</dd>
</dl>
</li>
</ul>
<a id="setColor(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColor</h4>
<pre class="methodSignature">void&nbsp;setColor&#8203;(int&nbsp;argb)</pre>
<div class="block">Set the primary color in ARGB format.
Example: 0x80FF0000 for semi-transparent red</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>argb</code> - primary color in ARGB format (e.g. 0x80FF0000)</dd>
</dl>
</li>
</ul>
<a id="getWarningColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarningColor</h4>
<pre class="methodSignature">int&nbsp;getWarningColor()</pre>
<div class="block">Get the warning phase color in ARGB format.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the warning phase color in ARGB format</dd>
</dl>
</li>
</ul>
<a id="setWarningColor(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWarningColor</h4>
<pre class="methodSignature">void&nbsp;setWarningColor&#8203;(int&nbsp;argb)</pre>
<div class="block">Set the warning phase color in ARGB format.
This color is used during the final warning phase.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>argb</code> - warning phase color in ARGB format</dd>
</dl>
</li>
</ul>
<a id="getWarningStartTick()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarningStartTick</h4>
<pre class="methodSignature">int&nbsp;getWarningStartTick()</pre>
<div class="block">Get the tick at which warning phase begins.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tick at which warning phase begins</dd>
</dl>
</li>
</ul>
<a id="setWarningStartTick(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWarningStartTick</h4>
<pre class="methodSignature">void&nbsp;setWarningStartTick&#8203;(int&nbsp;tick)</pre>
<div class="block">Set the tick at which warning phase begins.
When remaining ticks falls below this value, the telegraph uses the warning color.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tick</code> - tick at which warning phase begins</dd>
</dl>
</li>
</ul>
<a id="isAnimated()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAnimated</h4>
<pre class="methodSignature">boolean&nbsp;isAnimated()</pre>
<div class="block">Check if pulsing animation is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if pulsing animation is enabled</dd>
</dl>
</li>
</ul>
<a id="setAnimated(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAnimated</h4>
<pre class="methodSignature">void&nbsp;setAnimated&#8203;(boolean&nbsp;animated)</pre>
<div class="block">Enable or disable pulsing animation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>animated</code> - whether pulsing animation is enabled</dd>
</dl>
</li>
</ul>
<a id="getHeightOffset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeightOffset</h4>
<pre class="methodSignature">float&nbsp;getHeightOffset()</pre>
<div class="block">Get the height offset from ground level.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the height offset from ground level in blocks</dd>
</dl>
</li>
</ul>
<a id="setHeightOffset(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeightOffset</h4>
<pre class="methodSignature">void&nbsp;setHeightOffset&#8203;(float&nbsp;offset)</pre>
<div class="block">Set the height offset from ground level.
Default is 0.1 to prevent z-fighting with ground blocks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offset</code> - height offset from ground level in blocks</dd>
</dl>
</li>
</ul>
<a id="spawn(noppes.npcs.api.IWorld,double,double,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spawn</h4>
<pre class="methodSignature"><a href="ITelegraphInstance.html" title="interface in noppes.npcs.api">ITelegraphInstance</a>&nbsp;spawn&#8203;(<a href="IWorld.html" title="interface in noppes.npcs.api">IWorld</a>&nbsp;world,
double&nbsp;x,
double&nbsp;y,
double&nbsp;z)</pre>
<div class="block">Spawn this telegraph at a position.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>world</code> - The world to spawn in</dd>
<dd><code>x</code> - X position</dd>
<dd><code>y</code> - Y position</dd>
<dd><code>z</code> - Z position</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The spawned telegraph instance</dd>
</dl>
</li>
</ul>
<a id="spawn(noppes.npcs.api.IWorld,double,double,double,float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spawn</h4>
<pre class="methodSignature"><a href="ITelegraphInstance.html" title="interface in noppes.npcs.api">ITelegraphInstance</a>&nbsp;spawn&#8203;(<a href="IWorld.html" title="interface in noppes.npcs.api">IWorld</a>&nbsp;world,
double&nbsp;x,
double&nbsp;y,
double&nbsp;z,
float&nbsp;yaw)</pre>
<div class="block">Spawn this telegraph at a position with rotation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>world</code> - The world to spawn in</dd>
<dd><code>x</code> - X position</dd>
<dd><code>y</code> - Y position</dd>
<dd><code>z</code> - Z position</dd>
<dd><code>yaw</code> - Rotation yaw (for directional telegraphs like LINE/CONE)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The spawned telegraph instance</dd>
</dl>
</li>
</ul>
<a id="spawn(noppes.npcs.api.entity.IEntity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spawn</h4>
<pre class="methodSignature"><a href="ITelegraphInstance.html" title="interface in noppes.npcs.api">ITelegraphInstance</a>&nbsp;spawn&#8203;(<a href="entity/IEntity.html" title="interface in noppes.npcs.api.entity">IEntity</a>&nbsp;entity)</pre>
<div class="block">Spawn this telegraph following an entity.
The telegraph will update its position to follow the entity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - The entity to follow</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The spawned telegraph instance</dd>
</dl>
</li>
</ul>
<a id="spawn(noppes.npcs.api.entity.IEntity,float)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>spawn</h4>
<pre class="methodSignature"><a href="ITelegraphInstance.html" title="interface in noppes.npcs.api">ITelegraphInstance</a>&nbsp;spawn&#8203;(<a href="entity/IEntity.html" title="interface in noppes.npcs.api.entity">IEntity</a>&nbsp;entity,
float&nbsp;yaw)</pre>
<div class="block">Spawn this telegraph following an entity with rotation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - The entity to follow</dd>
<dd><code>yaw</code> - Rotation yaw</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The spawned telegraph instance</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><script> (function() { // Fix uppercase text in table cells // Javadoc 11: method names are in th[scope="row"] a, not td a function fixCase() { document.querySelectorAll("th[scope='row'] a, td a, .memberNameLink a").forEach(function(el) { var t = el.textContent.trim(); if (t.length > 2 && t === t.toUpperCase() && t.indexOf(" ") === -1) { el.textContent = t.toLowerCase(); } }); } // Correct navPadding = topNav height + subNav height // Uses !important to override jQuery's inline style function fixPadding() { var topNav = document.querySelector(".topNav"); var subNav = document.querySelector(".subNav"); var pad = document.querySelector(".navPadding"); if (!pad) return; var h = (topNav ? topNav.offsetHeight : 0) + (subNav ? subNav.offsetHeight : 0); if (h > 0) { pad.style.setProperty("padding-top", h + "px", "important"); } } document.addEventListener("DOMContentLoaded", function() { fixCase(); // Run fixPadding after jQuery has had its chance setTimeout(fixPadding, 0); setTimeout(fixPadding, 50); setTimeout(fixPadding, 200); // Use MutationObserver to permanently override any further jQuery writes var pad = document.querySelector(".navPadding"); if (pad) { var observer = new MutationObserver(function() { fixPadding(); }); observer.observe(pad, { attributes: true, attributeFilter: ["style"] }); } }); })(); </script></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>