CustomNPC-Plus/docs/noppes/npcs/api/roles/IRoleFollower.html

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.20) on Thu May 29 16:24:46 EDT 2025 -->
<title>IRoleFollower</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2025-05-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.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.6.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="IRoleFollower";
        }
    }
    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};
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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</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.roles</a></div>
<h2 title="Interface IRoleFollower" class="title">Interface IRoleFollower</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="IRole.html" title="interface in noppes.npcs.api.roles">IRole</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">IRoleFollower</span>
extends <a href="IRole.html" title="interface in noppes.npcs.api.roles">IRole</a></pre>
</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDaysLeft(int)">addDaysLeft</a></span>&#8203;(int&nbsp;days)</code></th>
<td class="colLast">&nbsp;</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="#getDaysLeft()">getDaysLeft</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDialogFarewell()">getDialogFarewell</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDialogHire()">getDialogHire</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGuiDisabled()">getGuiDisabled</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInfiniteDays()">getInfiniteDays</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOwner()">getOwner</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRate(int)">getRate</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasOwner()">hasOwner</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFollowing()">isFollowing</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDialogFarewell(java.lang.String)">setDialogFarewell</a></span>&#8203;(java.lang.String&nbsp;dialogFarewell)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDialogHire(java.lang.String)">setDialogHire</a></span>&#8203;(java.lang.String&nbsp;dialogHire)</code></th>
<td class="colLast">&nbsp;</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="#setGuiDisabled(boolean)">setGuiDisabled</a></span>&#8203;(boolean&nbsp;disabled)</code></th>
<td class="colLast">&nbsp;</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="#setInfiniteDays(boolean)">setInfiniteDays</a></span>&#8203;(boolean&nbsp;infinite)</code></th>
<td class="colLast">&nbsp;</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="#setIsFollowing(boolean)">setIsFollowing</a></span>&#8203;(boolean&nbsp;following)</code></th>
<td class="colLast">&nbsp;</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="#setOwner(noppes.npcs.api.entity.IPlayer)">setOwner</a></span>&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player)</code></th>
<td class="colLast">&nbsp;</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="#setRate(int,int)">setRate</a></span>&#8203;(int&nbsp;index,
       int&nbsp;amount)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.noppes.npcs.api.roles.IRole">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;noppes.npcs.api.roles.<a href="IRole.html" title="interface in noppes.npcs.api.roles">IRole</a></h3>
<code><a href="IRole.html#getNpc()">getNpc</a>, <a href="IRole.html#getType()">getType</a></code></li>
</ul>
</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="setOwner(noppes.npcs.api.entity.IPlayer)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOwner</h4>
<pre class="methodSignature">void&nbsp;setOwner&#8203;(<a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;player)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - Player who is set as the owner. If null given everything resets</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="getOwner()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwner</h4>
<pre class="methodSignature"><a href="../entity/IPlayer.html" title="interface in noppes.npcs.api.entity">IPlayer</a>&nbsp;getOwner()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the followers owner. Returns null if he has no owner or the owner is offline</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="hasOwner()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasOwner</h4>
<pre class="methodSignature">boolean&nbsp;hasOwner()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns whether or not the follower has an owner</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="isFollowing()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFollowing</h4>
<pre class="methodSignature">boolean&nbsp;isFollowing()</pre>
</li>
</ul>
<a id="setIsFollowing(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsFollowing</h4>
<pre class="methodSignature">void&nbsp;setIsFollowing&#8203;(boolean&nbsp;following)</pre>
</li>
</ul>
<a id="getDaysLeft()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDaysLeft</h4>
<pre class="methodSignature">int&nbsp;getDaysLeft()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns days left</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="addDaysLeft(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDaysLeft</h4>
<pre class="methodSignature">void&nbsp;addDaysLeft&#8203;(int&nbsp;days)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>days</code> - The days you want to add to the days remaining</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="getInfiniteDays()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInfiniteDays</h4>
<pre class="methodSignature">boolean&nbsp;getInfiniteDays()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns whether or not the follower is set to infinite days</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="setInfiniteDays(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInfiniteDays</h4>
<pre class="methodSignature">void&nbsp;setInfiniteDays&#8203;(boolean&nbsp;infinite)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>infinite</code> - Sets whether the days hired are infinite</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="getGuiDisabled()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGuiDisabled</h4>
<pre class="methodSignature">boolean&nbsp;getGuiDisabled()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Return whether the gui is disabled</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="setGuiDisabled(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGuiDisabled</h4>
<pre class="methodSignature">void&nbsp;setGuiDisabled&#8203;(boolean&nbsp;disabled)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>disabled</code> - Set the gui to be disabled or not</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.10c</dd>
</dl>
</li>
</ul>
<a id="setRate(int,int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRate</h4>
<pre class="methodSignature">void&nbsp;setRate&#8203;(int&nbsp;index,
             int&nbsp;amount)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - Index of Rate [0 - 2]</dd>
<dd><code>amount</code> - Amount hired for</dd>
</dl>
</li>
</ul>
<a id="getRate(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRate</h4>
<pre class="methodSignature">int&nbsp;getRate&#8203;(int&nbsp;index)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - Index of Rate [0 - 2]</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>amount fired for</dd>
</dl>
</li>
</ul>
<a id="setDialogHire(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDialogHire</h4>
<pre class="methodSignature">void&nbsp;setDialogHire&#8203;(java.lang.String&nbsp;dialogHire)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dialogHire</code> - New dialog hire string</dd>
</dl>
</li>
</ul>
<a id="getDialogHire()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDialogHire</h4>
<pre class="methodSignature">java.lang.String&nbsp;getDialogHire()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>dialog hire string</dd>
</dl>
</li>
</ul>
<a id="setDialogFarewell(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDialogFarewell</h4>
<pre class="methodSignature">void&nbsp;setDialogFarewell&#8203;(java.lang.String&nbsp;dialogFarewell)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dialogFarewell</code> - New dialog farewell string</dd>
</dl>
</li>
</ul>
<a id="getDialogFarewell()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDialogFarewell</h4>
<pre class="methodSignature">java.lang.String&nbsp;getDialogFarewell()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>dialog farewell string</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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</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>