amalthea-mc/ShopChest
1
0
Fork 0
mirror of https://github.com/amalthea-mc/ShopChest.git synced 2024-11-14 06:31:07 +00:00
Code Issues Projects Releases Wiki Activity
b656f2f119
ShopChest/javadoc/de/epiceric/shopchest/config/Config.html
Eric 537bc907d5 Updated Javadoc
2016-08-17 21:34:21 +02:00

892 lines
41 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_74) on Wed Aug 17 21:32:18 CEST 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Config (ShopChest 1.10.1 API)</title>
<meta name="date" content="2016-08-17">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Config (ShopChest 1.10.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Config.html">Use</a></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">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../de/epiceric/shopchest/config/LanguageConfiguration.html" title="class in de.epiceric.shopchest.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?de/epiceric/shopchest/config/Config.html" target="_top">Frames</a></li>
<li><a href="Config.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">de.epiceric.shopchest.config</div>
<h2 title="Class Config" class="title">Class Config</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>de.epiceric.shopchest.config.Config</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Config</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#allow_broken_items">allow_broken_items</a></span></code>
<div class="block">Whether players are allowed to sell/buy broken items</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#append_potion_level_to_item_name">append_potion_level_to_item_name</a></span></code>
<div class="block">Whether the extension of a potion or tipped arrow (if available) should be appended to the item name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#auto_calculate_item_amount">auto_calculate_item_amount</a></span></code>
<div class="block">Whether the item amount should be calculated to fit the available money or inventory space</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#auto_reload_time">auto_reload_time</a></span></code>
<div class="block">The time between automatic shop reloads (if set to 0, the timer will be disabled)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#blacklist">blacklist</a></span></code>
<div class="block">List containing items, of which players can't create a shop
If this list contains an item (e.g "STONE", "STONE:1"), it's in the blacklist.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#buy_greater_or_equal_sell">buy_greater_or_equal_sell</a></span></code>
<div class="block">Whether the buy price of a shop must be greater than or equal the sell price</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#database_mysql_database">database_mysql_database</a></span></code>
<div class="block">The database used for ShopChest's MySQL database</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#database_mysql_host">database_mysql_host</a></span></code>
<div class="block">The hostname used in ShopChest's MySQL database</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#database_mysql_password">database_mysql_password</a></span></code>
<div class="block">The password used in ShopChest's MySQL database</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#database_mysql_ping_interval">database_mysql_ping_interval</a></span></code>
<div class="block">The interval in seconds, a ping is sent to the MySQL server</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#database_mysql_port">database_mysql_port</a></span></code>
<div class="block">The port used for ShopChest's MySQL database</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#database_mysql_username">database_mysql_username</a></span></code>
<div class="block">The username used in ShopChest's MySQL database</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../de/epiceric/shopchest/sql/Database.DatabaseType.html" title="enum in de.epiceric.shopchest.sql">Database.DatabaseType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#database_type">database_type</a></span></code>
<div class="block">The database type used for ShopChest.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#default_limit">default_limit</a></span></code>
<div class="block">The default shop limit for players and groups that are not listed in <a href="../../../../de/epiceric/shopchest/config/Config.html#shopLimits_player"><code>shopLimits_player</code></a> or in <a href="../../../../de/epiceric/shopchest/config/Config.html#shopLimits_group"><code>shopLimits_group</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#enable_debug_log">enable_debug_log</a></span></code>
<div class="block">Whether the debug log file should be created</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#exclude_admin_shops">exclude_admin_shops</a></span></code>
<div class="block">Whether admin shops should be excluded of the shop limits</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#explosion_protection">explosion_protection</a></span></code>
<div class="block">Whether shops should be protected by explosions</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#hopper_protection">hopper_protection</a></span></code>
<div class="block">Whether shops should be protected by hoppers</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#language_file">language_file</a></span></code>
<div class="block">The language file to use (e.g <i>en_US</i>, <i>de_DE</i>)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#main_command_name">main_command_name</a></span></code>
<div class="block">The main command of ShopChest <i>(default: shop)</i></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#maximal_distance">maximal_distance</a></span></code>
<div class="block">The maximum distance between a player and a shop to see the hologram</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#maximal_item_distance">maximal_item_distance</a></span></code>
<div class="block">The maximum distance between a player and a shop to see the shop item</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#minimum_prices">minimum_prices</a></span></code>
<div class="block">The minimum prices for certain items
This returns a key set, which contains e.g "STONE", "STONE:1", of the <i>minimum-prices</i> section in ShopChest's config.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#remove_shop_on_error">remove_shop_on_error</a></span></code>
<div class="block">Whether shops should automatically be removed from the database if an error occurred while loading
(e.g. when no chest is found at a shop's location)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#shop_creation_price_admin">shop_creation_price_admin</a></span></code>
<div class="block">The price a player has to pay in order to create an admin shop</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#shop_creation_price_normal">shop_creation_price_normal</a></span></code>
<div class="block">The price a player has to pay in order to create a normal shop</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#shopLimits_group">shopLimits_group</a></span></code>
<div class="block">The shop limits of certain groups
This returns a key set, which contains the group names, of the <i>shop-limits.group</i> section in ShopChest's config.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#shopLimits_player">shopLimits_player</a></span></code>
<div class="block">The shop limits of certain players
This returns a key set, which contains the player names, of the <i>shop-limits.player</i> section in ShopChest's config.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#show_shop_items">show_shop_items</a></span></code>
<div class="block">Whether the shop items should be shown</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#two_line_hologram_lift">two_line_hologram_lift</a></span></code>
<div class="block">Amount the hologram should be lifted</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#two_line_prices">two_line_prices</a></span></code>
<div class="block">Whether the buy- and sell price should be arranged below each other</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#Config-de.epiceric.shopchest.ShopChest-">Config</a></span>(<a href="../../../../de/epiceric/shopchest/ShopChest.html" title="class in de.epiceric.shopchest">ShopChest</a>&nbsp;plugin)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#add-java.lang.String-java.lang.String-">add</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Add a value to a list in the config.yml.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../de/epiceric/shopchest/config/LanguageConfiguration.html" title="class in de.epiceric.shopchest.config">LanguageConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#getLanguageConfig--">getLanguageConfig</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#reload-boolean-boolean-">reload</a></span>(boolean&nbsp;firstLoad,
boolean&nbsp;langReload)</code>
<div class="block">Reload the configuration values from config.yml</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#remove-java.lang.String-java.lang.String-">remove</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/epiceric/shopchest/config/Config.html#set-java.lang.String-java.lang.String-">set</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Set a configuration value
<i>Config is automatically reloaded</i></div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="database_mysql_host">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>database_mysql_host</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> database_mysql_host</pre>
<div class="block">The hostname used in ShopChest's MySQL database</div>
</li>
</ul>
<a name="database_mysql_port">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>database_mysql_port</h4>
<pre>public&nbsp;int database_mysql_port</pre>
<div class="block">The port used for ShopChest's MySQL database</div>
</li>
</ul>
<a name="database_mysql_database">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>database_mysql_database</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> database_mysql_database</pre>
<div class="block">The database used for ShopChest's MySQL database</div>
</li>
</ul>
<a name="database_mysql_username">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>database_mysql_username</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> database_mysql_username</pre>
<div class="block">The username used in ShopChest's MySQL database</div>
</li>
</ul>
<a name="database_mysql_password">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>database_mysql_password</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> database_mysql_password</pre>
<div class="block">The password used in ShopChest's MySQL database</div>
</li>
</ul>
<a name="database_type">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>database_type</h4>
<pre>public&nbsp;<a href="../../../../de/epiceric/shopchest/sql/Database.DatabaseType.html" title="enum in de.epiceric.shopchest.sql">Database.DatabaseType</a> database_type</pre>
<div class="block">The database type used for ShopChest.</div>
</li>
</ul>
<a name="database_mysql_ping_interval">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>database_mysql_ping_interval</h4>
<pre>public&nbsp;int database_mysql_ping_interval</pre>
<div class="block">The interval in seconds, a ping is sent to the MySQL server</div>
</li>
</ul>
<a name="minimum_prices">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minimum_prices</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; minimum_prices</pre>
<div class="block"><p>The minimum prices for certain items</p>
This returns a key set, which contains e.g "STONE", "STONE:1", of the <i>minimum-prices</i> section in ShopChest's config.
To actually retrieve the price for an item, you have to get the Double <i>minimum-prices.<b>key</b></i>.</div>
</li>
</ul>
<a name="shopLimits_group">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shopLimits_group</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; shopLimits_group</pre>
<div class="block"><p>The shop limits of certain groups</p>
This returns a key set, which contains the group names, of the <i>shop-limits.group</i> section in ShopChest's config.
To actually retrieve the limits for a group, you have to get the Integer <i>shop-limits.group.<b>key</b></i>.</div>
</li>
</ul>
<a name="shopLimits_player">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shopLimits_player</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; shopLimits_player</pre>
<div class="block"><p>The shop limits of certain players</p>
This returns a key set, which contains the player names, of the <i>shop-limits.player</i> section in ShopChest's config.
To actually retrieve the limits for a player, you have to get the Integer <i>shop-limits.player.<b>key</b></i>.</div>
</li>
</ul>
<a name="blacklist">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>blacklist</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; blacklist</pre>
<div class="block"><p>List containing items, of which players can't create a shop</p>
If this list contains an item (e.g "STONE", "STONE:1"), it's in the blacklist.</div>
</li>
</ul>
<a name="buy_greater_or_equal_sell">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buy_greater_or_equal_sell</h4>
<pre>public&nbsp;boolean buy_greater_or_equal_sell</pre>
<div class="block">Whether the buy price of a shop must be greater than or equal the sell price</div>
</li>
</ul>
<a name="hopper_protection">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hopper_protection</h4>
<pre>public&nbsp;boolean hopper_protection</pre>
<div class="block">Whether shops should be protected by hoppers</div>
</li>
</ul>
<a name="explosion_protection">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explosion_protection</h4>
<pre>public&nbsp;boolean explosion_protection</pre>
<div class="block">Whether shops should be protected by explosions</div>
</li>
</ul>
<a name="enable_debug_log">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enable_debug_log</h4>
<pre>public&nbsp;boolean enable_debug_log</pre>
<div class="block">Whether the debug log file should be created</div>
</li>
</ul>
<a name="exclude_admin_shops">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exclude_admin_shops</h4>
<pre>public&nbsp;boolean exclude_admin_shops</pre>
<div class="block">Whether admin shops should be excluded of the shop limits</div>
</li>
</ul>
<a name="two_line_prices">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>two_line_prices</h4>
<pre>public&nbsp;boolean two_line_prices</pre>
<div class="block">Whether the buy- and sell price should be arranged below each other</div>
</li>
</ul>
<a name="append_potion_level_to_item_name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append_potion_level_to_item_name</h4>
<pre>public&nbsp;boolean append_potion_level_to_item_name</pre>
<div class="block">Whether the extension of a potion or tipped arrow (if available) should be appended to the item name.</div>
</li>
</ul>
<a name="show_shop_items">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>show_shop_items</h4>
<pre>public&nbsp;boolean show_shop_items</pre>
<div class="block">Whether the shop items should be shown</div>
</li>
</ul>
<a name="allow_broken_items">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allow_broken_items</h4>
<pre>public&nbsp;boolean allow_broken_items</pre>
<div class="block">Whether players are allowed to sell/buy broken items</div>
</li>
</ul>
<a name="remove_shop_on_error">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove_shop_on_error</h4>
<pre>public&nbsp;boolean remove_shop_on_error</pre>
<div class="block"><p>Whether shops should automatically be removed from the database if an error occurred while loading</p>
(e.g. when no chest is found at a shop's location)</div>
</li>
</ul>
<a name="auto_calculate_item_amount">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>auto_calculate_item_amount</h4>
<pre>public&nbsp;boolean auto_calculate_item_amount</pre>
<div class="block">Whether the item amount should be calculated to fit the available money or inventory space</div>
</li>
</ul>
<a name="two_line_hologram_lift">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>two_line_hologram_lift</h4>
<pre>public&nbsp;double two_line_hologram_lift</pre>
<div class="block">Amount the hologram should be lifted</div>
</li>
</ul>
<a name="maximal_distance">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maximal_distance</h4>
<pre>public&nbsp;double maximal_distance</pre>
<div class="block">The maximum distance between a player and a shop to see the hologram</div>
</li>
</ul>
<a name="maximal_item_distance">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maximal_item_distance</h4>
<pre>public&nbsp;double maximal_item_distance</pre>
<div class="block">The maximum distance between a player and a shop to see the shop item</div>
</li>
</ul>
<a name="shop_creation_price_normal">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shop_creation_price_normal</h4>
<pre>public&nbsp;double shop_creation_price_normal</pre>
<div class="block">The price a player has to pay in order to create a normal shop</div>
</li>
</ul>
<a name="shop_creation_price_admin">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shop_creation_price_admin</h4>
<pre>public&nbsp;double shop_creation_price_admin</pre>
<div class="block">The price a player has to pay in order to create an admin shop</div>
</li>
</ul>
<a name="default_limit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>default_limit</h4>
<pre>public&nbsp;int default_limit</pre>
<div class="block">The default shop limit for players and groups that are not listed in <a href="../../../../de/epiceric/shopchest/config/Config.html#shopLimits_player"><code>shopLimits_player</code></a> or in <a href="../../../../de/epiceric/shopchest/config/Config.html#shopLimits_group"><code>shopLimits_group</code></a></div>
</li>
</ul>
<a name="auto_reload_time">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>auto_reload_time</h4>
<pre>public&nbsp;int auto_reload_time</pre>
<div class="block">The time between automatic shop reloads (if set to 0, the timer will be disabled)</div>
</li>
</ul>
<a name="main_command_name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main_command_name</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> main_command_name</pre>
<div class="block">The main command of ShopChest <i>(default: shop)</i></div>
</li>
</ul>
<a name="language_file">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>language_file</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> language_file</pre>
<div class="block">The language file to use (e.g <i>en_US</i>, <i>de_DE</i>)</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Config-de.epiceric.shopchest.ShopChest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Config</h4>
<pre>public&nbsp;Config(<a href="../../../../de/epiceric/shopchest/ShopChest.html" title="class in de.epiceric.shopchest">ShopChest</a>&nbsp;plugin)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="set-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public&nbsp;void&nbsp;set(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><p>Set a configuration value</p>
<i>Config is automatically reloaded</i></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>property</code> - Property to change</dd>
<dd><code>value</code> - Value to set</dd>
</dl>
</li>
</ul>
<a name="add-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;add(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Add a value to a list in the config.yml.
If the list does not exist, a new list with the given value will be created</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>property</code> - Location of the list</dd>
<dd><code>value</code> - Value to add</dd>
</dl>
</li>
</ul>
<a name="remove-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;void&nbsp;remove(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
</li>
</ul>
<a name="reload-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reload</h4>
<pre>public&nbsp;void&nbsp;reload(boolean&nbsp;firstLoad,
boolean&nbsp;langReload)</pre>
<div class="block">Reload the configuration values from config.yml</div>
</li>
</ul>
<a name="getLanguageConfig--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLanguageConfig</h4>
<pre>public&nbsp;<a href="../../../../de/epiceric/shopchest/config/LanguageConfiguration.html" title="class in de.epiceric.shopchest.config">LanguageConfiguration</a>&nbsp;getLanguageConfig()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ShopChest's <a href="../../../../de/epiceric/shopchest/config/LanguageConfiguration.html" title="class in de.epiceric.shopchest.config"><code>LanguageConfiguration</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Config.html">Use</a></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">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../de/epiceric/shopchest/config/LanguageConfiguration.html" title="class in de.epiceric.shopchest.config"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?de/epiceric/shopchest/config/Config.html" target="_top">Frames</a></li>
<li><a href="Config.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink