mirror of
https://github.com/Minestom/Minestom.git
synced 2024-11-08 03:40:27 +01:00
349 lines
18 KiB
HTML
349 lines
18 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>ArgumentDouble (Minestom 1.0 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: net.minestom.server.command.builder.arguments.number, class: ArgumentDouble">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../../../script-dir/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../../../../script-dir/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.js"></script>
|
|
</head>
|
|
<body class="class-declaration">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flexBox">
|
|
<header role="banner" class="flexHeader">
|
|
<nav role="navigation">
|
|
<!-- ========= 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>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navListSearch"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="skipNav"><a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
</nav>
|
|
</header>
|
|
<div class="flexContent">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">net.minestom.server.command.builder.arguments.number</a></div>
|
|
<h1 title="Class ArgumentDouble" class="title">Class ArgumentDouble</h1>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance"><a href="../Argument.html" title="class in net.minestom.server.command.builder.arguments">net.minestom.server.command.builder.arguments.Argument</a><T>
|
|
<div class="inheritance"><a href="ArgumentNumber.html" title="class in net.minestom.server.command.builder.arguments.number">net.minestom.server.command.builder.arguments.number.ArgumentNumber</a><java.lang.Double>
|
|
<div class="inheritance">net.minestom.server.command.builder.arguments.number.ArgumentDouble</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<section class="description">
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">ArgumentDouble</span>
|
|
extends <a href="ArgumentNumber.html" title="class in net.minestom.server.command.builder.arguments.number">ArgumentNumber</a><java.lang.Double></pre>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="fieldSummary"><a id="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Field Summary</h2>
|
|
<div class="inheritedList">
|
|
<h3>Fields inherited from class net.minestom.server.command.builder.arguments.number.<a href="ArgumentNumber.html" title="class in net.minestom.server.command.builder.arguments.number">ArgumentNumber</a></h3>
|
|
<a id="fields.inherited.from.class.net.minestom.server.command.builder.arguments.number.ArgumentNumber">
|
|
<!-- -->
|
|
</a><code><a href="ArgumentNumber.html#hasMax">hasMax</a>, <a href="ArgumentNumber.html#hasMin">hasMin</a>, <a href="ArgumentNumber.html#max">max</a>, <a href="ArgumentNumber.html#min">min</a>, <a href="ArgumentNumber.html#NOT_NUMBER_ERROR">NOT_NUMBER_ERROR</a>, <a href="ArgumentNumber.html#RANGE_ERROR">RANGE_ERROR</a></code></div>
|
|
<div class="inheritedList">
|
|
<h3>Fields inherited from class net.minestom.server.command.builder.arguments.<a href="../Argument.html" title="class in net.minestom.server.command.builder.arguments">Argument</a></h3>
|
|
<a id="fields.inherited.from.class.net.minestom.server.command.builder.arguments.Argument">
|
|
<!-- -->
|
|
</a><code><a href="../Argument.html#SUCCESS">SUCCESS</a>, <a href="../Argument.html#UNDEFINED_ERROR">UNDEFINED_ERROR</a></code></div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li class="blockList">
|
|
<section class="constructorSummary"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Constructor Summary</h2>
|
|
<div class="memberSummary">
|
|
<table>
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">ArgumentDouble</a></span>​(java.lang.String id)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="methodSummary"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Summary</h2>
|
|
<div class="memberSummary">
|
|
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="memberSummary_tabpanel" role="tabpanel">
|
|
<table aria-labelledby="t0">
|
|
<thead>
|
|
<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>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor" id="i0">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConditionResult(java.lang.Double)">getConditionResult</a></span>​(java.lang.Double value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Called after <a href="../Argument.html#parse(java.lang.String)"><code>Argument.parse(String)</code></a> meaning that <code>value</code> should already represent a valid representation of the input.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i1">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCorrectionResult(java.lang.String)">getCorrectionResult</a></span>​(java.lang.String value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">First method called to check the validity of an input.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i2">
|
|
<td class="colFirst"><code>java.lang.Double</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.lang.String)">parse</a></span>​(java.lang.String value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Called after <a href="../Argument.html#getCorrectionResult(java.lang.String)"><code>Argument.getCorrectionResult(String)</code></a> returned <a href="../Argument.html#SUCCESS"><code>Argument.SUCCESS</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class net.minestom.server.command.builder.arguments.number.<a href="ArgumentNumber.html" title="class in net.minestom.server.command.builder.arguments.number">ArgumentNumber</a></h3>
|
|
<a id="methods.inherited.from.class.net.minestom.server.command.builder.arguments.number.ArgumentNumber">
|
|
<!-- -->
|
|
</a><code><a href="ArgumentNumber.html#between(T,T)">between</a>, <a href="ArgumentNumber.html#getMax()">getMax</a>, <a href="ArgumentNumber.html#getMin()">getMin</a>, <a href="ArgumentNumber.html#getRadix(java.lang.String)">getRadix</a>, <a href="ArgumentNumber.html#hasMax()">hasMax</a>, <a href="ArgumentNumber.html#hasMin()">hasMin</a>, <a href="ArgumentNumber.html#max(T)">max</a>, <a href="ArgumentNumber.html#min(T)">min</a>, <a href="ArgumentNumber.html#parseValue(java.lang.String)">parseValue</a>, <a href="ArgumentNumber.html#removeScientificNotation(java.lang.String)">removeScientificNotation</a></code></div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class net.minestom.server.command.builder.arguments.<a href="../Argument.html" title="class in net.minestom.server.command.builder.arguments">Argument</a></h3>
|
|
<a id="methods.inherited.from.class.net.minestom.server.command.builder.arguments.Argument">
|
|
<!-- -->
|
|
</a><code><a href="../Argument.html#allowSpace()">allowSpace</a>, <a href="../Argument.html#getCallback()">getCallback</a>, <a href="../Argument.html#getId()">getId</a>, <a href="../Argument.html#hasErrorCallback()">hasErrorCallback</a>, <a href="../Argument.html#setCallback(net.minestom.server.command.builder.ArgumentCallback)">setCallback</a>, <a href="../Argument.html#useRemaining()">useRemaining</a></code></div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li class="blockList">
|
|
<section class="constructorDetails"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Constructor Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="<init>(java.lang.String)">ArgumentDouble</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">ArgumentDouble</span>​(<span class="arguments">java.lang.String id)</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li class="blockList">
|
|
<section class="methodDetails"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getCorrectionResult(java.lang.String)">getCorrectionResult</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">getCorrectionResult</span>​(<span class="arguments">@NotNull
|
|
java.lang.String value)</span></div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../Argument.html#getCorrectionResult(java.lang.String)">Argument</a></code></span></div>
|
|
<div class="block">First method called to check the validity of an input.
|
|
<p>
|
|
If <a href="../Argument.html#allowSpace()"><code>Argument.allowSpace()</code></a> is enabled, the value will be incremented by the next word until it returns <a href="../Argument.html#SUCCESS"><code>Argument.SUCCESS</code></a>,
|
|
meaning that you need to be sure to check the inexpensive operations first (eg the number of brackets, the first and last char, etc...).</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../Argument.html#getCorrectionResult(java.lang.String)">getCorrectionResult</a></code> in class <code><a href="../Argument.html" title="class in net.minestom.server.command.builder.arguments">Argument</a><java.lang.Double></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - The received argument</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the error code or <a href="../Argument.html#SUCCESS"><code>Argument.SUCCESS</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="parse(java.lang.String)">parse</a></h3>
|
|
<div class="memberSignature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="returnType">java.lang.Double</span> <span class="memberName">parse</span>​(<span class="arguments">@NotNull
|
|
java.lang.String value)</span></div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../Argument.html#parse(java.lang.String)">Argument</a></code></span></div>
|
|
<div class="block">Called after <a href="../Argument.html#getCorrectionResult(java.lang.String)"><code>Argument.getCorrectionResult(String)</code></a> returned <a href="../Argument.html#SUCCESS"><code>Argument.SUCCESS</code></a>.
|
|
<p>
|
|
The correction being correct means that <code>value</code> shouldn't be verified again, you can assume that no exception will occur
|
|
when converting it to the correct type.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../Argument.html#parse(java.lang.String)">parse</a></code> in class <code><a href="../Argument.html" title="class in net.minestom.server.command.builder.arguments">Argument</a><java.lang.Double></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - The correct argument which does not need to be verified again</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The parsed argument</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getConditionResult(java.lang.Double)">getConditionResult</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">getConditionResult</span>​(<span class="arguments">@NotNull
|
|
java.lang.Double value)</span></div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../Argument.html#getConditionResult(T)">Argument</a></code></span></div>
|
|
<div class="block">Called after <a href="../Argument.html#parse(java.lang.String)"><code>Argument.parse(String)</code></a> meaning that <code>value</code> should already represent a valid representation of the input.
|
|
<p>
|
|
The condition result has for goal to check the optional conditions that are user configurable (eg min/max values for a number, a specific material
|
|
for an item, etc...).</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../Argument.html#getConditionResult(T)">getConditionResult</a></code> in class <code><a href="../Argument.html" title="class in net.minestom.server.command.builder.arguments">Argument</a><java.lang.Double></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - The parsed argument</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the error code or <a href="../Argument.html#SUCCESS"><code>Argument.SUCCESS</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<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>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|