mirror of
https://github.com/KAMKEEL/CustomNPC-Plus.git
synced 2026-11-11 21:57:40 +00:00
1037 lines
54 KiB
HTML
1037 lines
54 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.20) on Thu May 29 16:24:46 EDT 2025 -->
|
|
<title>IActionManager</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="IActionManager";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":18,"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,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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"> </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> <a href="package-summary.html">noppes.npcs.api.handler</a></div>
|
|
<h2 title="Interface IActionManager" class="title">Interface IActionManager</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<pre>public interface <span class="typeNameLabel">IActionManager</span></pre>
|
|
<div class="block">Manages a queue of <a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data"><code>IAction</code></a> instances, allowing scheduling of delayed,
|
|
repeating, or conditional "tasks" for NPC scripting.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </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>default void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addConditionalTask(java.lang.String,java.util.function.Supplier,java.util.function.Consumer)">addConditionalTask</a></span>​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Convenience: create & enqueue a conditional task that re-checks forever.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>default void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addConditionalTask(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier)">addConditionalTask</a></span>​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Convenience: create & enqueue a conditional task that gives up after maxChecks.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>default void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSingleTask(java.lang.String,int,java.util.function.Consumer)">addSingleTask</a></span>​(java.lang.String name,
|
|
int startAfterTicks,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Convenience: create & enqueue a task that will fire exactly once
|
|
after the given delay, and then auto-complete.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>default void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSingleTask(java.lang.String,java.util.function.Consumer)">addSingleTask</a></span>​(java.lang.String name,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Same as above, but fires immediately (no delay).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>default void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTask(java.lang.String,int,int,java.util.function.Consumer)">addTask</a></span>​(java.lang.String name,
|
|
int maxDuration,
|
|
int startAfterTicks,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Convenience: create and enqueue a normal repeating task.</div>
|
|
</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="#cancelAction(java.lang.String)">cancelAction</a></span>​(java.lang.String name)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Cancel (remove) the first queued action with the given name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IActionChain.html" title="interface in noppes.npcs.api.handler.data">IActionChain</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#chain()">chain</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Remove every scheduled action immediately.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(int,java.util.function.Consumer)">create</a></span>​(int delay,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> t)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String)">create</a></span>​(java.lang.String name)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String,int,int,java.util.function.Consumer)">create</a></span>​(java.lang.String name,
|
|
int maxDuration,
|
|
int startAfterTicks,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> action)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create a new action instance without immediately scheduling it.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String,int,java.util.function.Consumer)">create</a></span>​(java.lang.String name,
|
|
int delay,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> t)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String,java.util.function.Consumer)">create</a></span>​(java.lang.String name,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> t)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String,java.util.function.Supplier,java.util.function.Consumer)">create</a></span>​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier)">create</a></span>​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier,java.util.function.Consumer)">create</a></span>​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> onTermination)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.util.function.Consumer)">create</a></span>​(java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> t)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.util.function.Supplier,java.util.function.Consumer)">create</a></span>​(java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier)">create</a></span>​(java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier,java.util.function.Consumer)">create</a></span>​(java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> onTermination)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code>java.util.Queue<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActionQueue()">getActionQueue</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Retrieve the entire action queue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>java.util.List<<a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConditionalActions()">getConditionalActions</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentAction()">getCurrentAction</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Peek at the next action to run (the head of the queue).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndex(noppes.npcs.api.handler.data.IAction)">getIndex</a></span>​(<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> action)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the zero-based position of an action in the queue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IActionChain.html" title="interface in noppes.npcs.api.handler.data">IActionChain</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parallelChain()">parallelChain</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduleAction(java.lang.String,int,int,java.util.function.Consumer)">scheduleAction</a></span>​(java.lang.String name,
|
|
int maxDuration,
|
|
int startAfterTicks,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> action)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Convenience for <a href="#create(java.lang.String,int,int,java.util.function.Consumer)"><code>create(String, int, int, Consumer)</code></a> + enqueue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduleAction(java.lang.String,java.util.function.Supplier,java.util.function.Consumer)">scheduleAction</a></span>​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduleAction(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier)">scheduleAction</a></span>​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduleAction(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier,java.util.function.Consumer)">scheduleAction</a></span>​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> onTermination)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduleAction(noppes.npcs.api.handler.data.actions.IConditionalAction)">scheduleAction</a></span>​(<a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> action)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduleAction(noppes.npcs.api.handler.data.IAction)">scheduleAction</a></span>​(<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> action)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Schedule an existing action for execution.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduleActionAt(int,noppes.npcs.api.handler.data.IAction)">scheduleActionAt</a></span>​(int index,
|
|
<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> action)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Insert an action at a specific position in the queue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduleParallelAction(noppes.npcs.api.handler.data.IAction)">scheduleParallelAction</a></span>​(<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> action)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Begin processing scheduled actions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Halt processing of actions.</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="create(java.lang.String,int,int,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> create​(java.lang.String name,
|
|
int maxDuration,
|
|
int startAfterTicks,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> action)</pre>
|
|
<div class="block">Create a new action instance without immediately scheduling it.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - a unique name for this action</dd>
|
|
<dd><code>maxDuration</code> - the maximum lifetime of the action in ticks</dd>
|
|
<dd><code>startAfterTicks</code> - number of ticks to wait before the first run</dd>
|
|
<dd><code>action</code> - code to execute each time the action "fires"</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a fresh <a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data"><code>IAction</code></a> object</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.lang.String,int,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> create​(java.lang.String name,
|
|
int delay,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> t)</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="create(int,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> create​(int delay,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> t)</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.lang.String,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> create​(java.lang.String name,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> t)</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> create​(java.lang.String name)</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> create​(java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> t)</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.util.function.Supplier,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> create​(java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.lang.String,java.util.function.Supplier,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> create​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - unique name</dd>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> create​(java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dd><code>terminateWhen</code> - supplier checked every tick, if it returns true, action is terminated (gets marked done)</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> create​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - unique name</dd>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dd><code>terminateWhen</code> - supplier checked every tick, if it returns true, action is terminated (gets marked done)</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> create​(java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> onTermination)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dd><code>terminateWhen</code> - supplier checked every tick, if it returns true, action is terminated (gets marked done)</dd>
|
|
<dd><code>onTermination</code> - code to run when the termination condition returns true</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="create(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>create</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> create​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> onTermination)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - unique name</dd>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dd><code>terminateWhen</code> - supplier checked every tick, if it returns true, action is terminated (gets marked done)</dd>
|
|
<dd><code>onTermination</code> - code to run when the termination condition returns true</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="start()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>start</h4>
|
|
<pre class="methodSignature">void start()</pre>
|
|
<div class="block">Begin processing scheduled actions. Must be called once.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="stop()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>stop</h4>
|
|
<pre class="methodSignature">void stop()</pre>
|
|
<div class="block">Halt processing of actions. Queued actions remain but will not run until
|
|
<a href="#start()"><code>start()</code></a> is called again.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="scheduleAction(noppes.npcs.api.handler.data.IAction)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>scheduleAction</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> scheduleAction​(<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> action)</pre>
|
|
<div class="block">Schedule an existing action for execution.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>action</code> - the action to enqueue</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="scheduleAction(java.lang.String,int,int,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>scheduleAction</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> scheduleAction​(java.lang.String name,
|
|
int maxDuration,
|
|
int startAfterTicks,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> action)</pre>
|
|
<div class="block">Convenience for <a href="#create(java.lang.String,int,int,java.util.function.Consumer)"><code>create(String, int, int, Consumer)</code></a> + enqueue.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - a unique name for this action</dd>
|
|
<dd><code>maxDuration</code> - the maximum lifetime of the action in ticks</dd>
|
|
<dd><code>startAfterTicks</code> - number of ticks to wait before the first run</dd>
|
|
<dd><code>action</code> - code to execute each time the action "fires"</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="scheduleActionAt(int,noppes.npcs.api.handler.data.IAction)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>scheduleActionAt</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> scheduleActionAt​(int index,
|
|
<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> action)</pre>
|
|
<div class="block">Insert an action at a specific position in the queue.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>index</code> - zero-based queue position to insert at</dd>
|
|
<dd><code>action</code> - the action to insert</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getIndex(noppes.npcs.api.handler.data.IAction)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getIndex</h4>
|
|
<pre class="methodSignature">int getIndex​(<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> action)</pre>
|
|
<div class="block">Get the zero-based position of an action in the queue.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>action</code> - the action to look up</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>its index, or -1 if not found</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getCurrentAction()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCurrentAction</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> getCurrentAction()</pre>
|
|
<div class="block">Peek at the next action to run (the head of the queue).</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the current head action, or null if queue is empty</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getActionQueue()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getActionQueue</h4>
|
|
<pre class="methodSignature">java.util.Queue<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> getActionQueue()</pre>
|
|
<div class="block">Retrieve the entire action queue.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>live reference to the internal <code>Queue</code> of actions</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="scheduleAction(java.lang.String,java.util.function.Supplier,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>scheduleAction</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> scheduleAction​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - unique name</dd>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="scheduleAction(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>scheduleAction</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> scheduleAction​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - unique name</dd>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dd><code>terminateWhen</code> - supplier checked every tick, if it returns true, action is terminated (gets marked done)</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="scheduleAction(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>scheduleAction</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> scheduleAction​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> onTermination)</pre>
|
|
<div class="block">Schedule a conditional action that gives up after at most maxChecks attempts.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - unique name</dd>
|
|
<dd><code>condition</code> - supplier checked every tick, if it returns true, task is fired</dd>
|
|
<dd><code>task</code> - code to run once condition first becomes true</dd>
|
|
<dd><code>terminateWhen</code> - supplier checked every tick, if it returns true, action is terminated (gets marked done)</dd>
|
|
<dd><code>onTermination</code> - code to run when the termination condition returns true</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action scheduled</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="scheduleAction(noppes.npcs.api.handler.data.actions.IConditionalAction)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>scheduleAction</h4>
|
|
<pre class="methodSignature"><a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> scheduleAction​(<a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a> action)</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="getConditionalActions()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getConditionalActions</h4>
|
|
<pre class="methodSignature">java.util.List<<a href="data/actions/IConditionalAction.html" title="interface in noppes.npcs.api.handler.data.actions">IConditionalAction</a>> getConditionalActions()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the list of all conditional actions</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="cancelAction(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>cancelAction</h4>
|
|
<pre class="methodSignature">boolean cancelAction​(java.lang.String name)</pre>
|
|
<div class="block">Cancel (remove) the first queued action with the given name.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name assigned when scheduling</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if one was found and removed, false otherwise</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="clear()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>clear</h4>
|
|
<pre class="methodSignature">void clear()</pre>
|
|
<div class="block">Remove every scheduled action immediately.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="addTask(java.lang.String,int,int,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addTask</h4>
|
|
<pre class="methodSignature">default void addTask​(java.lang.String name,
|
|
int maxDuration,
|
|
int startAfterTicks,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</pre>
|
|
<div class="block">Convenience: create and enqueue a normal repeating task.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="addSingleTask(java.lang.String,int,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addSingleTask</h4>
|
|
<pre class="methodSignature">default void addSingleTask​(java.lang.String name,
|
|
int startAfterTicks,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</pre>
|
|
<div class="block">Convenience: create & enqueue a task that will fire exactly once
|
|
after the given delay, and then auto-complete.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - a unique name for this action</dd>
|
|
<dd><code>startAfterTicks</code> - delay before it runs (in ticks)</dd>
|
|
<dd><code>task</code> - code to execute once</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="addSingleTask(java.lang.String,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addSingleTask</h4>
|
|
<pre class="methodSignature">default void addSingleTask​(java.lang.String name,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</pre>
|
|
<div class="block">Same as above, but fires immediately (no delay).</div>
|
|
</li>
|
|
</ul>
|
|
<a id="addConditionalTask(java.lang.String,java.util.function.Supplier,java.util.function.Consumer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addConditionalTask</h4>
|
|
<pre class="methodSignature">default void addConditionalTask​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task)</pre>
|
|
<div class="block">Convenience: create & enqueue a conditional task that re-checks forever.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="addConditionalTask(java.lang.String,java.util.function.Supplier,java.util.function.Consumer,java.util.function.Supplier)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addConditionalTask</h4>
|
|
<pre class="methodSignature">default void addConditionalTask​(java.lang.String name,
|
|
java.util.function.Supplier<java.lang.Boolean> condition,
|
|
java.util.function.Consumer<<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a>> task,
|
|
java.util.function.Supplier<java.lang.Boolean> terminateWhen)</pre>
|
|
<div class="block">Convenience: create & enqueue a conditional task that gives up after maxChecks.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="scheduleParallelAction(noppes.npcs.api.handler.data.IAction)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>scheduleParallelAction</h4>
|
|
<pre class="methodSignature"><a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> scheduleParallelAction​(<a href="data/IAction.html" title="interface in noppes.npcs.api.handler.data">IAction</a> action)</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="chain()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>chain</h4>
|
|
<pre class="methodSignature"><a href="data/IActionChain.html" title="interface in noppes.npcs.api.handler.data">IActionChain</a> chain()</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="parallelChain()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>parallelChain</h4>
|
|
<pre class="methodSignature"><a href="data/IActionChain.html" title="interface in noppes.npcs.api.handler.data">IActionChain</a> parallelChain()</pre>
|
|
</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 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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>
|