2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
< html lang = "en" >
2019-08-05 11:13:19 +02:00
< head >
2022-06-10 15:30:56 +02:00
<!-- Generated by javadoc (17) -->
2022-06-18 11:05:58 +02:00
< title > PlanPlugin (Plan 5.5-SNAPSHOT API)< / title >
2021-07-24 13:27:37 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2021-03-10 09:12:21 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2021-07-24 13:27:37 +02:00
< meta name = "description" content = "declaration: package: com.djrapitops.plan, interface: PlanPlugin" >
< meta name = "generator" content = "javadoc/ClassWriterImpl" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../stylesheet.css" title = "Style" >
2021-07-24 13:27:37 +02:00
< 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" >
2019-08-05 11:13:19 +02:00
< script type = "text/javascript" src = "../../../script.js" > < / script >
2022-12-08 18:30:29 +01:00
< script type = "text/javascript" src = "../../../script-dir/jquery-3.6.0.min.js" > < / script >
2021-07-24 13:27:37 +02:00
< script type = "text/javascript" src = "../../../script-dir/jquery-ui.min.js" > < / script >
2019-08-05 11:13:19 +02:00
< / head >
2021-07-24 13:27:37 +02:00
< body class = "class-declaration-page" >
< script type = "text/javascript" > v a r e v e n R o w C o l o r = " e v e n - r o w - c o l o r " ;
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../";
loadScripts(document, 'script');< / script >
2019-08-05 11:13:19 +02:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-07-24 13:27:37 +02:00
< div class = "flex-box" >
< header role = "banner" class = "flex-header" >
2021-03-10 09:12:21 +01:00
< nav role = "navigation" >
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2022-06-10 15:30:56 +02:00
< 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" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "package-summary.html" > Package< / a > < / li >
2021-07-24 13:27:37 +02:00
< li class = "nav-bar-cell1-rev" > Class< / li >
2019-08-05 11:13:19 +02:00
< 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 >
2022-06-10 15:30:56 +02:00
< li > < a href = "../../../help-doc.html#class" > Help< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / div >
2021-07-24 13:27:37 +02:00
< div class = "sub-nav" >
2019-08-05 11:13:19 +02:00
< div >
2021-07-24 13:27:37 +02:00
< ul class = "sub-nav-list" >
2019-08-05 11:13:19 +02:00
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#method-summary" > Method< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
2021-07-24 13:27:37 +02:00
< ul class = "sub-nav-list" >
2019-08-05 11:13:19 +02:00
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#method-detail" > Method< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / div >
2022-06-10 15:30:56 +02:00
< 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" >
2021-07-24 13:27:37 +02:00
< / div >
2021-03-10 09:12:21 +01:00
< / div >
2021-07-24 13:27:37 +02:00
<!-- ========= END OF TOP NAVBAR ========= -->
2022-06-10 15:30:56 +02:00
< span class = "skip-nav" id = "skip-navbar-top" > < / span > < / nav >
2021-03-10 09:12:21 +01:00
< / header >
2021-07-24 13:27:37 +02:00
< div class = "flex-content" >
2021-03-10 09:12:21 +01:00
< main role = "main" >
2021-07-24 13:27:37 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2019-08-05 11:13:19 +02:00
< div class = "header" >
2021-07-24 13:27:37 +02:00
< div class = "sub-title" > < span class = "package-label-in-type" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan< / a > < / div >
< h1 title = "Interface PlanPlugin" class = "title" > Interface PlanPlugin< / h1 >
2019-08-05 11:13:19 +02:00
< / div >
2022-06-10 15:30:56 +02:00
< section class = "class-description" id = "class-description" >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > All Known Implementing Classes:< / dt >
2021-07-24 13:27:37 +02:00
< dd > < code > < a href = "Plan.html" title = "class in com.djrapitops.plan" > Plan< / a > < / code > , < code > < a href = "PlanBungee.html" title = "class in com.djrapitops.plan" > PlanBungee< / a > < / code > , < code > < a href = "../../../net/playeranalytics/plan/PlanFabric.html" title = "class in net.playeranalytics.plan" > PlanFabric< / a > < / code > , < code > < a href = "PlanNukkit.html" title = "class in com.djrapitops.plan" > PlanNukkit< / a > < / code > , < code > < a href = "PlanSponge.html" title = "class in com.djrapitops.plan" > PlanSponge< / a > < / code > , < code > < a href = "PlanVelocity.html" title = "class in com.djrapitops.plan" > PlanVelocity< / a > < / code > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< hr >
2021-07-24 13:27:37 +02:00
< div class = "type-signature" > < span class = "modifiers" > public interface < / span > < span class = "element-name type-name-label" > PlanPlugin< / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Abstraction interface for both Plan and PlanBungee.< / div >
2021-07-24 13:27:37 +02:00
< / section >
< section class = "summary" >
< ul class = "summary-list" >
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
2021-07-24 13:27:37 +02:00
< li >
2022-06-10 15:30:56 +02:00
< section class = "method-summary" id = "method-summary" >
2021-07-24 13:27:37 +02:00
< 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-tab5" role = "tab" aria-selected = "false" aria-controls = "method-summary-table.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('method-summary-table', 'method-summary-table-tab5', 3)" class = "table-tab" > Default Methods< / button > < button id = "method-summary-table-tab6" role = "tab" aria-selected = "false" aria-controls = "method-summary-table.tabpanel" tabindex = "-1" onkeydown = "switchTab(event)" onclick = "show('method-summary-table', 'method-summary-table-tab6', 3)" class = "table-tab" > Deprecated 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 >
2022-06-10 15:30:56 +02:00
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "commands/use/ColorScheme.html" title = "class in com.djrapitops.plan.commands.use" > ColorScheme< / a > < / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#getColorScheme()" class = "member-name-link" > getColorScheme< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6" > < code > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title = "class or interface in java.io" class = "external-link" > File< / a > < / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6" > < code > < a href = "#getDataFolder()" class = "member-name-link" > getDataFolder< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6" >
2022-08-31 11:57:15 +02:00
< div class = "block" > < span class = "deprecated-label" > Deprecated.< / span >
< div class = "deprecation-comment" > Use < code > @Named("dataFolder") File< / code > , or < code > PluginInformation.getDataFolder()< / code > < / div >
< / div >
2021-07-24 13:27:37 +02:00
< / div >
2022-06-10 15:30:56 +02:00
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title = "class or interface in java.io" class = "external-link" > InputStream< / a > < / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#getResource(java.lang.String)" class = "member-name-link" > getResource< / 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 > resource)< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "PlanSystem.html" title = "class in com.djrapitops.plan" > PlanSystem< / a > < / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#getSystem()" class = "member-name-link" > getSystem< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / div >
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < code > default boolean< / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < code > < a href = "#isSystemEnabled()" class = "member-name-link" > isSystemEnabled< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5" > < / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > void< / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#onDisable()" class = "member-name-link" > onDisable< / a > ()< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / div >
< div class = "col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > void< / code > < / div >
< div class = "col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#onEnable()" class = "member-name-link" > onEnable< / a > ()< / code > < / div >
< div class = "col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / div >
< div class = "col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > void< / code > < / div >
< div class = "col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < code > < a href = "#registerCommand(com.djrapitops.plan.commands.use.Subcommand)" class = "member-name-link" > registerCommand< / a > < wbr > (< a href = "commands/use/Subcommand.html" title = "class in com.djrapitops.plan.commands.use" > Subcommand< / a > command)< / code > < / div >
< div class = "col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3" > < / div >
2021-07-24 13:27:37 +02:00
< / div >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-07-24 13:27:37 +02:00
< / section >
< section class = "details" >
< ul class = "details-list" >
2019-08-05 11:13:19 +02:00
<!-- ============ METHOD DETAIL ========== -->
2021-07-24 13:27:37 +02:00
< li >
2022-06-10 15:30:56 +02:00
< section class = "method-details" id = "method-detail" >
2021-07-24 13:27:37 +02:00
< h2 > Method Details< / h2 >
< ul class = "member-list" >
< li >
< section class = "detail" id = "getResource(java.lang.String)" >
< h3 > getResource< / h3 >
2022-06-10 15:30:56 +02:00
< div class = "member-signature" > < span class = "return-type" > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title = "class or interface in java.io" class = "external-link" > InputStream< / a > < / span > < span class = "element-name" > getResource< / 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 > resource)< / span > < / div >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "getColorScheme()" >
< h3 > getColorScheme< / h3 >
< div class = "member-signature" > < span class = "return-type" > < a href = "commands/use/ColorScheme.html" title = "class in com.djrapitops.plan.commands.use" > ColorScheme< / a > < / span > < span class = "element-name" > getColorScheme< / span > ()< / div >
< / section >
2019-08-05 11:13:19 +02:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "getSystem()" >
< h3 > getSystem< / h3 >
< div class = "member-signature" > < span class = "return-type" > < a href = "PlanSystem.html" title = "class in com.djrapitops.plan" > PlanSystem< / a > < / span > < span class = "element-name" > getSystem< / span > ()< / div >
< / section >
2019-08-05 11:13:19 +02:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "isSystemEnabled()" >
< h3 > isSystemEnabled< / h3 >
< div class = "member-signature" > < span class = "modifiers" > default< / span > < span class = "return-type" > boolean< / span > < span class = "element-name" > isSystemEnabled< / span > ()< / div >
< / section >
2019-08-05 11:13:19 +02:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "registerCommand(com.djrapitops.plan.commands.use.Subcommand)" >
< h3 > registerCommand< / h3 >
2022-06-10 15:30:56 +02:00
< div class = "member-signature" > < span class = "return-type" > void< / span > < span class = "element-name" > registerCommand< / span > < wbr > < span class = "parameters" > (< a href = "commands/use/Subcommand.html" title = "class in com.djrapitops.plan.commands.use" > Subcommand< / a > command)< / span > < / div >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "onEnable()" >
< h3 > onEnable< / h3 >
< div class = "member-signature" > < span class = "return-type" > void< / span > < span class = "element-name" > onEnable< / span > ()< / div >
< / section >
2021-03-10 09:12:21 +01:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "onDisable()" >
< h3 > onDisable< / h3 >
< div class = "member-signature" > < span class = "return-type" > void< / span > < span class = "element-name" > onDisable< / span > ()< / div >
< / section >
2020-10-11 17:01:29 +02:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "getDataFolder()" >
< h3 > getDataFolder< / h3 >
2022-08-31 11:57:15 +02:00
< div class = "member-signature" > < span class = "annotations" > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title = "class or interface in java.lang" class = "external-link" > @Deprecated< / a > (< a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html#since()" title = "class or interface in java.lang" class = "external-link" > since< / a > ="2021-03-09")
2022-06-10 15:30:56 +02:00
< / span > < span class = "return-type" > < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title = "class or interface in java.io" class = "external-link" > File< / a > < / span > < span class = "element-name" > getDataFolder< / span > ()< / div >
2022-08-31 11:57:15 +02:00
< div class = "deprecation-block" > < span class = "deprecated-label" > Deprecated.< / span >
< div class = "deprecation-comment" > Use < code > @Named("dataFolder") File< / code > , or < code > PluginInformation.getDataFolder()< / code > < / div >
< / div >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-07-24 13:27:37 +02:00
< / main >
2019-08-05 11:13:19 +02:00
< / div >
< / div >
< / body >
< / html >
