mirror of
https://github.com/plexusorg/Website.git
synced 2024-12-25 19:37:38 +00:00
809 lines
62 KiB
HTML
809 lines
62 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>PlexCommand (Plex 1.0 API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: dev.plex.command, class: PlexCommand">
|
|
<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.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="../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<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="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#field-detail">Field</a> | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">dev.plex.command</a></div>
|
|
<h1 title="Class PlexCommand" class="title">Class PlexCommand</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">org.bukkit.command.Command
|
|
<div class="inheritance">dev.plex.command.PlexCommand</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code>org.bukkit.command.PluginIdentifiableCommand</code></dd>
|
|
</dl>
|
|
<dl class="notes">
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="impl/AdminChatCMD.html" title="class in dev.plex.command.impl">AdminChatCMD</a></code>, <code><a href="impl/AdminCMD.html" title="class in dev.plex.command.impl">AdminCMD</a></code>, <code><a href="impl/AdminworldCMD.html" title="class in dev.plex.command.impl">AdminworldCMD</a></code>, <code><a href="impl/AdventureCMD.html" title="class in dev.plex.command.impl">AdventureCMD</a></code>, <code><a href="impl/BanCMD.html" title="class in dev.plex.command.impl">BanCMD</a></code>, <code><a href="impl/BlockEditCMD.html" title="class in dev.plex.command.impl">BlockEditCMD</a></code>, <code><a href="impl/CommandSpyCMD.html" title="class in dev.plex.command.impl">CommandSpyCMD</a></code>, <code><a href="impl/CreativeCMD.html" title="class in dev.plex.command.impl">CreativeCMD</a></code>, <code><a href="impl/DebugCMD.html" title="class in dev.plex.command.impl">DebugCMD</a></code>, <code><a href="impl/DeopAllCMD.html" title="class in dev.plex.command.impl">DeopAllCMD</a></code>, <code><a href="impl/DeopCMD.html" title="class in dev.plex.command.impl">DeopCMD</a></code>, <code><a href="impl/EntityWipeCMD.html" title="class in dev.plex.command.impl">EntityWipeCMD</a></code>, <code><a href="impl/FlatlandsCMD.html" title="class in dev.plex.command.impl">FlatlandsCMD</a></code>, <code><a href="impl/FreezeCMD.html" title="class in dev.plex.command.impl">FreezeCMD</a></code>, <code><a href="impl/KickCMD.html" title="class in dev.plex.command.impl">KickCMD</a></code>, <code><a href="impl/ListCMD.html" title="class in dev.plex.command.impl">ListCMD</a></code>, <code><a href="impl/LocalSpawnCMD.html" title="class in dev.plex.command.impl">LocalSpawnCMD</a></code>, <code><a href="impl/LockupCMD.html" title="class in dev.plex.command.impl">LockupCMD</a></code>, <code><a href="impl/MasterbuilderworldCMD.html" title="class in dev.plex.command.impl">MasterbuilderworldCMD</a></code>, <code><a href="impl/MobPurgeCMD.html" title="class in dev.plex.command.impl">MobPurgeCMD</a></code>, <code><a href="impl/MuteCMD.html" title="class in dev.plex.command.impl">MuteCMD</a></code>, <code><a href="impl/NameHistoryCMD.html" title="class in dev.plex.command.impl">NameHistoryCMD</a></code>, <code><a href="impl/NotesCMD.html" title="class in dev.plex.command.impl">NotesCMD</a></code>, <code><a href="impl/OpAllCMD.html" title="class in dev.plex.command.impl">OpAllCMD</a></code>, <code><a href="impl/OpCMD.html" title="class in dev.plex.command.impl">OpCMD</a></code>, <code><a href="impl/PlexCMD.html" title="class in dev.plex.command.impl">PlexCMD</a></code>, <code><a href="impl/PunishmentsCMD.html" title="class in dev.plex.command.impl">PunishmentsCMD</a></code>, <code><a href="impl/RankCMD.html" title="class in dev.plex.command.impl">RankCMD</a></code>, <code><a href="impl/RawSayCMD.html" title="class in dev.plex.command.impl">RawSayCMD</a></code>, <code><a href="impl/SmiteCMD.html" title="class in dev.plex.command.impl">SmiteCMD</a></code>, <code><a href="impl/SpectatorCMD.html" title="class in dev.plex.command.impl">SpectatorCMD</a></code>, <code><a href="impl/SurvivalCMD.html" title="class in dev.plex.command.impl">SurvivalCMD</a></code>, <code><a href="impl/TagCMD.html" title="class in dev.plex.command.impl">TagCMD</a></code>, <code><a href="impl/TempbanCMD.html" title="class in dev.plex.command.impl">TempbanCMD</a></code>, <code><a href="impl/ToggleDropsCMD.html" title="class in dev.plex.command.impl">ToggleDropsCMD</a></code>, <code><a href="impl/UnbanCMD.html" title="class in dev.plex.command.impl">UnbanCMD</a></code>, <code><a href="impl/UnfreezeCMD.html" title="class in dev.plex.command.impl">UnfreezeCMD</a></code>, <code><a href="impl/UnmuteCMD.html" title="class in dev.plex.command.impl">UnmuteCMD</a></code>, <code><a href="impl/WorldCMD.html" title="class in dev.plex.command.impl">WorldCMD</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">PlexCommand</span>
|
|
<span class="extends-implements">extends org.bukkit.command.Command
|
|
implements org.bukkit.command.PluginIdentifiableCommand</span></div>
|
|
<div class="block">Superclass for all commands</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>private final <a href="source/RequiredCommandSource.html" title="enum class in dev.plex.command.source">RequiredCommandSource</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#commandSource" class="member-name-link">commandSource</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Required command source fetched from the permissions</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>private final <a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#level" class="member-name-link">level</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Minimum required rank fetched from the permissions</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>private final <a href="annotation/CommandParameters.html" title="annotation interface in dev.plex.command.annotation">CommandParameters</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#params" class="member-name-link">params</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The parameters for the command</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>private final <a href="annotation/CommandPermissions.html" title="annotation interface in dev.plex.command.annotation">CommandPermissions</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#perms" class="member-name-link">perms</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The permissions for the command</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>protected static <a href="../Plex.html" title="class in dev.plex">Plex</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#plugin" class="member-name-link">plugin</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Returns the instance of the plugin</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="fields-inherited-from-class-org.bukkit.command.Command">Fields inherited from class org.bukkit.command.Command</h3>
|
|
<code>description, timings, usageMessage</code></div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">PlexCommand</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Creates an instance of the command</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkRank(org.bukkit.command.CommandSender,dev.plex.rank.enums.Rank,java.lang.String)" class="member-name-link">checkRank</a><wbr>(org.bukkit.command.CommandSender sender,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks whether a sender has enough permissions or is high enough a rank</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkRank(org.bukkit.entity.Player,dev.plex.rank.enums.Rank,java.lang.String)" class="member-name-link">checkRank</a><wbr>(org.bukkit.entity.Player player,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks whether a player has enough permissions or is high enough a rank</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkTab(org.bukkit.command.CommandSender,dev.plex.rank.enums.Rank,java.lang.String)" class="member-name-link">checkTab</a><wbr>(org.bukkit.command.CommandSender sender,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks whether a sender has enough permissions or is high enough a rank</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkTab(org.bukkit.entity.Player,dev.plex.rank.enums.Rank,java.lang.String)" class="member-name-link">checkTab</a><wbr>(org.bukkit.entity.Player player,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks whether a player has enough permissions or is high enough a rank</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected net.kyori.adventure.text.Component</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#componentFromString(java.lang.String)" class="member-name-link">componentFromString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Converts a String to a legacy Kyori Component</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract net.kyori.adventure.text.Component</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#execute(org.bukkit.command.CommandSender,org.bukkit.entity.Player,java.lang.String%5B%5D)" class="member-name-link">execute</a><wbr>(@NotNull org.bukkit.command.CommandSender sender,
|
|
@Nullable org.bukkit.entity.Player playerSender,
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] args)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Executes the command</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLevel()" class="member-name-link">getLevel</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.bukkit.command.CommandMap</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMap()" class="member-name-link">getMap</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.bukkit.entity.Player</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNonNullPlayer(java.lang.String)" class="member-name-link">getNonNullPlayer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.bukkit.World</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNonNullWorld(java.lang.String)" class="member-name-link">getNonNullWorld</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOfflinePlexPlayer(java.util.UUID)" class="member-name-link">getOfflinePlexPlayer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> uuid)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOnlinePlexPlayer(java.lang.String)" class="member-name-link">getOnlinePlexPlayer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPlexPlayer(org.bukkit.entity.Player)" class="member-name-link">getPlexPlayer</a><wbr>(@NotNull org.bukkit.entity.Player player)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets a PlexPlayer from Player object</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="../Plex.html" title="class in dev.plex">Plex</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPlugin()" class="member-name-link">getPlugin</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">The plugin</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUUID(org.bukkit.command.CommandSender)" class="member-name-link">getUUID</a><wbr>(org.bukkit.command.CommandSender sender)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets the UUID of the sender</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAdmin(dev.plex.player.PlexPlayer)" class="member-name-link">isAdmin</a><wbr>(<a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a> plexPlayer)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if a player is an admin</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAdmin(java.lang.String)" class="member-name-link">isAdmin</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if a username is an admin</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAdmin(org.bukkit.command.CommandSender)" class="member-name-link">isAdmin</a><wbr>(org.bukkit.command.CommandSender sender)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if a sender is an admin</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isConsole(org.bukkit.command.CommandSender)" class="member-name-link">isConsole</a><wbr>(org.bukkit.command.CommandSender sender)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks whether a sender is console</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSeniorAdmin(org.bukkit.command.CommandSender)" class="member-name-link">isSeniorAdmin</a><wbr>(org.bukkit.command.CommandSender sender)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if a sender is a senior admin</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matches(java.lang.String)" class="member-name-link">matches</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> label)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if the String given is a matching command</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected net.kyori.adventure.text.Component</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#messageComponent(java.lang.String,java.lang.Object...)" class="member-name-link">messageComponent</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>... objects)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Converts a message entry from the "messages.yml" to a Component</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#messageString(java.lang.String,java.lang.Object...)" class="member-name-link">messageString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>... objects)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Converts a message entry from the "messages.yml" to a String</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected net.kyori.adventure.text.Component</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mmString(java.lang.String)" class="member-name-link">mmString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Converts a String to a MiniMessage Component</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected net.kyori.adventure.text.Component</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#noColorComponentFromString(java.lang.String)" class="member-name-link">noColorComponentFromString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#send(net.kyori.adventure.audience.Audience,java.lang.String)" class="member-name-link">send</a><wbr>(net.kyori.adventure.audience.Audience audience,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sends a message to an Audience</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#send(net.kyori.adventure.audience.Audience,net.kyori.adventure.text.Component)" class="member-name-link">send</a><wbr>(net.kyori.adventure.audience.Audience audience,
|
|
net.kyori.adventure.text.Component component)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sends a message to an Audience</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#silentCheckRank(org.bukkit.entity.Player,dev.plex.rank.enums.Rank,java.lang.String)" class="member-name-link">silentCheckRank</a><wbr>(org.bukkit.entity.Player player,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected net.kyori.adventure.text.Component</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#usage()" class="member-name-link">usage</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Converts usage to a Component</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected net.kyori.adventure.text.Component</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#usage(java.lang.String)" class="member-name-link">usage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Converts usage to a Component</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-org.bukkit.command.Command">Methods inherited from class org.bukkit.command.Command</h3>
|
|
<code>broadcastCommandMessage, broadcastCommandMessage, getAliases, getDescription, getLabel, getName, getPermission, getPermissionMessage, getTimingName, getUsage, isRegistered, permissionMessage, permissionMessage, register, setAliases, setDescription, setLabel, setName, setPermission, setPermissionMessage, setUsage, tabComplete, tabComplete, testPermission, testPermissionSilent, toString, unregister</code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="plugin">
|
|
<h3>plugin</h3>
|
|
<div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><a href="../Plex.html" title="class in dev.plex">Plex</a></span> <span class="element-name">plugin</span></div>
|
|
<div class="block">Returns the instance of the plugin</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="params">
|
|
<h3>params</h3>
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="annotation/CommandParameters.html" title="annotation interface in dev.plex.command.annotation">CommandParameters</a></span> <span class="element-name">params</span></div>
|
|
<div class="block">The parameters for the command</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="perms">
|
|
<h3>perms</h3>
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="annotation/CommandPermissions.html" title="annotation interface in dev.plex.command.annotation">CommandPermissions</a></span> <span class="element-name">perms</span></div>
|
|
<div class="block">The permissions for the command</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="level">
|
|
<h3>level</h3>
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a></span> <span class="element-name">level</span></div>
|
|
<div class="block">Minimum required rank fetched from the permissions</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="commandSource">
|
|
<h3>commandSource</h3>
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="source/RequiredCommandSource.html" title="enum class in dev.plex.command.source">RequiredCommandSource</a></span> <span class="element-name">commandSource</span></div>
|
|
<div class="block">Required command source fetched from the permissions</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>PlexCommand</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PlexCommand</span>()</div>
|
|
<div class="block">Creates an instance of the command</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="execute(org.bukkit.command.CommandSender,org.bukkit.entity.Player,java.lang.String[])">
|
|
<h3>execute</h3>
|
|
<div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">net.kyori.adventure.text.Component</span> <span class="element-name">execute</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull org.bukkit.command.CommandSender sender,
|
|
@Nullable
|
|
@Nullable org.bukkit.entity.Player playerSender,
|
|
@NotNull
|
|
@NotNull <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] args)</span></div>
|
|
<div class="block">Executes the command</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sender</code> - The sender of the command</dd>
|
|
<dd><code>playerSender</code> - The player who executed the command (null if CommandSource is console or if CommandSource is any but console executed)</dd>
|
|
<dd><code>args</code> - A Kyori Component to send to the sender (can be null)</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="matches(java.lang.String)">
|
|
<h3>matches</h3>
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">matches</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> label)</span></div>
|
|
<div class="block">Checks if the String given is a matching command</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>label</code> - The String to check</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the string is a command name or alias</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getPlexPlayer(org.bukkit.entity.Player)">
|
|
<h3>getPlexPlayer</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a></span> <span class="element-name">getPlexPlayer</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull org.bukkit.entity.Player player)</span></div>
|
|
<div class="block">Gets a PlexPlayer from Player object</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>player</code> - The player object</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>PlexPlayer Object</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../player/PlexPlayer.html" title="class in dev.plex.player"><code>PlexPlayer</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="send(net.kyori.adventure.audience.Audience,java.lang.String)">
|
|
<h3>send</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">send</span><wbr><span class="parameters">(net.kyori.adventure.audience.Audience audience,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div>
|
|
<div class="block">Sends a message to an Audience</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>audience</code> - The Audience to send the message to</dd>
|
|
<dd><code>s</code> - The message to send</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="send(net.kyori.adventure.audience.Audience,net.kyori.adventure.text.Component)">
|
|
<h3>send</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">send</span><wbr><span class="parameters">(net.kyori.adventure.audience.Audience audience,
|
|
net.kyori.adventure.text.Component component)</span></div>
|
|
<div class="block">Sends a message to an Audience</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>audience</code> - The Audience to send the message to</dd>
|
|
<dd><code>component</code> - The Component to send</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="checkRank(org.bukkit.command.CommandSender,dev.plex.rank.enums.Rank,java.lang.String)">
|
|
<h3>checkRank</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">checkRank</span><wbr><span class="parameters">(org.bukkit.command.CommandSender sender,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</span></div>
|
|
<div class="block">Checks whether a sender has enough permissions or is high enough a rank</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sender</code> - A CommandSender</dd>
|
|
<dd><code>rank</code> - The rank to check (if the server is using ranks)</dd>
|
|
<dd><code>permission</code> - The permission to check (if the server is using permissions)</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the sender has enough permissions</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums"><code>Rank</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="checkRank(org.bukkit.entity.Player,dev.plex.rank.enums.Rank,java.lang.String)">
|
|
<h3>checkRank</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">checkRank</span><wbr><span class="parameters">(org.bukkit.entity.Player player,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</span></div>
|
|
<div class="block">Checks whether a player has enough permissions or is high enough a rank</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>player</code> - The player object</dd>
|
|
<dd><code>rank</code> - The rank to check (if the server is using ranks)</dd>
|
|
<dd><code>permission</code> - The permission to check (if the server is using permissions)</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the sender has enough permissions</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums"><code>Rank</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="silentCheckRank(org.bukkit.entity.Player,dev.plex.rank.enums.Rank,java.lang.String)">
|
|
<h3>silentCheckRank</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">silentCheckRank</span><wbr><span class="parameters">(org.bukkit.entity.Player player,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="checkTab(org.bukkit.command.CommandSender,dev.plex.rank.enums.Rank,java.lang.String)">
|
|
<h3>checkTab</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">checkTab</span><wbr><span class="parameters">(org.bukkit.command.CommandSender sender,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</span></div>
|
|
<div class="block">Checks whether a sender has enough permissions or is high enough a rank</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sender</code> - The player object</dd>
|
|
<dd><code>rank</code> - The rank to check (if the server is using ranks)</dd>
|
|
<dd><code>permission</code> - The permission to check (if the server is using permissions)</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the sender has enough permissions</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums"><code>Rank</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="checkTab(org.bukkit.entity.Player,dev.plex.rank.enums.Rank,java.lang.String)">
|
|
<h3>checkTab</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">checkTab</span><wbr><span class="parameters">(org.bukkit.entity.Player player,
|
|
<a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a> rank,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> permission)</span></div>
|
|
<div class="block">Checks whether a player has enough permissions or is high enough a rank</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>player</code> - The player object</dd>
|
|
<dd><code>rank</code> - The rank to check (if the server is using ranks)</dd>
|
|
<dd><code>permission</code> - The permission to check (if the server is using permissions)</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the sender has enough permissions</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums"><code>Rank</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isAdmin(dev.plex.player.PlexPlayer)">
|
|
<h3>isAdmin</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isAdmin</span><wbr><span class="parameters">(<a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a> plexPlayer)</span></div>
|
|
<div class="block">Checks if a player is an admin</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>plexPlayer</code> - The PlexPlayer object</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the player is an admin</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../player/PlexPlayer.html" title="class in dev.plex.player"><code>PlexPlayer</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isAdmin(org.bukkit.command.CommandSender)">
|
|
<h3>isAdmin</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isAdmin</span><wbr><span class="parameters">(org.bukkit.command.CommandSender sender)</span></div>
|
|
<div class="block">Checks if a sender is an admin</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sender</code> - A command sender</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the sender is an admin or if console</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isAdmin(java.lang.String)">
|
|
<h3>isAdmin</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isAdmin</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div>
|
|
<div class="block">Checks if a username is an admin</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>name</code> - The username</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the username is an admin</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isSeniorAdmin(org.bukkit.command.CommandSender)">
|
|
<h3>isSeniorAdmin</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isSeniorAdmin</span><wbr><span class="parameters">(org.bukkit.command.CommandSender sender)</span></div>
|
|
<div class="block">Checks if a sender is a senior admin</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sender</code> - A command sender</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the sender is a senior admin or if console</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getUUID(org.bukkit.command.CommandSender)">
|
|
<h3>getUUID</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a></span> <span class="element-name">getUUID</span><wbr><span class="parameters">(org.bukkit.command.CommandSender sender)</span></div>
|
|
<div class="block">Gets the UUID of the sender</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sender</code> - A command sender</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A unique ID or null if the sender is console</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link"><code>UUID</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getPlugin()">
|
|
<h3>getPlugin</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="../Plex.html" title="class in dev.plex">Plex</a></span> <span class="element-name">getPlugin</span>()</div>
|
|
<div class="block">The plugin</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>getPlugin</code> in interface <code>org.bukkit.command.PluginIdentifiableCommand</code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The instance of the plugin</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../Plex.html" title="class in dev.plex"><code>Plex</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isConsole(org.bukkit.command.CommandSender)">
|
|
<h3>isConsole</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">isConsole</span><wbr><span class="parameters">(org.bukkit.command.CommandSender sender)</span></div>
|
|
<div class="block">Checks whether a sender is console</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sender</code> - A command sender</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the sender is console</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="messageComponent(java.lang.String,java.lang.Object...)">
|
|
<h3>messageComponent</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">net.kyori.adventure.text.Component</span> <span class="element-name">messageComponent</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>... objects)</span></div>
|
|
<div class="block">Converts a message entry from the "messages.yml" to a Component</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>s</code> - The message entry</dd>
|
|
<dd><code>objects</code> - Any objects to replace in order</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A Kyori Component</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="messageString(java.lang.String,java.lang.Object...)">
|
|
<h3>messageString</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">messageString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>... objects)</span></div>
|
|
<div class="block">Converts a message entry from the "messages.yml" to a String</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>s</code> - The message entry</dd>
|
|
<dd><code>objects</code> - Any objects to replace in order</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A String</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="usage()">
|
|
<h3>usage</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">net.kyori.adventure.text.Component</span> <span class="element-name">usage</span>()</div>
|
|
<div class="block">Converts usage to a Component</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A Kyori Component stating the usage</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="usage(java.lang.String)">
|
|
<h3>usage</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">net.kyori.adventure.text.Component</span> <span class="element-name">usage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div>
|
|
<div class="block">Converts usage to a Component
|
|
<p>
|
|
s The usage to convert</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A Kyori Component stating the usage</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getNonNullPlayer(java.lang.String)">
|
|
<h3>getNonNullPlayer</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.bukkit.entity.Player</span> <span class="element-name">getNonNullPlayer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getOnlinePlexPlayer(java.lang.String)">
|
|
<h3>getOnlinePlexPlayer</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a></span> <span class="element-name">getOnlinePlexPlayer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getOfflinePlexPlayer(java.util.UUID)">
|
|
<h3>getOfflinePlexPlayer</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a></span> <span class="element-name">getOfflinePlexPlayer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> uuid)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getNonNullWorld(java.lang.String)">
|
|
<h3>getNonNullWorld</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.bukkit.World</span> <span class="element-name">getNonNullWorld</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="componentFromString(java.lang.String)">
|
|
<h3>componentFromString</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">net.kyori.adventure.text.Component</span> <span class="element-name">componentFromString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div>
|
|
<div class="block">Converts a String to a legacy Kyori Component</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>s</code> - The String to convert</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A Kyori component</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="noColorComponentFromString(java.lang.String)">
|
|
<h3>noColorComponentFromString</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">net.kyori.adventure.text.Component</span> <span class="element-name">noColorComponentFromString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="mmString(java.lang.String)">
|
|
<h3>mmString</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">net.kyori.adventure.text.Component</span> <span class="element-name">mmString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div>
|
|
<div class="block">Converts a String to a MiniMessage Component</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>s</code> - The String to convert</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A Kyori Component</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLevel()">
|
|
<h3>getLevel</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rank/enums/Rank.html" title="enum class in dev.plex.rank.enums">Rank</a></span> <span class="element-name">getLevel</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getMap()">
|
|
<h3>getMap</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.bukkit.command.CommandMap</span> <span class="element-name">getMap</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|